Microsoft DirectX 8.1 (C++)

IGuideData::GetScheduleEntryIDs

The GetScheduleEntryIDs method retrieves an enumeration of the Description.ID metaproperties for all schedule entries on the specified transport stream.

Syntax

HRESULT GetScheduleEntryIDs(
  ITuneRequest*  pTuneRequest,
  IEnumVARIANT**  ppEnumScheduleEntries
);

Parameters

pTuneRequest

[in]  Pointer to a tune request that contains information needed to identify the requested transport stream. NULL indicates that information about the current transport stream is requested.

ppEnumScheduleEntries

[out]  Pointer to a variable that receives the returned collection.

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.

Remarks

The caller is responsible for releasing pEnumScheduleEntries.

"Description.ID" is shorthand for the metaproperty of MetaPropertyType "ID" within the standard Guide Store MetaPropertySet named "Description." For more information, see Metaproperties.

This method is used to get a list of schedule entries that have guide data properties in the specified transport stream. Each variant returned in the collection contains the unique Description.ID property for a schedule entry. More than one transport stream may contain properties for the same schedule entry. In this case the properties should be merged.

See Also