Retrieves information regarding the execution of an instance of action plan.
// Checks the execution of the action plan for compiling my project
bCompilOK is boolean = ActionPlanInfo("FacCoord", "admin", ...
"fackey", nPlanCompilMyProjectID, apStatusCompletedOK)
Syntax
<Result> = ActionPlanInfo(<Coordinator> , <User> , <Password> , <Identifier of Instance of Action Plan> [, <Information>])
<Result>: Type of the requested information
Requested information.
<Coordinator>: Character string
Name of the computer used to coordinate the execution of the action plans.
<User>: Character string
Name of user. This user must be allowed to run the action plan on the coordinator.
<Password>: Character string
User password.
<Identifier of Instance of Action Plan>: Integer
Identifier of the instance of action plan to use. This identifier is returned by ActionPlanExecute.
<Information>: Optional Integer constant
Requested information about the action plan.
| |
| apInfoCancelationInProgress | <Result> is a boolean and it is set to: - True if the instance of action plan is currently canceled,
- False otherwise.
|
| apInfoComputer | <Result> is a character string containing the name of the computer that runs the action plan. |
| apInfoEnd | <Result> is a DateTime variable corresponding to the end date and time for running the action plan. |
| apInfoLog | <Result> is a character string containing the runtime log of the action plan. |
| apInfoProgress | <Result> is an integer corresponding to the percentage of progress regarding the execution of the action plan. |
| apInfoStart | <Result> is a DateTime variable corresponding to the start date and time for running the action plan. |
apInfoStatus
(Default value) | <Result> is an Integer constant corresponding to the status of the action plan: - apStatusDisconnected: The robot used to run the action plan does not respond anymore.
- apStatusPending: The action plan is waiting to be run.
- apStatusInProgress: The action plan is currently run.
- apStatusStartup: The coordinator is going to start the action plan.
- apStatusCompletedFailure: The execution of the plane ended with error.
- apStatusCompletedOK: The execution of the plane ended without error.
|
| apInfoUser | <Result> is a character string containing the name of the user who started the execution of the action plan. |