Click or drag to resize
Task Scheduler Managed Class Library

TaskService Class

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

Namespace:  Microsoft.Win32.TaskScheduler
Assembly:  Microsoft.Win32.TaskScheduler (in Microsoft.Win32.TaskScheduler.dll) Version: 2.10.1
Syntax
[SerializableAttribute]
public sealed class TaskService : Component, 
	ISupportInitialize, ISerializable
Request Example View Source

The TaskService type exposes the following members.

Constructors
  NameDescription
Public methodTaskService
Creates a new instance of a TaskService connecting to the local machine as the current user.
Public methodTaskService(String, String, String, String, Boolean)
Initializes a new instance of the TaskService class.
Top
Properties
  NameDescription
Public propertyAllowReadOnlyTasks
Gets or sets a value indicating whether to allow tasks from later OS versions with new properties to be retrieved as read only tasks.
Public propertyAllTasks
Protected propertyCanRaiseEvents
Gets a value indicating whether the component can raise an event.
(Overrides ComponentCanRaiseEvents.)
Public propertyConnected
Gets a Boolean value that indicates if you are connected to the Task Scheduler service.
Public propertyConnectedDomain Obsolete.
Gets the name of the domain to which the TargetServer computer is connected.
Public propertyConnectedUser Obsolete.
Gets the name of the user that is connected to the Task Scheduler service.
Public propertyContainer
Gets the IContainer that contains the Component.
(Inherited from Component.)
Protected propertyDesignMode
Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component.)
Protected propertyEvents
Gets the list of event handlers that are attached to this Component.
(Inherited from Component.)
Public propertyHighestSupportedVersion
Gets the highest version of Task Scheduler that a computer supports.
Public propertyStatic memberInstance
Gets a local instance of the TaskService using the current user's credentials.
Public propertyStatic memberLibraryVersion
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.
Public propertyRootFolder
Gets the root ("\") folder. For Task Scheduler 1.0, this is the only folder.
Public propertySite
Gets or sets the ISite of the Component.
(Inherited from Component.)
Public propertyTargetServer
Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to.
Public propertyToken
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.
Public propertyUserAccountDomain
Gets or sets the user account domain to be used when connecting to the TargetServer.
Public propertyUserName
Gets or sets the user name to be used when connecting to the TargetServer.
Public propertyUserPassword
Gets or sets the user password to be used when connecting to the TargetServer.
Top
Methods
  NameDescription
Public methodAddAutomaticMaintenanceTask
Adds or updates an Automatic Maintenance Task on the connected machine.
Public methodCode exampleAddTask(String, Trigger, Action, String, String, TaskLogonType, String)
Creates a new task, registers the task, and returns the instance.
Public methodCode exampleAddTask(String, QuickTriggerType, String, String, String, String, TaskLogonType, String)
Creates a new task, registers the task, and returns the instance.
Public methodBeginInit
Signals the object that initialization is starting.
Public methodStatic memberCreateFromToken
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.
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodDispose
Releases all resources used by the Component.
(Inherited from Component.)
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the Component and optionally releases the managed resources.
(Overrides ComponentDispose(Boolean).)
Public methodEndInit
Signals the object that initialization is complete.
Public methodEquals
Determines whether the specified Object, is equal to this instance.
(Overrides ObjectEquals(Object).)
Public methodExecute
Initial call for a Fluent model of creating a task.
Protected methodFinalize
Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component.)
Public methodFindAllTasks(PredicateTask, Boolean)
Finds all tasks matching a name or standard wildcards.
Public methodFindAllTasks(Regex, Boolean)
Finds all tasks matching a name or standard wildcards.
Public methodFindTask
Finds a task given a name and standard wildcards.
Public methodStatic memberCode exampleGetDllResourceString
Gets a formatted string that tells the Task Scheduler to retrieve a string from a resource .dll file.
Public methodGetEventLog
Gets the event log for this TaskService instance.
Public methodGetFolder
Gets the path to a folder of registered tasks.
Public methodGetHashCode
Returns a hash code for this instance.
(Overrides ObjectGetHashCode.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodGetRunningTasks
Gets a collection of running tasks.
Protected methodGetService
Returns an object that represents a service provided by the Component or by its Container.
(Inherited from Component.)
Public methodGetTask
Gets the task with the specified path.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
Public methodNewTask
Returns an empty task definition object to be filled in with settings and properties and then registered using the RegisterTaskDefinition(String, TaskDefinition) method.
Public methodNewTaskFromFile
Returns a TaskDefinition populated with the properties defined in an XML file.
Public methodStatic memberRunComHandlerAction
Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the ITaskHandler interface.
Public methodStatic memberRunComHandlerActionAsync
Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the ITaskHandler interface.
Public methodStartSystemTaskSchedulerManager
Starts the Task Scheduler UI for the OS hosting the assembly if the session is running in interactive mode.
Public methodToString
Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component.)
Top
Events
  NameDescription
Public eventDisposed
Occurs when the component is disposed by a call to the Dispose method.
(Inherited from Component.)
Public eventServiceConnected
Occurs when the Task Scheduler is connected to the local or remote target.
Public eventServiceDisconnected
Occurs when the Task Scheduler is disconnected from the local or remote target.
Top
Extension Methods
  NameDescription
Public Extension MethodGetFilteredAvailableActions
Filtered the supplied available actions based on this version of the Task Scheduler and options that could be set on the TaskDefinition.
(Defined by TaskServiceExtensions.)
Public Extension MethodGetFilteredAvailableTriggers
Filtered the supplied available triggers based on this version of the Task Scheduler and options that could be set on the TaskDefinition.
(Defined by TaskServiceExtensions.)
Top
See Also