LoadMsgctl (XmlDoc subroutine): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (→‎Syntax terms: word change)
 
(4 intermediate revisions by 2 users not shown)
Line 9: Line 9:
<table>
<table>
<tr><th>doc</th>
<tr><th>doc</th>
<td>An XmlDoc object, to which elements are added corresponding to the cumulative set of <var>[[MSGCTL command|MSGCTL]]</var> commands which have been issued, or to the single <var>MSGCTL</var> setting as specified by the <var>EDEFHD</var> argument.</td></tr>
<td>An XmlDoc object, to which elements are added corresponding to either of these:
<ul>
<li>The cumulative set of <var>[[MSGCTL command|MSGCTL]]</var> commands which have been issued.</li>
 
<li>The single <var>MSGCTL</var> setting as specified by the <var>EDEFHD</var> argument. </li>
</ul></td></tr>


<tr><th><var>EDEFHD</var></th>
<tr><th><var>EDEFHD</var></th>
<td>A string of at least 14 bytes. This argument is used to create a single element in the <var class="term">doc</var> method object. That element is built from the first 14 bytes of the value specified for an internal Model&nbsp;204 header field labeled <code>EDEFHD</code>. These bytes identify an error message and control the processing when the given message is produced. 
<td>Used by Rocket Support.</td></tr>
<p>
Although this argument is likely to seldom be used, an example is [[#EDEFHD|shown below]]. </p></td></tr>
</table>
</table>


==Usage notes==
==Usage notes==
In the [[RKTools]] file <code>SIRIUS</code> (which can be [https://model204.rocketsoftware.com/maint/ullist downloaded from Rocket]) is a procedure (<code>RKTCMP_MSGINFO</code>) you can use to show the <var>MSGCTL</var> commands currently in effect in the Online. Example output from the procedure is shown below:
In the [[RKTools]] file <code>M204PROC</code> (which can be [https://model204.rocketsoftware.com/maint/ullist downloaded from Rocket]) is a procedure (<code>RKTCMP_MSGINFO</code>) you can use to show the <var>MSGCTL</var> commands currently in effect in the Online. Example output from the procedure is shown below:


<p class="output"><b>OPEN FILE SIRIUS
<p class="output"><b>OPEN FILE SIRIUS
Line 75: Line 78:


The <code>opr="yes"</code> attribute indicates that the message is sent to the console operator.
The <code>opr="yes"</code> attribute indicates that the message is sent to the console operator.
===<b id="EDEFHD"></b>Settings from a single MSGCTL command===
You can use the <var>EDEFHD</var> parameter of <var>LoadMsgctl</var> to display the attributes of an individual <var>MSGCTL</var> command instead of showing all the <var>MSGCTL</var> commands. If you inspect the hex value for the <var>MSGCTL</var> settings:
<p class="code">[[Overview of Model 204 commands#look|*LOOK]] MSGCTL 0 14                                   
MSGCTL  7D88E020                                   
MSGCTL  +00000000  7D89F080 034B0103 01000000 00000000
</p>
You can use the first 28 hexadecimal characters of the data at offset <code>+00000000</code>:
<p class="code"><nowiki>%doc:loadMsgctl(EDEFHD=('00000000' '034B0103' '0100000000' '0000'):hexToString)
%doc:print
</nowiki></p>
The result of the above fragment is:
<p class="output"><nowiki><msgctls M204Version="7.7.0F">
  <msg num="Mxxx.0843" class="I" auditType="MS" term="no" opr="yes" count="no"/>
</msgctls>
</nowiki></p>


==See also==
==See also==

Latest revision as of 09:27, 28 May 2019

Load MSGCTL commands to this XmlDoc (XmlDoc class)

[Introduced in Model 204 7.7]


This method displays the messages in the current session that have been affected by MSGCTL commands, as well as the current attributes of those messages.

Syntax

doc:LoadMsgctl[( [EDEFHD= forRocketSupport])]

Syntax terms

doc An XmlDoc object, to which elements are added corresponding to either of these:
  • The cumulative set of MSGCTL commands which have been issued.
  • The single MSGCTL setting as specified by the EDEFHD argument.
EDEFHD Used by Rocket Support.

Usage notes

In the RKTools file M204PROC (which can be downloaded from Rocket) is a procedure (RKTCMP_MSGINFO) you can use to show the MSGCTL commands currently in effect in the Online. Example output from the procedure is shown below:

OPEN FILE SIRIUS INCLUDE RKTCMP_MSGINFO MSGCTL M204.0843 NOOPR MSGCTL M204.1303 NODUMP NOSNAP MSGCTL M204.0099 NOAUDIT MSGCTL M204.0131 NOAUDIT MSGCTL M204.0353 NOAUDIT MSGCTL M204.0608 NOAUDIT MSGCTL M204.0619 NOAUDIT MSGCTL M204.0620 NOAUDIT MSGCTL M204.0621 NOAUDIT MSGCTL M204.0622 NOAUDIT MSGCTL M204.0821 NOAUDIT MSGCTL M204.0858 NOAUDIT MSGCTL M204.1149 NOAUDIT MSGCTL M204.1203 NOAUDIT MSGCTL M204.1238 NOAUDIT MSGCTL MSIR.0007 DUMPALL

Cumulative effect of all MSGCTL commands

If the only MSGCTL command issued in the Online has been:

MSGCTL M204.0843 NOOPR

Then the following request:

begin %d is object xmlDoc auto new %d:loadMsgctl %d:print end

Produces:

<msgctls M204Version="7.7.0F"> <msg num="M204.0843" class="I" auditType="MS" term="no" count="no"/> </msgctls>

The value of the M204Version attribute will, of course, depend on the Model 204 version you are using.

If you subsequently return M204.0843 to its normal state:

MSGCTL M204.0843 OPR

Then the result of the above request will be:

<msgctls M204Version="7.7.0F"> <msg num="M204.0843" class="I" auditType="MS" term="no" opr="yes" count="no"/> </msgctls>

The opr="yes" attribute indicates that the message is sent to the console operator.

See also

  • LoadMessageInfo, which produces an XmlDoc with the same attributes for the <msg> elements.
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=LoadMsgctl_(XmlDoc_subroutine)&oldid=117481"