IltmmTargetDevice::get_FriendlyName

Summary

Retrieves the devices descriptive name.

Syntax

#include "ltmm.h"

Language Syntax
C HRESULT IltmmTargetDevice_get_FriendlyName(pTargetDevice, pVal)
C++ HRESULT get_FriendlyName(BSTR* pVal)

Parameters

IltmmTargetDevice *pTargetDevice

Pointer to an IltmmTargetDevice Interface.

BSTR *pVal

Pointer to a variable that receives a 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 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

Platforms

Win32, x64.

See Also

Functions

Topics

Example

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

LEADTOOLS Multimedia C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.