$Session_Delete

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, 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 the id of the session to be deleted. This is a required argument.

The second argument is 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.

The third argument is 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.

Syntax

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

$Session_Delete function

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

0 - No errors 1 - Session not found 2 - Session in use

$Session_Delete return codes

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. 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

$Session_Delete

Syntax

Navigation menu