6100 MPS-B Programming Manual

WRITING APPLICATIONS THAT USE 6100 MPS-B
Status Codes and Status Detail Codes
Status. This byte contains a code representing either
normal completion or an error condition. For
example, the number 0 indicates normal
completion; the number 140 indicates a modem
error.
Request ID. This word contains the same number as in the
corresponding request. Thus, you can tell which
request completed.
Text Out. This word will always be zero.
Text In. This word contains the length, in bytes, of the
Text in this response. The value should match or
be less than the value declared in the
corresponding request.
Text. This string contains additional data or, if the
Status field contains a number other than zero,
this string may contain a status detail code.
For example, in the response to a FETCH
CONFIGURATION request, this field contains the
current values of the line configuration
parameters. In the case of a modem error (Status
field = 140), this field contains a status detail
code further defining the problem that caused the
error.
If the response buffer exceeds the read count specified in the
WRITEREAD call, the buffer is truncated for delivery to the
application. The condition code is zero, but the value of the
Text In field exceeds the count read value returned by GUARDIAN.
An application can compare these values to find out whether input
has been lost. To avoid receiving truncated responses, use a
value of read count that equals or exceeds the value of Text In
(in the request) plus 8.
Status Codes and Status Detail Codes
The code returned in the response buffer Status field represents
summary information concerning the request. When a request is
completed as expected, the status code is zero. A status code
greater than zero indicates that something other than an expected
result occurred.
3-11