| |
Write data to the server.
Syntax
object.Write( Buffer, [Length] )
Parameters
- Buffer
- A buffer variable that contains the data to be written to the
server. If the variable is a String type, then the data will
be written as a string of characters. This is the most appropriate
data type to use because the server expects text data that consists
of printable characters. If the string contains Unicode
characters, it will be automatically converted to use standard UTF-8
encoding prior to being sent. If you wish to send the data without
conversion, use a Byte array as the buffer instead
of a String variable.
- Length
- A numeric value 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
server, or -1 if an error was encountered.
Remarks
The Write method sends the data in buffer to the
server. If the connection is buffered, as is typically the case,
the data is copied to the send buffer and control immediately returns
to the program. If the control is blocking, the application will wait
until the data can be sent. If the control is non-blocking and the
write fails because it could not send all of the data to the server,
the OnWrite event will be fired when the server can accept
data again.
See Also
IsConnected Property,
IsWritable Property,
Timeout Property,
Read Method, OnWrite
Event
|
|