Microsoft DirectX 8.1 (C++)

IGuideData::GetScheduleEntryProperties

The GetScheduleEntryProperties method retrieves an enumeration of all guide data properties for the specified schedule entry.

Syntax

HRESULT GetScheduleEntryProperties(
  VARIANT  varScheduleEntryDescriptionID,
  IEnumGuideDataProperties**  ppEnumProperties
);

Parameters

varScheduleEntryDescriptionID

[in] Specifies the unique identifier for the schedule entry for which properties are requested.

ppEnumProperties

[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 must release ppEnumProperties when finished with it.

The following properties must be included in the returned property enumeration.

Property	Description
Description.ID	A unique identifier of a schedule entry.
Description.Version	The current version of the properties associated with this program.
Time.Start	The starting time and date of this schedule entry.
Time.End	The ending time and date of this schedule entry.
Schedule.Program	The Description.ID of the program that will play at the time specified by this schedule entry.
Schedule.Service	The Description.ID of the service that carries the program that will play at the time specified by this schedule entry.

The property notation, such as "Description.ID", is shorthand for the MetaPropertySet and the MetaPropertyType. For more information, see Metaproperties.

See Also