IGuideData::GetScheduleEntryProperties method (bdatif.h)
[The feature associated with this page, Microsoft TV Technologies, is a legacy feature. Microsoft strongly recommends that new code does not use this feature.]
The GetScheduleEntryProperties method retrieves the properties for a specified schedule entry.
Syntax
HRESULT GetScheduleEntryProperties(
[in] VARIANT varScheduleEntryDescriptionID,
[out] IEnumGuideDataProperties **ppEnumProperties
);
Parameters
[in] varScheduleEntryDescriptionID
Specifies the unique identifier for the schedule entry. Call the IGuideData::GetScheduleEntryIDs method to get a list of schedule entry identifiers.
[out] ppEnumProperties
Pointer to a variable that receives an IEnumGuideDataProperties interface pointer. Use this interface to enumerate the properties. The caller must release the interface
Return value
The method returns an HRESULT. Possible values include those in the following table.
| Return code | Description |
|---|---|
|
The method succeeded. |
Remarks
The returned collection includes the following properties.
| Property | Description |
|---|---|
| Description.ID | The unique identifier for the schedule entry. |
| Time.Start | The starting time and date of this schedule entry. The value of this property is an unsigned long containing the time and date in GPS time. |
| Time.End | The ending time and date of this schedule entry. The value of this property is an unsigned long containing the time and date in GPS time. |
| ScheduleEntry.ProgramID | Identifies the program that will play at the time specified by this schedule entry. The value of this property corresponds to the Description.ID property of the program. |
| ScheduleEntry.ServiceID | Identifies the service that carries the program represented by this schedule entry. The value of this property corresponds to the Description.ID property of the service. |
The method fails if the TIF has not received the schedule information from the PSI tables in the transport stream. The client should implement the IGuideDataEvent interface and wait for the IGuideDataEvent::ScheduleEntryChanged event to be fired.
Requirements
| Requirement | Value |
|---|---|
| Target Platform | Windows |
| Header | bdatif.h |