SessionStateChangeTrigger object
Scripting object that triggers tasks for console connect or disconnect, remote connect or disconnect, or workstation lock or unlock notifications.
Members
The SessionStateChangeTrigger object has these types of members:
Properties
The SessionStateChangeTrigger object has these properties.
| Property | Access type | Description |
|---|---|---|
| Delay |
Read/write |
Gets or sets a value that indicates how long of a delay takes place before a task is started after a Terminal Server session state change is detected. |
| 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 in which the task can be started by the trigger. |
| 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 a value that indicates 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. |
| StateChange |
Read/write |
Gets or sets the kind of Terminal Server session change that would trigger a task launch. |
| Type |
Read-only |
Inherited from the Trigger object. Gets the type of the trigger. |
| UserId |
Read/write |
Gets or sets the user for the Terminal Server session. When a session state change is detected for this user, a task is started. |
Remarks
When reading or writing your own XML for a task, a session state change trigger is specified using the SessionStateChangeTrigger element of the Task Scheduler schema.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows Vista [desktop apps only] |
| Minimum supported server |
Windows Server 2008 [desktop apps only] |
| Type library |
|
| DLL |
|
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for