OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-47
GPI_OPEN_
session output
INT.EXT:ref:1
is a valid session identifier that the GPI generates if the call establishes a session
successfully. If the call does not succeed, this parameter is unchanged. Use the
session identifier when calling the object management and message transfer
procedures that require a session parameter.
environment output
INT(32) .EXT:ref:1
is the object identifier of an object that represents the local environment. If the call
does not succeed, this parameter is unchanged. You cannot modify any of the
attributes of the environment object or gain access to the object after the session
ends.
An object of the environment class consists of an ADMD name, a country name,
and an optional PRMD identifier. For a complete definition of the environment
class, see MH-C-ENVIRONMENT
on page 3-19.
MHS-mgr-name input
STRING .EXT:ref:*
specifies the fully qualified name of the OSI/MHS manager process that controls the
MTA (OSI/MHS subsystem) with which the client application is to communicate.
The manager process you specify must be the one that is used to configure the
GATEWAY object specified by gateway-name. The form of the name is:
[system.]$process-name
For example, a typical MHS manager process name is \SYS1.$ZMHS.
MHS-mgr-name-length input
INT:value
specifies the length (in octets) of the MHS-mgr-name string. The maximum length
is 256.
gateway-password input
STRING .EXT:ref:*
specifies the gateway password as configured by DSM. The GPI service does not
transfer objects between the client and the X.400 MTA unless the gateway password
is provided to validate the authenticity of the client.
The maximum length of the gateway password is 62 IA5-string characters. You
must specify this parameter if the length of the gateway password is greater than 0.