tibemsConnection_IsDisconnected

Function

Purpose

Check whether the connection has been disconnected.

C Declaration

tibems_status tibemsConnection_IsDisconnected(
    tibemsConnection connection,
    tibems_bool* disconnected);

COBOL Call

CALL "tibemsConnection_IsDisconnected"
     USING BY VALUE connection,
           BY REFERENCE disconnected,
           RETURNING tibems-status
END-CALL.
Note: connection has usage pointer.

Parameters

Parameter Description
connection Get the status of this connection.
disconnected Store the connection status in this location.

Remarks

This function gets a value indicating whether the connection is disconnected from the server.
If the connection is disconnected from the server,
tibemsConnection_IsDisconnected sets the connection status to TRUE. Otherwise, the connection status is FALSE.

That is, if the client has called tibemsConnection_Close, or if the connection has been terminated due to a network failure, tibemsConnection_IsDisconnected returns TRUE.