Disconnect( ) method

Ends the connection to the SBM server for the user session. The associated Progress.BPM.UserSession object will no longer have a connection to an SBM server.

Return type:

LOGICAL

Access:

PUBLIC

Applies to:

Progress.BPM.UserSession class

 

Syntax 

Disconnect( INPUT delete-on-server-flag AS LOGICAL)

delete-on-server-flag

This flag identifies whether to delete the user session on the SBM Server. If TRUE, the session is deleted from the SBM Server. If FALSE, the session is not deleted from the SBM Server.

Disconnect( ) returns TRUE if the method succeeds, FALSE if it does not. If the UserSession object is not currently connected, Disconnect( ) returns FALSE.

If the UserSession had been connected but there is a problem executing Disconnect( ), the method fails (for example, if the physical connection to the server has been broken so it is not possible to execute Disconnect( ) on the server) and raises a BPM error.

Note:

When Disconnect( ) succeeds, all of the ABL objects (but not the corresponding objects on the server) that have been created directly or indirectly through the associated UserSession object become invalid. The delete-on-server-flag identifies whether the user session is over (such as when the user logs out of the application) and the session should be deleted on the SBM Server. See the notes for the Progress.BPM.UserSession class.

See also:

Connect( ) method, Progress.BPM.UserSession class