$Session_Create
Create a new session
Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Session_Create function is the SetSession shared method.
$Session_Create creates a new session, accepts four 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 to be given to the new session. This is a required argument.
The second argument is the userid that will own this session. An owner value of asterisk (*) 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 optional argument defaults to the creating user's userid.
The third argument is the time after a $Session_Close (or logout) after which the session is considered timed-out, that is, eligible for deletion. A value of -1 means use the SESDEFTO parameter value. This optional argument defaults to -1, that is the SESDEFTO parameter value.
The fourth argument is a blank delimited set of options to control the create process. The options are:
| OPEN | Automatically open the session upon creating it. This is the default behavior. |
|---|---|
| NOOPEN | Don't automatically open the session upon creating it. This is not the default behavior but might be useful if creating a session for another user or creating many sessions at once. |
Syntax
%rc = $Session_Create(sesid, [owner], [timeout], [opts])
Return codes
%rc is set to 0 or to an error indicator.
0 - No errors 1 - Session id already exists for user 2 - Online session limit exceeded 3 - User session limit exceeded
Example
The following example creates a session called "GROUCHO" followed by a timestamp then sets a cookie for a web application so that the session can be easily located on subsequent web requests.
%sesid = 'GROUCHO' WITH $SirTime %rc = $Session_Create(%sesid, , 3600) %rc = $Web_Set_Cookie('SESID', %sesid)
Products authorizing $Session_Create
- Sirius functions
- Fast/Unload User Language Interface
- Janus Open Client
- Janus Open Server
- Janus Sockets
- Janus Web Server
- Japanese functions
- Sir2000 Field Migration Facility