SPI Reference Summary

SPI Procedures and Functions

SPI Reference Summary—427507-006

2-10

#SSNULL Built-In Function

The #SSNULL built-in function initializes a structure with null values. Use this

procedure before setting values within a structure for an extensible structured token.

Expansion

Status code (SPI error) = 0, -3, -4, -7, -9

#SSPUT and #SSPUTV Built-In Functions

#SSPUT and #SSPUTV convert token values from external to binary form and insert

them into the SPI buffer. If the token value is in STRUCT, use #SSPUTV.

Note. Your macro or routine must always use #SSNULL before placing values in the fields of

a structure, even when all currently defined fields will be set explicitly. This practice lets the

program continue to work with future RVUs.

#SSNULL token-map struct

token-map

token map to be used in initializing the fields of the

structure

struct

structure to be initialized with null values

#SSPUT [ / option [ , option ] / ] buffer-var

token-code [ token-value [ token-value ]... ]

#SSPUTV [ / option [ , option ] ... / ] buffer-var

token-id source-var

option:

[ COUNT count ]

[ SSID ssid ]

buffer-var

SPI message-buffer variable into which tokens are placed

token-code (#SSPUT)

supplied token or special operation

token-value (#SSPUT)

value of token-code

token-id (#SSPUTV)

token code or token map of supplied token or special

operation

source-var (#SSPUTV)

STRUCT containing binary token values