Open (Dataset function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
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"> | ||
Line 29: | Line 30: | ||
</td></tr></table> | </td></tr></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 40: | Line 41: | ||
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}} |
Revision as of 18:03, 20 May 2011
Open this dataset (Dataset class)
This function opens the dataset associated with a Dataset object.
Syntax
[%rc =] dataset:Open
Syntax terms
%returnCode | 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.