Identifier

L'identité de la recette. Soit le libellé, soit le numéro de la recette. Voir la rubrique Configuration des recettes. Type STR.

Mode

Mnémonique

Action

1

EXIST

Test si une recette existe.

Retour :

1 si le n° de la recette existe.
2 si le libellé de la recette existe.
0 si la recette n'existe pas.

2

SEND

Envoi direct d'une recette. Les restrictions, qui sont normalement imposées lors de l'envoi d'une recette à partir d'une animation s'appliquent, par exemple, l'utilisateur doit avoir les droits nécessaires et le bit d'autorisation doit être défini.

3

REALTIME

Modifie une recette en prenant les valeurs temps réel de chaque variable.

6

SENDEVEN

Similaire au Mode 2 sauf que les valeurs temps réel sont substituées même si certaines d'entre elles sont invalides ou hors plage.

7

REALTIMEEVEN

Similaire au Mode 3 sauf que les valeurs en temps réel sont substituées même si certaines d'entre elles sont invalides ou hors plage.

9

STOPWATCH

Arrête une demande de rafraîchissement des variables d'une recette (commencé avec STARTWATCH).

Retour : 1 si OK, 0 sinon, excepté pour le Mode 1 (EXIST).

Argument

Définition

Identifier

Identifiant de la recette. Soit le libellé, soit le numéro de la recette. Voir la rubrique « Configuration des recettes ». Type STR.

NewNum

Numéro de la nouvelle recette. Type STR.

NewTitle

Titre de la nouvelle recette. Type STR.

Flag

Sauvegarde de la nouvelle recette dans un fichier. (0 ou 1).

File

Nom du fichier dans lequel la recette est sauvegardée.

Mode

Mnémonique

Action

3

REALTIME

Une nouvelle recette est créée en utilisant la liste de variables de la recette spécifiée par son identifiant, mais avec la valeur courante (temps réel) pour chacune des variables. Si File est spécifié, le fichier correspondant sera sauvegardé. Toute recette existante avec le même identifiant sera écrasée.

7

REALTIMEEVEN

Similaire au Mode 3 sauf que les valeurs en temps réel sont substituées même si certaines d'entre elles sont invalides ou hors plage.

Retour : 1 si OK, 0 sinon.

Argument

Définition

Identifier

Identifiant de la recette. Soit le libellé, soit le numéro de la recette. Voir la rubrique « Configuration des recettes ». Type STR.

Handle

Localisation du buffer mémoire retournée par un ALLOC_BUFFER. Type de retour : LONG.

Size

Taille du fichier recette. Doit être plus petit que la taille du buffer ou une erreur se produira à l'exécution.

Mode

Mnémonique

Action

4

READ

Lecture d'une recette dans un buffer mémoire.

Retour : 1 si OK, 0 sinon.

Argument

Définition

Handle

Localisation du buffer mémoire retournée par un ALLOC_BUFFER. Type de retour : LONG.

NewNum

Numéro de la nouvelle recette. Type STR.

NewTitle

Titre de la nouvelle recette. Type STR.

Flag

Sauvegarde de la nouvelle recette dans un fichier. (0 ou 1).

File

Nom du fichier dans lequel la recette est sauvegardée (si Flag = 1).

Mode

Mnémonique

Action

5

CREATE

Une nouvelle recette est créée en utilisant le contenu du buffer mémoire. Si File est spécifié, le fichier correspondant sera sauvegardé. Toute recette existante avec le même identifiant sera écrasée.

Retour : 1 si OK, 0 sinon.

Identifier

Identifiant de la recette. Soit le libellé, soit le numéro de la recette. Voir la rubrique « Configuration des recettes ». Type STR.

Branch

Branche qui préfixe tous les noms de variable de la recette. Type STR.

Mode

Mnémonique

Action

2

SEND

Envoi direct d'une recette. Les restrictions, qui sont normalement imposées lors de l'envoi d'une recette à partir d'une animation s'appliquent, par exemple, l'utilisateur doit avoir les droits nécessaires et le bit d'autorisation doit être défini.

6

SENDEVEN

Envoi direct d'une recette. Similaire au Mode 2 sauf que les valeurs temps réel sont substituées même si certaines d'entre elles sont invalides ou hors plage.

9

STOPWATCH

Arrête une demande de rafraîchissement des variables d'une recette (commencé avec STARTWATCH).

10

REALTIMECREATE

Modifie une recette en prenant les valeurs temps réel de chaque variable.

11

REALTIMECREATEEVEN

Modifier la recette en prenant les temps réel de chaque variable, même si certaines d'entre elles sont invalides ou hors plage.

Retour : 1 si OK, 0 sinon.

Argument

Définition

Identifier

Identifiant de la recette. Soit le libellé, soit le numéro de la recette. Voir la rubrique « Configuration des recettes ». Type STR.

ResultVar

Nom de la variable état. Type STR.

Status ResultVar:

1 les valeurs ont été rafraîchies.

0 l'identifiant n'a pas été trouvé ou la variable état n'a pas le bon type.

Status

0 ou 1.

Mode

Mnémonique

Action

8

STARTWATCH

Mode permettant de rafraîchir les variables de la recette qui ne sont pas cochées en surveillance permanente. L'état ResultVar est positionné à la valeur de Status quand la fonction est exécutée.

Retour : Id de la requête STARTWATCH. Cet Id est à réutiliser lors de l'appel à STOPWATCH.

Argument

Définition

Identifier

Identifiant de la recette. Soit le libellé, soit le numéro de la recette. Type STR.

Varname

Nom de la variable état. Type STR.

Status ResultVar:

1 les valeurs ont été rafraîchies.

0 l'identifiant n'a pas été trouvé ou la variable état n'a pas le bon type.

Status

0 ou 1.

Branch

Branche qui préfixe tous les noms de variable de la recette. Type STR.

Mode

Mnémonique

Action

8

STARTWATCH

Mode permettant de rafraîchir les variables de la recette qui ne sont pas cochées en surveillance permanente. L'état ResultVar est positionné à la valeur de Status quand la fonction est exécutée.

Retour : Id de la requête STARTWATCH. Cet Id est à réutiliser lors de l'appel à STOPWATCH.

Identifier

Identifiant de la recette. Soit le libellé, soit le numéro de la recette. Voir la rubrique « Configuration des recettes ». Type STR.

Branch

Branche qui préfixe tous les noms de variable de la recette. Type STR.

NewNum

Numéro de la nouvelle recette. Type STR.

NewTitle

Titre de la nouvelle recette. Type STR.

File

Nom du fichier dans lequel la recette est sauvegardée.

Mode

Mnémonique

Action

10

REALTIMECREATE

Une nouvelle recette est créée en utilisant la liste de variables de la recette spécifiée par son identifiant, mais avec la valeur courante (temps réel) pour chacune des variables. Si File est spécifié, le fichier correspondant sera sauvegardé. Toute recette existante avec le même identifiant sera écrasée.

11

REALTIMECREATEEVEN

Similaire au Mode 10, sauf que l'action sera effectuée même si certaines valeurs de variables sont invalides ou hors plage.

Retour : 1 si OK, 0 sinon.

Mode

Mnémonique

Action

12

REFRESH

Force le rechargement de la configuration des recettes à partir du répertoire \R du projet. Ce mode permet de prendre en compte des ajouts ou suppressions de recettes effectués de manière externe au logiciel PcVue.

Retour : 1 si OK, 0 sinon.

WatchID

L'identifiant de la précédente fonction STARTWATCH. Type de retour : LONG.

Mode

Mnémonique

Action

9

STOPWATCH

Arrête une requête de rafraîchissement des valeurs d'une recette lancée avec STARTWATCH et identifiée par son WatchID.

Retour : 1 si OK, 0 sinon.

Argument

Définition

RecipeID

Nom ou numéro de la recette. Type STR.

List

Nom de la liste des postes de l'architecture multipostes destinataires des modifications (liste créée par le menu Configuration.Communication.Multipostes). Type STR.

La liste doit être de type Liste de clients de modification.

HStatus

Handle du buffer alloué par ALLOC_BUFFER. Après l'exécution de l'instruction, le buffer contient une liste des postes et leur statut de mise-à-jour suivant le format :

StaNum,Status,...;.,...;...;

Où StaNum est le numéro du poste et Status est à 1 si OK, 0 sinon.

EventVar

Nom de la variable état positionnée à 1 après exécution de l'instruction. Si EventVar n'est pas nécessaire, une chaîne nulle ("") doit être utilisée, car cet argument ne peut pas être omis. Type STR.

LocalRemote

Flag déterminant l'emplacement où le changement de configuration de la recette doit être propagé :

1 : Tous les postes (y compris le poste local).
0 : Postes distants uniquement (par défaut).

Mode

Mnémonique

Action

14

NETWORKBROADCAST

Diffuse la configuration de la recette passée en argument vers les postes définis dans la liste.

Retour : 1 si OK, 0 sinon.

Argument

Définition

List

Nom de la liste des postes de l'architecture multipostes destinataires des modifications (liste créée par le menu Configuration.Communication.Multipostes). Type STR.

La liste doit être de type Liste de clients de modification.

HStatus

Handle du buffer alloué par ALLOC_BUFFER. Après l'exécution de l'instruction, le buffer contient une liste des postes et leur statut de mise-à-jour suivant le format :

StaNum,Status, etc.;

Où StaNum est le numéro du poste et Status est à 1 si OK, 0 sinon. Type LONG.

EventVar

Nom de la variable état positionnée à 1 après exécution de l'instruction. Si EventVar n'est pas nécessaire une chaîne nulle ("") doit être utilisée, car cet argument ne peut pas être omis. Type STR.

LocalRemote

Mode

Mnémonique

Action

15

NETWORKBROADCASTALL

Diffuse la configuration de l'ensemble des recettes vers les postes définis dans la liste.

Retour : 1 si OK, 0 sinon.