RegistrationTrigger object
Scripting object that represents a trigger that starts a task when the task is registered or updated.
Members
The RegistrationTrigger object has these types of members:
Properties
The RegistrationTrigger object has these properties.
| Property | Access type | Description |
|---|---|---|
| Delay |
Read/write |
Gets or sets the amount of time between when the task is registered and when the task is started. |
| Enabled |
Read/write |
Inherited from the Trigger object. Gets or sets a Boolean value that indicates whether the trigger is enabled. |
| EndBoundary |
Read/write |
Inherited from the Trigger object. Gets or sets the date and time when the trigger is deactivated. The trigger cannot start the task after it is deactivated. |
| ExecutionTimeLimit |
Read/write |
Inherited from the Trigger object. Gets or sets the maximum amount of time that the task launched by the trigger is allowed to run. |
| Id |
Read/write |
Inherited from the Trigger object. Gets or sets the identifier for the trigger. |
| Repetition |
Read/write |
Inherited from the Trigger object. Gets or sets how often the task is run and how long the repetition pattern is repeated after the task is started. |
| StartBoundary |
Read/write |
Inherited from the Trigger object. Gets or sets the date and time when the trigger is activated. |
| Type |
Read-only |
Inherited from the Trigger object. Gets the type of the trigger. |
Remarks
When creating your own XML for a task, a registration trigger is specified using the RegistrationTrigger element of the Task Scheduler schema.
If a task with a delayed registration trigger is registered, and the computer that the task is registered on is shutdown or restarted during the delay, before the task runs, then the task will not run and the delay will be lost.
Examples
For more information and a code example for this scripting object, see Registration Trigger Example (Scripting).
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows Vista [desktop apps only] |
| Minimum supported server |
Windows Server 2008 [desktop apps only] |
| Type library |
|
| DLL |
|