LEADTOOLS Multimedia API Help
| LEADTOOLS Multimedia API Help > LEADTOOLS Multimedia Features > Multimedia Function References > IltmmAudioInput Interface > IltmmAudioInput::get_FriendlyName |
#include "ltmm.h"
|
C Syntax |
HRESULT IltmmAudioInput_get_FriendlyName(pInput, pVal) |
|
C++ Syntax |
HRESULT get_FriendlyName(pVal) |
|
IltmmAudioInput *pInput; |
/* pointer to an interface */ |
|
BSTR *pVal; |
/* pointer to a string */ |
Retrieves the audio input friendly name.
|
Parameter |
Description |
|
pInput |
Pointer to an IltmmAudioInput Interface. |
|
pVal |
Pointer to a variable to be updated with the inputs 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 retrieved string might be the same as that retrieved by IltmmAudioInput::Name. Call SysFreeString to free the memory allocated for the string when it is no longer needed.
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: |
|
|
Topics: |
Example
For a C example, refer to IltmmAudioInput::get_Bass Example for C.
For a C++ example, refer to IltmmAudioInput::get_Bass Example for C++.
