ITocParser::GetTocByType method (wmcodecdsp.h)

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

Syntax

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

Parameters

enumTocPosType

[in] guidTocType

A globally unique identifier (GUID) that specifies the type of table of contents to retrieve. See Remarks.

[out] ppTocs

Pointer to an ITocCollection interface that represents the collection 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

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

ITocParser

RemoveTocByType