Finishing Work: close

SOAP APIs › Scenario Management APIs › Finishing Work: close_session()

Finishing Work: close_session()

The close_session API function lets you log out of the Control Service. After you log in to the Control Service, you call the close_session argument to log out of the Control Service.

Arguments

The close_session API function includes the arguments described in the following table:

Name	Type	Description
session_id	uint	The session ID that was returned by calling the create_session API.
why_not_reason	out string	Contains the reason for failure when this API fails.

Return Values

The return type is Boolean. When the return value is true, the session was closed. When the return value is false, the session was not closed.

Example

public bool close_session_example()
        {
            try
            {
                string why_not_reason = "";
                return get_mng().close_session(_session_id, out why_not_reason);
            }
            catch (Exception ex)
            {
                System.Windows.Forms.MessageBox.Show(ex.Message);
            }
            return false;
        }