IltmmCompressor::get_FriendlyName

#include "ltmm.h"

C Syntax

HRESULT IltmmCompressor_get_FriendlyName(pCompressor, pVal)

C++ Syntax

HRESULT get_FriendlyName(pVal)

IltmmCompressor *pCompressor;

pointer to an interface

BSTR *pVal;

string

Retrieves the compressors descriptive name.

Parameter

Description

pCompressor

Pointer to an IltmmCompressor interface.

pVal

Pointer to a character string containing the compressors friendly 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 name is not unique. However, it is ideal for presenting a descriptive name in user interfaces.

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