LEADTOOLS Media Foundation Help > LEADTOOLS Media Foundation Features > Media Foundation Function References > IltmfTargetVideoFormat Interface > IltmfTargetVideoFormat::get_FriendlyName |
#include "ltmf.h"
C Syntax |
HRESULT IltmfTargetVideoFormat_get_FriendlyName(pTargetVideoFormat, pVal) |
C++ Syntax |
HRESULT get_FriendlyName(pVal) |
IltmfTargetVideoFormat *pTargetVideoFormat; |
/* pointer to an interface */ |
BSTR * pVal |
/* pointer to a variable */ |
Retrieves the target video format's descriptive name.
Parameter |
Description |
TargetVideoFormat |
Pointer to an IltmfTargetVideoFormat. |
pVal |
Pointer to a variable that receives a string containing the target video format's friendly name (the target Video format's descriptive 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 MediaFoundation documentation. |
Comments:
The returned name is not unique. However, it is ideal for presenting a descriptive name in user interfaces.
Required DLLs and Libraries
LTMF 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: |
IltmfTargetVideoFormat Interface, IltmfTargetVideoFormat::put_Selected, IltmfTargetVideoFormat::get_Name, IltmfTargetVideoFormat::get_Selected |
Topics: |
Example
For a C++ example, refer to Recompressing MP4 File Example for C++.