ViewPoint Manual

Customizing ViewPoint
ViewPoint Manual—426801-001
6-32
Status-Server Command Codes
Status-Server Command Codes
This section gives a general description of the command that corresponds to each
command code. The structures of the command and response messages are shown in a
figure in the subsection “Message Structures for Status Commands and Responses.”
Z-GET-VERSION-CODE
This command retrieves the version of the message interface that the server
implements. The server returns the software release version of the GDDL file it is
using (for instance, “C20” for the C20 release) in Z-VERSION-CODE of ZVPT-
IPC-HDR.
Z-SCAN-ITEM-CODE
This command provides a display-type field; its value can be blank or nonblank. If
it is blank, the response should be information about the first status item
implemented by the server. If the value is not blank, the server should search all
status items it implements for a matching display type. If a match is found, the
server should return information about that status item in the response. If no match
is found, the server should return the error code ZERR-STAT-NO-SUCH-TYPE.
When the response contains status-item information, it should also contain an index
into the list of status items that the server implements. If the first status item is
returned, this index value should be 1.
Z-NEXT-ITEM-CODE
This command provides the index of a previously scanned status item. The server
should increment this index and return the status item to which the new index value
corresponds. If the new index value exceeds the number of status items
Figure 6-9. Status-Server Command Codes and Error Codes
* REQUEST-CODE VALUES
CONSTANT Z-GET-VERSION-CODE VALUE IS 1.
CONSTANT Z-SCAN-ITEM-CODE VALUE IS 2.
CONSTANT Z-NEXT-ITEM-CODE VALUE IS 3.
CONSTANT Z-CHECK-ITEM-CODE VALUE IS 4.
CONSTANT Z-SAMPLE-ITEM-CODE VALUE IS 5.
CONSTANT Z-SAMPLE-LIST-CODE VALUE IS 6.
* ERROR-CODE VALUES
CONSTANT Z-ALL-OK-CODE VALUE IS 0.
CONSTANT ZERR-STAT-COLLECT-REQUEST VALUE IS 0206.
CONSTANT ZERR-STAT-NO-SUCH-TYPE VALUE IS 0207.
CONSTANT ZERR-STAT-NO-SUCH-OBJECT VALUE IS 0208.
CONSTANT ZERR-STAT-END-OF-TYPES VALUE IS 0209.
CONSTANT ZERR-STAT-CNFG-INCOMPATIBLE VALUE IS 0210.
CONSTANT ZERR-STAT-OBJECT-UNAVAILABLE VALUE IS 0211.