IltmmPlay::get_Description

#include "ltmm.h"

C Syntax

HRESULT IltmmPlay__get_Description(pPlay, pVal)

C++ Syntax

HRESULT get_Description(pVal)

 

IltmmPlay *pPlay;

/* pointer to an interface */

BSTR *pVal;

/* pointer to a string */

Retrieves a description of the media’s content.

Parameter

Description

pPlay

Pointer to an IltmmPlay interface.

pVal

Pointer to a character string containing the information.

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

If the function 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, Mobile

See Also

Elements:

IltmmPlay::get_Author, IltmmPlay::get_Copyright, IltmmPlay::get_Rating, IltmmPlay::get_Title

Topics:

Multimedia Function Group

Example

For a C example, refer to the Simple Media Player for C.

For a C++ example, refer to the Simple Media Player for C++.