| API / APIs Radiofréquence | |
| Version ACE : 5.0-00 | |
|
Package : Standard Sous-programme Basic : Ctr_Imp Nom de la gnc : gnc_rf_ctr_imp |
Fonctionnalité :Général |
| Schémas d’entrée et de sortie : | voir en fin de document. |
Cette API permet de contrôler qu’une file d’impression existe avec le type « Imprimante » (valeur « I »).
API imbriquées : aucune.
Contraintes et limites de fonctionnement (hors périmètre)
| RAS. |
Paramétrage (PPE)
| RAS. |
Prototype de la fonction Basic
| Retour = Ctr_Imp (numero_module, imprimante) |
Messages en entrée
| CTR_IMP~imprimante~ |
Messages en sortie
| Aucun. |
Valeurs restituées par l’API
| VALEUR | REMARQUE |
| 1 | La file d’impression existe et elle est de type Imprimante. |
| 0 | La file d’impression n’existe pas ou elle n’est pas de type Imprimante. |
Processus, contrôles et règles de gestion
| ETAPE | DESCRIPTION DU PROCESSUS |
| 1 | Identification de la file d’impression définie en entrée. |
| 2 | Contrôle que la file d’impression est de type Imprimante. |
| Détail : |
Read the queue (UT_FIL). If the queue does not exist, the API returns 0. If the queue type is not a printer queue (typut_fil != ‘I’), the API returns 0. |
Erreurs possibles
| CAUSE | EFFET |
| La file n’existe pas ou n’est pas de type Imprimante. |
Code retour 0, message « Imprimante inconnue : xxx » |
Exemple(s) d’utilisation
| Retour_Ctr_Imp = Ctr_Imp (numero_module, w_imprimante) |
| NOM DU PARAMÈTRE | TYPE | FORMAT | TAILLE | OBL O/N | REMARQUE |
| Fil | CHAR | 31 | O | Queue |