Every reply from the CLIENT process includes the LightWave reply header followed by user data if the request was successful or error information if an error occurred. The reply header has the following format:
The rp-code field will contain one of the following values:
These values should be interpreted as follows:
- If RP-CODE contains LW-RP-SUCCESS, the request was successful and user data follows the LightWave header.
- If RP-CODE contains LW-RP-INFO, the request was successful but string field or array truncation occurred while the response was being processed. In this case the contents of the INFO-CODE and INFO-DETAIL fields will describe the condition that occurred.
- If RP-CODE contains LW-RP-ERROR then an error occurred while processing the request.
Handling Field and Array Truncation Warnings
When RP-CODE contains LW-RP-INFO, the iNFO-CODE field will contain one of the following values:
If INFO-CODE contains LW-INFO-TRUNCATED then a string value in the service response message was too long to copy to the associated string field in the reply IPM. In this case the iNFO-DETAIL field contains the IPM offset of the string field that caused the warning.
If INFO-CODE contains LW-INFO-OVERFLOW, then an array in the response message contained more elements than were defined in the associated array in the reply IPM. In this case the iNFO-DETAIL field contains the IPM offset of the array that caused the warning.
Although it is possible for multiple string or array truncations to occur in a single response, CLIENT only reports the first occurrence of the truncation.
When RP-CODE contains LW-RP-ERROR, the reply IPM is formatted as a LIGHTWAVE-ERROR-RP structure which contains detailed information about the error.
The ERROR-SOURCE field contains one of the error source values and identifies the subsystem that reported the error.
If ERROR-SOURCE contains LW-ERROR-SRC-LIGHTWAVE then ERROR-CODE will contain one of the following LIGHTWAVE-ERROR-ENUM values:
The ERROR-SUBCODE and ERROR-MESSAGE fields may contain additional information.
If ERROR-SOURCE contains any other error source value, the remaining error fields provide the error codes and message reported by that subsystem.
The error source value LW-ERROR-SRC-SSL may refer to an error encountered on an SSL or TLS connection.
The error source value LW-ERROR-INVALID-TYPE is not used in will not be returned. The value has been left in the definition in order avoid affecting existing applications that may reference it.