IltmfDevice::get_FriendlyName

#include "ltmf.h"

C Syntax

HRESULT IltmfDevice_get_FriendlyName(pDevice, pVal)

C++ Syntax

HRESULT get_FriendlyName(pVal)

IltmfDevice *pDevice;

pointer to an interface

BSTR * pVal;

pointer to a string

Retrieves the devices descriptive name.

Parameter

Description

pDevice

Pointer to an IltmfDevice interface.

pVal

Pointer to a character string containing the devices 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 MediaFoundation 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

LTMF

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:

IltmfDevice::get_Name

Topics:

Media Foundation Function Group

Example

For an example, refer to Selecting ltmfCapture Object Devices for C++.

Help Version 19.0.2017.10.19
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Media Foundation C API Help