IltmfCompressor::get_Name

#include "ltmf.h"

C Syntax

HRESULT IltmfCompressor_get_Name(pCompressor, pVal)

C++ Syntax

HRESULT get_Name(pVal)

IltmfCompressor *pCompressor;

pointer to an interface

BSTR *pVal;

string

Retrieves the compressors unique name.

Parameter

Description

pCompressor

Pointer to an IltmfCompressor interface.

pVal

Pointer to a character string containing the compressors 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 string can be used to uniquely identify a compressor . A program can save this value to persistent storage and used later with the ltmfCompressors::Find function to restore the compressor selection.

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

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.

Platforms

Win32

See Also

Elements:

IltmfCompressor::get_FriendlyName, ltmfCompressors::Find

Topics:

Media Foundation Function Group

Example

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

Help Version 19.0.2017.10.19
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Media Foundation C API Help