$JpStatL: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (→‎Error codes: add code)
m (→‎Products authorizing {{PAGENAMEE}}: fix "Sirius functions")
 
(3 intermediate revisions by 2 users not shown)
Line 31: Line 31:


===Error codes===
===Error codes===
<p class="code"> -3 &mdash; CCATEMP is full
<p class="code"> -3 &mdash; CCATEMP is full.
  -5 &mdash; Required parameter not specified.
  -5 &mdash; Required parameter not specified.
  -6 &mdash; Invalid $list identifier.
  -6 &mdash; Invalid $list identifier.
-12 &mdash; Invalid parameter in <var class="term">stat_list</var>.
-12 &mdash; Invalid parameter in <var class="term">stat_list</var>.
-13 &mdash; STAT not linked in.
-13 &mdash; STAT not linked in.
-17 &mdash; No Janus port active.
</p>
</p>


==Products authorizing {{PAGENAMEE}}==
==Products authorizing {{PAGENAMEE}}==
<ul class="smallAndTightList">
<ul class="smallAndTightList">
<li>[[List of $functions|Sirius functions]]</li>
<li>[[Sirius Functions]]</li>
</ul>
</ul>


[[Category:$Functions|$UsStatL]]
[[Category:$Functions|$UsStatL]]

Latest revision as of 23:38, 20 September 2018

Retrieve statistics for set of Janus ports into $list

Syntax

%result = $JpStatL(list_identifier, stat_list)

Syntax terms

%result Either a positive number, which is the milliseconds since the Online was brought up, or a negative error code.
list_identifier The identifier of the $list to receive the results. The current contents of the $list are deleted and replaced with the requested statistics. The format of each $list item is:
Byte 1-30 Blank padded port name
Byte 31-32 Binary port number
Byte 33- Returned statistics
stat_list A string of blank delimited words indicating the statistics to be returned. The length of each returned statistic is always a multiple of four bytes. This facilitates the use of $StatLD with the returned $list. For more information about available statistics, see SirMon Janus Monitor menu.

Error codes

-3 — CCATEMP is full. -5 — Required parameter not specified. -6 — Invalid $list identifier. -12 — Invalid parameter in stat_list. -13 — STAT not linked in. -17 — No Janus port active.

Products authorizing $JpStatL