$SirMsg - Revision history

JAL: misc formatting and links

2017-08-14T16:49:01Z

misc formatting and links

← Older revision		Revision as of 16:49, 14 August 2017
Line 7:		Line 7:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%msg</span> = $SirMsg (<span class="term">line_num, %arg1, %arg2, %arg3</span>)		<p class="syntax"><span class="term">%msg</span> = $SirMsg (<span class="term">line_num</span> [,<span class="term">%arg1</span>][,<span class="term">%arg2</span>][,<span class="term">%arg3</span>])
	</p>		</p>

Line 20:		Line 20:
	If there is no current <var>$SirMsg</var> procedure or the requested line number is invalid (negative or greater than the number of lines in the <var>$SirMsg</var> procedure), <var>$SirMsg</var> returns a null string.</p></td></tr>		If there is no current <var>$SirMsg</var> procedure or the requested line number is invalid (negative or greater than the number of lines in the <var>$SirMsg</var> procedure), <var>$SirMsg</var> returns a null string.</p></td></tr>

	<tr><th ~~nowrap~~>%arg1</th>		<tr><th>%arg1</th>
	<td>An optional substitution argument that will replace the first %C, if one is present, in the message.</td></tr>		<td>An optional substitution argument that will replace the first occurrence of the literal <code>%C</code>, if one is present, in the message. See the example in the "Examples" section, below. </td></tr>

	<tr><th ~~nowrap~~>%arg2</th>		<tr><th>%arg2</th>
	<td>An optional substitution argument that will replace the second %C, if one is present, in the message.</td></tr>		<td>An optional substitution argument that will replace the second <code>%C</code>, if one is present, in the message.</td></tr>

	<tr><th ~~nowrap~~>%arg3</th>		<tr><th>%arg3</th>
	<td>An optional substitution argument that will replace the third %C, if one is present, in the message.</td></tr>		<td>An optional substitution argument that will replace the third <code>%C</code>, if one is present, in the message.</td></tr>
	</table>		</table>

Line 49:		Line 49:
	</p>		</p>

	If this Print statement:		If this <var>Print</var> statement is in a <var>For</var> loop against file <code>HISTORY</code>, on record number 355:
	<p class="code">Print $SirMsg(2,$~~CURREC~~,$~~CURFILE~~)</p>		<p class="code">Print $SirMsg(2,$Currec,$Curfile)</p>
	<p>		<p>
	~~was in a FOR loop against file HISTORY, on record number 355, this message would print~~:		The output is:
	</p>		</p>
	<~~code~~>MSG0002: Processing record number=355 in file=HISTORY</~~code~~>.		<p class="output">MSG0002: Processing record number=355 in file=HISTORY </p>
	<p>		<p>
	$~~CURREC~~ replaces the first %C substitution string and $~~CURFILE~~ replaces the second. ~~Up to~~ three, optional, substitution strings (%C) ~~may~~ be present in one message.		The value of <var>[[$Currec]]</var> replaces the first <code>%C</code> substitution string, and the value of <var>[[$Curfile]]</var> replaces the second. As many as three, optional, substitution strings (<code>%C</code>) might be present in one message.
	</p>		</p>

	<p>		<p>
	The following statement ~~would print~~ a null string:		The following statement prints a null string: </p>
	<p class="code">Print $SirMsg(4)		<p class="code">Print $SirMsg(4)
	~~</p>~~

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

JDamon: Removed "This argument may also be a literal."

2017-08-08T16:59:10Z

Removed "This argument may also be a literal."

← Older revision		Revision as of 16:59, 8 August 2017
Line 21:		Line 21:

	<tr><th nowrap>%arg1</th>		<tr><th nowrap>%arg1</th>
	<td>An optional substitution argument that will replace the first %C, if one is present, in the message~~. This argument may also be a literal~~.</td></tr>		<td>An optional substitution argument that will replace the first %C, if one is present, in the message.</td></tr>

	<tr><th nowrap>%arg2</th>		<tr><th nowrap>%arg2</th>
	<td>An optional substitution argument that will replace the second %C, if one is present, in the message~~. This argument may also be a literal~~.</td></tr>		<td>An optional substitution argument that will replace the second %C, if one is present, in the message.</td></tr>

	<tr><th nowrap>%arg3</th>		<tr><th nowrap>%arg3</th>
	<td>An optional substitution argument that will replace the third %C, if one is present, in the message~~. This argument may also be a literal~~.</td></tr>		<td>An optional substitution argument that will replace the third %C, if one is present, in the message.</td></tr>
	</table>		</table>

JDamon: Provided examples of %C substitutions

2017-08-08T16:54:55Z

Provided examples of %C substitutions

← Older revision		Revision as of 16:54, 8 August 2017
Line 44:		Line 44:
	Suppose the current <var>$SirMsg</var> procedure as set by <var>$SirMsgP</var> contains these lines:		Suppose the current <var>$SirMsg</var> procedure as set by <var>$SirMsgP</var> contains these lines:

	<p class="code">MSG0001 Invalid PF key.		<p class="code">MSG0001: Invalid PF key.
	MSG0002 ~~Record not found~~.		MSG0002: Processing record number=%C in file=%C.
	MSG0003 Invalid data in input field.		MSG0003: Invalid data in input field.
	</p>		</p>

	~~The following~~ statement would print: <code>MSG0002 ~~Record not found~~</code>.		If this Print statement:
	<p ~~class="code"~~>~~Print~~ $~~SirMsg~~(2)		<p class="code">Print $SirMsg(2,$CURREC,$CURFILE)</p>
			<p>
			was in a FOR loop against file HISTORY, on record number 355, this message would print:
			</p>
			<code>MSG0002: Processing record number=355 in file=HISTORY</code>.
			<p>
			$CURREC replaces the first %C substitution string and $CURFILE replaces the second. Up to three, optional, substitution strings (%C) may be present in one message.
	</p>		</p>

			<p>
	The following statement would print a null string:		The following statement would print a null string:
	<p class="code">Print $SirMsg(4)		<p class="code">Print $SirMsg(4)

JDamon: Added the optional %arg1, %arg2, %arg3 substitutions for %C in the message

2017-08-08T16:25:06Z

Added the optional %arg1, %arg2, %arg3 substitutions for %C in the message

← Older revision		Revision as of 16:25, 8 August 2017
Line 7:		Line 7:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%msg</span> = $SirMsg (<span class="term">line_num</span>)		<p class="syntax"><span class="term">%msg</span> = $SirMsg (<span class="term">line_num, %arg1, %arg2, %arg3</span>)
	</p>		</p>

Line 19:		Line 19:
	<p>		<p>
	If there is no current <var>$SirMsg</var> procedure or the requested line number is invalid (negative or greater than the number of lines in the <var>$SirMsg</var> procedure), <var>$SirMsg</var> returns a null string.</p></td></tr>		If there is no current <var>$SirMsg</var> procedure or the requested line number is invalid (negative or greater than the number of lines in the <var>$SirMsg</var> procedure), <var>$SirMsg</var> returns a null string.</p></td></tr>

			<tr><th nowrap>%arg1</th>
			<td>An optional substitution argument that will replace the first %C, if one is present, in the message. This argument may also be a literal.</td></tr>

			<tr><th nowrap>%arg2</th>
			<td>An optional substitution argument that will replace the second %C, if one is present, in the message. This argument may also be a literal.</td></tr>

			<tr><th nowrap>%arg3</th>
			<td>An optional substitution argument that will replace the third %C, if one is present, in the message. This argument may also be a literal.</td></tr>
	</table>		</table>

JAL: misc formatting

2017-08-07T19:37:13Z

misc formatting

← Older revision		Revision as of 19:37, 7 August 2017
Line 1:		Line 1:
	{{DISPLAYTITLE:$SirMsg}}		{{DISPLAYTITLE:$SirMsg}}
	<span class="pageSubtitle">Line of current ~~<var>~~$SirMsgP~~</var>~~ procedure</span>		<span class="pageSubtitle">Line of current $SirMsgP procedure</span>

	<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $SirMsg 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 <var>$SirMsg</var> function.</p>

	The <var>$SirMsg</var> function is used to retrieve a line from the current <var>$SirMsg</var> procedure as set by <var>[[$SirMsgP]]</var>.		The <var>$SirMsg</var> function is used to retrieve a line from the current <var>$SirMsg</var> procedure as set by <var>[[$SirMsgP]]</var>.
Line 15:		Line 15:
	<td>A string set to the contents of <var class="term">line_num</var> in the current <var>$SirMsg</var> procedure.</td></tr>		<td>A string set to the contents of <var class="term">line_num</var> in the current <var>$SirMsg</var> procedure.</td></tr>

	<tr><th>line-num</th>		<tr><th nowrap>line-num</th>
	<td>The number of the line within the current <var>$SirMsg</var> procedure to be returned. A zero returns the name of the current <var>$SirMsg</var> procedure.		<td>The number of the line within the current <var>$SirMsg</var> procedure to be returned. A zero returns the name of the current <var>$SirMsg</var> procedure.
	<p>		<p>

JAL: misc cleanup

2015-10-06T22:57:11Z

misc cleanup

← Older revision		Revision as of 22:57, 6 October 2015
Line 2:		Line 2:
	<span class="pageSubtitle">Line of current <var>$SirMsgP</var> procedure</span>		<span class="pageSubtitle">Line of current <var>$SirMsgP</var> procedure</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 $SirMsg 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 $SirMsg function.</p>

	The <var>$SirMsg</var> function is used to retrieve a line from the current <var>$SirMsg</var> procedure as set by <var>[[$SirMsgP]]</var>.		The <var>$SirMsg</var> function is used to retrieve a line from the current <var>$SirMsg</var> procedure as set by <var>[[$SirMsgP]]</var>.

	~~<var>$SirMsg</var> accepts one required argument, and it returns a string.~~

	~~The argument is the number of the line within the current <var>$SirMsg</var> procedure to be returned. A zero returns the name of the current <var>$SirMsg</var> procedure.~~

	If there is no current <var>$SirMsg</var> procedure or the requested line number is invalid (negative or greater than the number of lines in the <var>$SirMsg</var> procedure), <var>$SirMsg</var> returns a null string.

	==Syntax==		==Syntax==
	<p class="syntax">%~~MSG~~ = $SirMsg (line_num)		<p class="syntax"><span class="term">%msg</span> = $SirMsg (<span class="term">line_num</span>)
	</p>		</p>

	<p>%~~MSG is~~ set to the contents of line_num in the current <var>$SirMsg</var> procedure.</p>		===Syntax terms===
			<table>
			<tr><th>%msg</th>
			<td>A string set to the contents of <var class="term">line_num</var> in the current <var>$SirMsg</var> procedure.</td></tr>

			<tr><th>line-num</th>
			<td>The number of the line within the current <var>$SirMsg</var> procedure to be returned. A zero returns the name of the current <var>$SirMsg</var> procedure.
			<p>
			If there is no current <var>$SirMsg</var> procedure or the requested line number is invalid (negative or greater than the number of lines in the <var>$SirMsg</var> procedure), <var>$SirMsg</var> returns a null string.</p></td></tr>
			</table>

	==Usage notes==		==Usage notes==
Line 38:		Line 41:

	The following statement would print: <code>MSG0002 Record not found</code>.		The following statement would print: <code>MSG0002 Record not found</code>.
	<p class="code"> ~~PRINT~~ $SirMsg(2)		<p class="code">Print $SirMsg(2)
	</p>		</p>

	The following statement would print a null string:		The following statement would print a null string:
	<p class="code">~~PRINT~~ $SirMsg(4)		<p class="code">Print $SirMsg(4)
	</p>		</p>

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

JAL at 22:10, 19 July 2013

2013-07-19T22:10:37Z

← Older revision		Revision as of 22:10, 19 July 2013
Line 4:		Line 4:
	<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 $SirMsg 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 $SirMsg function.</p>

	The <var>$SirMsg</var> function is used to retrieve a line from the current <var>$SirMsg</var> procedure as set by [[$SirMsgP]].		The <var>$SirMsg</var> function is used to retrieve a line from the current <var>$SirMsg</var> procedure as set by <var>[[$SirMsgP]]</var>.

	<var>$SirMsg</var> accepts one required argument, and it returns a string.		<var>$SirMsg</var> accepts one required argument, and it returns a string.
Line 18:		Line 18:
	<p>%MSG is set to the contents of line_num in the current <var>$SirMsg</var> procedure.</p>		<p>%MSG is set to the contents of line_num in the current <var>$SirMsg</var> procedure.</p>

	<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:		==Usage notes==
			<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:

	<ul>		<ul>
Line 24:		Line 26:
	<li>The virtual storage holding the messages can be shared among users.		<li>The virtual storage holding the messages can be shared among users.
	<li>It simplifies sharing common messages among procedures in a subsystem or online.		<li>It simplifies sharing common messages among procedures in a subsystem or online.
			</ul>
	</ul>		</ul>

			==Examples==
	Suppose the current <var>$SirMsg</var> procedure as set by <var>$SirMsgP</var> contains these lines:		Suppose the current <var>$SirMsg</var> procedure as set by <var>$SirMsgP</var> contains these lines:

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">Line of current <var>$SirMsgP</var> procedure</span>		<span class="pageSubtitle">Line of current <var>$SirMsgP</var> procedure</span>

	<p class="~~warning~~">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $SirMsg 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 $SirMsg function.</p>

	The <var>$SirMsg</var> function is used to retrieve a line from the current <var>$SirMsg</var> procedure as set by [[$SirMsgP]].		The <var>$SirMsg</var> function is used to retrieve a line from the current <var>$SirMsg</var> procedure as set by [[$SirMsgP]].

JALWiccan: Automatically generated page update

2013-04-10T18:17:41Z

Automatically generated page update

← Older revision		Revision as of 18:17, 10 April 2013
Line 13:		Line 13:

	==Syntax==		==Syntax==
	<p class="syntax"~~><section begin="syntax" /~~>%MSG = $SirMsg (line_num)		<p class="syntax">%MSG = $SirMsg (line_num)
	~~<section end="syntax" />~~</p>		</p>

	<p>%MSG is set to the contents of line_num in the current <var>$SirMsg</var> procedure.</p>		<p>%MSG is set to the contents of line_num in the current <var>$SirMsg</var> procedure.</p>

JALWiccan: 1 revision

2012-10-26T00:37:32Z

1 revision

← Older revision	Revision as of 00:37, 26 October 2012
(No difference)