DSM Template Services Manual

Display-Text Procedures
DSM Template Services Manual—427187-004
2-6
SPI_BUFFER_FORMATNEXT_
Values of Length Parameters
The values 20 and 10 for the token-label-len and field-label-len
parameters are minimum values, not recommended values. Larger values provide the
SPI_BUFFER_FORMATNEXT_ procedure with greater latitude to produce readable
display text.
SPI_BUFFER_FORMATNEXT_
The SPI_BUFFER_FORMATNEXT_ procedure represents an SPI message as display
text. One procedure call can represent the entire SPI message if the text buffer is large
enough. Otherwise, one or more follow-up calls to the procedure completes the
representation.
A sketch of the procedure logic follows the syntax box and should help clarify the brief
definitions within the box. If you use EMSTEXT, many aspects of this procedure will be
familiar.
status
INT
returns the outcome of the call:
status := SPI_BUFFER_FORMATNEXT_
( format-ID ! i
, spi-buffer ! io
, text-buffer:size ! o:i
, n ! i
, lengths ! o
, [ status-1 ] ! o
, [ status-2 ] ); ! o
0 Text returned; no more left to do
-1 Invalid SPI buffer
-2 Illegal parameter value
-3 Missing required parameter
-4 Illegal parameter address
-5 Buffer full
-6 Invalid checksum
-7 Internal error
-8 Token not found
-9 Illegal token code or map
-10 Invalid subsystem ID
-11 Operation not supported