IltmmTargetDevice::get_FriendlyName

#include "ltmm.h"

C Syntax

HRESULT IltmmTargetDevice_get_FriendlyName(pTargetDevice, pVal)

C++ Syntax

HRESULT get_FriendlyName(BSTR* pVal)

 

IltmmTargetDevice *pTargetDevice;

/* pointer to an interface */

BSTR * pVal;

/* pointer to a string */

Retrieves the device’s descriptive name.

Parameter

Description

pTargetDevice

Pointer to an IltmmTargetDevice Interface.

pVal

Pointer to a variable that receives a string containing the device’s friendly 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 name is not unique. However, it is ideal for presenting a descriptive name in user interfaces.

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:

IltmmTargetDevice::get_Name

Topics:

Multimedia Function Group

Example

For a C example, refer to Selecting ltmmCapture Object Target Devices for C and Selecting ltmmConvert Object Target Devices for C.

For a C++ example, refer to Selecting ltmmCapture Object Target Devices for C++ and Selecting ltmmConvert Object Target Devices for C++