ITocParser::GetTocByType Method

Article
04/12/2010

The GetTocByType retrieves all tables of contents of a specified type from the TOC Parser object.

Syntax

HRESULT GetTocByType(
  [in]   enum TOC_POS_TYPE enumTocPosType,
  [in]   GUID guidTocType,
  [out]  ITocCollection **ppTocs
);

Parameters

enumTocPosType [in]
A member of the TOC_POS_TYPE enumeration that specifies the position type of the table of contents to be retrieved.
guidTocType [in]
A globally unique identifier (GUID) that specifies the type of table of contents to retrieve. See Remarks.
ppTocs [out]
Pointer to an ITocCollection interface that represents the colleciton of retrieved tables of contents.

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 might want to design several different type of tables of contents. In that case, you can distinguish between types by creating a GUID that represents each type. You can identify a table of contents as a particular type by setting the guidType member of a TOC_DESCRIPTOR structure and then passing the TOC_DESCRIPTOR structure to IToc::SetDescriptor.

Requirements

Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Header	Wmcodecdsp.h
DLL	Wmvdspa.dll

Share via