IltmmMediaInfo::get_Description

#include "ltmm.h"

C Syntax

HRESULT IltmmMediaInfo__get_Description (pMediaInfo, Description)

C++ Syntax

HRESULT get_Description (Description)

 

IltmmMediaInfo *pMediaInfo;

/* pointer to an interface */

BSTR * Description;

/* pointer to a string */

Retrieves the description of the media in the current source media file.

Parameter

Description

pMediaInfo

Pointer to an IltmmMediaInfo interface.

Description

Pointer to a string that receives the description of the media.

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

Call SysFreeString to free the memory allocated for the string when it is no longer needed.

The current source media file, set using IltmmMediaInfo::put_SourceFile, is the file for which the IltmmMediaInfo interface/object gets information. This function must be called before calling any of the other IltmmMediaInfo functions used for retrieving information.

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

See Also

Elements:

IltmmMediaInfo::get_Copyright, IltmmMediaInfo::get_Author, IltmmMediaInfo::put_SourceFile, IltmmMediaInfo::get_SourceFile, IltmmMediaInfo::get_Title, IltmmMediaInfo::get_Description, IltmmMediaInfo::get_Rating

Topics:

Multimedia Function Group
Media File Information

Example

For a C example, refer to Retrieving Media File Information for C.

For a C++ example, refer to Retrieving Media File Information for C++.