ISCTE_EAS::GetTableDescriptorByTag Method

This topic applies to Windows Vista and later.
The GetTableDescriptorByTag method searches the EAS table for a descriptor with the specified descriptor tag.

Syntax

HRESULT GetTableDescriptorByTag(
  [in]   BYTE bTag,
  [in]   DWORD *pdwCookie,
  [out]  IGenericDescriptor **ppDescriptor
);

Parameters

  • bTag [in]
    Specifies the descriptor tag for which to search.

  • pdwCookie [in]
    Pointer to a variable that specifies the start position in the descriptor list. This parameter is optional. If the value of pdwCookie is NULL, the search starts from the first descriptor in the list. Otherwise, the search starts from the position given in *pdwCookie. When the method returns, the pdwCookie parameter contains the position of the next matching descriptor, if any. You can use this parameter to iterate through the descriptor list, looking for every instance of a particular descriptor tag.

  • ppDescriptor [out]
    Receives a pointer to the IGenericDescriptor interface. Use this interface to retrieve the information in the descriptor. The caller must release the interface.

Return Value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description

MPEG2_E_NOT_PRESENT

The specified tag was not found.

MPEG2_E_OUT_OF_BOUNDS

Index out of bounds.

MPEG2_E_UNINITIALIZED

The Initialize method was not called.

MPEG2_S_MORE_DATA_AVAILABLE

The record contains at least one more descriptor with this tag.

MPEG2_S_NO_MORE_DATA_AVAILABLE

The record does not contain any more descriptors with this tag.

S_OK

The method succeeded.

Requirements

Header Declared in Atscpsipparser.h.

See Also

ISCTE_EAS Interface

Send comments about this topic to Microsoft

Build date: 12/4/2008