IltmmProcessor::get_Name

#include "ltmm.h"

C Syntax

HRESULT IltmmProcessor__get_Name(pProcessor, pVal)

C++ Syntax

HRESULT get_Name(pVal)

 

IltmmProcessor *pProcessor;

/* pointer to an interface */

BSTR *pVal;

/* pointer to a string */

Retrieves the processor’s unique name.

Parameter

Description

pProcessor

Pointer to an IltmmProcessor interface.

pVal

Pointer to a character string containing the processor’s name.

Returns

S_OK

The function was successful.

<> S_OK

An error occurred. Refer to the Error Codes or the HRESULT error codes in the DirectShow documentation.

Comments

The returned string can be used to uniquely identify a processor. A program can save this value to persistent storage and used later with the ltmmProcessors::Find function to locate the processor in the collection.

If the method succeeds, the caller must free the returned BSTR by calling the SysFreeString function.

Required DLLs and Libraries

LTMM

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64

See Also

Elements:

IltmmProcessor::get_FriendlyName, IltmmProcessors::Find

Topics:

Multimedia Function Group

Example

For an example, refer to Selecting ltmmCapture Object Processors for C.

For an example, refer to Selecting ltmmCapture Object Processors for C++.