IATSC_EIT::GetRecordTitleText 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 GetRecordTitleText method returns the title text for a record in the EIT.

Syntax

HRESULT GetRecordTitleText(
  [in]  DWORD dwRecordIndex,
  [out] DWORD *pdwLength,
  [out] BYTE  **ppText
);

Parameters

[in] dwRecordIndex

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

[out] pdwLength

Receives the length of the title text, in bytes.

[out] ppText

Receives a pointer to the text buffer. The method allocates the buffer and fills it with the title text, which is formatted as a Multiple String Structure as defined by ATSC PSIP Standard A/65. The caller must free the buffer by calling CoTaskMemFree.

Return value

The method returns an HRESULT. Possible values include those in the following table.

Return code Description
E_OUTOFMEMORY
 Insufficient memory.
E_POINTER
 NULL pointer argument.
MPEG2_E_OUT_OF_BOUNDS
 Index out of bounds.
S_FALSE
 This record does not contain a title.
S_OK
 The method succeeded.

Requirements

Requirement Value
Target Platform Windows
Header atscpsipparser.h

See also

IATSC_EIT Interface