attribut comm_status
L’attribut ACF [comm_status] provoque le retour d’un code d’erreur lorsqu’une erreur de communication se produit pendant l’exécution d’une fonction.
[comm_status [ , ACF-function-attributes ] ]
error_status_t function-name(
[ [ ACF-parameter-attributes ] ] parameter-name
, ...);
[ [ ACF-function-attributes ] ] function-name(
[comm_status [ , ACF-parameter-attributes ] ] error_status_t name
, ...);
Paramètres
-
ACF-function-attributes
-
Spécifie zéro ou plusieurs attributs de fonction ACF, tels que [comm_status] et [nocode].. Les attributs de fonction sont placés entre crochets. Zéro ou plusieurs attributs peuvent être appliqués à une fonction. Séparez plusieurs attributs de fonction par des virgules. Notez que si [comm_status] apparaît en tant qu’attribut de fonction, il ne peut pas également apparaître en tant qu’attribut de paramètre.
-
nom de la fonction
-
Spécifie le nom de la fonction tel que défini dans le fichier IDL.
-
ACF-parameter-attributes
-
Spécifie les attributs qui s’appliquent à un paramètre. Notez que zéro, un ou plusieurs attributs peuvent être appliqués au paramètre. Séparez plusieurs attributs de paramètres par des virgules. Les attributs de paramètre sont placés entre crochets. Les attributs de paramètre IDL, tels que les attributs directionnels, ne sont pas autorisés dans l’ACF. Notez que si [comm_status] apparaît en tant qu’attribut de paramètre, il ne peut pas également apparaître en tant qu’attribut de fonction.
-
nom_paramètre
-
Spécifie le paramètre de la fonction tel que défini dans le fichier IDL. Chaque paramètre de la fonction doit être spécifié dans la même séquence, en utilisant le même nom que défini dans le fichier IDL.
Notes
L’attribut [comm_status] peut être utilisé comme attribut de fonction ou comme attribut de paramètre, mais il ne peut apparaître qu’une seule fois par fonction. Elle peut être appliquée à la fonction ou à un paramètre dans chaque fonction.
L’attribut [comm_status] ne peut être appliqué qu’aux fonctions qui retournent le type error_status_t. Lorsqu’une erreur de communication se produit pendant l’exécution de la fonction, un code d’erreur est retourné.
Lorsque [comm_status] est utilisé comme attribut de paramètre, le paramètre doit être défini dans le fichier IDL et doit être un paramètre [out] de type error_status_t. Lorsqu’une erreur de communication se produit pendant l’exécution de la fonction, le paramètre est défini sur le code d’erreur. Une fois l’appel distant terminé, la procédure définit la valeur.
Il est possible que les attributs [comm_status] et [fault_status] apparaissent dans une seule fonction, soit sous forme d’attributs de fonction, soit d’attributs de paramètre. Si les deux attributs sont des attributs de fonction ou s’ils s’appliquent au même paramètre et qu’aucune erreur ne se produit, la fonction ou le paramètre a la valeur error_status_ok. Sinon, il contient la valeur [comm_status] ou [fault_status] appropriée. Étant donné que les valeurs retournées pour [comm_status] sont différentes des valeurs retournées pour [fault_status], les valeurs retournées sont facilement interprétées.
Voir aussi