Mode

Mnémonique

Syntaxe

Retour

Mode

Mnemonique

Action

0

MAINBRANCH

Renvoie la branche du programme qui contient la fonction d'où l'appel à GETARG est effectué, c'est-à-dire la branche avec laquelle le programme a été chargé.

1-8

ARG1 to ARG8

Renvoie respectivement du 1er au 8ème champ contenu dans le paramètre d'appel.

25-28

ARG9 to ARG12

Renvoie respectivement du 9ème au 12ème champ contenu dans le paramètre d'appel qui se trouve dans : Le champ de l'argument peut être spécifié en utilisant :

CYCLIC
EVENT
CRONTAB
KEY
EDITOR.Animation.Envoi.Programme
Action liée à une alarme.
Sélection ou validation d'une animation table par SELECTOR.

10

SOURCE

Renvoie une chaîne identifiant l'origine de l'appel de la fonction :

CYCLIC
EVENT
CRONTAB
KEY
MIMIC
ACTIONS
ARRAY_SELEC
ARRAY_INPUT
SCRIPT

11

PROGRAM

Renvoie le nom du programme courant.

12

BRANCH

Renvoie la branche passée en argument à la fonction courante.

13

FUNCTION

Renvoie le nom de la fonction courante.

14

WINDOW

Retourne le nom de la fenêtre depuis laquelle l'appel a été effectué.

Renvoie le repère de l'animation de type forçage programme ou d'une action associée à une alarme ou à une animation tableau.

15

WBRANCH

Retourne le nom de la branche de la fenêtre, comme en Mode 14.

16

IDENTIFIER

Renvoie le repère de l'animation de type forçage programme ou d'une action associée à une alarme ou à une animation tableau.

17

VARNAME

Renvoie le nom de la variable qui a changée de valeur dans le cas d'un EVENT.

18

VARVALUE

Renvoie la nouvelle valeur de la variable qui a changée dans le cas d’un EVENT si la variable est de type état, alarme ou mesure. Ce mode ne peut pas être utilisé pour les variables de type texte.

19

VARSTATUS

Renvoie :

Le status de la variable de déclenchement, si la SOURCE est un EVENT. 1 si la variable est valide, 0 si la variable est invalide.

La région d'appel, si la SOURCE est un Synoptique ou Array_Select. Cet usage est obsolète, utilisez le mode GETREGION à la place.

Type de retour : INTEGER.

20

KEYTYPE

Renvoie le type de programmation de touche "Down/Shift/Control" dans le cas d'un KEY.

21

KEYCODE

Renvoie le code de la touche enfoncée dans le cas d'un KEY.

22

CRONTYPE

Renvoie le type de programmation horaire dans le cas d'un CRONTAB :

ONCE
EACH_HOUR
EACH_DAY
EACH_WEEK
EACH_MONTH

23

CRONDATE

Renvoie la date ou le jour du déclenchement horaire selon le type dans le cas d'un CRONTAB.

24

CRONTIME

Renvoie l'heure ou la minute du déclenchement horaire selon le type dans le cas d'un CRONTAB.

29

WEB

Renvoie un flag pour indiquer l'accès :

0 = Utilisateur local

Différent de zéro = Client WebVue (utilisant une animation Forçage Programme).

Retourne la valeur de la variable de type texte dans le cas d'un EVENT.

0 = Horodatage par le logiciel PcVue.
1 = Horodotage à la source (en utilisant un protocole horodaté).
2 = Horodatage à la source mais l'horodate est invalide ou incertaine.

Retourne la valeur de la variable de type mesure dans le cas d'un EVENT. Notez que la valeur est retournée sous forme de DOUBLE.

Retourne la valeur de la variable de type état dans le cas d'un EVENT :

1 = On
0 = Off

Retourne la valeur de la variable de type alarme dans le cas d'un EVENT :

0 = Disparue acquittée
1 = Présente non acquittée
2 = Disparue non acquittée
3 = Présente acquittée
12 = Masquée par un opérateur
13 = Masquée par programme
14 = Masquée par variable
15 = Masquée par expression

Retourne la valeur de la variable de type texte dans le cas d'un EVENT.