WriteRecord (Dataset subroutine) - Revision history

JAL at 00:41, 15 November 2012

2012-11-15T00:41:25Z

← Older revision		Revision as of 00:41, 15 November 2012
Line 3:		Line 3:
	==Syntax==		==Syntax==
	{{Template:Dataset:WriteRecord syntax}}		{{Template:Dataset:WriteRecord syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>dataset</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.</td></tr>
	</td></tr>
	<tr><th>string</th>		<tr><th>string</th>
	<td>A string or [[Longstrings\|longstring]] variable that contains the records to be written.		<td>A string or [[Longstrings\|longstring]] variable that contains the records to be written.</td></tr>
	</td></tr>
	</table>		</table>

Line 16:		Line 16:
	<ul>		<ul>
	<li>To use the <var>WriteRecord</var> method, the <var>Dataset</var> object must be an output object,		<li>To use the <var>WriteRecord</var> method, the <var>Dataset</var> object must be an output object,
	that is, its [[Output (Dataset property)\|Output]]) value must be <var>True</var>. .		that is, its <var>[[Output (Dataset property)\|Output]]</var> value must be <var>True</var>.
	Using <var>WriteRecord</var> against an input dataset results in request cancellation.		Using <var>WriteRecord</var> against an input dataset results in request cancellation.
	<li>The <var>Dataset</var> object must be in the <var>Open</var> state to use the <var>WriteRecord</var> method.
			<li>The <var>Dataset</var> object must be in the <var>Open</var> [[Dataset class#The DatasetState enumeration\|state]] to use the <var>WriteRecord</var> method.
	Using <var>WriteRecord</var> against a dataset in the <var>Closed</var> or <var>Full</var> state		Using <var>WriteRecord</var> against a dataset in the <var>Closed</var> or <var>Full</var> state
	results in request cancellation.		results in request cancellation.

	<li>If a <var>WriteRecord</var> method is used after a <var>WriteRecord</var> method, the block		<li>If a <var>WriteRecord</var> method is used after a <var>WriteRecord</var> method, the block
	containing the record written by the preceding <var>WriteRecord</var> is written,		containing the record written by the preceding <var>WriteRecord</var> is written, if it has not already been written.
	if it has not already been written.
	<li>For F and FB format files, the output string written by <var>WriteRecord</var>		<li>For F and FB format files, the output string written by <var>WriteRecord</var>
	must be shorter than or equal in length to the value of <var>[[RecordLength (Dataset property)\|RecordLength]]</var>).		must be shorter than or equal in length to the value of <var>[[RecordLength (Dataset property)\|RecordLength]]</var>.
	Records shorter than the <var>RecordLength</var> value are padded with blanks so their		Records shorter than the <var>RecordLength</var> value are padded with blanks so their
	length exactly equals the <var>RecordLength</var>.		length exactly equals the <var>RecordLength</var>. Output strings that are too long result in request cancellation.
	Output strings that are too long result in request cancellation.
	<li>For V and VB format files, the output string written by <var>WriteRecord</var>		<li>For V and VB format files, the output string written by <var>WriteRecord</var>
	must be shorter than or equal in length to the <var>RecordLength</var> value minus four.		must be shorter than or equal in length to the <var>RecordLength</var> value minus four.
	Four is subtracted because the <var>WriteRecord</var> method adds the required RDW before		Four is subtracted because the <var>WriteRecord</var> method adds the required RDW before the record.
	the record.
	This is true even under CMS, where records are not really stored on disks		This is true even under CMS, where records are not really stored on disks
	with BDWs and RDWs &~~amp;~~mdash; they are mapped from the MVS format to the		with BDWs and RDWs — they are mapped from the MVS format to the CMS format by BSAM simulation.
	CMS format by BSAM simulation.
	Output strings that are too long result in request cancellation.		Output strings that are too long result in request cancellation.

	<li>If there is no more room for a <var>WriteRecord</var> in a file, the dataset switches		<li>If there is no more room for a <var>WriteRecord</var> in a file, the dataset switches
	from the <var>Open</var> to the <var>Full</var> state.		from the <var>Open</var> to the <var>Full</var> state.
	After this, a <var>WriteRecord</var> or <var>WriteBlock</var> results in request cancellation.		After this, a <var>WriteRecord</var> or <var>[[WriteBlock (Dataset subroutine)\|WriteBlock]]</var> results in request cancellation.

	<li>Since <var>WriteRecord</var> blocks the data before writing it, <var>WriteRecord</var> usually		<li>Since <var>WriteRecord</var> blocks the data before writing it, <var>WriteRecord</var> usually
	returns before the data has actually been written to disk.		returns before the data has actually been written to disk.
Line 45:		Line 47:
	not have actually been written to disk, either because of an I/O error or,		not have actually been written to disk, either because of an I/O error or,
	more likely, because the file filled.		more likely, because the file filled.

	==See also==		==See also==
	{{Template:Dataset:WriteRecord footer}}		{{Template:Dataset:WriteRecord footer}}

JAL2 at 22:40, 20 May 2011

2011-05-20T22:40:00Z

← Older revision		Revision as of 22:40, 20 May 2011
Line 1:		Line 1:
	{{Template:Dataset:WriteRecord subtitle}}		{{Template:Dataset:WriteRecord subtitle}}

	~~This subroutine writes a block of data to an output dataset.~~
	==Syntax==		==Syntax==
	{{Template:Dataset:WriteRecord syntax}}		{{Template:Dataset:WriteRecord syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>~~%string~~</th>		<tr><th>dataset</th>
	<td>A ~~string or longstring variable that contains the records~~ to ~~be written~~.		<td>A reference to an instance of a <var>Dataset</var> object.
	</td></tr>		</td></tr>
	<tr><th>~~%dataset~~</th>		<tr><th>string</th>
	<td>A ~~reference~~ to ~~an instance of a <var>Dataset</var> object~~.		<td>A string or [[Longstrings\|longstring]] variable that contains the records to be written.
			</td></tr>
	</td></tr></table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>

DmeWiccan: 1 revision

2011-05-20T18:03:36Z

1 revision

← Older revision	Revision as of 18:03, 20 May 2011
(No difference)

JAL2: Created page with "This subroutine writes a block of data to an output dataset. ==WriteRecord syntax==
%dataset:writeRecord(%string)
===Syntax terms===
2011-05-20T18:03:34Z
Created page with "This subroutine writes a block of data to an output dataset. ==WriteRecord syntax== <p class="pre"> %dataset:writeRecord(%string) </p> ===Syntax terms=== <table class="syntaxTabl..."

← Older revision Revision as of 18:03, 20 May 2011
Line 1: Line 1:

{{Template:Dataset:WriteRecord subtitle}}

This subroutine writes a block of data to an output dataset.
This subroutine writes a block of data to an output dataset.

==WriteRecord syntax==
==Syntax==

<p class="pre"> %dataset:writeRecord(%string)
{{Template:Dataset:WriteRecord syntax}}

</p>

===Syntax terms===
===Syntax terms===

<table class="syntaxTable">
<table class="syntaxTable">

Line 12: Line 13:

</td></tr></table>
</td></tr></table>

==Usage Notes==
==Usage notes==

<ul>
<ul>

<li>To use the <var>WriteRecord</var> method, the <var>Dataset</var> object must be an output object,
<li>To use the <var>WriteRecord</var> method, the <var>Dataset</var> object must be an output object,

Line 33: Line 34:

the record.
the record.

This is true even under CMS, where records are not really stored on disks
This is true even under CMS, where records are not really stored on disks

with BDWs and RDWs — they are mapped from the MVS format to the
with BDWs and RDWs &mdash; they are mapped from the MVS format to the

CMS format by BSAM simulation.
CMS format by BSAM simulation.

Output strings that are too long result in request cancellation.
Output strings that are too long result in request cancellation.

Line 44: Line 45:

not have actually been written to disk, either because of an I/O error or,
not have actually been written to disk, either because of an I/O error or,

more likely, because the file filled.
more likely, because the file filled.

==See also==

{{Template:Dataset:WriteRecord footer}}

JAL2: Created page with "This subroutine writes a block of data to an output dataset. ==WriteRecord syntax==
%dataset:writeRecord(%string)
===Syntax terms===
2011-05-20T16:54:20Z
Created page with "This subroutine writes a block of data to an output dataset. ==WriteRecord syntax== <p class="pre"> %dataset:writeRecord(%string) </p> ===Syntax terms=== <table class="syntaxTabl..."
New page
This subroutine writes a block of data to an output dataset.
==WriteRecord syntax==
<p class="pre"> %dataset:writeRecord(%string)
</p>
===Syntax terms===
<table class="syntaxTable">
<tr><th>%string</th>
<td>A string or longstring variable that contains the records to be written.
</td></tr>
<tr><th>%dataset</th>
<td>A reference to an instance of a <var>Dataset</var> object.

</td></tr></table>
==Usage Notes==
<ul>
<li>To use the <var>WriteRecord</var> method, the <var>Dataset</var> object must be an output object,
that is, its [[Output (Dataset property)|Output]]) value must be <var>True</var>. .
Using <var>WriteRecord</var> against an input dataset results in request cancellation.
<li>The <var>Dataset</var> object must be in the <var>Open</var> state to use the <var>WriteRecord</var> method.
Using <var>WriteRecord</var> against a dataset in the <var>Closed</var> or <var>Full</var> state
results in request cancellation.
<li>If a <var>WriteRecord</var> method is used after a <var>WriteRecord</var> method, the block
containing the record written by the preceding <var>WriteRecord</var> is written,
if it has not already been written.
<li>For F and FB format files, the output string written by <var>WriteRecord</var>
must be shorter than or equal in length to the value of <var>[[RecordLength (Dataset property)|RecordLength]]</var>).
Records shorter than the <var>RecordLength</var> value are padded with blanks so their
length exactly equals the <var>RecordLength</var>.
Output strings that are too long result in request cancellation.
<li>For V and VB format files, the output string written by <var>WriteRecord</var>
must be shorter than or equal in length to the <var>RecordLength</var> value minus four.
Four is subtracted because the <var>WriteRecord</var> method adds the required RDW before
the record.
This is true even under CMS, where records are not really stored on disks
with BDWs and RDWs — they are mapped from the MVS format to the
CMS format by BSAM simulation.
Output strings that are too long result in request cancellation.
<li>If there is no more room for a <var>WriteRecord</var> in a file, the dataset switches
from the <var>Open</var> to the <var>Full</var> state.
After this, a <var>WriteRecord</var> or <var>WriteBlock</var> results in request cancellation.
<li>Since <var>WriteRecord</var> blocks the data before writing it, <var>WriteRecord</var> usually
returns before the data has actually been written to disk.
As such, it is possible that data written by a previous <var>WriteRecord</var> might
not have actually been written to disk, either because of an I/O error or,
more likely, because the file filled.