SPI Programming Manual (G06.24+, H06.03+, J06.03+)

The SPI Procedures
SPI Programming Manual—427506-006
3-25
Considerations
dest-buffer input, output
INT .EXT:ref:*
is the SPI buffer to which the specified token or tokens are to be copied.
dest-index input
INT:value
if greater than zero, identifies the first occurrence of
token-id to be replaced in
the destination buffer. A value of 1 specifies that replacement should start with the
first occurrence of the token code, a value of 2 specifies the second occurrence,
and so on. If the specified occurrences are not found in the destination buffer, the
tokens being copied are added to the end of the buffer.
if zero or not supplied, SSMOVE or SSMOVETKN adds the tokens from the source
buffer to the end of the destination buffer.
count input, output
INT .EXT:ref:1
is used as an input and output count parameter:
•
On the call, it specifies the maximum number of tokens to copy, unless
token-id is a list token; in the latter case, it gives the maximum number of
lists to move. If not supplied,
count defaults to 1.
•
On return, it specifies the actual number of token values or lists copied.
ssid input
INT .EXT:ref:6
is a subsystem ID, as described in Section 4, ZSPI Data Definitions
, that qualifies
the token ID. If not supplied or equal to zero (6*[0]),
ssid defaults to the
subsystem ID of the current list, or if the current-token pointer is not in a list, then
to the subsystem ID specified in the SPI message header (ZSPI-TKN-SSID). The
version field of
ssid is not used in searching the source buffer.
Considerations
•
Any odd-length buffer fields are padded at the end so that the next token added by
SSMOVE or SSMOVETKN always starts on a word (even) boundary. The same
circumstances also apply to SSPUT or SSPUTTKN operations.
•
Tokens copied by SSMOVE or SSMOVETKN are not deleted or removed from the
source buffer.
•
For checkpointing purposes, note that calls to SSMOVE and SSMOVETKN can
modify the SPI message header of the source buffer. Positioning information in the
header changes frequently, and future versions of SPI might introduce other kinds