OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-22
GPI_OM_CREATE_
GPI_OM_CREATE_
This procedure creates a new object of a specified class. The GPI allocates the required
resources to represent the object and then, optionally, adds to the object those attributes
and their values that are defined by their class as having initial values.
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
.
class input
INT:value
is an integer that identifies the class of object to be created. For a description of the
object classes, see Section 3, Object Classes and Attribute Types
. For the DDL
definitions of object classes, see Appendix A, DDL Definitions.
Object classes of the EDI package and two object classes of the MH package
(MH-C-ALGORITHM and MH-C-ALGORITHM-AND-RESULT) are identified by
an ASN.1 object identifier rather than an integer. To create an object of these
classes, set the class parameter to ZGPI-CLASS-UNSPECIFIED and specify the
ASN.1 object identifier using the class-obj-id and class-obj-id-len
parameters.
initialize input
INT(32):value
specifies whether to initialize the new object as defined by its class.
The value can be:
object output
INT(32) .EXT:ref:1
is the object identifier of the newly created object. If the procedure is not successful,
this parameter is unchanged.
status := GPI_OM_CREATE_ ( class ! I
, initialize ! I
, object ! O
, [ root-object ] ! I
, [ session ] ) ; ! I
, [ class-obj-id ] ! I
, [ class-obj-id-len ] ) ; ! I
OM-TRUE specifies creating the object with initial values.
OM-FALSE specifies creating the object with the OM-T-CLASS attribute only.