API RF VALZN_X

  Version ACE : 5.2-00

Package : Standard

Nom de la gnc : gnc_rf_valzn_egx

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

Cette API permet de consulter et de mettre à jour une zone paramétrée d'une table défini en entrée d'API : PRO, TIE, LREE, LMODINV, LMVTSTK, OST ou LOP.

API imbriquées : VALZN -

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

RAS.

Paramétrage (PPE)

RAS.

Prototype de la fonction Basic

Retour_Fct_Valzn_X=Fct_Valzn_X(mode, nom_table ,cle_table , text, num)

Messages en entrée

nom_table~cle_table~text~num

Messages en sortie

Retour~text

Valeurs restituées par l’API

VALEUR REMARQUE
1 La lecture de l’entité s’est correctement effectuée
0 Erreur de lecture de l’entité

Processus, contrôles et règles de gestion

ETAPE DESCRIPTION DU PROCESSUS
1 Identification de l’entité dans la base de données.
2 Recherche de la Nième zone paramétrée de l’entité.
3 En mode écriture, mise à jour de la Nième zone paramétrée de l’entité.
Détail :

Call the API gnc_rf_valzn (API VALZN). The function gnc_rf_valzn writes data to a given parameterized field or reads data from it for a particular table (pro, tie, ree, lmi, mvt, ost or lop).

The API returns the result of the gnc_rf_valzn execution. If the returned value is 0 the nom_table parameter or cle_table parameter is incorrect.

Erreurs possibles

CAUSE EFFET
Le nom de table n’existe pas. Retour valeur 0
La clé de la table n’existe pas. Retour valeur 0

Exemple(s) d’utilisation

Retour_Fct_Valzn_X=Fct_Valzn_X(« 2 », »pro « , « LBR911 », text, 1)

Lecture de la premiere zone complémentaire de l’article LBR911. la valeur est retournée dans la variable text.

Paramètres en entrée

NOM DU PARAMÈTRE TYPE FORMAT TAILLE OBL O/N REMARQUE
mode Long   1 O Action (1=écriture / 2=lecture).
nom_table Char   49 O

Nom de la relation à lire ou modifier :

  • spro : fiche article
  • sree : en-tête de réception
  • stie : tiers
  • slmi : mode d'inventaire
  • smvt : mouvement de stock
  • sost : objet lot
  • slop : en-tête d'op
cle_table Char   49 O

Identitiant de la relation à lire ou modifier.

pro : code produit

         

tie : type de tiers position 1 à 3

sigle tiers position 4 à 15

         

ree : type tiers dépôt position 1 à 3

sigle dépôt position 4 à 15

numéro de réception

         

lmi : type tiers dépôt position 1 à 3

sigle dépôt position 4 à 15

mode d'inventaire position 16 à 17

         

mvt : type tiers dépôt position 1 à 3

sigle dépôt position 4 à 15

type de mouvement position 16

sens du mouvement position 17

numéro de mouvement

lop : type tiers dépôt position 1 à 3

sigle dépôt position 4 à 15

numéro d'OP

text Char   49 N Dans le cas d'une mise à jour, valeur à mettre à jour dans la Nième zone complémentaire de l'entité.
num Long   1 O Numéro de la zone complémentaire à lire ou modifier.

Paramètres en sortie

NOM DU PARAMÈTRE TYPE FORMAT TAILLE REMARQUE
paramOut1 Char   49

Valeur de la Nième zone complémentaire :

  • sen mode lecture, valeur de la zone complémentaire dans la base de données.
  • sen mode écriture, valeur de la zone complémentaire après modification.