$SirMsg: Difference between revisions
m (misc cleanup) |
m (misc formatting) |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$SirMsg}} | {{DISPLAYTITLE:$SirMsg}} | ||
<span class="pageSubtitle">Line of current | <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> | ||
Revision as of 19:37, 7 August 2017
Line of current $SirMsgP procedure
Note: Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $SirMsg function.
The $SirMsg function is used to retrieve a line from the current $SirMsg procedure as set by $SirMsgP.
Syntax
%msg = $SirMsg (line_num)
Syntax terms
| %msg | A string set to the contents of line_num in the current $SirMsg procedure. |
|---|---|
| line-num | The number of the line within the current $SirMsg procedure to be returned. A zero returns the name of the current $SirMsg procedure.
If there is no current $SirMsg procedure or the requested line number is invalid (negative or greater than the number of lines in the $SirMsg procedure), $SirMsg returns a null string. |
Usage notes
- $SirMsgP and $SirMsg allow a programmer to use a Model 204 procedure as a message repository. Each line of the procedure corresponds to a message that can be requested by line number with $SirMsg. The advantages of using $SirMsg are:
- No server space is wasted holding infrequently used error messages.
- The virtual storage holding the messages can be shared among users.
- It simplifies sharing common messages among procedures in a subsystem or online.
Examples
Suppose the current $SirMsg procedure as set by $SirMsgP contains these lines:
MSG0001 Invalid PF key. MSG0002 Record not found. MSG0003 Invalid data in input field.
The following statement would print: MSG0002 Record not found.
Print $SirMsg(2)
The following statement would print a null string:
Print $SirMsg(4)