Share via

IAtscContentAdvisoryDescriptor::GetRecordRatingDescriptionText Method

This topic applies to Update Rollup 2 for Microsoft Windows XP Media Center Edition 2005 and later.
The GetRecordRatingDescriptionText method returns the rating description for a specified rating region.

Syntax

HRESULT GetRecordRatingDescriptionText(
  [in]   BYTE bIndex,
  [out]  BYTE *pbLength,
  [out]  BYTE **ppText
);

Parameters

  • bIndex [in]
    Zero-based index of the rating region. To get the number of rating regions, call IAtscContentAdvisoryDescriptor::GetRatingRegionCount.

  • pbLength [out]
    Receives the rating_description_length field.

  • ppText [out]
    Receives a pointer to a buffer that contains the rating_description_text field. The text is formatted as a Multiple String Structure as defined by ATSC PSIP Standard A/65. The caller must free the buffer by calling the CoTaskMemFree function.

Return Value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description

MPEG2_E_OUT_OF_BOUNDS

The bIndex parameter is out of bounds.

S_OK

The method succeeded.

Requirements

Header Declared in Atscpsipparser.h.

See Also

IAtscContentAdvisoryDescriptor Interface

Send comments about this topic to Microsoft

Build date: 12/4/2008