$Session Create - Revision history

Dme at 12:19, 10 July 2017

2017-07-10T12:19:19Z

← Older revision		Revision as of 12:19, 10 July 2017
Line 2:		Line 2:
	<span class="pageSubtitle">Create a new session</span>		<span class="pageSubtitle">Create a new session</span>

	<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Session_Create function is the <var>[[~~Global_and_session_objects#Using_system_class_methods_to_access_global_and_session_objects~~\|SetSession]]</var> ~~shared method~~.</p>		<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Session_Create function is the <var>[[SetSession (Object subroutine)\|SetSession]]</var> subroutine.</p>

	<var>$Session_Create</var> creates a new [[Sessions\|session]], and it returns a zero, indicating success, or a number indicating the cause of error, if there is one.		<var>$Session_Create</var> creates a new [[Sessions\|session]], and it returns a zero, indicating success, or a number indicating the cause of error, if there is one.

JAL: misc cleanup

2015-10-06T22:21:03Z

misc cleanup

← Older revision		Revision as of 22:21, 6 October 2015
Line 2:		Line 2:
	<span class="pageSubtitle">Create a new session</span>		<span class="pageSubtitle">Create a new session</span>

	<p class="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Session_Create function is the <var>[[Global_and_session_objects#Using_system_class_methods_to_access_global_and_session_objects\|SetSession]]</var> shared method.</p>		<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Session_Create function is the <var>[[Global_and_session_objects#Using_system_class_methods_to_access_global_and_session_objects\|SetSession]]</var> shared method.</p>

	<var>$Session_Create</var> creates a new [[Sessions\|session]], ~~accepts four arguments~~ and returns a zero, indicating success, or a number indicating the cause of error, if there is one.		<var>$Session_Create</var> creates a new [[Sessions\|session]], and it 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.~~		==Syntax==
			<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Session_Create</span>(<span class="term">sesid</span>, [<span class="term">owner</span>], [<span class="term">timeout</span>], [<span class="term">opts</span>])
			</p>

	~~The second argument is the userid that will own this session. An '''owner''' value of asterisk (~~<tt>*</tt>~~) 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~~.		<table>
			<tr><th>sesid</th>
			<td>The ID to be given to the new session. This is a required argument.</td></tr>

	~~The third argument is the time after a~~ <~~var~~>~~[[$Session_Close]]~~</~~var~~> ~~(or logout) after which the~~ session ~~is considered~~ '''~~timed-out~~'''~~, that is, eligible for deletion. A~~ value of ~~-1 means use the~~ <~~var~~>~~[[SESDEFTO parameter\|SESDEFTO]]~~</~~var~~> ~~parameter value~~. This optional argument defaults to ~~-1, that is~~ the <~~var~~>~~SESDEFTO~~</~~var~~> ~~parameter value.~~		<tr><th>owner</th>
			<td>The userid that will own this session. An '''owner''' value of asterisk (<tt>*</tt>) 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. </td></tr>

	The ~~fourth~~ argument is a blank delimited set of options to control the create process. The options are:		<tr><th>timeout</th>
			<td>The time after a <var>[[$Session_Close]]</var> (or logout) after which the session is considered '''timed-out''', that is, eligible for deletion. A value of -1 means use the <var>[[SESDEFTO parameter\|SESDEFTO]]</var> parameter value. This optional argument defaults to -1, that is the <var>SESDEFTO</var> parameter value. </td></tr>

			<tr><th>opts</th>
			<td>A blank-delimited set of options to control the create process. The options are:
	<table class="thJustBold">		<table class="thJustBold">
	<tr><th>OPEN</th>		<tr><th>OPEN</th>
	<td>Automatically open the session upon creating it. This is the default behavior.</td></tr>		<td>Automatically open the session upon creating it. This is the default behavior.</td></tr>

	<tr><th>NOOPEN</th>		<tr><th>NOOPEN</th>
	<td>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.		<td>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.
	</td></tr></table>		</td></tr></table>
			</td></tr></table>
	~~==Syntax==~~
	~~<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Session_Create</span>(<span class="term">sesid~~</~~span>, [<span class="term">owner</span>], [<span class="term">timeout</span>], [<span class="term"~~>~~opts~~</~~span~~>])
	</p>

	===Return codes===		===Return codes===
Line 34:		Line 41:

	==Example==		==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.		The following example creates a session called <code>GROUCHO</code>, followed by a timestamp then sets a cookie for a web application so that the session can be easily located on subsequent web requests.
	<p class="code">%sesid = 'GROUCHO' WITH $SirTime		<p class="code">%sesid = 'GROUCHO' WITH $SirTime
	%rc = $Session_Create(%sesid, , 3600)		%rc = $Session_Create(%sesid, , 3600)
Line 50:		Line 57:
	<li>Japanese functions</li>		<li>Japanese functions</li>
	<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]]</li>		<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]]</li>

	</ul>		</ul>
	~~<p>~~
	~~</p>~~


	[[Category:$Functions\|$Session_Create]]		[[Category:$Functions\|$Session_Create]]

JALWiccan: Automatically generated page update

2015-02-19T23:09:45Z