IltmmDevice::get_FriendlyName
#include "ltmm.h"
C Syntax |
HRESULT IltmmDevice__get_FriendlyName(pDevice, pVal) |
C++ Syntax |
HRESULT get_FriendlyName(pVal) |
IltmmDevice *pDevice; |
/* pointer to an interface */ |
BSTR * pVal; |
/* pointer to a string */ |
Retrieves the device’s descriptive name.
Parameter |
Description |
pDevice |
Pointer to an IltmmDevice interface. |
pVal |
Pointer to a character 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. |
See Also
Elements: |
|
Topics: |
Example
For an example, refer to Selecting ltmmCapture Object Devices for C.
For an example, refer to Selecting ltmmCapture Object Devices for C++.