IltmfCompressor::get_FriendlyName

Summary

Retrieves the compressors descriptive name.

Syntax

#include "ltmf.h"

Language Syntax
C HRESULT IltmfCompressor_get_FriendlyName(pCompressor, pVal)
C++ HRESULT get_FriendlyName(pVal)

Parameters

IltmfCompressor *pCompressor

Pointer to an IltmfCompressor interface.

BSTR *pVal

Pointer to a character string containing the compressors friendly 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 MediaFoundation documentation.

Comments

The returned name is not unique. However, it is ideal for presenting a descriptive name in user interfaces.

If the function succeeds, the caller must free the returned BSTR by calling the SysFreeString function.

Required DLLs and Libraries

Platforms

Win32.

See Also

Functions

Topics

Example

For an example, refer to Selecting ltmfConvert Object Compressors for C++.

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

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