IltmmCompressor::get_Name

#include "ltmm.h"

C Syntax

HRESULT IltmmCompressor__get_Name(pCompressor, pVal)

C++ Syntax

HRESULT get_Name(pVal)

 

IltmmCompressor *pCompressor;

/* pointer to an interface */

BSTR *pVal;

/* string */

Retrieves the compressor’s unique name.

Parameter

Description

pCompressor

Pointer to an IltmmCompressor interface.

pVal

Pointer to a character string containing the compressor’s 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 compressor Also known as an encoder Also known as compressor, this is a module or algorithm to compress data. Playing that data back requires a decompressor, or decoder., this is a module or algorithm to compress data. Playing that data back requires a decompressor, or decoder Also known as a decompressor, this is a module or algorithm to decompress data... A program can save this value to persistent storage and used later with the ltmmCompressors::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

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.

See Also

Elements:

IltmmCompressor::get_FriendlyName, ltmmCompressors::Find

Topics:

Multimedia Function Group

Example

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

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