Extract_Shutdown_State - Querying the shutdown state of the server

By issuing the Extract_Shutdown_State (CMESHS) call, a program can obtain the current shutdown state of the UTM partner application.

The Extract_Shutdown_State call is permitted in the "Send" and "Receive" states as well as in the "Reset" state immediately after a Receive-/Receive_Mapped_Data call.

This function is not part of the CPI-C specification but an additional function of the UPIC carrier system.

Syntax

CMESHS (conversation_ID, shutdown_state, return_code)

Parameters

--> conversation_ID	Identification of the conversation
<-- shutdown_state	The value contains the shutdown state of the UTM partner application. The shutdown_state variable can have one of the following values: CM_SHUTDOWN_NONE: The application has not initiated a shutdown. CM_SHUTDOWN_WARN: The application has initiated SHUTDOWN WARN. CM_SHUTDOWN_GRACE: The application has initiated SHUTDOWN GRACE.
<-- return_code	Result of the function call

Result (return_code)

CM_OK

Call OK

CM_PROGRAM_PARAMETER_CHECK

The value in conversation_ID is invalid.
The value of conversation_ID is invalid because the function was called more than once after the end of the conversation or because no conversation existed at the time (there was no Initialize_Conversation call after the Enable_UTM_UPIC call).

CM_PRODUCT_SPECIFIC_ERROR

The UPIC instance could not be found.

State change

The call does not change the state of the conversation.

Note

• If the return code is different from CM_OK then the value of shutdown_state is of no significance.

• After the end of the conversation, the value of conversation_ID remains valid for this function call until Initialize_Conversation or Extract_Shutdown_State is called.

Behavior in the event of errors

CM_PROGRAM_PARAMETER_CHECK

Modify program.

CM_PRODUCT_SPECIFIC_ERROR

The operating system cannot provide sufficient memory for internal buffers. Check whether the memory requirement of your program is too high and if necessary reboot your system.

Function declaration: Extract_Shutdown_State

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