OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-7
GPI_INITIALIZE_
GPI_INITIALIZE_
This procedure sets up an environment that allows other GPI procedures to operate
correctly. You should call this procedure before calling any other GPI procedure in your
client application program.
status returned value
INT:value
indicates the outcome of the call. A value of OM-RC-SUCCESS indicates a
successful call. For additional values of status, see Appendix B, Return Codes
.
swap-volume input
STRING .EXT:ref:8
specifies a disk volume to be used as the swap volume for the GPI extended data
segment used by your application. The length of swap-volume is 8 octets. The
first octet must be a dollar sign ($), and the value must include trailing spaces if the
number of characters is less than 8 octets. For example, the value $USER should
contain three trailing spaces.
If you omit this parameter, the swap volume for the GPI extended data segment is
the same as the swap volume used for the data stack of your program.
max-table-entries input
INT(32):value
specifies the maximum number of entries that the GPI is to use for each of its object
trees. An object tree is the internal form of an X.400 message maintained by the
GPI.
The minimum value allowed is ZGPI-MIN-OT-TBL-ENTRIES (50). The maximum
value allowed is ZGPI-MAX-OT-TBL-ENTRIES (1,048,576). The default value of
ZGPI-DEFAULT-OT-TBL-ENTRIES (10,000) is used, if you omit this parameter.
max-table-data input
INT(32):value
specifies the maximum length (in octets) that the GPI is to use for string data space
in memory in each of its object trees. If you omit this parameter, the default value of
ZGPI-DEFAULT-OT-DATA-LEN (2,097,152) is used. The minimum value allowed
is ZGPI-MIN-OT-DATA-LEN (2,048). The maximum value allowed is ZGPI-
MAX-OT-DATA-LEN (10,485,760). The value must be greater than or equal to the
value you specify for the max-string-length parameter.
status := GPI_INITIALIZE_ ( [ swap-volume ] ! I
, [ max-table-entries ] ! I
, [ max-table-data ] ! I
, [ max-string-length ] ) ; ! I