ICaptionServiceDescriptor::GetCaptionServiceNumber

Microsoft DirectShow 9.0

ICaptionServiceDescriptor::GetCaptionServiceNumber

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

The GetCaptionServiceNumber method returns the service number within the closed captioning stream for a specified caption service.

Syntax

  HRESULT GetCaptionServiceNumber(
    BYTE bIndex,
    BYTE *pbVal
);

Parameters

bIndex

[in]  Zero-based index of the caption service. To get the number of caption services, call ICaptionServiceDescriptor::GetNumberOfServices.

pbVal

[out]  Receives the caption_service_number field.

Return Values

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

Return code	Description
S_OK	The method succeeded.
MPEG2_E_INCORRECT_DESCRIPTOR_TAG	The table descriptor tag is incorrect.
MPEG2_E_MALFORMED_TABLE	The PSIP table is not well formed.
MPEG2_E_OUT_OF_BOUNDS	The bIndex parameter is out of range.

Requirements

Header: Include atscpsipparser.h.

See Also

• ICaptionServiceDescriptor Interface