$Session_Close

From m204wiki
Revision as of 17:39, 19 October 2012 by JALWiccan (talk | contribs) (1 revision)
Jump to navigation Jump to search

Close an open session

Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Session_Close function is to be entered.

$Session_Close closes an open session, accepts three arguments and returns a zero, indicating success, or a number indicating the cause of error, if there is one.

The first argument is new id to be given to the session being closed. This is an optional argument and if not specified leaves the session's id unchanged.

The second argument is the userid that is to be set as the new owner of the session being closed. An owner of "*" means that the session is public, that is available to all users. Only a system administrator can create a non-public session for a user other than itself. This is an optional argument and if not specified leaves the session's owner unchanged.

The third argument is the new value to be used as the session timeout value, that is the time after which the session is considered timed-out, that is eligible for deletion. A value of -1 means to use the SRSDEFTO parameter value. This is an optional argument and if not specified leaves the session's timeout value unchanged.

Syntax

<section begin="syntax" />%rc = $Session_Close(sesid, owner, timeout) <section end="syntax" />

$Session_Close function

%RC is set to 0 or to an error indicator.

-1 - Session not open 0 - No errors 1 - Session id already exists for user 2 - Online session limit exceeded 3 - User session limit exceeded

$Session_Close return codes

The return codes greater than 0 can only happen when one or more of the session attributes (id, owner, timeout) is being changed.

After a $Session_Close, any session $lists, longstrings and XMLDocs will no longer be accessible.

If a $Session_Delete had been done for the session before it was closed by the user who had the session open or someone else, the session is immediately deleted when the $Session_Close is done. A logout always does an implied $Session_Close so $Session_Close is only necessary if another session is to be open or to minimize the time window in which the session might be requested by another thread.


The following example closes the current session, making it a public session in the process:

%RC = $Session_Close(, '*')

Products authorizing $Session_Create

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$Session_Close&oldid=30132"