ScheduleEventStates Enumeration

Contains the possible states of a scheduled recording event.

Syntax

public enum ScheduleEventStates

The ScheduleEventStates enumeration defines the following constants:

Members Description
All This value is used only to specify all states for the GetScheduleEvents method. This value is not used as a state for any actual scheduled recording event.
Alternate Indicates an alternative airing of a specific program. The state occurs only when an "IsOccuring" scheduled recording event of the same TV recording event fails.
Canceled The scheduled recording event has been canceled before it starts, typically due to a user request.
Conflict The scheduled recording event exists, but it will not occur due to another scheduled recording event with a higher priority.
Deleted The scheduled recording event has finished, but the recorded media for it has been deleted.
Error The scheduled recording event exists, but it will not occur or it failed to start because of an error, such as insufficient disk space or the tuner was not available at the scheduled time.
HasOccurred The scheduled recording event has finished and the recorded file is available.
IsOccurring The scheduled recording event is in progress.
None The initial state in which the scheduled recording event does not exist or does not have any state.
WillOccur The scheduled recording event is scheduled to occur.

Remarks

This enumeration is bit-field flag. You can specify or receive values of this enumeration combined by a bitwise OR.

An application should not handle scheduled recording events with the following states because they may disappear without notification:

  • None
  • Canceled
  • Deleted

If a future scheduled recording event might not be recorded due to insufficient disk space, that possibility is not reflected in this state information.

Requirements

Reference: ehRecObj

Namespace: Microsoft.MediaCenter.TV.Scheduling

Assembly: ehRecObj.dll

Platform: Windows Vista Ultimate, Windows Vista Home Premium, and later

See Also