RUI_PURGE

Artículo
07/21/2023

El verbo RUI_PURGE cancela un RUI_READ anterior.

En la estructura siguiente se describe el miembro LUA_COMMON del bloque de control de verbos (VCB) usado por RUI_PURGE.

Sintaxis

  
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;  
};

Members

lua_verb
Parámetro proporcionado. Contiene el código de verbo, LUA_VERB_RUI para verbos de interfaz de unidad de solicitud (RUI).

lua_verb_length
Parámetro proporcionado. Especifica la longitud en bytes del VCB de la aplicación de unidad lógica (LUA). Debe contener la longitud del registro de verbo que se va a emitir.

lua_prim_rc
Código de retorno principal establecido por LUA al finalizar el verbo. Los códigos de retorno válidos varían en función del verbo LUA emitido.

lua_sec_rc
Código de retorno secundario establecido por LUA al finalizar el verbo. Los códigos de retorno válidos varían en función del verbo LUA emitido.

lua_opcode
Parámetro proporcionado. Contiene el código de comando LUA (código de operación de verbo) para el verbo que se va a emitir, LUA_OPCODE_RUI_PURGE.

lua_correlator
Parámetro proporcionado. Contiene un valor proporcionado por el usuario que vincula el verbo con otra información proporcionada por el usuario. LUA no usa ni cambia esta información. Este parámetro es opcional.

lua_luname
Parámetro proporcionado. Especifica el nombre ASCII de la LU local usada por la sesión de LUA de Windows.

RUI_PURGE solo requiere este parámetro si lua_sid es cero.

Este parámetro tiene ocho bytes de longitud, rellenado a la derecha con espacios (0x20) si el nombre tiene más de ocho caracteres.

lua_extension_list_offset
RuI no se usa en Microsoft® Host Integration Server y debe establecerse en cero.

lua_cobol_offset
LuA no se usa en Host Integration Server y debe ser cero.

lua_sid
Parámetro proporcionado. Especifica el identificador de sesión y lo devuelve SLI_OPEN y RUI_INIT. Otros verbos usan este parámetro para identificar la sesión usada para el comando . Si otros verbos usan el parámetro lua_luname para identificar sesiones, establezca el parámetro lua_sid en cero.

lua_max_length
No se usa en RUI_PURGE y debe establecerse en cero.

lua_data_length
No se usa en RUI_PURGE y debe establecerse en cero.

lua_data_ptr
Apunta a la ubicación del RUI_READ verbos VCB que se va a cancelar.

lua_post_handle
Parámetro proporcionado. Se usa en Microsoft® Windows Server si los eventos van a realizar notificaciones asincrónicas. Esta variable contiene el identificador del evento que se va a indicar o un identificador de ventana.

lua_th
No se usa en RUI_PURGE y debe establecerse en cero.

lua_rh
No se usa en RUI_PURGE y debe establecerse en cero.

lua_flag1
No se usa en RUI_PURGE y debe establecerse en cero.

lua_message_type
No se usa en RUI_PURGE y debe establecerse en cero.

lua_flag2
Parámetro devuelto. Contiene marcas para los mensajes devueltos por LUA.

lua_flag2.async

Indica que el verbo de interfaz LUA se completó de forma asincrónica si se establece en 1.

lua_resv56
Reservado y debe establecerse en cero.

lua_encr_decr_option
Reservado y debe establecerse en cero.

Códigos de retorno

LUA_OK
Código de retorno principal; el verbo se ha ejecutado correctamente.

LUA_CANCELED
Código de retorno principal; el verbo no se completó correctamente porque otro verbo lo canceló.

LUA_TERMINATED

Código de retorno secundario; RUI_TERM se emitió mientras RUI_PURGE estaba pendiente.

LUA_PARAMETER_CHECK
Código de retorno principal; el verbo no se ha ejecutado debido a un error en un parámetro.

LUA_BAD_DATA_PTR

Código de retorno secundario; el parámetro lua_data_ptr se estableció en null.

LUA_BAD_SESSION_ID

Código de retorno secundario; se especificó un valor no válido para lua_sid en el VCB.

LUA_INVALID_POST_HANDLE

Código de retorno secundario; para un sistema operativo Windows que usa eventos como método de contabilización asincrónica, el VCB de LUA de Windows no contiene un identificador de eventos válido.

LUA_RESERVED_FIELD_NOT_ZERO

Código de retorno secundario; un campo reservado en el registro de verbo, o un parámetro no utilizado por este verbo, se estableció en un valor distinto de cero.

LUA_VERB_LENGTH_INVALID

Código de retorno secundario; Se emitió un verbo LUA con el valor de lua_verb_length inesperado por LUA.

LUA_STATE_CHECK
Código de retorno principal; el verbo no se ejecutó porque se emitió en un estado no válido.

LUA_NO_RUI_SESSION

Código de retorno secundario; RUI_INIT aún no se ha completado correctamente para el nombre de LU especificado en este verbo.

LUA_UNSUCCESSFUL
Código de retorno principal; el verbo proporcionado era válido, pero el verbo no se completó correctamente.

LUA_INVALID_PROCESS

Código de retorno secundario; el proceso del sistema operativo/2 que emitió este verbo no era el mismo proceso que emitió RUI_INIT para esta sesión. Solo el proceso que inició una sesión puede emitir verbos en esa sesión.

LUA_NO_READ_TO_PURGE

Código de retorno secundario; ya sea lua_data_ptr no contenía un puntero a un VCB de RUI_READ o RUI_READ completado antes de que se emitiera RUI_PURGE .

LUA_COMM_SUBSYSTEM_ABENDED
Código de retorno principal; indica una de las condiciones siguientes:

El nodo utilizado por esta conversación encontró una anulación.
La conexión entre el programa de transacción (TP) y el nodo 2.1 de la unidad física (PU) se interrumpió (un error laN).
SnaBase en el equipo TPs encontró un ABEND.

LUA_SESSION_FAILURE
Código de retorno principal; Se ha finalizado un componente de Host Integration Server necesario.

LUA_LU_COMPONENT_DISCONNECTED

Código de retorno secundario; indica que se produjo un error en la sesión de LUA debido a un problema con el servicio de vínculo o con la LU del host.

LUA_RUI_LOGIC_ERROR

Código de retorno secundario; se detectó un error interno en LUA. Este error no debe producirse durante el funcionamiento normal.

LUA_INVALID_VERB
Código de retorno principal; El código de verbo o el código de operación, o ambos, no son válidos. El verbo no se ejecutó.

LUA_STACK_TOO_SMALL
Código de retorno principal; el tamaño de la pila de la aplicación es demasiado pequeño para ejecutar el verbo. Aumente el tamaño de pila de la aplicación.

LUA_COMM_SUBSYSTEM_NOT_LOADED
Código de retorno principal; no se pudo cargar un componente necesario o se ha terminado mientras se procesa el verbo. Por tanto, no se pudo establecer la comunicación. Consulte al administrador del sistema para aplicar una acción correctiva.

LUA_UNEXPECTED_DOS_ERROR
Código de retorno principal; después de emitir una llamada del sistema operativo, se recibió un código de retorno inesperado del sistema operativo y se especifica en el código de retorno secundario.

Comentarios

RUI_READ puede esperar indefinidamente si se envía sin usar la opción lua_flag1.nowait (devolución inmediata) y no hay datos disponibles en el flujo especificado. RUI_PURGE obliga al verbo en espera a que se devuelva (con el código de retorno principal LUA_CANCELED).

Este verbo solo se usa cuando se ha emitido RUI_READ y está pendiente de finalización. (El código de retorno principal es LUA_IN_PROGRESS).

Consulte también

RUI_INIT
RUI_READ
RUI_TERM
RUI_WRITE
SLI_OPEN
SLI_PURGE
SLI_RECEIVE
SLI_SEND

Compartir a través de