$Session_Delete
Jump to navigation
Jump to search
Delete a session
Note: Many $functions have been deprecated in favor of Object Oriented methods. The O-O equivalent of $Session_Delete is the DiscardSession shared method.
$Session_Delete deletes a session.
Syntax
%rc = $Session_Delete(sesid, [owner], [timeout])
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 value of asterisk (*) 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 has not been deleted, it will be as soon as it is closed. In fact, this would be the normal return code when deleting the current session — 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