Write Method

Write data to virtual display.

Syntax

object.Write( Buffer [, Length] )

Remarks

The Write method writes the data in buffer to the virtual display at the current cursor location. If the data contains control characters or escape sequences, they will be processed according the Emulation property setting.

Buffer
A buffer variable that contains the data to be written to the display. If the variable is a string then the data will be written as a string of characters. This is the most appropriate data type to use for text data that consists of printable characters. If the data contains control characters, escape sequences or international characters, it is recommended that you use an array of bytes instead of a string.
Length
A numeric argument which specifies the number of bytes to write. Its maximum value is 231-1 = 2147483647. If a value is specified for this argument and it is greater than the actual size of the buffer, then the Length argument will be ignored and the entire contents of the buffer will be written. If the argument is omitted, then the maximum number of bytes to write is determined by the size of the buffer.

Return Value

This method returns the number of bytes actually written to the display, or -1 if an error was encountered.

See Also

Emulation Property, Text Property


Copyright © 2008 Catalyst Development Corporation. All rights reserved.