TaskService Class

Provides access to the Task Scheduler service for managing registered tasks.

Definition

Namespace: Microsoft.Win32.TaskScheduler
Assembly: Microsoft.Win32.TaskScheduler (in Microsoft.Win32.TaskScheduler.dll) Version: 2.11.0
[SerializableAttribute]
public sealed class TaskService : Component, 
	ISupportInitialize, ISerializable
Inheritance
Object    MarshalByRefObject    Component    TaskService
Implements
ISupportInitialize, ISerializable

Constructors

TaskServiceCreates a new instance of a TaskService connecting to the local machine as the current user.
TaskService(String, String, String, String, Boolean)Initializes a new instance of the TaskService class.

Properties

AllowReadOnlyTasks Gets or sets a value indicating whether to allow tasks from later OS versions with new properties to be retrieved as read only tasks.
AllTasksGets a IEnumeratorT which enumerates all the tasks in all folders.
CanRaiseEventsGets a value indicating whether the component can raise an event.
(Overrides ComponentCanRaiseEvents)
ConnectedGets a Boolean value that indicates if you are connected to the Task Scheduler service.
ConnectedDomainGets the name of the domain to which the TargetServer computer is connected.
Obsolete.
ConnectedUserGets the name of the user that is connected to the Task Scheduler service.
Obsolete.
ContainerGets the IContainer that contains the Component.
(Inherited from Component)
DesignModeGets a value that indicates whether the Component is currently in design mode.
(Inherited from Component)
EventsGets the list of event handlers that are attached to this Component.
(Inherited from Component)
HighestSupportedVersionGets the highest version of Task Scheduler that a computer supports.
InstanceGets a local instance of the TaskService using the current user's credentials.
LibraryVersion Gets the library version. This is the highest version supported by the local library. Tasks cannot be created using any compatibility level higher than this version.
RootFolderGets the root ("\") folder. For Task Scheduler 1.0, this is the only folder.
SiteGets or sets the ISite of the Component.
(Inherited from Component)
TargetServerGets or sets the name of the computer that is running the Task Scheduler service that the user is connected to.
Token Gets the connection token for this TaskService instance. This token is thread safe and can be used to create new TaskService instances on other threads using the CreateFromToken(TaskServiceConnectionToken) static method.
UserAccountDomainGets or sets the user account domain to be used when connecting to the TargetServer.
UserNameGets or sets the user name to be used when connecting to the TargetServer.
UserPasswordGets or sets the user password to be used when connecting to the TargetServer.

Methods

AddAutomaticMaintenanceTaskAdds or updates an Automatic Maintenance Task on the connected machine.
AddTask(String, Trigger, Action, String, String, TaskLogonType, String)Creates a new task, registers the task, and returns the instance.
AddTask(String, QuickTriggerType, String, String, String, String, TaskLogonType, String)Creates a new task, registers the task, and returns the instance.
BeginInitSignals the object that initialization is starting.
CreateFromToken Creates a new TaskService instance from a token. Given that a TaskService instance is thread specific, this is the preferred method for multi-thread creation or asynchronous method parameters.
CreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject)
DisposeReleases all resources used by the Component.
(Inherited from Component)
Dispose(Boolean) Releases the unmanaged resources used by the Component and optionally releases the managed resources.
(Overrides ComponentDispose(Boolean))
EndInitSignals the object that initialization is complete.
EqualsDetermines whether the specified Object, is equal to this instance.
(Overrides ObjectEquals(Object))
ExecuteInitial call for a Fluent model of creating a task.
FinalizeReleases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component)
FindAllTasks(PredicateTask, Boolean)Finds all tasks matching a name or standard wildcards.
FindAllTasks(Regex, Boolean)Finds all tasks matching a name or standard wildcards.
FindTaskFinds a task given a name and standard wildcards.
GetDllResourceStringGets a formatted string that tells the Task Scheduler to retrieve a string from a resource .dll file.
GetEventLogGets the event log for this TaskService instance.
GetFolderGets the path to a folder of registered tasks.
GetHashCodeReturns a hash code for this instance.
(Overrides ObjectGetHashCode)
GetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
GetRunningTasksGets a collection of running tasks.
GetServiceReturns an object that represents a service provided by the Component or by its Container.
(Inherited from Component)
GetTaskGets the task with the specified path.
GetTypeGets the Type of the current instance.
(Inherited from Object)
InitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
MemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject)
NewTask Returns an empty task definition object to be filled in with settings and properties and then registered using the RegisterTaskDefinition(String, TaskDefinition) method.
NewTaskFromFileReturns a TaskDefinition populated with the properties defined in an XML file.
RunComHandlerAction Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the ITaskHandler interface.
RunComHandlerActionAsync Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the ITaskHandler interface.
StartSystemTaskSchedulerManagerStarts the Task Scheduler UI for the OS hosting the assembly if the session is running in interactive mode.
ToStringReturns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component)

Events

DisposedOccurs when the component is disposed by a call to the Dispose method.
(Inherited from Component)
ServiceConnectedOccurs when the Task Scheduler is connected to the local or remote target.
ServiceDisconnectedOccurs when the Task Scheduler is disconnected from the local or remote target.

Extension Methods

GetFilteredAvailableActionsFiltered the supplied available actions based on this version of the Task Scheduler and options that could be set on the TaskDefinition.
(Defined by TaskServiceExtensions)
GetFilteredAvailableTriggersFiltered the supplied available triggers based on this version of the Task Scheduler and options that could be set on the TaskDefinition.
(Defined by TaskServiceExtensions)

See Also