#include "ltmm.h"
|
C Syntax |
HRESULT IltmmTargetDevice_get_Name(pTargetDevice, pVal) |
|
C++ Syntax |
HRESULT get_Name(pVal); |
|
IltmmTargetDevice *pTargetDevice; |
/* pointer to an interface */ |
|
BSTR * pVal; |
/* pointer to a string */ |
Retrieves the device’s unique name.
|
Parameter |
Description |
|
pTargetDevice |
Pointer to an IltmmTargetDevice Interface. |
|
pVal |
Pointer to a variable that receives a string containing the device’s 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 string can be used to uniquely identify a device. A program can save this value to persistent storage and use it later with the IltmmTargetDevices::Find function to restore the device selection.
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. |
Win32, x64
See Also
|
Elements: |
IltmmTargetDevice::get_FriendlyName, IltmmTargetDevices::Find |
|
Topics: |
Example
For a C example, refer to Selecting ltmmCapture Object Target Devices for C and Selecting ltmmConvert Object Target Devices for C.
For a C++ example, refer to Selecting ltmmCapture Object Target Devices for C++ and Selecting ltmmConvert Object Target Devices for C++.