ITocCollection::GetEntryByIndex method (wmcodecdsp.h)

The GetEntryByIndex method retrieves a table of contents, specified by an index, from the collection.

Syntax

HRESULT GetEntryByIndex(
  [in]  DWORD dwEntryIndex,
  [out] IToc  **ppToc
);

Parameters

[in] dwEntryIndex

Specifies the index of the table of contents to retrieve.

[out] ppToc

Pointer to a variable that receives a pointer to an IToc interface that represents the 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.

Remarks

In the context of an ITocCollection interface, the word entry refers to an individual table of contents. That meaning of the word entry is in contrast to its meaning in the context of other interfaces in the TOC Parser technology. For example, in the context of an IToc interface, the word entry refers to a block of information, in a table of contents, that represents a section of a video file.

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

ITocCollection