Write( ) method (FileOutputStream)

This method writes data from the indicated MEMPTR to the file output stream. It returns the total number of bytes written.

Return type: INT64

Access: PUBLIC

Applies to: Progress.IO.FileOutputStream class

Syntax

Write( INPUT source-data AS MEMPTR, INPUT offset AS INT64,
       INPUT length AS INT64 )

Write( INPUT source-data AS MEMPTR )

length

An INT64 value indicating how many bytes the method should read from the MEMPTR. If the length is greater than the number of bytes in the MEMPTR, only the available data is written to the stream, and the method returns that number of bytes.

offset

Indicates which byte of the source-data MEMPTR the method should start with when writing to the current file output stream. The AVM will raise an error if this value is less than 0 or greater than the size of the MEMPTR.

source-data

A MEMPTR variable containing the data the method will write to the output stream.

Notes

• If the MEMPTR's size is 0, the AVM will raise an error.
• If the size of a MEMPTR was allocated outside of the AVM, (in a Windows DLL or UNIX shared library, for example), you must use the SET-SIZE statement to initialize the MEMPTR before calling the Write( ) method.
• This class inherits two additional overloads of this method from File.IO.OutputStream:
  • Write( INPUT source-data AS CHARACTER )
  • Write( INPUT source-data AS LONGCHAR )
  These two overloads are NOT available in Version 11.6. The methods raise an error if called.