RUI_PURGE

Le verbe RUI_PURGE annule un RUI_READprécédent.

La structure suivante décrit le LUA_COMMON membre du bloc de contrôle de verbe (VCB) utilisé par RUI_PURGE.

Syntaxe

  
struct LUA_COMMON {  
    unsigned short lua_verb;  
    unsigned short lua_verb_length;  
    unsigned short lua_prim_rc;  
    unsigned long  lua_sec_rc;  
    unsigned short lua_opcode;  
    unsigned long  lua_correlator;  
    unsigned char  lua_luname[8];  
    unsigned short lua_extension_list_offset;  
    unsigned short lua_cobol_offset;  
    unsigned long  lua_sid;  
    unsigned short lua_max_length;  
    unsigned short lua_data_length;  
    char FAR *      lua_data_ptr;  
    unsigned long  lua_post_handle;  
    struct LUA_TH  lua_th;  
    struct LUA_RH  lua_rh;  
    struct LUA_FLAG1 lua_flag1;  
    unsigned char  lua_message_type;  
    struct LUA_FLAG2 lua_flag2;  
    unsigned char  lua_resv56[7];  
    unsigned char  lua_encr_decr_option;  
};  

Membres

lua_verb
Paramètre fourni. Contient le code de verbe, LUA_VERB_RUI pour les verbes RUI (Request Unit interface).

lua_verb_length
Paramètre fourni. Spécifie la longueur, en octets, de l’application d’unité logique (LUA) VCB. Il doit contenir la longueur de l’enregistrement de verbe émis.

lua_prim_rc
Code de retour principal défini par LUA à la fin du verbe. Les codes de retour valides varient en fonction du verbe LUA émis.

lua_sec_rc
Code de retour secondaire défini par LUA à la fin du verbe. Les codes de retour valides varient en fonction du verbe LUA émis.

lua_opcode
Paramètre fourni. Contient le code de commande LUA (code d’opération de verbe) du verbe à émettre, LUA_OPCODE_RUI_PURGE.

lua_correlator
Paramètre fourni. Contient une valeur fournie par l’utilisateur qui lie le verbe à d’autres informations fournies par l’utilisateur. LUA n’utilise pas ou ne modifie pas ces informations. Ce paramètre est facultatif.

lua_luname
Paramètre fourni. spécifie le nom ASCII du LU local utilisé par la session LUA Windows.

RUI_PURGE nécessite uniquement ce paramètre si lua_sid est égal à zéro.

Ce paramètre a une longueur de huit octets, complété à droite par des espaces (0x20) si le nom est inférieur à huit caractères.

lua_extension_list_offset
non utilisé par RUI dans Microsoft® Host Integration Server et doit être défini à zéro.

lua_cobol_offset
non utilisé par LUA dans Host Integration Server et doit être égal à zéro.

lua_sid
Paramètre fourni. Spécifie l’identificateur de session et est retourné par SLI_OPEN et RUI_INIT. Les autres verbes utilisent ce paramètre pour identifier la session utilisée pour la commande. Si d’autres verbes utilisent le paramètre lua_luname pour identifier les sessions, affectez la valeur zéro au paramètre lua_sid .

lua_max_length
Non utilisé par RUI_PURGE et doit être défini à zéro.

lua_data_length
Non utilisé par RUI_PURGE et doit être défini à zéro.

lua_data_ptr
Pointe vers l’emplacement du RUI_READ les verbes VCB à annuler.

lua_post_handle
Paramètre fourni. utilisé sous Microsoft® Windows Server si la notification asynchrone doit être effectuée par des événements. Cette variable contient le handle de l’événement à signaler ou un handle de fenêtre.

lua_th
Non utilisé par RUI_PURGE et doit être défini à zéro.

lua_rh
Non utilisé par RUI_PURGE et doit être défini à zéro.

lua_flag1
Non utilisé par RUI_PURGE et doit être défini à zéro.

lua_message_type
Non utilisé par RUI_PURGE et doit être défini à zéro.

lua_flag2
Paramètre retourné. Contient des indicateurs pour les messages retournés par LUA.

lua_flag2. Async

Indique que le verbe d’interface LUA s’est exécuté de façon asynchrone si la valeur est égale à 1.

lua_resv56
Réservé et doit être défini à zéro.

lua_encr_decr_option
Réservé et doit être défini à zéro.

Codes de retour

LUA_OK
Code de retour principal ; indique que le verbe s’est exécuté correctement.

LUA_CANCELED
Code de retour principal ; le verbe ne s’est pas terminé correctement, car il a été annulé par un autre verbe.

LUA_TERMINATED

Code de retour secondaire ; RUI_TERM a été émise alors que RUI_PURGE était en attente.

LUA_PARAMETER_CHECK
Code de retour principal ; le verbe n’a pas été exécuté en raison d’une erreur de paramètre.

LUA_BAD_DATA_PTR

Code de retour secondaire ; le paramètre lua_data_ptr a la valeur null.

LUA_BAD_SESSION_ID

Code de retour secondaire ; une valeur non valide a été spécifiée pour lua_sid dans le VCB.

LUA_INVALID_POST_HANDLE

Code de retour secondaire ; dans le cas d’un système d’exploitation Windows utilisant des événements comme méthode de publication asynchrone, le Windows le format d’événement LUA ne contient pas de handle d’événement valide.

LUA_RESERVED_FIELD_NOT_ZERO

Code de retour secondaire ; un champ réservé dans l’enregistrement de verbe, ou un paramètre qui n’est pas utilisé par ce verbe, a été défini sur une valeur différente de zéro.

LUA_VERB_LENGTH_INVALID

Code de retour secondaire ; un verbe LUA a été émis avec la valeur de lua_verb_length inattendue par lua.

LUA_STATE_CHECK
Code de retour principal ; le verbe n’a pas été exécuté, car il a été émis dans un état non valide.

LUA_NO_RUI_SESSION

Code de retour secondaire ; RUI_INIT n’a pas encore été effectuée avec succès pour le nom de l’unité logique spécifiée sur ce verbe.

LUA_UNSUCCESSFUL
Code de retour principal ; le verbe fourni était valide, mais le verbe ne s’est pas terminé correctement.

LUA_INVALID_PROCESS

Code de retour secondaire ; le processus du système d’exploitation/2 qui a émis ce verbe n’était pas le même que celui qui a émis RUI_INIT pour cette session. Seul le processus qui a démarré une session peut émettre des verbes sur cette session.

LUA_NO_READ_TO_PURGE

Code de retour secondaire ; soit lua_data_ptr ne contenait pas de pointeur vers un RUI_READ VCB, soit RUI_READ terminé avant l’émission de RUI_PURGE .

LUA_COMM_SUBSYSTEM_ABENDED
Code de retour principal ; indique l’une des situations suivantes :

  • Le nœud utilisé par cette conversation a rencontré un abandon (ABEND).

  • La connexion entre le programme de transaction (TP) et le nœud de l’unité physique (PU) 2,1 a été interrompue (erreur LAN).

  • Le SnaBase sur l’ordinateur TPs a rencontré un ABEND.

    LUA_SESSION_FAILURE
    Code de retour principal ; un composant Host Integration Server requis s’est arrêté.

    LUA_LU_COMPONENT_DISCONNECTED

    Code de retour secondaire ; indique que la session LUA a échoué en raison d’un problème au niveau du service de liaison ou de l’unité logique hôte.

    LUA_RUI_LOGIC_ERROR

    Code de retour secondaire ; une erreur interne a été détectée dans LUA. Cette erreur ne doit pas se produire lors d’un fonctionnement normal.

    LUA_INVALID_VERB
    Code de retour principal ; le code du verbe ou le code d’opération, ou les deux, ne sont pas valides. Le verbe n’a pas été exécuté.

    LUA_STACK_TOO_SMALL
    Code de retour principal ; indique que la taille de la pile de l’application est trop petite pour exécuter le verbe. Augmentez la taille de pile de votre application.

    LUA_COMM_SUBSYSTEM_NOT_LOADED
    Code de retour principal ; un composant requis n’a pas pu être chargé ou a été arrêté lors du traitement du verbe. Par conséquent, la communication n’a pas pu être établie. Contactez l’administrateur système pour mettre en place une action corrective.

    LUA_UNEXPECTED_DOS_ERROR
    Code de retour principal ; après l’émission d’un appel de système d’exploitation, un code de retour de système d’exploitation inattendu a été reçu et est spécifié dans le code de retour secondaire.

Remarques

RUI_READ peut attendre indéfiniment s’il est envoyé sans utiliser l’option lua_flag1. NOWAIT (retour immédiat) et qu’aucune donnée n’est disponible sur le Flow spécifié. RUI_PURGE force le verbe en attente à retourner (avec le code de retour principal LUA_CANCELED).

Ce verbe est utilisé uniquement lorsque RUI_READ a été émis et est en attente d’achèvement. (Le code de retour principal est LUA_IN_PROGRESS.)

Voir aussi

RUI_INIT
RUI_READ
RUI_TERM
RUI_WRITE
SLI_OPEN
SLI_PURGE
SLI_RECEIVE
SLI_SEND