IToc::GetDescription method (wmcodecdsp.h)

  • Article

The GetDescription method retrieves the description, set by a previous call to SetDescription, of the table of contents.

Syntax

HRESULT GetDescription(
  [in, out] WORD   *pwDescriptionSize,
  [out]     LPWSTR pwszDescription
);

Parameters

[in, out] pwDescriptionSize

If pwszDescription is NULL, this is an output parameter that receives the size, in wide characters, of the buffer required to receive the description. If pwszDescription is not NULL, this is an input parameter that specifies the size, in wide characters, of the caller-allocated buffer pointed to by pwszDescription.

[out] pwszDescription

NULL, or a pointer to a caller-allocated buffer that, on successful completion, receives the description. The description is null-terminated.

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.
MF_E_BUFFERTOOSMALL
 The method returns this error code if pwszDescription is not NULL and the description, including its NULL terminator, is larger than the size specified by pwDescriptionSize. In that case, pwDescriptionSize serves as an output parameter and receives the size of the required buffer.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header wmcodecdsp.h
DLL Wmvdspa.dll

See also

IToc