BlockSize (Dataset property): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (→Syntax terms) |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Dataset:BlockSize subtitle}} | |||
This | This property is only settable while the object is in the <var>Closed</var> state. | ||
An attempt to set it while the dataset is not closed results in request | An attempt to set it while the dataset is not closed results in request | ||
cancellation. | cancellation. | ||
== | ==Syntax== | ||
{{Template:Dataset:BlockSize syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%currentNumber</th> | ||
<td>A variable to receive the blocksize of the dataset | <td>A numeric variable to receive the blocksize of the <var class="term">dataset</var> object. | ||
</td></tr> | </td></tr> | ||
<tr><th> | <tr><th>dataset</th> | ||
<td>A reference to an instance of a <var>Dataset</var> object. | <td>A reference to an instance of a <var>Dataset</var> object. | ||
<tr><th>newNumber</th> | |||
</td></tr></table> | <td>A numeric variable to be used to set the <var class="term">dataset</var> object's blocksize. | ||
==Usage | </td></tr></table> | ||
==Usage notes== | |||
<ul> | <ul> | ||
<li><var>Blocksize</var> can be set to any value from 1 to 32767. | <li><var>Blocksize</var> can be set to any value from 1 to 32767. | ||
| Line 28: | Line 26: | ||
file attributes, whether or not the <var>Blocksize</var> property had been set. | file attributes, whether or not the <var>Blocksize</var> property had been set. | ||
</ul> | </ul> | ||
==See also== | |||
{{Template:Dataset:BlockSize footer}} | |||
Latest revision as of 22:31, 20 May 2011
The block size of this dataset (Dataset class)
This property is only settable while the object is in the Closed state.
An attempt to set it while the dataset is not closed results in request
cancellation.
Syntax
%currentNumber = dataset:BlockSize dataset:BlockSize = newNumber
Syntax terms
| %currentNumber | A numeric variable to receive the blocksize of the dataset object. |
|---|---|
| dataset | A reference to an instance of a Dataset object. |
| newNumber | A numeric variable to be used to set the dataset object's blocksize. |
Usage notes
- Blocksize can be set to any value from 1 to 32767.
- If Blocksize is never set for a dataset before it is opened, the open process will attempt to determine an appropriate blocksize for the dataset.
- For input datasets, the blocksize will usually be set from the input file attributes, whether or not the Blocksize property had been set.