$Session Close: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 11: | Line 11: | ||
===Syntax terms=== | ===Syntax terms=== | ||
< | <table class="syntaxTable"> | ||
<tr><th>%rc</th> | |||
<td>A numeric value set to 0 or to an error indicator. See [[#Status codes|"Status codes"]].</td></tr> | |||
<tr><th>sesid</th> | |||
<td>A new ID to be given to the session being closed. This is an optional argument which if not specified leaves the session's ID unchanged. </td></tr> | |||
The | <tr><th>owner</th> | ||
<td>The userid that is to be set as the new owner of the session being closed. An <var class="term">owner</var> value of <code>*</code> 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. | |||
<p> | |||
This is an optional argument which if not specified leaves the session's owner unchanged. </p></td></tr> | |||
=== | <tr><th>timeout</th> | ||
<p class="code"> | <td>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 <var>[[SRSDEFTO parameter|SRSDEFTO]]</var> parameter value. | ||
<p> | |||
This is an optional argument; if it is not specified, there is no change to the session's timeout value.</p></td></tr> | |||
</table> | |||
===Status codes=== | |||
<p class="code">-1 — Session not open | |||
0 — No errors | |||
1 — Session id already exists for user | |||
2 — Online session limit exceeded | |||
3 — User session limit exceeded | |||
</p> | </p> | ||
The | The status codes greater than 0 can only happen when one or more of the session attributes (<var class="term">sesid</var>, <var class="term">owner</var>, <var class="term">timeout</var>) is being changed. | ||
==Usage notes== | ==Usage notes== | ||
| Line 34: | Line 44: | ||
<li>After a <var>$Session_Close</var>, any session $lists, longstrings and XMLDocs will no longer be accessible. | <li>After a <var>$Session_Close</var>, any session $lists, longstrings and XMLDocs will no longer be accessible. | ||
<li>If a <var>$Session_Delete</var> 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 <var>$Session_Close</var> is done. A logout always does an implied <var>$Session_Close</var> so <var>$Session_Close</var> 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. | <li>If a <var>[[$Session_Delete]]</var> 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 <var>$Session_Close</var> is done. A logout always does an implied <var>$Session_Close</var> so <var>$Session_Close</var> 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. | ||
==Example== | ==Example== | ||
Revision as of 21:10, 19 November 2012
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.
Syntax
<section begin="syntax" />%rc = $Session_Close(sesid, owner, timeout) <section end="syntax" />
Syntax terms
| %rc | A numeric value set to 0 or to an error indicator. See "Status codes". |
|---|---|
| sesid | A new ID to be given to the session being closed. This is an optional argument which if not specified leaves the session's ID unchanged. |
| owner | The userid that is to be set as the new owner of the session being closed. An owner value 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 which if not specified leaves the session's owner unchanged. |
| timeout | 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; if it is not specified, there is no change to the session's timeout value. |
Status codes
-1 — Session not open 0 — No errors 1 — Session id already exists for user 2 — Online session limit exceeded 3 — User session limit exceeded
The status codes greater than 0 can only happen when one or more of the session attributes (sesid, owner, timeout) is being changed.
Usage notes
- 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.
Example
The following example closes the current session, making it a public session in the process:
%rc = $Session_Close(, '*')
Products authorizing $Session_Close