Share via


ScheduleToken Class

 

Represents a task schedule as used by Configuration Manager.

Namespace:   Microsoft.ConfigurationManagement.Messaging.Framework.Scheduler
Assembly:  Microsoft.ConfigurationManagement.Messaging (in Microsoft.ConfigurationManagement.Messaging.dll)

Inheritance Hierarchy

System.Object
  Microsoft.ConfigurationManagement.Messaging.Framework.Scheduler.ScheduleToken
    Microsoft.ConfigurationManagement.Messaging.Framework.Scheduler.AsapScheduleToken
    Microsoft.ConfigurationManagement.Messaging.Framework.Scheduler.NonRecurringScheduleToken
    Microsoft.ConfigurationManagement.Messaging.Framework.Scheduler.RecurringIntervalScheduleToken
    Microsoft.ConfigurationManagement.Messaging.Framework.Scheduler.RecurringMonthlyByDateScheduleToken
    Microsoft.ConfigurationManagement.Messaging.Framework.Scheduler.RecurringWeeklyScheduleToken
    Microsoft.ConfigurationManagement.Messaging.Framework.Scheduler.SimpleScheduleToken

Syntax

[SerializableAttribute]
public abstract class ScheduleToken
[SerializableAttribute]
public ref class ScheduleToken abstract 
<SerializableAttribute>
Public MustInherit Class ScheduleToken

Properties

Name Description
System_CAPS_pubproperty Duration

Gets or sets the duration of time for which the schedule runs. This property is optional.

System_CAPS_pubproperty RecurrenceFlag

Gets a flag that represents the schedule type.

System_CAPS_pubproperty StartTime

Gets or sets the start time for the schedule. This property is required.

System_CAPS_pubproperty UseGmt

Specifies whether GMT or local time is used.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_static FromBitmask(UInt64)

Parses a long representation of a schedule token and creates a well-formed object.

System_CAPS_pubmethodSystem_CAPS_static FromString(String)

Converts a schedule from a string to a token.

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethod ProcessRecurrence()

Schedule implementor's specific durational processing

System_CAPS_pubmethod ToMask()

Returns the schedule as a ulong.

System_CAPS_pubmethod ToString()

Returns a String that represents the current Object. (Overrides Object.ToString().)

System_CAPS_pubmethod ToString(Boolean)

Returns a String that represents the current Object.

System_CAPS_pubmethod ToString(Boolean, String, Object[])

Returns a String that represents the current Object.

System_CAPS_protmethod Validate(IList<Exception>)

Validates the schedule.

Operators

Name Description
System_CAPS_puboperatorSystem_CAPS_static Explicit(ScheduleToken to String)

Converts from a schedule token to a string

System_CAPS_puboperatorSystem_CAPS_static Explicit(ScheduleToken to UInt64)

Converts from a schedule token to a ulong.

System_CAPS_puboperatorSystem_CAPS_static Explicit(String to ScheduleToken)

Converts from a string to a schedule token.

System_CAPS_puboperatorSystem_CAPS_static Explicit(UInt64 to ScheduleToken)

Converts from a ulong to a schedule token.

Remarks

See schedlst.cpp/schedlst.h.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.ConfigurationManagement.Messaging.Framework.Scheduler Namespace

Return to top