SPI Reference Summary

SPI Procedures and Functions

SPI Reference Summary—427507-006

2-9

TACL Built-In Functions

SPI built-in functions can be used in TACL macros and routines. These built-in

functions are #SSGET, #SSGETV, #SSINIT, #SSMOVE, #SSPUT, and #SSPUTV.

#SSINIT Built-In Function

#SSINIT initializes a STRUCT as an SPI message buffer.

Expansion

Status code (SPI error) = 0, -2 through -5, -7, -10, -12

#SSINIT [ / TYPE 0 / ] buffer-var ssid command

[ / type-0-option [ , type-0-option ] ... / ]

TYPE 0

header type of SPI buffer (default = command or response,

value is 0)

buffer-var

variable to be initialized as an SPI buffer; must be

writable STRUCT

ssid

subsystem ID

command

command number

type-0-option

[ CHECKSUM checksum ]

[ MAXFIELDVERSION max-field-version ]

[ MAXRESPONSES max-resp ]

[ OBJECT object-type ]

[ SERVERVERSION server-version ]

Parameter Description

CHECKSUM checksum Provides checksum flag: if 0 or omitted,

checksum protection disabled (default); if not 0,

checksum protection enabled

MAXFIELDVERSION max-field-

version

Unsigned integer value that initializes maximum

field version of buffer header (default = 0)

MAXRESPONSES max-resp Gives maximum response records to be

returned in response message (default = 0)

OBJECT object-type Object type (default =

ZSPI^VAL^NULL^OBJECT^TYPE (0))

SERVERVERSION server-version Version (16-bit unsigned integer) of subsystem

or server (default = 0)