Share via

IDVB_BAT::GetRecordDescriptorByIndex Method

  • Article

This topic applies to Update Rollup 2 for Microsoft Windows XP Media Center Edition 2005 and later.
The GetRecordDescriptorByIndex method retrieves a descriptor for a specified record in the BAT.

Syntax

HRESULT GetRecordDescriptorByIndex(
  [in]   DWORD dwRecordIndex,
  [in]   DWORD dwIndex,
  [out]  IGenericDescriptor **ppDescriptor
);

Parameters

  • dwRecordIndex [in]
    Specifies the record number, indexed from zero. Call the IDVB_BAT::GetCountOfRecords method to get the number of records in the BAT.

  • dwIndex [in]
    Specifies which descriptor to retrieve, indexed from zero. Call the IDVB_BAT::GetRecordCountOfDescriptors method to get the number of descriptors for a particular record.

  • ppDescriptor [out]
    Address of a variable that receives an IGenericDescriptor interface pointer. 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 those in the following table.

Return code Description

E_POINTER

NULL pointer argument.

MPEG2_E_OUT_OF_BOUNDS

Index out of bounds.

S_OK

The method succeeded.

Requirements

Header Declared in Dvbsiparser.h.

See Also

IDVB_BAT Interface

Send comments about this topic to Microsoft

Build date: 12/4/2008