ILMMixCapSrcDevice::get_FriendlyName

Summary

Retrieves the device's descriptive name.

Syntax

#include "ilmmixcapsrc.h"
Platform Syntax
C HRESULT ILMMixCapSrcDevice_get_FriendlyName(pixCapSrcDevice, pVal)
C++ HRESULT get_FriendlyName(pVal)

Parameters

ILMMixCapSrcDevice * pixCapSrcDevice

Pointer to an ILMMixCapSrcDevice interface.

BSTR *pVal

Pointer to a character string containing the device's 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 retrieved 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 value of pVal by calling the SysFreeString function.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

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

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