$FiStat - Revision history

JDamon: Correction to length of stats returned

2021-08-04T22:35:56Z

Correction to length of stats returned

← Older revision		Revision as of 22:35, 4 August 2021
Line 20:		Line 20:

	<tr><th>stat_list</th>		<tr><th>stat_list</th>
	<td>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 <var>[[$StatD]]</var> with the returned string. For more information about available statistics, see <var class="product">[[File statistics displayed in SirMon]]</var>. </td></tr>		<td>a string of blank-delimited words indicating the statistics to be returned. The length of each returned statistic is always four bytes. The first statistic in the stat list will be at byte number 17, the second at byte number 21 and so on. This facilitates the use of <var>[[$StatD]]</var> with the returned string. For more information about available statistics, see <var class="product">[[File statistics displayed in SirMon]]</var>. </td></tr>

	<tr><th>file_num</th>		<tr><th>file_num</th>

JAL: /* Syntax */ add "unsigned"

2016-10-04T14:55:57Z

Syntax: add "unsigned"

← Older revision		Revision as of 14:55, 4 October 2016
Line 15:		Line 15:
	<td>A string of data. If the string is exactly four bytes, it contains a binary [[#Return codes\|error code]].		<td>A string of data. If the string is exactly four bytes, it contains a binary [[#Return codes\|error code]].
	<p>		<p>
	Otherwise, the first four bytes contain the binary number of milliseconds that the Online has been up. This provides a convenient number for calculating rates for the statistics. </p>		Otherwise, the first four bytes contain the unsigned binary number of milliseconds that the Online has been up. This provides a convenient number for calculating rates for the statistics. </p>
	<p>		<p>
	The next ten bytes contain the blank-padded file name, then follows two bytes containing the binary file number. This means that the actual data starts at offset 16 (byte number 17) in the result string.</p></td></tr>		The next ten bytes contain the blank-padded file name, then follows two bytes containing the binary file number. This means that the actual data starts at offset 16 (byte number 17) in the result string.</p></td></tr>

JAL: clarify return value

2016-10-03T21:54:56Z

clarify return value

← Older revision		Revision as of 21:54, 3 October 2016
Line 13:		Line 13:
	<table>		<table>
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>A string ~~containing binary~~ data. If the string is exactly four bytes, it contains an [[#Return codes\|error code]].		<td>A string of data. If the string is exactly four bytes, it contains a binary [[#Return codes\|error code]].
	<p>		<p>
	Otherwise, the first four bytes contain the number of milliseconds that the Online has been up. This provides a convenient number for calculating rates for the statistics. </p>		Otherwise, the first four bytes contain the binary number of milliseconds that the Online has been up. This provides a convenient number for calculating rates for the statistics. </p>
	<p>		<p>
	The next ten bytes contain the blank-padded file name, then follows two bytes containing the binary file number. This means that the actual data starts at offset 16 (byte number 17) in the result string.</p></td></tr>		The next ten bytes contain the blank-padded file name, then follows two bytes containing the binary file number. This means that the actual data starts at offset 16 (byte number 17) in the result string.</p></td></tr>
Line 27:		Line 27:

	===Return codes===		===Return codes===
	<p class="code"> -5 - Required parameter not specified		<p class="code"> -5 Required parameter not specified
	-12 - Invalid parameter (argument 2 > NUSERS, or invalid name in stat_list)		-12 Invalid parameter (argument 2 > NUSERS, or invalid name in stat_list)
	-13 - STAT not linked in		-13 STAT not linked in
	-14 - Result string would be longer than 255 bytes		-14 Result string would be longer than 255 bytes
	-15 - File no longer open		-15 File no longer open
	</p>		</p>

JAL: clarify return value

2016-10-03T21:01:57Z

clarify return value

← Older revision		Revision as of 21:01, 3 October 2016
Line 2:		Line 2:
	<span class="pageSubtitle">Retrieve file's statistics into string</span>		<span class="pageSubtitle">Retrieve file's statistics into string</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 $FiStat 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>$FiStat</var> function.</p>

	This function allows retrieval of a specific file's statistics into a string.		This function allows retrieval of a specific file's statistics into a string.

	~~The <var>$FiStat</var> function accepts two arguments and returns a string made up of an error code and returned statistics.~~

	==Syntax==		==Syntax==
Line 15:		Line 13:
	<table>		<table>
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>~~Binary~~ data, the first 4 bytes of ~~which is an error code~~. If the ~~error code is negative~~, %string ~~is only 4 bytes long~~.</td></tr>		<td>A string containing binary data. If the string is exactly four bytes, it contains an [[#Return codes\|error code]].
			<p>
			Otherwise, the first four bytes contain the number of milliseconds that the Online has been up. This provides a convenient number for calculating rates for the statistics. </p>
			<p>
			The next ten bytes contain the blank-padded file name, then follows two bytes containing the binary file number. This means that the actual data starts at offset 16 (byte number 17) in the result string.</p></td></tr>

	<tr><th>stat_list</th>		<tr><th>stat_list</th>
	<td>a string of blank-delimited words indicating the statistics to be returned. The length of each returned statistic is always a multiple of 4 bytes. This facilitates the use of <var>[[$StatD]]</var> with the returned string. For more information about available statistics, see <var class="product">[[File statistics displayed in SirMon]]</var>. </td></tr>		<td>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 <var>[[$StatD]]</var> with the returned string. For more information about available statistics, see <var class="product">[[File statistics displayed in SirMon]]</var>. </td></tr>

	<tr><th>file_num</th>		<tr><th>file_num</th>
	<td>The file number of the file for which data is to be returned.</td></tr>		<td>The file number of the file for which data is to be returned.</td></tr>
	</table>		</table>

	~~==Usage notes==~~
	~~<ul>~~
	<li>The data returned by <var>$FiStat</var> is binary, the first 4 bytes of which contain a return code. If the return code is negative, only 4 bytes are returned. If the return code is positive, it contains a number of milliseconds that the online has been up. This provides a convenient number for calculating rates for the statistics.
	~~<p>~~
	With a positive return code, the next 10 bytes contain the blank-padded file name, followed by 2 bytes that contain the binary file number. This means that the actual data starts at offset 16 (byte number 17) in the result string.</p></li>
	~~</ul>~~

	===Return codes===		===Return codes===
Line 41:		Line 36:
	==Example==		==Example==
	The following program displays some totals for file 0 (always CCATEMP).		The following program displays some totals for file 0 (always CCATEMP).
	<p class="code">B		<p class="code">Begin
			%data IS STRING LEN 255

	%~~DATA IS STRING LEN 255~~		%data = $FiStat('DKIO CFRCONF CFRQUEU', 0)
			IF $Len(%data) = 4 THEN
	~~%DATA~~ = $FiStat('DKIO CFRCONF CFRQUEU', 0)		PRINT '$FISTAT ERROR... RC = ' WITH $Unbin(%data)
	IF $~~LEN~~(%~~DATA~~) = 4 THEN
	PRINT '$FISTAT ERROR... RC = ' WITH -
	$~~UNBIN~~(%~~DATA~~)
	STOP		STOP
	END IF		END IF

	PRINT 'FILENAME = ' WITH $~~SUBSTR~~(%~~DATA~~, 5, 10)		PRINT 'FILENAME = ' WITH $Substr(%data, 5, 10)
	PRINT 'DKIO = ' WITH -		PRINT 'DKIO = ' WITH $Unbin( $Substr(%data, 17, 4) )
	$~~UNBIN~~( $~~SUBSTR~~(%~~DATA~~, 17, 4) )		PRINT 'CFRCONF = ' WITH $Unbin( $Substr(%data, 21, 4) )
	PRINT 'CFRCONF = ' WITH -		PRINT 'CFRQUEU = ' WITH $Unbin( $Substr(%data, 25, 4) )
	$~~UNBIN~~( $~~SUBSTR~~(%~~DATA~~, 21, 4) )		End
	PRINT 'CFRQUEU = ' WITH -
	$~~UNBIN~~( $~~SUBSTR~~(%~~DATA~~, 25, 4) )

	~~END~~
	</p>		</p>

JAL: /* Usage notes */ remove item

2016-09-23T17:50:23Z

Usage notes: remove item

← Older revision		Revision as of 17:50, 23 September 2016
Line 26:		Line 26:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	~~<li>This function is only available to sites that own the Sirius Functions or have a site-license for all M204 products.</li>~~

	<li>The data returned by <var>$FiStat</var> is binary, the first 4 bytes of which contain a return code. If the return code is negative, only 4 bytes are returned. If the return code is positive, it contains a number of milliseconds that the online has been up. This provides a convenient number for calculating rates for the statistics.		<li>The data returned by <var>$FiStat</var> is binary, the first 4 bytes of which contain a return code. If the return code is negative, only 4 bytes are returned. If the return code is positive, it contains a number of milliseconds that the online has been up. This provides a convenient number for calculating rates for the statistics.
	<p>		<p>

JAL: link repair

2016-09-13T19:11:31Z

link repair

← Older revision		Revision as of 19:11, 13 September 2016
Line 9:		Line 9:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%~~STRING~~</span> = <span class="literal">$FiStat</span>(<span class="term">stat_list</span>, <span class="term">file_num</span>)		<p class="syntax"><span class="term">%string</span> = <span class="literal">$FiStat</span>(<span class="term">stat_list</span>, <span class="term">file_num</span>)
	</p>		</p>
	~~<p>%STRING is made up of binary data, the first 4 bytes of which is an error code. If the error code is negative, %STRING will only be 4 bytes long.</p>~~
	The first argument is a string of blank-delimited words indicating the statistics to be returned. The length of each returned statistic is always a multiple of 4 bytes. This facilitates the use of $StatD [[$StatD]] with the returned string. For more information on available statistics, see the <var class="product">[http://sirius-software.com/maint/download/monr.pdf SirMon User's Guide]</var>.

	The ~~second argument~~ is the file number of the file for which data is to be returned.		===Syntax terms===
			<table>
			<tr><th>%string</th>
			<td>Binary data, the first 4 bytes of which is an error code. If the error code is negative, %string is only 4 bytes long.</td></tr>

			<tr><th>stat_list</th>
			<td>a string of blank-delimited words indicating the statistics to be returned. The length of each returned statistic is always a multiple of 4 bytes. This facilitates the use of <var>[[$StatD]]</var> with the returned string. For more information about available statistics, see <var class="product">[[File statistics displayed in SirMon]]</var>. </td></tr>

			<tr><th>file_num</th>
			<td>The file number of the file for which data is to be returned.</td></tr>
			</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>

	<li>This function is only available to sites that own the Sirius Functions or have a site-license for all M204 products.</li>		<li>This function is only available to sites that own the Sirius Functions or have a site-license for all M204 products.</li>

	<li>The data returned by <var>$FiStat</var> is binary, the first 4 bytes of which contain a return code. If the return code is negative, only 4 bytes are returned. If the return code is positive, it contains a number of milliseconds that the online has been up. This provides a convenient number for calculating rates for the statistics. <~~/li~~>		<li>The data returned by <var>$FiStat</var> is binary, the first 4 bytes of which contain a return code. If the return code is negative, only 4 bytes are returned. If the return code is positive, it contains a number of milliseconds that the online has been up. This provides a convenient number for calculating rates for the statistics.
			<p>
	With a positive return code, the next 10 bytes contain the blank-padded file name, followed by 2 bytes that contain the binary file number. This means that the actual data starts at offset 16 (byte number 17) in the result string.		With a positive return code, the next 10 bytes contain the blank-padded file name, followed by 2 bytes that contain the binary file number. This means that the actual data starts at offset 16 (byte number 17) in the result string.</p></li>
	</ul>		</ul>

JAL: /* Return codes */ misc formatting

2016-09-13T18:59:57Z

Return codes: misc formatting

← Older revision		Revision as of 18:59, 13 September 2016
Line 27:		Line 27:
	===Return codes===		===Return codes===
	<p class="code"> -5 - Required parameter not specified		<p class="code"> -5 - Required parameter not specified
	-12 - Invalid parameter (argument 2 > NUSERS,		-12 - Invalid parameter (argument 2 > NUSERS, or invalid name in stat_list)
	or invalid name in stat_list)
	-13 - STAT not linked in		-13 - STAT not linked in
	-14 - Result string would be longer than 255 bytes		-14 - Result string would be longer than 255 bytes

Dme: /* Example */

2016-09-13T18:13:19Z

Example

← Older revision		Revision as of 18:13, 13 September 2016
Line 57:		Line 57:
	END		END
	</p>		</p>

			==<b id="auth"></b>Products authorizing {{PAGENAMEE}}==
			<ul class="smallAndTightList">
			<li>[[List of $functions\|Sirius functions]]</li>
			<li>[[SirMon]]</li>
			</ul>

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

Alan at 16:16, 13 September 2016

2016-09-13T16:16:11Z

← Older revision		Revision as of 16:16, 13 September 2016
Line 17:		Line 17:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>The data returned by <var>$FiStat</var> is binary, the first 4 bytes of which contain a return code. If the return code is negative, only 4 bytes are returned. If the return code is positive, it contains a number of milliseconds that the online has been up. This provides a convenient number for calculating rates for the statistics.
			<li>This function is only available to sites that own the Sirius Functions or have a site-license for all M204 products.</li>

			<li>The data returned by <var>$FiStat</var> is binary, the first 4 bytes of which contain a return code. If the return code is negative, only 4 bytes are returned. If the return code is positive, it contains a number of milliseconds that the online has been up. This provides a convenient number for calculating rates for the statistics. </li>

	With a positive return code, the next 10 bytes contain the blank-padded file name, followed by 2 bytes that contain the binary file number. This means that the actual data starts at offset 16 (byte number 17) in the result string.		With a positive return code, the next 10 bytes contain the blank-padded file name, followed by 2 bytes that contain the binary file number. This means that the actual data starts at offset 16 (byte number 17) in the result string.

JALWiccan: Automatically generated page update

2013-07-18T20:36:13Z

Automatically generated page update

← Older revision		Revision as of 20:36, 18 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Retrieve file's statistics into string</span>		<span class="pageSubtitle">Retrieve file's statistics into string</span>

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

	This function allows retrieval of a specific file's statistics into a string.		This function allows retrieval of a specific file's statistics into a string.