IltmmTargetFormat::get_Name

#include "ltmm.h"

C Syntax

HRESULT IltmmTargetFormat_get_Name(pTargetFormat, pVal)

C++ Syntax

HRESULT get_Name(pVal)

IltmmTargetFormat *pTargetFormat;

pointer to an interface

BSTR *pVal;

pointer to a string

Retrieves the formats unique name.

Parameter

Description

pTargetFormat

Pointer to an IltmmTargetFormat interface.

pVal

Pointer to a variable that receives a string containing the formats 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 format. A program can save this value to persistent storage and used later with the IltmmTargetFormats::Find function to restore the format 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.

Platforms

Win32, x64

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

LEADTOOLS Multimedia C API Help