Writes bytes to a file.
Syntax:
call "CBL_WRITE_FILE" using file-handle
file-offset
byte-count
flags
buffer
Parameters:
|
Using call prototype (see
Key)
|
Picture
|
file-handle
|
cblt-bytestream-handle
|
pic x(4) comp-5.
|
file-offset
|
cblt-x8-compx
|
pic x(8) comp-x.
|
byte-count
|
cblt-x4-compx
|
pic x(4) comp-x.
|
flags
|
cblt-x1-compx
|
pic x comp-x.
|
buffer
|
pic x(n).
|
pic x(n).
|
On Entry:
-
file-handle
- The file handle returned when the file was opened.
-
file-offset
- The offset in the file at which to write. This field is limited to a maximum value of x"00FFFFFFFF" unless bit 4 of the access-mode
flag is set when the file is opened using CBL_OPEN_FILE or CBL_CREATE_FILE.
-
byte-count
- The number of bytes to write.
Putting a value of zero in this field causes the file to be truncated or extended to the size specified in the file-offset
field.
-
flags
- This parameter can take the following value:
- 0: standard write
-
buffer
- The buffer from which the bytes are written. It is your responsibility to ensure that the buffer is large enough to hold the
number of bytes to be written.
Comments:
The success of the call can be checked by examining RETURN-CODE.