OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-52
GPI_STATUS_
buffer remains unchanged. For a complete description of the information buffer, see
Appendix B, Return Codes.
info-buffer-length input
INT:value
specifies the length (in octets) of the buffer specified by info-buffer. If you
specify 0, GPI_STATUS_ returns the total number of octets of error information in
the total-info-length parameter. You can use this technique to determine the
amount of information available without retrieving it. This parameter is required if
you specify info-buffer.
actual-info-length output
INT .EXT:ref:1
is the number of octets of information returned to info-buffer. If no
information is returned, the value is 0.
total-info-length output
INT .EXT:ref:1
is the total number of octets of information available. You can call the
GPI_STATUS_ procedure again to get the information in info-buffer. If the
buffer is not large enough to hold the information, it is truncated to fit. You cannot
call the procedure again to get the additional information. If you want all the
information, you must increase the length of the buffer by revising
info-buffer-length (and possibly declare a different area for info-
buffer).
Considerations
•
The recommended value for info-buffer-length is also the maximum value,
which is ZGPI-MAX-STATUS-BUF-LEN (512) octets. This length accommodates
the optimum amount of error information.
•
For detailed information about examining the information buffer and the other
values returned by the GPI_STATUS_ procedure, see Appendix B, Return Codes.