IltmmWMProfile::get_Description

#include "ltmm.h"

C Syntax

HRESULT IltmmWMProfile_get_Description(pProfile, pVal)

C++ Syntax

HRESULT get_Description(pVal)

 

IltmmWMProfile *pProfile;

/* pointer to an interface */

BSTR *pVal;

/* pointer to a string */

Gets the profile description.

Parameter

Description

pProfile

Pointer to an IltmmWMProfile interface.

pVal

Pointer to a string to be updated with the profile description.

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 description is a string that contains an explanation of the profile's use.

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

For more information, refer to the Microsoft documentation for IWMProfile::GetDescription .

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:

IltmmWMProfile::put_Description, IltmmWMProfile::get_Name, IltmmWMProfile::put_Name, IltmmWMProfile::get_Version

Topics:

Windows Media Support

 

Multimedia Function Group

Example

For a C example, refer to IltmmWMProfile::get_Version Example for C.

For a C++ example, refer to IltmmWMProfile::get_Version Example for C++.