Note that the string can contain binary data, and if reading an ASCII string be sure to include the null termination byte. With binary data, the standard string manipulations may not work, and in fact can easily cause a program crash.
The first argument is an array of size 3 or larger. Upon return, retcode will contain the server return code, which is an integer 0-9, or possibly -1 on error. The value in retcode will be the size of the message returned, which will be 0 or larger. The value in retcode will be 0 on success, 1 on error. If an error occurred, an error message is available from GetError.
The return code in retcode can have the following response types:
|1||in block, waiting for ``end''|
|-1||error reading data from server|
The return value is of string-type, and may be null or binary. With binary data, the standard string manipulations may not work, and in fact can easily cause a program crash. It is not likely that the return will have any use other than as an argument to ConvertReply.
This function will fail (halt the script) only if the retcode argument is bad.
Upon return, retcode will contain a ``data_ok'' flag, which will be nonzero if the message contained data and the data were read properly. The function will fail (by halting the script) if the retcode argument is bad, i.e., not an array of size 3 or larger, or the message argument is not string-type.
The response codes 0-2 contain no data and are status responses from the server. The data responses will set the type and data of the function return, if successful. The retcode value will be nonzero on success in these cases, and will always be false if ``longmode'' is not enabled.
Note that the type returned can be anything, and if assigned to a variable that already has a different type, an error will occur. The delete operator can be applied to the assigned-to variable to clear its state, before the function call.
The response type 9 is returned from the geom server function. This function will return a handle to a geometry stream, which can be passed to GsReadObject.
This function never fails (halts the script). The return value is the number of bytes written, or 0 on error. On error, a message is available from GetError.