IATSC_VCT::GetRecordIsHiddenBitSet method (atscpsipparser.h)

  • Article

[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 GetRecordIsHiddenBitSet method queries whether the hidden bit is set for a particular record in the VCT.

Syntax

HRESULT GetRecordIsHiddenBitSet(
  [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 hidden bit is set. Otherwise, the value is FALSE. Hidden channels are not accessed by the user; for example, they might be used for test signals.

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

Requirement Value
Target Platform Windows
Header atscpsipparser.h

See also

IATSC_VCT Interface