IWMProfile::SetDescription method

The SetDescription method specifies the description of a profile. The description is a string that contains an explanation of what the profile should be used for.

Syntax

HRESULT SetDescription(
  const WCHAR *pwszDescription
);

Parameters

pwszDescription

Pointer to a wide-character null-terminated string containing the description. Profile descriptions are limited to 1024 wide characters.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
The method succeeded.
E_INVALIDARG
The pwszDescription parameter is NULL.

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps only],Windows Media Format 7 SDK, or later versions of the SDK
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header wmsdkidl.h (include Wmsdk.h)
Library Wmvcore.lib; WMStubDRM.lib (if you use DRM)

See also

IWMProfile Interface

IWMProfile2

IWMProfile3

IWMProfile::GetDescription