IltmmCaptureSubType::get_Name

#include "ltmm.h"

C Syntax

HRESULT IltmmCaptureSubType_get_Name(pCaptureSubType, pVal)

C++ Syntax

HRESULT get_Name(pVal)

 

IltmmCaptureSubType *pCaptureSubType;

/* pointer to an interface */

BSTR *pVal;

/* pointer to a string */

Retrieves the subtype’s unique name.

Parameter

Description

pCaptureSubType

Pointer to an IltmmCaptureSubType interface.

pVal

Pointer to a character string to be updated with the subtype’s unique 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 string obtained by the function can be used to uniquely identify a subtype. This name can be saved and used later with the ltmmCaptureSubTypes::Find function to restore the subtype selection.

If the function succeeds, the caller must free the updated 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:

ltmmCaptureSubTypes::Find, ltmmCaptureSubType::get_Selected

Topics:

Multimedia Function Group

Example

For a C example, refer to the IltmmCaptureSubTypes::get_Count Example for C.

For a C++ example, refer to the IltmmCaptureSubTypes::get_Count Example for C++.