IATSC_VCT::GetRecordIsHideGuideBitSet 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 GetRecordIsHideGuideBitSet method queries whether the hide_guide bit is set for a particular record in the VCT.

Syntax

HRESULT GetRecordIsHideGuideBitSet(
  [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 hide_guide bit is set, or FALSE otherwise.

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.

Remarks

If the hidden bit is set, the hide_guide bit may be set to 0, indicating that this virtual channel should appear in electronic program guide (EPG) displays. If the hidden bit is 0, the hide_guide bit is ignored.

Requirements

Requirement	Value
Target Platform	Windows
Header	atscpsipparser.h

Share via