$Session, $Session Id, $Session Owner, and $Session Timeout: Difference between revisions
mNo edit summary |
mNo edit summary |
||
Line 2: | Line 2: | ||
<span class="pageSubtitle">$Session, $Session_Id, $Session_Owner, and $Session_Timeout</span> | <span class="pageSubtitle">$Session, $Session_Id, $Session_Owner, and $Session_Timeout</span> | ||
<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. | <p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There are no direct OO equivalents for the $Session, $Session_Id, $Session_Owner, and $Session_Timeout functions.</p> | ||
These functions accept no arguments and return the requested value associated with the current open session. | These functions accept no arguments and return the requested value associated with the current open [[Sessions|session]]. | ||
<var>$Session</var> returns a 1 (if the user has a session currently open) or a 0 otherwise. | <var>$Session</var> returns a 1 (if the user has a session currently open) or a 0 otherwise. | ||
Line 13: | Line 13: | ||
<var>$Session_Timeout</var> returns the timeout value of the currently open session (if there is one) or a <code>-1</code> otherwise. | <var>$Session_Timeout</var> returns the timeout value of the currently open session (if there is one) or a <code>-1</code> otherwise. | ||
==Products authorizing $Session, $Session_Id, $Session_Owner, and $Session_Timeout== | ==Products authorizing $Session, $Session_Id, $Session_Owner, and $Session_Timeout== |
Revision as of 22:54, 25 July 2013
$Session, $Session_Id, $Session_Owner, and $Session_Timeout
Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. There are no direct OO equivalents for the $Session, $Session_Id, $Session_Owner, and $Session_Timeout functions.
These functions accept no arguments and return the requested value associated with the current open session.
$Session returns a 1 (if the user has a session currently open) or a 0 otherwise.
$Session_Id returns the ID of the currently open session (if there is one) or a null otherwise.
$Session_Owner returns the owner of the currently open session (if there is one) or a null otherwise. A value of asterisk (*) indicates that the currently open session is a public session.
$Session_Timeout returns the timeout value of the currently open session (if there is one) or a -1
otherwise.