ReadRecords (Dataset function): Difference between revisions
Jump to navigation
Jump to search
(Better document use of MIN and MAX parameters) |
m (misc formatting) |
||
| Line 7: | Line 7: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table | <table> | ||
<tr><th>%stringlist</th> | <tr><th>%stringlist</th> | ||
<td>A <var>Stringlist</var> object variable to receive the blocks of data.</td></tr> | <td>A <var>Stringlist</var> object variable to receive the blocks of data.</td></tr> | ||
| Line 15: | Line 15: | ||
<tr><th><var>Max</var></th> | <tr><th><var>Max</var></th> | ||
<td>This is an optional, [[Notation conventions for methods#Named parameters|name required]], numeric argument that sets an upper limit for the number of records to be read in by the method. Assuming that this can be catered for by the CCATEMP resources of the job, the count method against the target | <td>This is an optional, [[Notation conventions for methods#Named parameters|name required]], numeric argument that sets an upper limit for the number of records to be read in by the method. Assuming that this can be catered for by the CCATEMP resources of the job, the count method against the target <var>Stringlist</var> object would return the same value as the <var>MAX</var> setting after the <var>ReadRecords</var> invocation completes. | ||
The default limit is [[??]].</td></tr> | The default limit is [[??]].</td></tr> | ||
<tr><th><var>Min</var></th> | <tr><th><var>Min</var></th> | ||
<td>This is an optional, name required, numeric argument that sets a minimum number of records to be read via the method. If this minimum number of record reads | <td>This is an optional, name required, numeric argument that sets a minimum number of records to be read via the method. If this minimum number of record reads is not achieved, the request is cancelled with: | ||
<p class="code">Cancelling request: MSIR.0752: ... too few records available to meet requested minimum </p> | |||
Cancelling request: MSIR.0752: | <p> | ||
The default minimum value is [[??]]. </p></td></tr> | |||
The default minimum value is [[??]].</td></tr> | |||
</table> | </table> | ||
Revision as of 16:51, 11 April 2017
Read multiple records from this dataset (Dataset class)
This page is under construction.
Syntax
%sl = dataset:ReadRecords[( [Max= number], [Min= number])]
Syntax terms
| %stringlist | A Stringlist object variable to receive the blocks of data. |
|---|---|
| dataset | A reference to an instance of a Dataset object. |
| Max | This is an optional, name required, numeric argument that sets an upper limit for the number of records to be read in by the method. Assuming that this can be catered for by the CCATEMP resources of the job, the count method against the target Stringlist object would return the same value as the MAX setting after the ReadRecords invocation completes. The default limit is ??. |
| Min | This is an optional, name required, numeric argument that sets a minimum number of records to be read via the method. If this minimum number of record reads is not achieved, the request is cancelled with:
Cancelling request: MSIR.0752: ... too few records available to meet requested minimum The default minimum value is ??. |