Click or drag to resize
Task Scheduler Managed Class Library

ComHandlerAction Class

Represents an action that fires a handler. Only available on Task Scheduler 2.0.
Note  Note
Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later.
Inheritance Hierarchy
SystemObject
  Microsoft.Win32.TaskSchedulerAction
    Microsoft.Win32.TaskSchedulerComHandlerAction

Namespace: Microsoft.Win32.TaskScheduler
Assembly: Microsoft.Win32.TaskScheduler (in Microsoft.Win32.TaskScheduler.dll) Version: 2.12.0
Syntax
C#
[XmlTypeAttribute(IncludeInSchema = true)]
[XmlRootAttribute("ComHandler", Namespace = "http://schemas.microsoft.com/windows/2004/02/mit/task", 
	IsNullable = false)]
public class ComHandlerAction : Action
Request Example View Source

The ComHandlerAction type exposes the following members.

Constructors
 NameDescription
Public methodComHandlerActionCreates an unbound instance of ComHandlerAction.
Public methodComHandlerAction(Guid, String)Creates an unbound instance of ComHandlerAction.
Top
Properties
 NameDescription
Public propertyActionTypeGets the type of the action.
(Inherited from Action)
Public propertyClassIdGets or sets the identifier of the handler class.
Public propertyClassNameGets the name of the object referred to by ClassId.
Public propertyDataGets or sets additional data that is associated with the handler.
Public propertyIdGets or sets the identifier of the action.
(Inherited from Action)
Top
Methods
 NameDescription
Public methodCloneCreates a new object that is a copy of the current instance.
(Inherited from Action)
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.
(Inherited from Action)
Public methodDisposeReleases all resources used by this class.
(Inherited from Action)
Public methodEquals(Action)Indicates whether the current object is equal to another object of the same type.
(Overrides ActionEquals(Action))
Public methodEquals(Object)Determines whether the specified Object, is equal to this instance.
(Inherited from Action)
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 methodGetHashCodeReturns a hash code for this instance.
(Inherited from Action)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodToStringGets a string representation of the ComHandlerAction.
(Overrides ActionToString)
Public methodToString(CultureInfo)Returns a String that represents this action.
(Inherited from Action)
Top
Events
 NameDescription
Public eventPropertyChangedOccurs when a property value changes.
(Inherited from Action)
Top
Fields
 NameDescription
Protected fieldunboundValuesList of unbound values when working with Actions not associated with a registered task.
(Inherited from Action)
Top
Remarks
This action is the most complex. It allows the task to execute and In-Proc COM server object that implements the ITaskHandler interface. There is a sample project that shows how to do this in the Downloads section.
Example
C#
ComHandlerAction comAction = new ComHandlerAction(new Guid("{CE7D4428-8A77-4c5d-8A13-5CAB5D1EC734}"));
comAction.Data = "Something specific the COM object needs to execute. This can be left unassigned as well.";
See Also