DSM Template Services Manual

Display-Text Procedures
DSM Template Services Manual—427187-004
2-16
SPI_BUFFER_FORMATFINISH_
Representation Determined by DISPLAY Clause
As mentioned, a DISPLAY clause can change the way certain fields are represented.
Table 2-6 shows the DISPLAY codes that can be used in DISPLAY clauses for each
field type. Field types not mentioned do not have suitable DISPLAY codes.
Numeric strings (fields described by PIC 9 ... without COMP) are treated as character
strings, not as numbers. If any of the numeric DISPLAY codes are applied to a numeric
string field, they are applied to the value of each 8-bit byte in turn. For the meaning of
these edit codes, see Table 2-1 on page 2-11.
SPI_BUFFER_FORMATFINISH_
The SPI_BUFFER_FORMATFINISH_ procedure releases the internal storage, which is
needed only until the display text for a message is complete.
status
INT
is a number that describes the outcome of the call:
TACL TSTAMP Represents the internal value in Local Civil Time (LCT). If the internal
time is not in GMT, the conversion to LCT fails, and the display-text
representation is wrong. The format is: YYYY-MM-DD
HH:MM:SS.mil.mic
TACL TRANSID Represents a TMF transaction identifier through the
TRANSIDTOTEXT procedure.
TACL USERNAME Represented field by field.
Table 2-6. Suitable DISPLAY Codes by Field Type
Field Type DISPLAY Codes Used With This Type
TYPE BINARY I, B, O, Z
TYPE ENUM I, B, O, Z
TACL ENUM I, B, O, Z
Alphanumeric strings A, I, B, O, Z
Numeric strings A, I, B, O, Z
status := SPI_BUFFER_FORMATFINISH_
( format-ID ! io
, [ status-1 ] ! o
, [ status-2 ] ); ! o
Table 2-5. Field Representation by DDL TACL Clause (page 2 of 2)
TACL Clause Indicated Representation