Safeguard Management Programming Manual (G06.29+, H06.08+, J06.03+)

SPI Programming Considerations
Safeguard Management Programming Manual—422086-028
5-2
Discontinuing a Command in Progress
•
ZSFG-MAP-REMOVE-OWNERS
•
ZSFG-MAP-OWNERLIST
•
ZSFG-TKN-AUDITFILENUMBER
•
ZSFG-TKN-MEMBERNAME
•
ZSFG-TKN-REMOVE-MEMBERNAME
If any of the other tokens in a command appear more than once, the Safeguard
subsystem returns the error ZCOM-ERR-TKN-DUP.
Discontinuing a Command in Progress
For a discussion of general programming considerations for discontinuing a command
in progress, see the SPI Common Extensions Manual.
The Safeguard subsystem supports the use of the token ZSPI-TKN-ALLOW-TYPE,
which allows an application to specify, in a command operating on multiple objects,
whether the Safeguard subsystem should continue immediately to the next object if it
failed on the previous one. If no value is specified for this token, the Safeguard
subsystem continues to the next object only if no errors or warnings occurred on the
previous one.
When the Safeguard subsystem discontinues execution of a command because of an
error or warning, it immediately sends a reply message to the application. The reply
message contains a context token. The application can then choose to resend the
command, causing the Safeguard subsystem to proceed to the next object, or to
abandon the command.
Receiving and Decoding the Response Buffer
These programming considerations apply when an application receives and decodes
the response buffer for a Safeguard response.
In responses to Safeguard commands that operate on objects, a response record
always contains response information for the operation of the command on a single
object.
The Safeguard subsystem supports multiple response records in a single reply
message. The maximum number of response records returned in one reply message is
controlled by the value of the header token ZSPI-TKN-MAXRESP in the command.
The Safeguard subsystem also supports the use of the token ZSPI-TKN-RESPONSE-
TYPE, which allows an application to specify, in a command that operates on multiple
objects, which kinds of response records should be returned. Response records can
be returned for every object or only for objects on which errors or warnings occurred. If