$Session List: Difference between revisions
m (1 revision) |
(Automatically generated page update) |
||
| Line 7: | Line 7: | ||
==Syntax== | ==Syntax== | ||
<p class="syntax" | <p class="syntax">%rc = $Session_List(listid, sesid, owner) | ||
</p> | |||
<p>%rc is set to the number of added items.</p> | <p>%rc is set to the number of added items.</p> | ||
The first argument is the $list identifier to receive the output from <var>$Session_List</var>. This is a required argument. | The first argument is the $list identifier to receive the output from <var>$Session_List</var>. This is a required argument. | ||
The second argument is the session id for which information is to be returned. This argument can contain wildcards | The second argument is the session id for which information is to be returned. This argument can contain wildcards — for example "PEQ*" indicates that information is to be returned for all sessions beginning with the letters "PEQ". This is an optional argument and defaults to "*" meaning all session ids are to be listed. | ||
The third argument is the session owner for which information is to be returned. This argument can contain wildcards though for a non-system manager user only sessions owned by the requesting user and public sessions will be listed. Note that a "*" will list all private and public sessions but a ""*" will list public sessions only. This is an optional argument and defaults to the userid of the invoking user. | The third argument is the session owner for which information is to be returned. This argument can contain wildcards though for a non-system manager user only sessions owned by the requesting user and public sessions will be listed. Note that a "*" will list all private and public sessions but a ""*" will list public sessions only. This is an optional argument and defaults to the userid of the invoking user. | ||
Revision as of 18:17, 10 April 2013
Get list of sessions
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Session_List function is to be entered.
$Session_Create returns information about sessions to a $list, accepts three arguments and returns a the number of items added to the output $list. All errors result in request cancellation.
Syntax
%rc = $Session_List(listid, sesid, owner)
%rc is set to the number of added items.
The first argument is the $list identifier to receive the output from $Session_List. This is a required argument.
The second argument is the session id for which information is to be returned. This argument can contain wildcards — for example "PEQ*" indicates that information is to be returned for all sessions beginning with the letters "PEQ". This is an optional argument and defaults to "*" meaning all session ids are to be listed.
The third argument is the session owner for which information is to be returned. This argument can contain wildcards though for a non-system manager user only sessions owned by the requesting user and public sessions will be listed. Note that a "*" will list all private and public sessions but a ""*" will list public sessions only. This is an optional argument and defaults to the userid of the invoking user.
Output format
The format of the data in the output $list is
| Col 1-10 | Owner of the session; * for public sessions. |
|---|---|
| Col 11-16 | Session timeout value. |
| Col 17-30 | Session creation time in YYYYMMDDHHMISS format. |
| Col 31-44 | Last session access time in YYYYMMDDHHMISS format. If the session is currently open this value is the time of the $Session_List invocation and will have the same value for all sessions open at the time of the $Session_List call. |
| Col 45-50 | User number with session open. If the session is not currently open by any users these columns contain all blanks. |
| Col 51- | The session id. |
Usage notes
- The session ID and owner specified in the second and third arguments can be explicit names or can contain the following wildcard characters:
* Matches any number of characters including none ? Matches any single character " Indicates that the next character must be treated literally even if it is a wildcard character. For example,
C*Dmatches "CUSTID", "COD" or "CLOD".S??Tmatches "SALT", "SLOT" or "SORT"."*matches "*" (that is, public sessions, in the case of the owner).
Example
The following example displays information about all sessions owned by the current user:
%list = $ListNew %rc = $Session_List(%list) %rc = $List_Print(%list)