LoadMsgctl (XmlDoc subroutine): Difference between revisions
m (typo) |
|||
| Line 3: | Line 3: | ||
==Syntax== | ==Syntax== | ||
{{Template:XmlDoc:LoadMsgctl syntax}} | {{Template:XmlDoc:LoadMsgctl syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<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 | <td>An XmlDoc object, to which elements are added corresponding to the cumulative set of <var>[[MSGCTL command|MSGCTL]]</var> commands that have been issued, or to the single <var>MSGCTL</var> setting as specified by the <var>EDEFHD</var> argument.</td></tr> | ||
<tr><th><var>EDEFHD</var></th> | <tr><th><var>EDEFHD</var></th> | ||
<td>A string of at least 14 bytes. | <td>A string of at least 14 bytes. If this argument is specified, it is used to create a single element in the <var class="term">doc</var> method object, corresponding to the first 14 bytes of the value specified for <var>EDEFHD</var>.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
===Cumulative effect of all MSGCTL commands=== | |||
===Cumulative | If the only <var>MSGCTL</var> command issued in the Online so far is: | ||
If the only <var>MSGCTL</var> command issued in the Online | |||
<p class="code">MSGCTL M204.0843 NOOPR</p> | <p class="code">MSGCTL M204.0843 NOOPR</p> | ||
| Line 73: | Line 51: | ||
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. | ||
=== | ===Settings from a single MSGCTL command - EDEFHD=== | ||
If you inspect the hex value for the MSGCTL settings: | If you inspect the hex value for the <var>MSGCTL</var> settings: | ||
<p class="code">*LOOK MSGCTL 0 14 | <p class="code">*LOOK MSGCTL 0 14 | ||
| Line 96: | Line 74: | ||
==See also== | ==See also== | ||
<ul> | <ul> | ||
<li><var>[[LoadMessageInfo (XmlDoc subroutine)|LoadMessageInfo], which produces an XmlDoc with the same attributes for the <code><msg></code> elements. | <li><var>[[LoadMessageInfo (XmlDoc subroutine)|LoadMessageInfo]]</var>, which produces an XmlDoc with the same attributes for the <code><msg></code> elements. | ||
</ul> | </ul> | ||
{{Template:XmlDoc:LoadMsgctl footer}} | {{Template:XmlDoc:LoadMsgctl footer}} | ||
Revision as of 21:53, 14 July 2016
Load MSGCTL commands to this XmlDoc (XmlDoc class)
[Introduced in Model 204 7.7]
Syntax
doc:LoadMsgctl[( [EDEFHD= forRocketSupport])]
Syntax terms
| doc | An XmlDoc object, to which elements are added corresponding to the cumulative set of MSGCTL commands that have been issued, or to the single MSGCTL setting as specified by the EDEFHD argument. |
|---|---|
| EDEFHD | A string of at least 14 bytes. If this argument is specified, it is used to create a single element in the doc method object, corresponding to the first 14 bytes of the value specified for EDEFHD. |
Usage notes
Cumulative effect of all MSGCTL commands
If the only MSGCTL command issued in the Online so far is:
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.
Settings from a single MSGCTL command - EDEFHD
If you inspect the hex value for the MSGCTL settings:
*LOOK MSGCTL 0 14 MSGCTL 7D88E020 MSGCTL +00000000 7D89F080 034B0103 01000000 00000000
You can use the first 28 hexadecimal characters of the data at offset +00000000:
%doc:loadMsgctl(EDEFHD=('00000000' '034B0103' '0100000000' '0000'):hexToString) %doc:print
The result of the above fragment is:
<msgctls M204Version="7.7.0F"> <msg num="Mxxx.0843" class="I" auditType="MS" term="no" opr="yes" count="no"/> </msgctls>
See also
- LoadMessageInfo, which produces an XmlDoc with the same attributes for the
<msg>elements.