API RF CTR_INC

Version ACE : 5.0-00  

Package : Standard

Sous-programme Basic : Fct_Ctr_Incident

Nom de la gnc : gnc_rf_ctr_incident

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

Cette API permet de contrôler l’existence d’un code incident (dans la table LTIC).

API imbriquées : aucune.

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

RAS.

Paramétrage (PPE)

RAS.

Prototype de la fonction Basic

Fct_Ctr_Incident(p_typinc As String, p_linccod As String, p_lib As String, p_natstk As String, p_idmotif As String) As Integer

Messages en entrée

CTR_INC~p_typinc~p_linccod ~

Messages en sortie

Retour~p_lib~p_natstk~p_idmotif

Valeurs restituées par l’API

VALEUR REMARQUE
1 Le code incident existe.
0 Le code incident n’existe pas.

Erreurs possibles

CAUSE EFFET
Le code incident n’existe pas. Affichage du message « Code inconnu »

Exemple(s) d’utilisation

Fct_Ctr_Incident(“REC”, “001”, p_lib, p_natstk, p_idmotif )

Détail de l'API

Call the function gnc_linc_ctr_linccod, to controls the existence of the incident code.

If the function gnc_linc_ctr_linccod returns 0, the API returns the error code 0.

Collect the output information from the LTIC table.

Paramètres en entrée

NOM DU PARAMÈTRE TYPE FORMAT TAILLE OBL O/N REMARQUE
typinc   Char(1)   O Type of the incident
linccod   Char(3)   O Incident code

Paramètres en sortie

NOM DU PARAMÈTRE FORMAT REMARQUE
ParamOut1 Char(30) Incident label (LTIC.lib)
ParamOut2 Char(2) Stock nature (ltic.natstk)
ParamOut3 Number Incident motive identifier (ltic.idmotif)