$CfStatL: Difference between revisions
(Automatically generated page update) |
|||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">List of statistics for users holding critical file resources</span> | <span class="pageSubtitle">List of statistics for users holding critical file resources</span> | ||
<p class=" | <p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $CfStatL function.</p> | ||
This function allows retrieval of statistics for all users holding critical file resources in a given file into a $list. | This function allows retrieval of statistics for all users holding critical file resources in a given file into a $list. | ||
| Line 8: | Line 8: | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><span class="term">%result</span> = $CfStatL(list_identifier, stat_list, file_num) | <p class="syntax"><span class="term">%result</span> = <span class="literal">$CfStatL</span>(<span class="term">list_identifier</span>, <span class="term">stat_list</span>, <span class="term">file_num</span>) | ||
</p> | </p> | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table | <table> | ||
<tr><th>%result</th> | <tr><th>%result</th> | ||
<td>Either a positive number which is the number of milliseconds since the | <td>Either a positive number which is the number of milliseconds since the Online was brought up, or a negative [[#Return codes|error]] code.</td></tr> | ||
<tr><th>list_identifier</th> | <tr><th>list_identifier</th> | ||
<td>The indentifier of the $list that is 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: | <td>The indentifier of the $list that is 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: | ||
<table class=" | <table class="thJustBold"> | ||
<tr><th>Byte 1-10</th> | <tr><th>Byte 1-10</th> | ||
<td>Blank padded userid</td></tr> | <td>Blank padded userid</td></tr> | ||
| Line 31: | Line 31: | ||
<td>A string of blank-delimited words indicating the statistics to be returned. All standard user statistics can be returned, as well as extra critical file resource held statistics. The length of each returned statistic is always a multiple of 4 bytes. This facilitates the use of <var>[[$StatLD]]</var> with the returned $list. | <td>A string of blank-delimited words indicating the statistics to be returned. All standard user statistics can be returned, as well as extra critical file resource held statistics. The length of each returned statistic is always a multiple of 4 bytes. This facilitates the use of <var>[[$StatLD]]</var> with the returned $list. | ||
<p> | <p> | ||
For more information on available statistics, see | For more information on available statistics, see [[Critical File Resource statistics displayed in SirMon]].</p> </td></tr> | ||
<tr><th>file_num</th> | <tr><th>file_num</th> | ||
| Line 38: | Line 38: | ||
===Return codes=== | ===Return codes=== | ||
<p class="code"> | <p class="code"> -3 - CCATEMP is full | ||
-5 - Required parameter not specified | |||
-6 - Invalid $list identifier | |||
-12 - Invalid name in stat_list | |||
-13 - STAT not linked in | |||
-16 - Invalid file number | |||
</p> | </p> | ||
| Line 72: | Line 71: | ||
END | END | ||
</p> | </p> | ||
==Products authorizing {{PAGENAMEE}}== | |||
<ul class="smallAndTightList"> | |||
<li>[[SirMon|SirMon]]</li> | |||
</ul> | |||
<p> | |||
</p> | |||
[[Category:$Functions|$CfStatL]] | [[Category:$Functions|$CfStatL]] | ||
Latest revision as of 14:02, 8 November 2018
List of statistics for users holding critical file resources
Note: Many $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $CfStatL function.
This function allows retrieval of statistics for all users holding critical file resources in a given file into a $list.
Syntax
%result = $CfStatL(list_identifier, stat_list, file_num)
Syntax terms
| %result | Either a positive number which is the number of milliseconds since the Online was brought up, or a negative error code. | ||||||
|---|---|---|---|---|---|---|---|
| list_identifier | The indentifier of the $list that is 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:
| ||||||
| stat_list | A string of blank-delimited words indicating the statistics to be returned. All standard user statistics can be returned, as well as extra critical file resource held statistics. The length of each returned statistic is always a multiple of 4 bytes. This facilitates the use of $StatLD with the returned $list.
For more information on available statistics, see Critical File Resource statistics displayed in SirMon. | ||||||
| file_num | The file number of the file in which the returned list of users hold critical file resources. Unlike selection criterion for $UsStatL, users not holding critical file resources in the indicated file are not placed on the output $list. This could prevent them from being placed on the difference $list by a $StatLD call if rates or differences are calculated. |
Return codes
-3 - CCATEMP is full -5 - Required parameter not specified -6 - Invalid $list identifier -12 - Invalid name in stat_list -13 - STAT not linked in -16 - Invalid file number
Example
The following program displays users and resources for users holding critical file resources in file number 13.
B %DATA IS STRING LEN 255 %LIST = $ListNew %DATA = $CfStatL(%LIST, 'HDDIRCT HDINDEX HDEXIST HDRECNQ', 13) IF %DATA < 0 THEN PRINT '$CFSTATL ERROR... RC = ' WITH %DATA STOP END IF FOR %I FROM 1 TO $ListCnt(%LIST) %DATA = $ListInf(%LIST, %I) PRINT 'USERID = ' WITH $SUBSTR(%DATA, 1, 10) PRINT 'USERNUM = ' WITH - $UNBIN( $SUBSTR(%DATA, 11, 2) ) PRINT 'HDDIRCT = ' WITH $SUBSTR(%DATA, 13, 4) PRINT 'HDINDEX = ' WITH $SUBSTR(%DATA, 17, 4) PRINT 'HDEXIST = ' WITH $SUBSTR(%DATA, 21, 4) PRINT 'HDRECNQ = ' WITH $SUBSTR(%DATA, 25, 4) PRINT END FOR END
Products authorizing $CfStatL