API RF CTREMP

Version ACE : 5.0-00

Package : Standard

Sous-programme Basic : Ctremp

Nom de la gnc : gnc_rf_ctremp

Fonctionnalité :Général

Schémas d’entrée et de sortie :

voir en fin de document.

The API retrieves the first slot address corresponding to the slot control key, if only the control key parameter is filled. The API retrieves the slot address, if both parameters – slot address and slot control key are filled and there is a correspondence between them. The API retrieves the slot control key corresponding to the slot address, if only the address parameter is filled.

API imbriquées : aucune.

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

RAS.

Paramétrage (PPE)

RAS.

Prototype de la fonction Basic

Function Ctremp(p_numero_module As String, p_sigdep As String, p_adremp As String, p_ctremp As String) As Integer

Message en entrée

"CTREMP"~p_sigdep~p_adremp~p_ctremp~

Message en sortie

Retour~p_adremp~p_ctremp

Valeurs restituées par l’API

VALEUR	REMARQUE
1	Le code emplacement a été identifié.
0	Le code emplacement n’existe pas ou incohérence entre code emplacement et contrôle emplacement.

Processus, contrôles et règles de gestion

ETAPE	DESCRIPTION DU PROCESSUS
1	Dans le cas où le contrôle emplacement est renseigné seul, recherche du premier emplacement correspondant au code contrôle. Dans le cas où plusieurs emplacements correspondent, alors c’est le premier emplacement par ordre alphabétique qui pris pour valeur de retour.
2	Dans le cas où le contrôle emplacement et le code emplacement sont renseignés simultanément.
3	Dans le cas où, le code emplacement est renseigné seul, recherche de l’emplacement.
Détail :	If both parameters – slot address and slot control key - are not filled the API returns the error code 0. If the slot control key is filled. If the slot address is filled. Read the slot address data (EMP) which corresponds to the input parameters (sigdep, ctremp, adremp). If the slot address is not filled. Retrieve the first slot address which corresponds to the input parameters (codemp.sigdep, codemp.ctremp). If the retrieved slot address contains more than 8 characters the API returns the error code 0. If the retrieval of the data is successful the API copies the slot address found to the adremp output parameter. If the retrieval of the data is not successful the API copies an empty string to the adremp output parameter. Else If the slot control key is not filled. Read the slot address data (EMP) with the input parameters (sigdep, adremp). If the retrieval of the data is successful the API copies the slot control key found to the ctremp output parameter. If the retrieval of the data is not successful the API copies an empty string to the slot address output parameter. If the slot address output parameter is not filled, the API returns the error code 0.

Erreurs possibles

CAUSE	EFFET
Le code emplacement et le contrôle emplacement ne sont pas renseignés.	Retour 0
Dans le cas ou le code emplacement n’existe pas ou il code emplacement ne correspond pas au contrôle emplacement.	Retour 0
Le code contrôle ne correspond à aucun emplacement.	Retour 0

Exemple(s) d’utilisation

Retour_Ctremp=Ctremp(numero_module,”D001”,”A000112”,”DZK”)

Paramètres en entrée

NOM DU PARAMÈTRE	TYPE	FORMAT	TAILLE	OBL O/N	REMARQUE
Sigdep	Char		12	O	Sigle dépôt.
Adremp	Char		8	N	Code emplacement.
ctremp	char		10	N	Contrôle d'emplacement.

Paramètres en sortie

NOM DU PARAMÈTRE	TYPE	FORMAT	TAILLE	REMARQUE
Adremp	Char		10	Code emplacement.
ctremp	char		10	Contrôle emplacement.