SPI Common Extensions Manual

Extended SPI Concepts
SPI Common Extensions Manual—427508-001
2-9
Summary-State Selector Modifier
To assign a SUB modifier value to the token ZCOM-TKN-SUB:
INT sub^val;
sub^val := ZCOM^VAL^SUB^ONLY;
status := SSPUTTKN(message^buffer,ZCOM^TKN^SUB,sub^val);
Summary-State Selector Modifier
The token ZCOM-TKN-SEL-SUMSTATE, called the select summary-state modifier, lets
you apply a command to objects selectively, based on their summary state. You can
assign any valid summary-state value (ZCOM-VAL-SUMSTATE-state) to restrict
application of the command to objects reporting that summary state.
ZCOM-TKN-SEL-SUMSTATE is implemented as an integer pair. The second integer
contains the summary-state value (see Table 2-2 on page 2-10). The first integer
contains a Boolean value with the meaning:
When used in combination, the SUB modifier is evaluated first, and the SUMSTATE
modifier is applied to those objects that satisfy the SUB criteria.
Command-Timeout Modifier
The value assigned to ZCOM-TKN-CMD-TIMEOUT specifies the maximum number of
microseconds that an SCP process waits for a subsystem to return a response. If the
time limit is exceeded, the SCP process cancels the command.
Command-Power Modifier
The command-power modifier, ZCOM-TKN-CMD-POWER, specifies how forcefully a
command is applied to an object relative to the object’s condition. This modifier can be
included in a DELETE, STOP, or SUSPEND command to indicate how abruptly the
command should be completed.
For valid values and their meanings, see ZCOM-TKN-CMD-POWER on page 4-3.
* ZCOM-VAL-SUB-NONE A,B,C
* ZCOM-VAL-SUB-ALL A,B,C,…,X,Y,Z
*ZCOM-OBJ-PUD,E,F,G,H
ZSPI-VAL-FALSE Do not apply the command to objects in the specified state.
ZSPI-VAL-TRUE Apply the command only to objects in the specified state.
Objects Named in
STOP Command SUB Modifier Value Objects Stopped