IWMProfile::GetDescription method (wmsdkidl.h)
[The feature associated with this page, Windows Media Format 11 SDK, is a legacy feature. It has been superseded by Source Reader and Sink Writer. Source Reader and Sink Writer have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Source Reader and Sink Writer instead of Windows Media Format 11 SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
The GetDescription method retrieves the profile description. The description is a string that contains an explanation of what the profile should be used for.
Syntax
HRESULT GetDescription(
[out] WCHAR *pwszDescription,
[in, out] DWORD *pcchDescription
);
Parameters
[out] pwszDescription
Pointer to a wide-character null-terminated string containing the description. Pass NULL to retrieve the required length for the description.
[in, out] pcchDescription
On input, specifies the length of the pwszDescription string. On output, if the method succeeds, specifies a pointer to a count of the number of characters in the name, including the terminating null character.
Return value
The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.
| Return code | Description |
|---|---|
|
The method succeeded. |
|
The pcchName parameter is NULL. |
|
The buffer pointed to by the pwszDescription parameter is not large enough. |
|
The method failed for an unspecified reason. |
Remarks
You should make two calls to GetDescription. On the first call, pass NULL as pwszDescription. On return, the value pointed to by pcchDescription is set to the number of wide characters, including the terminating null character, required to hold the profile description. Then you can allocate the required amount of memory for the string and pass a pointer to it as pwszDescription on the second call.
Requirements
| Requirement | Value |
|---|---|
| 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) |