DSM Template Services Manual

Display-Text Procedures
DSM Template Services Manual—427187-004
2-2
SPI_BUFFER_FORMATSTART_
Use the SPI_BUFFER_FORMAT procedures in:
•
Writing management or utility applications. For example, you could use these
procedures to develop an application that lists all tokens from selected event
messages on a log file.
•
System products, such as Inspect and TMDS. When debugging an application, an
Inspect user can ask to have an SPI buffer displayed. Inspect calls the
SPI_BUFFER_FORMAT procedures to interpret the SPI buffer and produce a
symbolic display of its contents.
SPI_BUFFER_FORMATSTART_
The SPI_BUFFER_FORMATSTART_ procedure allocates and initializes the internal
storage for the representation of one SPI message. This procedure returns a format ID
that identifies the internal storage so that the other procedures in the group can use
and release the storage. SPI_BUFFER_FORMATSTART_ creates no display text. The
procedure SPI_BUFFER_FORMATNEXT_ uses any parameters provided here that
control the way display text is represented.
status
INT
is a number that describes the outcome of the call:
status := SPI_BUFFER_FORMATSTART_
( format-ID ! o
, numeric-format ! i
, string-format ! i
, type-override ! i
, display-redef ! i
, display-hidden ! i
, no-header ! i
, label-source ! i
, buffer-values-only ! i
, token-label-len ! i
, field-label-len ! i
, [ status-1 ] ! o
, [ status-2 ] ); ! o
0 Successful
-2 Illegal parameter value
-3 Missing required parameter
-4 Illegal parameter address
-7 Internal error
-12 Insufficient stack space
-13 File-system error; see status-1 and status-2