SPI Programming Manual (H06.24+, J06.13+)

SPI Programming Manual—427506-007
3-1
3 The SPI Procedures
This section describes these SPI procedures:
This section describes the procedures and their parameters in a general context. The
exact syntax of an SPI procedure call depends on the programming language you use.
For the syntax necessary in a particular programming language, see the language-
specific sections of this manual.
Overview of the SPI Procedures
Both SPI requesters and servers use the SSINIT, SSNULL, SSPUT, SSGET, and
SSMOVE procedures to initialize messages and extensible structured tokens, place
tokens in messages, retrieve token values from messages, and move tokens from one
message buffer to another. The functions of these five basic procedures are:
These variants perform the same functions as their namesakes, differing only in the
way they refer to token codes in the procedure parameters:
Topic Page
Overview of the SPI Procedures
3-1
SSINIT Procedure 3-4
SSNULL Procedure 3-7
SSPUT and SSPUTTKN Procedures 3-8
SSGET and SSGETTKN Procedures 3-13
SSMOVE and SSMOVETKN Procedures 3-25
SSIDTOTEXT Procedure 3-35
TEXTTOSSID Procedure 3-37
SSINIT Initializes an SPI message buffer
SSNULL Initializes an extensible structured token with null values
SSPUT Puts a token into a buffer or performs a resetting or repositioning operation on
the buffer
SSGET Extracts a token value or other information from the buffer
SSMOVE Copies a token or list from one buffer to another
SSPUTTKN Adds a token to the buffer or performs a resetting or repositioning
operation on the buffer
SSGETTKN Extracts a token value or other information from the buffer
SSMOVETKN Copies a token or list from one buffer to another