IDvbSubtitlingDescriptor::GetRecordAncillaryPageID method (dvbsiparser.h)

[The feature associated with this page, Microsoft TV Technologies, is a legacy feature. Microsoft strongly recommends that new code does not use this feature.]

Gets the ancillary page identifier for a Digital Video Broadcast (DVB) subtitling descriptor. The DVB subtitling segments signalling the ancillary page identifier are decoded if the previous data in the subtitling descriptor matches the user's selection criteria.

Syntax

HRESULT GetRecordAncillaryPageID(
  [in]  BYTE bRecordIndex,
  [out] WORD *pwVal
);

Parameters

[in] bRecordIndex

Zero-based index of the descriptor to return. To get the number of descriptors, call IDvbSubtitlingDescriptor::GetCountOfRecords

[out] pwVal

Receives the ancillary page identifier.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

If the subtitling descriptor has no ancillary page, the values in the ancillary_page_id and composition_page_id fields of the descriptor are the same.

The ancillary_page_id is never signalled in a composition segment. It may be signalled in color lookup table (CLUT) definition segments, object segments, or any other type of segment.

Requirements

See also

IDvbSubtitlingDescriptor

IDvbSubtitlingDescriptor::GetCountOfRecords