IToc::SetDescription method (wmcodecdsp.h)

  • Article

The SetDescription method associates a description with the table of contents.

Syntax

HRESULT SetDescription(
  [in] LPCWSTR pwszDescription
);

Parameters

[in] pwszDescription

Pointer to a NULL-terminated, wide-character string that contains the description.

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.

Remarks

You can use this method to associate any description with the table of contents. TOC parser does not inspect or interpret the description.

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

GetDescription

IToc