RUI_PURGE

Das RUI_PURGE Verb bricht ein vorheriges RUI_READ ab.

Die folgende Struktur beschreibt das LUA_COMMON Element des Verbsteuerelementblocks (VCB), das von RUI_PURGE verwendet wird.

Syntax

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

Elemente

lua_verb
Angegebener Parameter. Enthält den Verbcode LUA_VERB_RUI für RUI-Verben (Request Unit Interface).

lua_verb_length
Angegebener Parameter. Gibt die Länge in Byte der VCB (Logical Unit Application, LUA) an. Er muss die Länge des Verbdatensatzes enthalten, der ausgegeben wird.

lua_prim_rc
Primärer Rückgabecode, der von LUA nach Abschluss des Verbs festgelegt wurde. Die gültigen Rückgabecodes variieren je nach ausgestellten LUA-Verb.

lua_sec_rc
Sekundärer Rückgabecode, der von LUA beim Abschluss des Verbs festgelegt wurde. Die gültigen Rückgabecodes variieren je nach ausgestellten LUA-Verb.

lua_opcode
Angegebener Parameter. Enthält den LUA-Befehlscode (Verboperationscode) für das zu ausgestellte Verb LUA_OPCODE_RUI_PURGE.

lua_correlator
Angegebener Parameter. Enthält einen vom Benutzer bereitgestellten Wert, der das Verb mit anderen vom Benutzer bereitgestellten Informationen verknüpft. LUA verwendet oder ändert diese Informationen nicht. Dieser Parameter ist optional.

lua_luname
Angegebener Parameter. Gibt den ASCII-Namen der lokalen LU an, die von der Windows LUA-Sitzung verwendet wird.

RUI_PURGE erfordert diesen Parameter nur, wenn lua_sid null ist.

Dieser Parameter ist acht Bytes lang, rechts mit Leerzeichen (0x20) aufgefüllt, wenn der Name kürzer als acht Zeichen ist.

lua_extension_list_offset
Wird von RUI in Microsoft® Host Integration Server nicht verwendet und sollte auf Null festgelegt werden.

lua_cobol_offset
Wird nicht von LUA im Hostintegrationsserver verwendet und sollte null sein.

lua_sid
Angegebener Parameter. Gibt den Sitzungsbezeichner an und wird von SLI_OPEN und RUI_INIT zurückgegeben. Andere Verben verwenden diesen Parameter, um die für den Befehl verwendete Sitzung zu identifizieren. Wenn andere Verben den parameter lua_luname verwenden, um Sitzungen zu identifizieren, legen Sie den lua_sid Parameter auf Null fest.

lua_max_length
Wird von RUI_PURGE nicht verwendet und sollte auf Null festgelegt werden.

lua_data_length
Wird von RUI_PURGE nicht verwendet und sollte auf Null festgelegt werden.

lua_data_ptr
Verweist auf die Position der RUI_READ Verben, die abgebrochen werden sollen.

lua_post_handle
Angegebener Parameter. Wird unter Microsoft® Windows Server verwendet, wenn eine asynchrone Benachrichtigung durch Ereignisse durchgeführt werden soll. Diese Variable enthält das Handle des Ereignisses, das signalisiert werden soll, oder ein Fensterhandle.

lua_th
Wird von RUI_PURGE nicht verwendet und sollte auf Null festgelegt werden.

lua_rh
Wird von RUI_PURGE nicht verwendet und sollte auf Null festgelegt werden.

lua_flag1
Wird von RUI_PURGE nicht verwendet und sollte auf Null festgelegt werden.

lua_message_type
Wird von RUI_PURGE nicht verwendet und sollte auf Null festgelegt werden.

lua_flag2
Zurückgegebener Parameter. Enthält Flags für nachrichten, die von LUA zurückgegeben werden.

lua_flag2.async

Gibt an, dass das LUA-Schnittstellenverb asynchron abgeschlossen wurde, wenn er auf 1 festgelegt ist.

lua_resv56
Reserviert und sollte auf Null festgelegt werden.

lua_encr_decr_option
Reserviert und sollte auf Null festgelegt werden.

Rückgabecodes

LUA_OK
Primärer Rückgabecode; das Verb erfolgreich ausgeführt wurde.

LUA_CANCELED
Primärer Rückgabecode; das Verb wurde nicht erfolgreich abgeschlossen, da es von einem anderen Verb abgebrochen wurde.

LUA_TERMINATED

Sekundärer Rückgabecode; RUI_TERM wurde ausgestellt, während RUI_PURGE aussteht.

LUA_PARAMETER_CHECK
Primärer Rückgabecode; das Verb wurde aufgrund eines Parameterfehlers nicht ausgeführt.

LUA_BAD_DATA_PTR

Sekundärer Rückgabecode; der parameter lua_data_ptr wurde auf NULL festgelegt.

LUA_BAD_SESSION_ID

Sekundärer Rückgabecode; Ein ungültiger Wert für lua_sid wurde im VCB angegeben.

LUA_INVALID_POST_HANDLE

Sekundärer Rückgabecode; für ein Windows-Betriebssystem, das Ereignisse als asynchrone Bereitstellungsmethode verwendet, enthält die Windows LUA VCB kein gültiges Ereignishandle.

LUA_RESERVED_FIELD_NOT_ZERO

Sekundärer Rückgabecode; Ein reserviertes Feld im Verbdatensatz oder ein Parameter, der von diesem Verb nicht verwendet wird, wurde auf einen Wert ungleich Null festgelegt.

LUA_VERB_LENGTH_INVALID

Sekundärer Rückgabecode; ein LUA-Verb wurde mit dem Wert lua_verb_length unerwartet von LUA ausgegeben.

LUA_STATE_CHECK
Primärer Rückgabecode; das Verb wurde nicht ausgeführt, weil es in einem ungültigen Zustand ausgegeben wurde.

LUA_NO_RUI_SESSION

Sekundärer Rückgabecode; RUI_INIT wurde für den in diesem Verb angegebenen LU-Namen noch nicht erfolgreich abgeschlossen.

LUA_UNSUCCESSFUL
Primärer Rückgabecode; Das angegebene Verb war gültig, aber das Verb wurde nicht erfolgreich abgeschlossen.

LUA_INVALID_PROCESS

Sekundärer Rückgabecode; Der Betriebssystem/2-Prozess, der dieses Verb ausgestellt hat, war nicht derselbe Prozess, der RUI_INIT für diese Sitzung ausgestellt hat. Nur der Prozess, der eine Sitzung gestartet hat, kann Verben in dieser Sitzung ausgeben.

LUA_NO_READ_TO_PURGE

Sekundärer Rückgabecode; Entweder enthielt lua_data_ptr keinen Zeiger auf eine RUI_READ VCB oder RUI_READ abgeschlossen, bevor RUI_PURGE ausgestellt wurde.

LUA_COMM_SUBSYSTEM_ABENDED
Primärer Rückgabecode; gibt eine der folgenden Bedingungen an:

• Der von dieser Unterhaltung verwendete Knoten hat einen ABEND gefunden.

• Die Verbindung zwischen dem Transaktionsprogramm (TP) und dem Physischen Einheitsknoten (PU) 2.1 wurde unterbrochen (LAN-Fehler).

• Die SnaBase auf dem Computer der TPs hat einen ABEND gefunden.

  LUA_SESSION_FAILURE
  Primärer Rückgabecode; eine erforderliche Hostintegrationsserverkomponente wurde beendet.

  LUA_LU_COMPONENT_DISCONNECTED

  Sekundärer Rückgabecode; gibt an, dass die LUA-Sitzung aufgrund eines Problems mit dem Linkdienst oder mit der Host-LU fehlgeschlagen ist.

  LUA_RUI_LOGIC_ERROR

  Sekundärer Rückgabecode; Ein interner Fehler wurde in LUA erkannt. Dieser Fehler sollte während des normalen Vorgangs nicht auftreten.

  LUA_INVALID_VERB
  Primärer Rückgabecode; entweder der Verbcode oder der Vorgangscode oder beides ist ungültig. Das Verb wurde nicht ausgeführt.

  LUA_STACK_TOO_SMALL
  Primärer Rückgabecode; Die Stapelgröße der Anwendung ist zu klein, um das Verb auszuführen. Erhöhen Sie die Stapelgröße Ihrer Anwendung.

  LUA_COMM_SUBSYSTEM_NOT_LOADED
  Primärer Rückgabecode; Eine erforderliche Komponente konnte nicht geladen oder beendet werden, während das Verb verarbeitet wird. So konnte die Kommunikation nicht stattfinden. Wenden Sie sich an den Systemadministrator, um Korrekturmaßnahmen zu ergreifen.

  LUA_UNEXPECTED_DOS_ERROR
  Primärer Rückgabecode; nach dem Ausgeben eines Betriebssystemaufrufs wurde ein unerwarteter Rückgabecode des Betriebssystems empfangen und im sekundären Rückgabecode angegeben.

Bemerkungen

RUI_READ können auf unbestimmte Zeit warten, wenn sie gesendet wird, ohne die Option lua_flag1.nowait (sofortige Rückgabe) zu verwenden, und es sind keine Daten für den angegebenen Fluss verfügbar. RUI_PURGE erzwingt, dass das Warteverb zurückgegeben wird (mit dem primären Rückgabecode LUA_CANCELED).

Dieses Verb wird nur verwendet, wenn RUI_READ ausgestellt wurde und aussteht. (Der primäre Rückgabecode ist LUA_IN_PROGRESS.)

Siehe auch

RUI_INIT
RUI_READ
RUI_TERM
RUI_WRITE
SLI_OPEN
SLI_PURGE
SLI_RECEIVE
SLI_SEND