IATSC_VCT::GetRecordIsOutOfBandBitSet method (atscpsipparser.h)

Article
12/05/2018

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

This topic applies to Update Rollup 2 for Microsoft Windows XP Media Center Edition 2005 and later.

The GetRecordIsOutOfBandBitSet method queries whether the out_of_band bit is set for a particular record in the VCT.

Syntax

HRESULT GetRecordIsOutOfBandBitSet(
  [in]  DWORD dwRecordIndex,
  [out] BOOL  *pfVal
);

Parameters

[in] dwRecordIndex

Specifies the record number, indexed from zero. Call the IATSC_VCT::GetCountOfRecords method to get the number of records in the VCT.

[out] pfVal

Receives a Boolean value. The value is TRUE if the out_of_band bit is set, indicating that this channel is carried on an out-of-band physical transmission channel. Otherwise, the value is FALSE.

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_NOT_PRESENT	The table does not contain an out_of_band bit.
MPEG2_E_OUT_OF_BOUNDS	Index out of bounds.
S_OK	The method succeeded.

Remarks

This bit applies only to cable VCTs. If the VCT is a terrestrial VCT, the method returns MPEG2_E_NOT_PRESENT.

Requirements

Requirement	Value
Target Platform	Windows
Header	atscpsipparser.h

Share via