OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Return Codes
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B-63
Information Buffer
Z-STRUCT-TYPE
The first 32 bits of the information buffer always contains this structure type.
If the actual buffer length returned from the GPI is greater than zero, the information
buffer contains error information. The five structure types for which information is
returned are described in the following DDL definitions and field descriptions. For
attributes in error and dangling objects, a figure also shows the data structure of the
information buffer.
ZGPI-ST-ERROR-ATTR (Value 10)
This structure returns the content of an attribute descriptor that has caused an error.
Z-OBJ-ID
is the object identifier of the object associated with the error. The value
OM-ELEMENTS-UNSPECIFIED indicates that the object identifier is unknown.
Z-OBJ-CLASS
is the class of the object, if known; otherwise, the value is
ZGPI-CLASS-UNSPECIFIED.
Z-OBJ-TYPE
is the attribute type of the object, if known and if the object is a subobject;
otherwise, the value is OM-T-UNSPECIFIED.
CONSTANT ZGPI-ST-NULL TYPE BINARY 32 VALUE 0.
CONSTANT ZGPI-ST-ERROR-ATTR TYPE BINARY 32 VALUE 10.
CONSTANT ZGPI-ST-DANGLING-OBJ TYPE BINARY 32 VALUE 20.
CONSTANT ZGPI-ST-INFO-3 TYPE BINARY 32 VALUE 30.
CONSTANT ZGPI-ST-INFO-4 TYPE BINARY 32 VALUE 40.
CONSTANT ZGPI-ST-INFO-5 TYPE BINARY 32 VALUE 50.
DEFINITION ZGPI-INFO-1.
02 Z-STRUCT-TYPE TYPE BINARY 32.
02 Z-DATA TYPE ZGPI-ERROR-ATTR-DATA.
END
DEFINITION ZGPI-ERROR-ATTR-DATA.
02 Z-OBJ-ID TYPE OM-OBJECT.
02 Z-OBJ-CLASS TYPE OM-CLASS.
02 Z-OBJ-TYPE TYPE OM-TYPE.
02 Z-ATTR-DSCR TYPE OM-DESCRIPTOR.
02 Z-ATTR-STRING-VALUE TYPE CHARACTER 16.
END