ReadRecords (Dataset function): Difference between revisions
Jump to navigation
Jump to search
m (Automatically generated page update) |
|||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
This page is [[under construction]]. | This page is [[under construction]]. | ||
==Syntax== | ==Syntax== | ||
{{Template:Dataset:ReadRecords syntax}} | {{Template:Dataset:ReadRecords syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table | <table> | ||
<tr><th>%stringlist</th><td><var>Stringlist</var> object</td></tr> | <tr><th>%stringlist</th> | ||
<td>A <var>Stringlist</var> object variable to receive the blocks of data.</td></tr> | |||
<tr><th>dataset</th> | <tr><th>dataset</th> | ||
<td>Dataset object</td></tr> | <td>A reference to an instance of a <var>Dataset</var> object.</td></tr> | ||
<tr><th><var>Max</var></th> | <tr><th><var>Max</var></th> | ||
<td | <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 limit can be accommodated by the CCATEMP resources of the job, the <var>Count</var> method against the target <var>Stringlist</var> object after the <var>ReadRecords</var> invocation completes will return the same value as the <var>Max</var> setting. | ||
<p> | |||
The default limit is to read all the records from the input dataset. </p></td></tr> | |||
<tr><th><var>Min</var></th> | <tr><th><var>Min</var></th> | ||
<td>number< | <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">MSIR.0752: ... too few records available to meet requested minimum </p> | |||
<p> | |||
There is no default minimum value. </p></td></tr> | |||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
==Examples== | ==Examples== | ||
==See also== | ==See also== | ||
{{Template:Dataset:ReadRecords footer}} | {{Template:Dataset:ReadRecords footer}} | ||
Latest revision as of 12:21, 25 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 limit can be accommodated by the CCATEMP resources of the job, the Count method against the target Stringlist object after the ReadRecords invocation completes will return the same value as the Max setting.
The default limit is to read all the records from the input dataset. |
| 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:
MSIR.0752: ... too few records available to meet requested minimum There is no default minimum value. |