$Session Delete: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 4: | Line 4: | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Session_Delete function is '''[[to be entered]]'''.</p> | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Session_Delete function is '''[[to be entered]]'''.</p> | ||
<var>$Session_Delete</var> deletes a [[Sessions|session]] | <var>$Session_Delete</var> deletes a [[Sessions|session]]. | ||
==Syntax== | ==Syntax== | ||
| Line 14: | Line 13: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%rc</th> | <tr><th>%rc</th> | ||
<td> | <td>A numeric variable that is set to 0, indicating success, or to a numeric error indicator: | ||
<p class="code">0 - No errors | <p class="code">0 - No errors | ||
1 - Session not found | 1 - Session not found | ||
| Line 31: | Line 30: | ||
==Usage notes== | ==Usage notes== | ||
A return code of 2 indicates that while the session hasn't been deleted, it will be as soon as it is closed. In fact, this would be the normal return code when deleting the current sesssion — the session actually being deleted when it is closed or the user logs off. | <ul> | ||
<li>A return code of 2 indicates that while the session hasn't been deleted, it will be as soon as it is closed. In fact, this would be the normal return code when deleting the current sesssion — the session actually being deleted when it is closed or the user logs off. | |||
</ul> | |||
==Example== | ==Example== | ||
The following example deletes the current session no matter what its id: | The following example deletes the current session no matter what its id: | ||
<p class="code">% | <p class="code">%sesid = $Session_Id | ||
% | %rc = $Session_Delete(%SESID) | ||
% | %rc = $Session_Close | ||
</p> | </p> | ||
Revision as of 20:27, 29 October 2012
Delete a session
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Session_Delete function is to be entered.
$Session_Delete deletes a session.
Syntax
<section begin="syntax" />%rc = $Session_Delete(sesid, [owner], [timeout]) <section end="syntax" />
Syntax terms
| %rc | A numeric variable that is set to 0, indicating success, or to a numeric error indicator:
0 - No errors 1 - Session not found 2 - Session in use |
|---|---|
| sesid | The id of the session to be deleted. This is a required argument. |
| owner | The userid that owns the session to be deleted. An owner of "*" means that the session is public, that is available to all users. This optional argument defaults to the creating user's userid. |
| timeout | The time to wait for an in-use session to be closed to perform a synchronous delete. If timeout is 0 or the session being deleted is the session currently opened by the invoking user or the session is not closed within the indicated timeout time, the session is deleted asynchronously when the session is closed. This argument defaults to 0 which means that if the session is in-use it is deleted asynchronously. |
Usage notes
- A return code of 2 indicates that while the session hasn't been deleted, it will be as soon as it is closed. In fact, this would be the normal return code when deleting the current sesssion — the session actually being deleted when it is closed or the user logs off.
Example
The following example deletes the current session no matter what its id:
%sesid = $Session_Id %rc = $Session_Delete(%SESID) %rc = $Session_Close
Products authorizing $Session_Delete
- Sirius functions
- Fast/Unload User Language Interface
- Janus Open Client
- Janus Open Server
- Janus Sockets
- Janus Web Server
- Japanese functions
- Sir2000 Field Migration Facility