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.
Definition
Namespace: Microsoft.Win32.TaskScheduler
Assembly: Microsoft.Win32.TaskScheduler (in Microsoft.Win32.TaskScheduler.dll) Version: 2.11.0
Assembly: Microsoft.Win32.TaskScheduler (in Microsoft.Win32.TaskScheduler.dll) Version: 2.11.0
C#
[XmlTypeAttribute(IncludeInSchema = false)]
public class Task : IDisposable, IComparable, IComparable<Task>,
INotifyPropertyChanged- Inheritance
- Object Task
- Derived
- Implements
- INotifyPropertyChanged, IComparable, IComparableTask, IDisposable
Properties
| Definition | Gets the definition of the task. |
| Enabled | Gets or sets a Boolean value that indicates if the registered task is enabled. |
| Folder | Gets an instance of the parent folder. |
| IsActive | Gets a value indicating whether this task instance is active. |
| LastRunTime | Gets the time the registered task was last run. |
| LastTaskResult | Gets the results that were returned the last time the registered task was run. |
| Name | Gets the name of the registered task. |
| NextRunTime | Gets the time when the registered task is next scheduled to run. |
| NumberOfMissedRuns | Gets the number of times the registered task has missed a scheduled run. |
| Path | Gets the path to where the registered task is stored. |
| ReadOnly | Gets a value indicating whether this task is read only. Only available if AllowReadOnlyTasks is true. |
| SecurityDescriptor | Gets or sets the security descriptor for the task. Obsolete. |
| State | Gets the operational state of the registered task. |
| TaskService | Gets or sets the TaskService that manages this task. |
| Xml | Gets the XML-formatted registration information for the registered task. |
Methods
| CompareTo | 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. |
| Dispose | Releases all resources used by this class. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Export | Exports the task to the specified file in XML. |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetAccessControl | Gets a TaskSecurity object that encapsulates the specified type of access control list (ACL) entries for the task described by the current Task object. |
| GetAccessControl(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. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetInstances | Gets all instances of the currently running registered task. |
| GetLastRegistrationTime | Gets the last registration time, looking first at the Date value and then looking for the most recent registration event in the Event Log. |
| GetRunTimes | Gets the times that the registered task is scheduled to run during a specified time. |
| GetSecurityDescriptorSddlForm | Gets the security descriptor for the task. Not available to Task Scheduler 1.0. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnNotifyPropertyChanged | Called when a property has changed to notify any attached elements. |
| RegisterChanges | 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. |
| Run | Runs the registered task immediately. |
| RunEx | Runs the registered task immediately using specified flags and a session identifier. |
| SetAccessControl | Applies access control list (ACL) entries described by a TaskSecurity object to the file described by the current Task object. |
| SetSecurityDescriptorSddlForm | Sets the security descriptor for the task. Not available to Task Scheduler 1.0. |
| ShowEditor | Dynamically tries to load the assembly for the editor and displays it as editable for this task. |
| ShowPropertyPage | Shows the property page for the task (v1.0 only). |
| Stop | Stops the registered task immediately. |
| ToString | Returns a String that represents this instance. (Overrides ObjectToString) |
Events
| PropertyChanged | Occurs when a property value changes. |