IStimulusProfileSession Members
- Updated2023-02-21
- 4 minute(s) read
The IStimulusProfileSession type exposes the following members.
| Name | Description | |
|---|---|---|
| Abort | Overloaded.
Aborts the Stimulus Profile Session. If an error occurs, this instance throws an exception.
| |
| Deploy | Overloaded.
Deploys the Stimulus Profile Session. If an error occurs, this instance throws an exception.
| |
| Lock | Overloaded.
Locks the Stimulus Profile Session with the new_password. If the session is locked, any attempts to modify its execution state fail. If an error occurs, this instance throws an exception.
| |
| Pause | Overloaded.
Pauses the Stimulus Profile Session. If an error occurs, this instance throws an exception.
| |
| Run | Overloaded.
Runs the Stimulus Profile Session. If an error occurs, this instance throws an exception.
| |
| SingleStep | Overloaded.
Single-steps the Stimulus Profile Session. If an error occurs, this instance throws an exception.
| |
| Stop | Overloaded.
Stops the Stimulus Profile Session. If an error occurs, this instance throws an exception.
| |
| Undeploy | Overloaded.
Undeploys the Stimulus Profile Session. If an error occurs, this instance throws an exception.
| |
| Unlock | Overloaded.
Unlocks the Stimulus Profile Session. If an error occurs, this instance throws an exception.
|
Properties
| Name | Description | |
|---|---|---|
| Deployed | Indicates whether the Stimulus Profile Session is deployed. | |
| Description | Gets the description of the Stimulus Profile Session. | |
| Locked | Indicates whether the Stimulus Profile Session is locked. If the session is locked, any attempts to modify its execution state fail. | |
| Name | Gets the name of the Stimulus Profile Session. | |
| Sequence | Gets a reference to the sequence specified by the qualified sequence name in the Stimulus Profile Session. | |
| SequenceNames | Gets the qualified sequence names of all the sequences in the Stimulus Profile Session. |
Events
| Name | Description | |
|---|---|---|
| SessionComplete | Callback invoked when the session finishes execution. | |
| SessionUndeploy | Callback invoked when the session is undeployed. |