Extract_Shutdown_State - Shutdown-Status des Servers abfragen

Mit dem Aufruf Extract_Shutdown_State (CMESHS) erhält ein Programm den aktuellen Shutdown-Status der UTM-Partner-Anwendung.

Der Aufruf Extract_Shutdown_State ist im Zustand "Send" und "Receive" und im Zustand "Reset" unmittelbar nach einem Receive-/Receive_Mapped_Data-Aufruf erlaubt.

Diese Funktion ist nicht Bestandteil der CPI-C Spezifikation, sondern eine zusätzliche Funktion des UPIC-Trägersystems.

Syntax

CMESHS (conversation_ID, shutdown_state, return_code)

Parameter

--> conversation_ID	Identifikation der Conversation
<-- shutdown_state	Der Wert enthält den Shutdown-Status der UTM-Partner-Anwendung. Gültige Werte sind: CM_SHUTDOWN_NONE: Die Anwendung hat keinen Shutdown eingeleitet. CM_SHUTDOWN_WARN: Die Anwendung hat SHUTDOWN WARN eingeleitet. CM_SHUTDOWN_GRACE: Die Anwendung hat SHUTDOWN GRACE eingeleitet.
<-- return_code	Ergebnis des Funktionsaufrufs

Ergebnis (return_code)

CM_OK

Aufruf OK

CM_PROGRAM_PARAMETER_CHECK

Der Wert in conversation_ID ist ungültig.
Der Wert der conversation_ID ist ungültig, weil die Funktion nach Ende der Conversation mehr als einmal aufgerufen wurde oder weil noch keine Conversation existierte (nach dem Enable_UTM_UPIC-Aufruf ist noch kein Initialize_Conversation Aufruf erfolgt).

CM_PRODUCT_SPECIFIC_ERROR

Die UPIC-Instanz konnte nicht gefunden werden.

Zustandsänderung

Der Aufruf ändert den Zustand der Conversation nicht.

Hinweis

• Falls der Returncode von CM_OK verschieden ist, hat der Wert von shutdown_state keine Bedeutung.

• Der Wert der conversation_ID bleibt für diesen Funktionsaufruf nach dem Ende einer Conversation so lange gültig, bis Initialize_Conversation oder Extract_Shutdown_State aufgerufen werden.

Verhalten im Fehlerfall

CM_PROGRAM_PARAMETER_CHECK

Programm ändern.

CM_PRODUCT_SPECIFIC_ERROR

Das Betriebssystem kann nicht genügend Speicherplatz für interne Puffer bereitstellen. Überprüfen Sie Ihr Programm auf zu hohe Speicherplatzanforderung und starten Sie ggf. Ihr System neu.

Funktionsdeklaration: Extract_Shutdown_State

CM_ENTRY Extract_Shutdown_State( 
                        unsigned char      CM_PTR  conversation_ID, 
                        CM_SHUTDOWN_STATE  CM_PTR  shutdown_sate,
                        CM_RETURN_CODE     CM_PTR  return_code )