File Utility Program (FUP) Management Programming Manual

FUP Programmatic Interface
File Utility Program (FUP) Management Programming Manual—523322-001
2-10
Common Syntax Elements
Token Types
These are represented by symbolic names using the form Zsss-TYP-name (where sss
is the subsystem abbreviation, and name is the token type). FUP does not define any
private token types (such as token types with the name ZFUP-TYP-name). Table 2-3
on page 2-11 shows the standard SPI token types used by FUP.
Predefined Value Names
These are represented by symbolic names using the form Zsss-VAL-name (where
sss is the subsystem abbreviation, and name is the predefined value). An example of
a predefined value name is ZFUP-VAL-BUFLEN, which is the recommended buffer
length.
Token Maps and Structured Tokens
A token map is a variable-length integer array that contains decoding information and a
reference name for an extensible structured token. A token map contains a token code
and a description of the token value—including the token fields, the null values for the
fields, and the version number for the fields. An application uses a token map to pass
information in an extensible structured token to FUP.
Field Types
FUP uses SPI standard field types that are represented using the form ZSPI-DDL-
name (where name specifies the field type). For example, the symbolic name for the
message buffer is ZFUP-DDL-MSG-BUFFER.
Table 2-2. FUP Token Codes
Token Code (ZFUP-TKN-) Token Type
ALTFILE-NUM ZSPI-TYP-INT
BLOCKLEN ZSPI-TYP-INT2
DEST-FILE ZSPI-TYP-FNAME
FILE ZSPI-TYP-FNAME
PART-NO ZSPI-TYP-INT
PE-NUM ZSPI-TYP-INT
READ-COUNT ZSPI-TYP-INT4
RECLEN ZSPI-TYP-INT2
REC-COUNT ZSPI-TYP-INT4
SOURCE-FILE ZSPI-TYP-FNAME
Note. For more information about the FUP token maps, see Section 3, FUP Commands and
Responses.