DSM Template Services Manual

Display-Text Procedures
DSM Template Services Manual—427187-004
2-17
Status Information
format-ID
INT .EXT:ref:1
identifies the storage to release. This variable contains the format ID returned by
SPI_BUFFER_FORMATSTART_.
After releasing the storage identified by format-ID, the procedure stores a null
format ID in the indicated variable. If an application accidentally uses the variable
again without resetting it through a call to SPI_BUFFER_FORMATSTART_, the
error is caught.
status-1
INT .EXT:ref:1
supplements status. For a list of values, see Supplementary Status Values on
page 2-18.
status-2
INT .EXT:ref:1
supplements status. For a list of values, see Supplementary Status Values on
page 2-18.
The amount of internal storage available in each program is strictly limited. The
program must release the storage for one SPI buffer (by calling
SPI_BUFFER_FORMATFINISH_) before allocating storage for another buffer (by
calling SPI_BUFFER_FORMATSTART_). Otherwise, a subsequent call to
SPI_BUFFER_FORMATSTART_ fails with error -27: no format ID available.
(A program is restricted to a single format ID.)
Status Information
The SPI_BUFFER_FORMAT procedures return the main status value (the function
value) and two supplementary values (parameters status-1 and status-2). In
Table 2-7, an asterisk (*) indicates the possibility of supplementary status information
for the entry. For a description of supplementary status values, see Table 2-2 on
page 2-13. When you use an error value, be sure to include the prefix ZSPI-ERR-. For
example, use ZSPI-ERR-ILLPARM rather than just ILLPARM.
0 Successful
-2 Illegal parameter value
-3 Missing required parameter
-4 Illegal parameter address
-12 Insufficient stack space
-14 A Guardian procedure error; see status-1
and status-2 on this page.