IltmfDevice::get_FriendlyName

Summary

Retrieves the devices descriptive name.

Syntax

#include "ltmf.h"

Platform Syntax
C HRESULT IltmfDevice_get_FriendlyName(pDevice, pVal)
C++ HRESULT get_FriendlyName(pVal)

Parameters

IltmfDevice *pDevice

Pointer to an IltmfDevice interface.

BSTR *pVal

Pointer to a character string containing the devices friendly name.

Returns

Value Meaning
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 function succeeds, the caller must free the returned BSTR by calling the SysFreeString function.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

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

Help Version 22.0.2022.6.24
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2022 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Media Foundation C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2022 LEAD Technologies, Inc. All Rights Reserved.