Share via

ITocParser::GetTocByIndex Method

  • Article

The GetTocByIndex method retrieves a table of contents, specified by an index, from the TOC Parser object.

Syntax

HRESULT GetTocByIndex(
  [in]   enum TOC_POS_TYPE enumTocPosType,
  [in]   DWORD dwTocIndex,
  [out]  IToc **ppToc
);

Parameters

  • enumTocPosType [in]
    A member of the TOC_POS_TYPE enumeration that specifies the position type of the table of contents to be retrieved.

  • dwTocIndex [in]
    The index of the table of contents to be retrieved.

  • ppToc [out]
    Pointer to a variable that receives a pointer to an IToc interface that represents the retrieved table 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.

 

Requirements

Minimum supported client

 Windows Vista

Minimum supported server

 Windows Server 2008

Header

 Wmcodecdsp.h

DLL

 Wmvdspa.dll

See Also

ITocParser Interface

 

 

Send comments about this topic to Microsoft

Build date: 4/7/2010