Windows Media Format SDK banner art
PreviousNext

IWMProfile::GetDescription

The GetDescription method retrieves the profile description.

Syntax

HRESULT GetDescription(
  WCHAR*  pwszDescription,
  DWORD*  pcchName
);

Parameters

  pwszDescription

[out]  Pointer to a wide-character NULL-terminated string containing the description.

  pcchName

[in, out]  On input, specifies the length of the pwszDescription string. On output, and if the method succeeds, specifies a pointer to a count of the actual number of characters in the name.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Return code Meaning
E_INVALIDARG The pcchName parameter is NULL.
ASF_E_BUFFERTOOSMALL The pwszDescription parameter is not large enough.
E_UNEXPECTED The method failed for an unspecified reason.

See Also

PreviousNext


© 1999 Microsoft Corporation. All rights reserved.