Open (Dataset function): Difference between revisions
Jump to navigation
Jump to search
m (Created page with "==Open (Dataset function)== This function opens the dataset associated with a <var>Dataset</var> object. ==Open syntax== <p class="pre"> [%returnCode =] %dataset:open </p> ===Syn...") |
m (→Syntax terms) |
||
| (9 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Dataset:Open subtitle}} | |||
This function opens the dataset associated with a <var>Dataset</var> object. | This function opens the dataset associated with a <var>Dataset</var> object. | ||
== | ==Syntax== | ||
{{Template:Dataset:Open syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%rc</th> | ||
<td>A variable to receive the return code from the <var> | <td>A variable to receive the return code from the <var>Open</var> method, indicating whether or not the open succeeded. | ||
whether or not the open succeeded. | |||
Possible return codes are: | Possible return codes are: | ||
< | <table class="noVar"> | ||
< | <tr><th>0</th> | ||
< | <td>Open is successful.</td></tr> | ||
< | |||
< | <tr><th>1 | ||
<td>Generic failure. | |||
One likely cause of this is that another user has the dataset open, currently. | One likely cause of this is that another user has the dataset open, currently. | ||
< | |||
< | <tr><th>3</th> | ||
< | <td>Stream or dataset not defined, or access not allowed.</td></tr> | ||
< | |||
< | <tr><th>14</th> | ||
< | <td>Insufficient virtual storage for buffers or control blocks.</td></tr> | ||
</ | <tr><th>15</th> | ||
</td></tr> | <td>Parallel stream has incompatible parallel members.</td></tr> | ||
<tr><th> | </table></td></tr> | ||
<td>A variable containing a reference to a <var>Dataset</var> object for which the | |||
underlying dataset is to be opened. | <tr><th>dataset</th> | ||
<td>A variable containing a reference to a <var>Dataset</var> object for which the underlying dataset is to be opened.</td></tr> | |||
</td></tr></table> | </table> | ||
==Usage | |||
==Usage notes== | |||
<ul> | <ul> | ||
<li>An <var>Open</var> can modify the <var>BlockSize</var>, <var>RecordLength</var>, <var>RecordFormat</var>, or | <li>An <var>Open</var> can modify the <var>BlockSize</var>, <var>RecordLength</var>, <var>RecordFormat</var>, or | ||
| Line 37: | Line 38: | ||
from the DSCB (or CMS or VSE equivalents) will tend to override attributes | from the DSCB (or CMS or VSE equivalents) will tend to override attributes | ||
set explicitly before the open. | set explicitly before the open. | ||
<li>An | <li>An <var>Open</var> of a dataset or stream usually places an exclusive lock on the | ||
dataset or stream until it is closed. | dataset or stream until it is closed. | ||
This means no other thread can access the dataset while it is opened. | This means no other thread can access the dataset while it is opened. | ||
</ul> | </ul> | ||
==See also== | |||
{{Template:Dataset:Open footer}} | |||
Latest revision as of 22:37, 14 November 2012
Open this dataset (Dataset class)
This function opens the dataset associated with a Dataset object.
Syntax
[%rc =] dataset:Open
Syntax terms
| %rc | A variable to receive the return code from the Open method, indicating whether or not the open succeeded.
Possible return codes are:
| ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| dataset | A variable containing a reference to a Dataset object for which the underlying dataset is to be opened. |
Usage notes
- An Open can modify the BlockSize, RecordLength, RecordFormat, or NumberOfBuffers properties. This is especially likely for input datasets where the dataset attributes from the DSCB (or CMS or VSE equivalents) will tend to override attributes set explicitly before the open.
- An Open of a dataset or stream usually places an exclusive lock on the dataset or stream until it is closed. This means no other thread can access the dataset while it is opened.