ActionPlanInfo (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Standard functions / Windows functions / Software Factory functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

ActionPlanInfo (Function)

In french: PlanActionInfo

Retrieves information regarding the execution of an instance of action plan.

Example

// Teste l'exécution du plan d'action de compilation de mon projet
bCompilOK is boolean = ActionPlanInfo("CoordFab", "admin", ...
	"clefab", nIdPlanCompilMonProjet, apStatusCompletedOK)

Syntax

<Result> = ActionPlanInfo(<Coordinator> , <User> , <Password> , <Identifier of Instance of Action Plan> [, <Information>])

<Result>: Type of the desired information

Requested information.

<Coordinator>: Character string

Name of the computer used to coordinate the execution of the action plans.

<User>: Character string

User name. This user must be allowed to run the action plan on the coordinator.

<Password>: Character string or Secret string

User password.
New in version 2025
Secret strings: If you use the secret string vault, the type of secret string used for this parameter must be "ANSI or Unicode string".
To learn more about secret strings and how to use the vault, see Secret string vault.

<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.
apInfoCancellationInProgress <Result> is a boolean and it is set to:
True if the action plan instance is being cancelled,
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:
paStatusDisconnected The automation used to execute the action plan is no longer responding.
paEtatEnAttente The action plan is pending execution.
paEtatEnCours Action plan in progress.
paEtatLancement: The coordinator will launch the action plan.
paEtatTerminatedFailed Plan execution terminated with error.
paEtatTerminéOK Plan execution completed without error.
apInfoUser <Result> is a character string containing the name of the user who started the execution of the action plan.

Component: wd300std.dll