API RF PPE

  Version ACE : 5.0-00

Package : Standard

Sous-programme Basic : ppe

Nom de la gnc : gnc_rf_ppe

Fonctionnalité : Général
Schémas d’entrée et de sortie : voir en fin de document.

Cette API permet non seulement de détecter la présence d’un paramètre (PPE) associé à la fonction courante ou associé à l’ensemble des fonctions ACE , mais aussi de fournir la valeur d'une des zones de ce paramètre.

API imbriquées : FCT_COD.

Contraintes et limites de fonctionnement (hors périmètre)

Aucune.

Paramétrage (PPE)

Aucun.

Prototype de la fonction Basic

Retour= Ppe(numero_module, codpar, champ, valeur)

Message en entrée

PPE~codpar~champ~valeur

Message en sortie

Retour~valeur

Valeurs restituées par l’API

VALEUR REMARQUE
1 Le paramètre existe pour la fonction courante ou en paramétrage général.
0 Le paramètre n’est pas associé à la fonction courante.

Processus, contrôles et règles de gestion

ETAPE DESCRIPTION DU PROCESSUS
1 Lecture du paramétrage sur la fonction courante. La fonction courante est déterminée préalablement par l’API FCT_COD
2 Dans le cas où le paramètre n’est pas associé à la fonction courante, recherche du paramètre dans le paramétrage générale de l’appplication.
Détail :

Call the function gnc_ppe() with the input code parameter code(codpar) as so to retrieve all the fields data for the parameter.

If the retrieval of the parameter’s data is not successful, the API returns an error code 0.

The API returns the value of that parameter field which corresponds to the ‘champ’ input parameter.

For example: if the value of the input parameter ‘champ’ is equal to ‘A1’, the value of the parameter’s field ‘para1’ is collected.

Erreurs possibles

CAUSE EFFET
Le paramètre n’est pas associé ni à la fonction courante, ni à l’ensemble des fonctions (paramétrage général). Retour 0
Le champ ne fait pas partie de la liste des valeurs possibles. Retour 0

Exemple(s) d’utilisation

Retour_Ppe= Ppe(numero_module, “LRFLOP”, “A1”, valeur)

Recherche de la valeur A1 du ppe LRFLOP sur la fonction courante.

Paramètres en entrée

NOM DU PARAMÈTRE TYPE FORMAT TAILLE OBL O/N REMARQUE
codpar Char   6 O Nom du paramètre
champ Char   2 O

Champ recherché. Valeurs autorisées :

A1,A2,A2,N1,N2,N3,N4,N5,D1,D2,D3,M1,M2

Paramètres en sortie

NOM DU PARAMÈTRE TYPE FORMAT TAILLE REMARQUE
paramOut1 Char   30 Valeur du champ