Output (Dataset property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:Dataset:Output subtitle}}
This <var>[[Enumerations#Using Boolean enumerations|Boolean]]</var> property indicates
This <var>[[Enumerations#Using Boolean enumerations|Boolean]]</var> property indicates
whether or not the dataset is an output dataset,
whether or not the dataset is an output dataset,
Line 5: Line 7:
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.
==Output syntax==
 
<p class="pre"> %boolean = %dataset:output
==Syntax==
{{Template:Dataset:Output syntax}}
%dataset:output = %boolean
 
</p>
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%boolean</th>
<tr><th>%currentBoolean</th>
<td>A variable to receive the <var>Boolean</var> value that indicates whether or not
<td>A variable to receive the <var>Boolean</var> value that indicates whether or not the <var class="term">dataset</var> object is an output dataset.</td></tr>
the dataset is an output dataset, or a variable to be used to set
 
the dataset's output attribute.
<tr><th>dataset</th>
</td></tr>
<td>A reference to an instance of a <var>Dataset</var> object.</td></tr>
<tr><th>%dataset</th>
 
<td>A reference to an instance of a <var>Dataset</var> object.
<tr><th>newBoolean</th>
<td>A <var>Boolean</var> enumeration value (<var>True</var> or <var>False</var>) to be used to set the <var class="term">dataset</var> object's output attribute.</td></tr>
</td></tr></table>
</table>
==Usage Notes==
 
==Usage notes==
<ul>
<ul>
<li>Output is a boolean value, that is, it must be <var>True</var>
<li>The initial value for <var>Output</var> is <var>False</var>. That is, by default, datasets are input datasets.
or <var>False</var>.
<li>The initial value for <var>Output</var> is <var>False</var>.
That is, by default, datasets are input datasets.
</ul>
</ul>
==See also==
{{Template:Dataset:Output footer}}

Latest revision as of 23:12, 14 November 2012

Indicates whether this dataset is writeable (Dataset class)


This Boolean property indicates whether or not the dataset is an output dataset, that is, whether it is to be written to or not. It 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

%currentBoolean = dataset:Output dataset:Output = newBoolean

Syntax terms

%currentBoolean A variable to receive the Boolean value that indicates whether or not the dataset object is an output dataset.
dataset A reference to an instance of a Dataset object.
newBoolean A Boolean enumeration value (True or False) to be used to set the dataset object's output attribute.

Usage notes

  • The initial value for Output is False. That is, by default, datasets are input datasets.

See also