SNAX/HLS Application Programming Manual

HLS-CALL-USER Verb
Customization
7–8 104707 Tandem Computers Incorporated
RETURN-CODE
is a computational (that is, binary) field that indicates the success or failure of the
operation requested. The return condition of RC-OK indicates success. The
possible error responses are explained below. A full discussion of the error codes
is in Appendix A of the SNAX/HLS Diagnosis and Support Manual.
SYSTEM-ERROR-CODE
is a modifier to the return code. Its interpretation depends upon the return code,
as follows:
If the RETURN-CODE specifies RC-SYNTAX-ERROR, it identifies the field in
error, by counting each field following the REQUEST-FORMAT fields. For
example, a value of 1 indicates that the first field following the REQUEST-
FORMAT field is in error.
If the RETURN-CODE contains any value other than those listed above, this
field is undefined and should not be analyzed.
USER-ERROR-CODE
is an extension of the system-error-code. It is presently unused.
RETRY-ACTION-CODE
is a summary indicator that indicates whether an unsuccessful request should be
retried. The value returned here is installation-defined.
ARGUMENTS
are identical to those passed on the request unless modified by user-exit routines.
USER-DATA-LENGTH
specifies the number of bytes that are being returned. Unless the
SNAXHLS^USEREXIT^VERB^OUT routine modifies this value, SNAX/HLS
always returns a zero in this field, implying that there is no user-data text.
USER-DATA-S
contains text returned by the SNAXHLS^USEREXIT^VERB^OUT routine.