Click or drag to resize
Task Scheduler Managed Class Library

Task Class

Provides the methods that are used to run the task immediately, get any running instances of the task, get or set the credentials that are used to register the task, and the properties that describe the task.
Inheritance Hierarchy
SystemObject
  Microsoft.Win32.TaskSchedulerTask
    Microsoft.Win32.TaskSchedulerRunningTask

Namespace: Microsoft.Win32.TaskScheduler
Assembly: Microsoft.Win32.TaskScheduler (in Microsoft.Win32.TaskScheduler.dll) Version: 2.12.0
Syntax
C#
[XmlTypeAttribute(IncludeInSchema = false)]
public class Task : IDisposable, IComparable, IComparable<Task>, 
	INotifyPropertyChanged
Request Example View Source

The Task type exposes the following members.

Properties
 NameDescription
Public propertyDefinitionGets the definition of the task.
Public propertyEnabledGets or sets a Boolean value that indicates if the registered task is enabled.
Public propertyFolderGets an instance of the parent folder.
Public propertyIsActiveGets a value indicating whether this task instance is active.
Public propertyLastRunTimeGets the time the registered task was last run.
Public propertyCode exampleLastTaskResultGets the results that were returned the last time the registered task was run.
Public propertyNameGets the name of the registered task.
Public propertyNextRunTimeGets the time when the registered task is next scheduled to run.
Public propertyNumberOfMissedRunsGets the number of times the registered task has missed a scheduled run.
Public propertyPathGets the path to where the registered task is stored.
Public propertyReadOnly Gets a value indicating whether this task is read only. Only available if AllowReadOnlyTasks is true.
Public propertySecurityDescriptorObsolete.
Gets or sets the security descriptor for the task.
Public propertyStateGets the operational state of the registered task.
Public propertyTaskServiceGets or sets the TaskService that manages this task.
Public propertyXmlGets the XML-formatted registration information for the registered task.
Top
Methods
 NameDescription
Public methodCompareTo Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
Public methodDisposeReleases all resources used by this class.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodExportExports the task to the specified file in XML.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetAccessControl Gets a TaskSecurity object that encapsulates the specified type of access control list (ACL) entries for the task described by the current Task object.
Public methodGetAccessControl(AccessControlSections) Gets a TaskSecurity object that encapsulates the specified type of access control list (ACL) entries for the task described by the current Task object.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetInstancesGets all instances of the currently running registered task.
Public methodGetLastRegistrationTime Gets the last registration time, looking first at the Date value and then looking for the most recent registration event in the Event Log.
Public methodGetRunTimesGets the times that the registered task is scheduled to run during a specified time.
Public methodGetSecurityDescriptorSddlFormGets the security descriptor for the task. Not available to Task Scheduler 1.0.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnNotifyPropertyChangedCalled when a property has changed to notify any attached elements.
Public methodRegisterChanges Updates the task with any changes made to the Definition by calling RegisterTaskDefinition(String, TaskDefinition) from the currently registered folder using the currently registered name.
Public methodCode exampleRunRuns the registered task immediately.
Public methodCode exampleRunExRuns the registered task immediately using specified flags and a session identifier.
Public methodCode exampleSetAccessControl Applies access control list (ACL) entries described by a TaskSecurity object to the file described by the current Task object.
Public methodSetSecurityDescriptorSddlFormSets the security descriptor for the task. Not available to Task Scheduler 1.0.
Public methodShowEditorDynamically tries to load the assembly for the editor and displays it as editable for this task.
Public methodShowPropertyPageShows the property page for the task (v1.0 only).
Public methodStopStops the registered task immediately.
Public methodToStringReturns a String that represents this instance.
(Overrides ObjectToString)
Top
Events
 NameDescription
Public eventPropertyChangedOccurs when a property value changes.
Top
See Also