Write to Stream File (QHFWRTSF) API

The Write to Stream File (QHFWRTSF) API writes bytes to a stream file. The file must have been opened with an access mode of write only or read/write. If there is a deny write or deny read/write lock on a byte range being written to, the function fails.

The write operation starts at the current position of the file pointer, the location in the file where the next read or write operation occurs. When a file is opened with the Open Stream File (QHFOPNSF) API the file pointer is set to the first byte of the file. You can move the pointer explicitly with the QHFCHGFP API; see Change File Pointer (QHFCHGFP) API for details. After the write operation, the file pointer value is increased by the number of bytes written.

Authorities and Locks

None.

Required Parameter Group

Open file handle

INPUT; CHAR(16)

The file handle returned when the file is opened with the QHFOPNSF API.

Data buffer

INPUT; CHAR(*)

The buffer containing the data being written.

Bytes to write

INPUT; BINARY(4)

The number of bytes being written to the file, starting at the current file pointer position. The number must be less than or equal to the length of the data buffer.

The application can write beyond the end of the file. This increases the file's size.

Bytes actually written

OUTPUT; BINARY(4)

The number of bytes actually written to the file. If an error occurs during the write operation, the value of this parameter can be less than the value of the bytes-to-write input parameter.

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter.

Error Messages