Share via

IToc::SetDescription Method

  • Article

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

Syntax

HRESULT SetDescription(
  [in]  LPCWSTR  pwszDescription
);

Parameters

  • pwszDescription [in]
    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

Minimum supported client

 Windows Vista

Minimum supported server

 Windows Server 2008

Header

 Wmcodecdsp.h

DLL

 Wmvdspa.dll

See Also

IToc

GetDescription

 

 

Send comments about this topic to Microsoft

Build date: 4/7/2010