$SirMsgP - Revision history

JAL: misc formatting

2017-08-07T19:43:21Z

misc formatting

← Older revision		Revision as of 19:43, 7 August 2017
Line 15:		Line 15:
	<table>		<table>
	<tr><th>%result</th>		<tr><th>%result</th>
	<td>A numeric code set to indicate the success of the function.</td></tr>		<td>A [[#Return codes\|numeric code]] set to indicate the success of the function.</td></tr>

	<tr><th>proc_name</th>		<tr><th>proc_name</th>
Line 27:		Line 27:
	<p class="code">0 - Procedure set as current <var>$SirMsg</var> procedure		<p class="code">0 - Procedure set as current <var>$SirMsg</var> procedure
	1 - Procedure is locked for edit or delete		1 - Procedure is locked for edit or delete
	2 - Procedure does not exist or the current user does not		2 - Procedure does not exist or the current user does not have access privilege
	have access privilege
	3 - Specified procedure name is invalid (null)		3 - Specified procedure name is invalid (null)
	4 - Either file name invalid, or no current file, or		4 - Either file name invalid, or no current file, or caller does not have
	caller does not have sufficient privilege to		sufficient privilege to display/include procedures
	display/include procedures		7 - There is insufficient virtual storage to load the procedure
	7 - There is insufficient virtual storage to load the
	procedure
	</p>		</p>

Line 51:		Line 48:
	<li>If <var>$SirMsgP</var> determines that another thread has the same procedure as its current <var>$SirMsg</var> procedure then that thread's virtual storage copy is shared. <var>$SirMsgP</var> considers another thread to be using the same <var>$SirMsg</var> procedure if the procedure name, file name and contents of the procedure are identical to the one being set.		<li>If <var>$SirMsgP</var> determines that another thread has the same procedure as its current <var>$SirMsg</var> procedure then that thread's virtual storage copy is shared. <var>$SirMsgP</var> considers another thread to be using the same <var>$SirMsg</var> procedure if the procedure name, file name and contents of the procedure are identical to the one being set.
	<p>		<p>
	If not released explicitly, the virtual storage occupied by a <var>$SirMsg</var> procedure will not be released until user logoff or restart. To release the virtual storage used by a <var>$SirMsg</var> procedure without setting a new one, simply invoke <var>$SirMsgP</var> with a null procedure name. For example, the following statement would clear the current <var>$SirMsg</var> procedure and set %rc to 3:</p>		If not released explicitly, the virtual storage occupied by a <var>$SirMsg</var> procedure will not be released until user logoff or restart. To release the virtual storage used by a <var>$SirMsg</var> procedure without setting a new one, simply invoke <var>$SirMsgP</var> with a null procedure name. For example, the following statement would clear the current <var>$SirMsg</var> procedure and set <code>%rc</code> to 3:</p>

	<p class="code">%rc = $SirMsgP('')		<p class="code">%rc = $SirMsgP('')

JAL: misc cleanup

2015-10-06T23:08:49Z

misc cleanup

← Older revision		Revision as of 23:08, 6 October 2015
Line 2:		Line 2:
	<span class="pageSubtitle">Load procedure for retrieval via $SirMsg</span>		<span class="pageSubtitle">Load procedure for retrieval via $SirMsg</span>

	<p class="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $SirMsgP function.</p>		<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $SirMsgP function.</p>

	The <var>$SirMsgP</var> function is used to load a procedure into virtual storage for use as the current <var>$SirMsg</var> procedure.		The <var>$SirMsgP</var> function is used to load a procedure into virtual storage for use as the current <var>$SirMsg</var> procedure.

	<var>$SirMsgP</var> accepts two arguments and returns a numeric code. ~~As of <var class="product">[[Sirius Mods]]</var> Version 6.8, it~~ is a [[Calling Sirius Mods $functions\|callable]] $function .		<var>$SirMsgP</var> accepts two arguments and returns a numeric code. It is a [[Calling Sirius Mods $functions\|callable]] $function .

	~~The first argument is required and identifies the <var class="product">User Language</var> procedure to be made the current <var>$SirMsg</var> procedure.~~

	~~The second argument is an optional file name. If the second argument is not provided, or is a null string, the current file is used~~.

	==Syntax==		==Syntax==
Line 16:		Line 12:
	</p>		</p>

	<p>		===Syntax terms===
	<~~var class="term"~~>%result</~~var~~> is set to indicate the success of the function.</p>		<table>
			<tr><th>%result</th>
			<td>A numeric code set to indicate the success of the function.</td></tr>

			<tr><th>proc_name</th>
			<td>This required argument identifies the <var class="product">SOUL</var> procedure to be made the current <var>$SirMsg</var> procedure. </td></tr>

			<tr><th>file_name</th>
			<td>An optional file name. If this argument is not provided or is a null string, the current file is used. </td></tr>
			</table>

	===Return codes===		===Return codes===

ELowell at 23:07, 11 November 2014

2014-11-11T23:07:20Z

← Older revision		Revision as of 23:07, 11 November 2014
Line 48:		Line 48:
	If not released explicitly, the virtual storage occupied by a <var>$SirMsg</var> procedure will not be released until user logoff or restart. To release the virtual storage used by a <var>$SirMsg</var> procedure without setting a new one, simply invoke <var>$SirMsgP</var> with a null procedure name. For example, the following statement would clear the current <var>$SirMsg</var> procedure and set %rc to 3:</p>		If not released explicitly, the virtual storage occupied by a <var>$SirMsg</var> procedure will not be released until user logoff or restart. To release the virtual storage used by a <var>$SirMsg</var> procedure without setting a new one, simply invoke <var>$SirMsgP</var> with a null procedure name. For example, the following statement would clear the current <var>$SirMsg</var> procedure and set %rc to 3:</p>

	<p class="code">%rc = $SirMsgP(~~<nowiki>''</nowiki>~~)		<p class="code">%rc = $SirMsgP('')
	</p>		</p>

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

JALWiccan: Automatically generated page update

2013-07-19T18:59:19Z

Automatically generated page update

← Older revision		Revision as of 18:59, 19 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Load procedure for retrieval via $SirMsg</span>		<span class="pageSubtitle">Load procedure for retrieval via $SirMsg</span>

	<p class="~~warning~~">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $SirMsgP function.</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $SirMsgP function.</p>

	The <var>$SirMsgP</var> function is used to load a procedure into virtual storage for use as the current <var>$SirMsg</var> procedure.		The <var>$SirMsgP</var> function is used to load a procedure into virtual storage for use as the current <var>$SirMsg</var> procedure.

JALWiccan: Automatically generated page update

2013-04-12T18:43:38Z

Automatically generated page update

← Older revision		Revision as of 18:43, 12 April 2013
Line 13:		Line 13:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = <span class="literal">$SirMsgP</span>(<span class="term">proc_name</span>, ~~<span class="term"></span>~~[<span class="term">file_name</span>])		<p class="syntax"><span class="term">%result</span> = <span class="literal">$SirMsgP</span>(<span class="term">proc_name</span>, [<span class="term">file_name</span>])
	</p>		</p>

JALWiccan: Automatically generated page update

2013-04-12T18:30:57Z

Automatically generated page update

← Older revision		Revision as of 18:30, 12 April 2013
Line 13:		Line 13:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = <span class="literal">$SirMsgP</span>(<span class="term">proc_name</span>, [<span class="term">file_name</span>])		<p class="syntax"><span class="term">%result</span> = <span class="literal">$SirMsgP</span>(<span class="term">proc_name</span>, <span class="term"></span>[<span class="term">file_name</span>])
	</p>		</p>

JAL: /* Usage notes */

2013-04-11T21:10:32Z

Usage notes

← Older revision		Revision as of 21:10, 11 April 2013
Line 35:		Line 35:
	<ul>		<ul>
	<li><var>$SirMsgP</var> and <var>[[$SirMsg]]</var> allow a programmer to use a <var class="product">Model 204</var> procedure as a message repository. Each line of the procedure corresponds to a message that can be requested by line number with <var>$SirMsg</var>.		<li><var>$SirMsgP</var> and <var>[[$SirMsg]]</var> allow a programmer to use a <var class="product">Model 204</var> procedure as a message repository. Each line of the procedure corresponds to a message that can be requested by line number with <var>$SirMsg</var>.
			<p>
	The advantages of using <var>$SirMsg</var> are:		The advantages of using <var>$SirMsg</var> are:
			</p>
	<ul>		<ul>
	<li>No server space is wasted holding infrequently used error messages.		<li>No server space is wasted holding infrequently used error messages.
Line 44:		Line 45:

	<li>If <var>$SirMsgP</var> determines that another thread has the same procedure as its current <var>$SirMsg</var> procedure then that thread's virtual storage copy is shared. <var>$SirMsgP</var> considers another thread to be using the same <var>$SirMsg</var> procedure if the procedure name, file name and contents of the procedure are identical to the one being set.		<li>If <var>$SirMsgP</var> determines that another thread has the same procedure as its current <var>$SirMsg</var> procedure then that thread's virtual storage copy is shared. <var>$SirMsgP</var> considers another thread to be using the same <var>$SirMsg</var> procedure if the procedure name, file name and contents of the procedure are identical to the one being set.
			<p>
			If not released explicitly, the virtual storage occupied by a <var>$SirMsg</var> procedure will not be released until user logoff or restart. To release the virtual storage used by a <var>$SirMsg</var> procedure without setting a new one, simply invoke <var>$SirMsgP</var> with a null procedure name. For example, the following statement would clear the current <var>$SirMsg</var> procedure and set %rc to 3:</p>

	If not released explicitly, the virtual storage occupied by a <var>$SirMsg</var> procedure will not be released until user logoff or restart. To release the virtual storage used by a <var>$SirMsg</var> procedure without setting a new one, simply invoke <var>$SirMsgP</var> with a null procedure name. For example, the following statement would clear the current <var>$SirMsg</var> procedure and set %rc to 3:
	<p class="code">%rc = $SirMsgP(<nowiki>''</nowiki>)		<p class="code">%rc = $SirMsgP(<nowiki>''</nowiki>)
	</p>		</p>

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

JAL: /* Usage notes */

2013-04-11T21:08:38Z

Usage notes

← Older revision		Revision as of 21:08, 11 April 2013
Line 33:		Line 33:

	==Usage notes==		==Usage notes==
	<var>$SirMsgP</var> and [[$SirMsg]] allow a programmer to use a <var class="product">Model 204</var> procedure as a message repository. Each line of the procedure corresponds to a message that can be requested by line number with <var>$SirMsg</var>.		<ul>
			<li><var>$SirMsgP</var> and <var>[[$SirMsg]]</var> allow a programmer to use a <var class="product">Model 204</var> procedure as a message repository. Each line of the procedure corresponds to a message that can be requested by line number with <var>$SirMsg</var>.

	The advantages of using <var>$SirMsg</var> are:		The advantages of using <var>$SirMsg</var> are:

	<ul>		<ul>
	<li>No server space is wasted holding infrequently used error messages.		<li>No server space is wasted holding infrequently used error messages.
Line 43:		Line 43:
	</ul>		</ul>

			<li>If <var>$SirMsgP</var> determines that another thread has the same procedure as its current <var>$SirMsg</var> procedure then that thread's virtual storage copy is shared. <var>$SirMsgP</var> considers another thread to be using the same <var>$SirMsg</var> procedure if the procedure name, file name and contents of the procedure are identical to the one being set.

	If <var>$SirMsgP</var> determines that another thread has the same procedure as its current <var>$SirMsg</var> procedure then that thread's virtual storage copy is shared. <var>$SirMsgP</var> considers another thread to be using the same <var>$SirMsg</var> procedure if the procedure name, file name and contents of the procedure are identical to the one being set.		If not released explicitly, the virtual storage occupied by a <var>$SirMsg</var> procedure will not be released until user logoff or restart. To release the virtual storage used by a <var>$SirMsg</var> procedure without setting a new one, simply invoke <var>$SirMsgP</var> with a null procedure name. For example, the following statement would clear the current <var>$SirMsg</var> procedure and set %rc to 3:
			<p class="code">%rc = $SirMsgP(<nowiki>''</nowiki>)
	If not released explicitly, the virtual storage occupied by a <var>$SirMsg</var> procedure will not be released until user logoff or restart. To release the virtual storage used by a <var>$SirMsg</var> procedure without setting a new one, simply invoke <var>$SirMsgP</var> with a null procedure name. For example
	<p class="code"> %RC = $SirMsgP('')
	</p>		</p>
	~~would clear the current <var>$SirMsg</var> procedure and set %RC to 3.~~

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

JAL: /* Syntax */

2013-04-11T21:04:45Z

Syntax

← Older revision		Revision as of 21:04, 11 April 2013
Line 13:		Line 13:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = <span class="literal">$SirMsgP</span>(<span class="term">proc_name, file_name)		<p class="syntax"><span class="term">%result</span> = <span class="literal">$SirMsgP</span>(<span class="term">proc_name</span>, [<span class="term">file_name</span>])
	</p>		</p>

	<p>		<p>
	</p>		<var class="term">%result</var> is set to indicate the success of the function.</p>
	<p>~~%result~~ is set to indicate the success of the function.</p>

	<p class="code">		===Return codes===
	0 - Procedure set as current <var>$SirMsg</var> procedure		<p class="code">0 - Procedure set as current <var>$SirMsg</var> procedure
	1 - Procedure is locked for edit or delete		1 - Procedure is locked for edit or delete
	2 - Procedure does not exist or the current user does not		2 - Procedure does not exist or the current user does not
	have access privilege		have access privilege
	3 - Specified procedure name is invalid (null)		3 - Specified procedure name is invalid (null)
	4 - Either file name invalid, or no current file, or		4 - Either file name invalid, or no current file, or
	caller does not have sufficient privilege to		caller does not have sufficient privilege to
	display/include procedures		display/include procedures
	7 - There is insufficient virtual storage to load the		7 - There is insufficient virtual storage to load the
	procedure		procedure
	~~</p>~~
	~~<p class="caption">$SirMsgP return codes~~
	</p>		</p>

			==Usage notes==
	<var>$SirMsgP</var> and [[$SirMsg]] allow a programmer to use a <var class="product">Model 204</var> procedure as a message repository. Each line of the procedure corresponds to a message that can be requested by line number with <var>$SirMsg</var>.		<var>$SirMsgP</var> and [[$SirMsg]] allow a programmer to use a <var class="product">Model 204</var> procedure as a message repository. Each line of the procedure corresponds to a message that can be requested by line number with <var>$SirMsg</var>.

JALWiccan: Automatically generated page update

2013-04-10T21:52:38Z

Automatically generated page update

← Older revision		Revision as of 21:52, 10 April 2013
Line 13:		Line 13:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = $SirMsgP(proc_name, file_name)		<p class="syntax"><span class="term">%result</span> = <span class="literal">$SirMsgP</span>(<span class="term">proc_name, file_name)
	</p>		</p>
	<p>		<p>