IltmmTargetFormat::get_Name

Summary

Retrieves the formats unique name.

Syntax

#include "ltmm.h"

Language Syntax
C HRESULT IltmmTargetFormat_get_Name(pTargetFormat, pVal)
C++ HRESULT get_Name(pVal)

Parameters

IltmmTargetFormat *pTargetFormat

Pointer to an IltmmTargetFormat interface.

BSTR *pVal

Pointer to a variable that receives a string containing the formats name.

Returns

Value Meaning
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

Platforms

Win32, x64.

See Also

Functions

Topics

Example

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

LEADTOOLS Multimedia C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.