IltmmRenderer::get_Name

#include "ltmm.h"

C Syntax

HRESULT IltmmRenderer__get_Name(pRenderer, pVal)

C++ Syntax

HRESULT get_Name(pVal)

 

IltmmRenderer *pRenderer;

/* pointer to an interface */

BSTR * pVal;

/* pointer to a string */

Retrieves the renderer’s unique name.

Parameter

Description

pRenderer

Pointer to an IltmmRenderer interface.

pVal

Pointer to a character string containing the renderer’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 renderer. A program can save this value to persistent storage and used later with the IltmmRenderers::Find function to restore the renderer selection.

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.

See Also

Elements:

IltmmRenderer::get_FriendlyName, ltmmRenderers::Find

Topics:

Multimedia Function Group

Example

For a C example, refer to Selecting ltmmCapture Object Renderers for C.

For a C++ example, refer to Selecting ltmmCapture Object Renderers for C++.