The updt->Function field should be interrogated to determine
the which type of call is being made.
- Names
- ARCCSXIT_PROCESS_NAMES
- Parameters
- ARCCSXIT_PROCESS_PARMS
Do not attempt to use parameters that are not specified
as being valid for a given call.
Table 1. Names
call parameters
| Parameter |
Meaning |
| updt->pFileName |
Address of the null delimited file
name. |
| updt->ApplGrpName |
Null delimited application group name. This
is the application group name that ARSLOAD will attempt to use if
no action is performed by the Names call. |
| updt->ApplName |
Null delimited application name. This is
the application name that ARSLOAD will attempt to use if no action
is performed by the Names call. |
| updt->ObjServer |
Null delimited object server
name. This is the object server that ARSLOAD will attempt to
use if no action is performed by the Names call. If no object server
is explicitly specified, ARSLOAD will use the object server specified
by the storage node that is designated for loading in the storage
set assigned to the application group. |
| updt->StorageNode |
Null delimited storage node name. This is
the storage node that ARSLOAD will attempt to use if no action is
performed by the Names call. If no node is explicitly specified, ARSLOAD
will use the primary storage node specified by the storage node that
is designated for loading in the storage set assigned to the application
group. |
| updt->ArsCSXitUpdtExit-pJES |
Pointer to the JES information. If this
pointer is not null, the object being loaded is being read from the
JES SPOOL. The JES information contains a DDNAME that is currently
allocated to the SPOOL file and a pointer to the JES SSS2 SSOB extension.
If null, the file being processed is either an MVS data set or an HFS file. |
Table 2. Parameters call parameters
| Parameter |
Meaning |
| updt->pFileName |
Address of the null delimited file
name. |
| updt->ApplGrpName |
Null delimited application group name. This
is the application group name the document will be stored under. |
| updt->ApplName |
Null delimited application name. This is
the application name the document will be stored under. |
| updt->ObjServer |
Null delimited object server
name. This is the object server that will be stored in. If the
object server is X'00', ARSLOAD will use the object server specified
by the storage node that is designated for loading in the storage
set assigned to the application group. |
| updt->StorageNode |
Null delimited storage node name. This is
the storage node that ARSLOAD will be stored in. If the node is X'00',
ARSLOAD will use the primary storage node that is specified by the
storage node that is designated for loading in the storage set that
is assigned to the application group. |
| updt->ArsCSXitUpdtExit-pJES |
Pointer to the JES information. If this
pointer is not null, the object being loaded is being read from the
JES SPOOL. The JES information contains a DDNAME that is currently
allocated to the SPOOL file and a pointer to the JES SSS2 SSOB extension.
If null, the file being processed is either an MVS data set or an HFS file. |
| updt->IndexerParms |
The indexer parameter that will be passed
to the indexer. The indexers parameters are a series of records separated
by newline characters (X'15'). If altered by the exit,
these parameters will be stored back into indexer parameters that
are associated with the application. |
| updt->CCType |
Carriage control type. If altered by the exit, this value will be stored
in the view information that is associated with the application. Changing this value after
reports have been loaded might cause previously loaded documents to display
incorrectly. |
| updt->LRECL |
For fixed record format the length of each line. This has no meaning for
variable format. If altered by the exit, this value will be stored in the view information
that is associated with the application. Changing this value after reports have been loaded
might cause previously loaded documents to display incorrectly. |
| updt->RECFM |
The record format the document is stored in OnDemand. If altered by the
exit, this value will be stored in the view information that is associated with the
application. Changing this value after reports have been loaded might cause previously
loaded documents to display incorrectly. |
| updt->update_appl |
Indicates that the application is to be
updated. If zero, any changes made by the exit will not be reflected
in the application definitions. If non-zero, the application will
be updated with the new values. |
| updt->Delim |
For documents stored as stream, this is
the NULL terminated string that contains the string that is used to
determine record boundaries. For example, records that
use EBCDIC newline characters as record delimiters would specify X'15'. |
Valid values for record format are described in this table.
Table 3. Record formats
| Format |
Value |
| Fixed |
ARCCSXIT_DOC_FORMAT_FIXED |
| Variable |
ARCCSXIT_DOC_FORMAT_VARIABLE |
| Stream |
ARCCSXIT_DOC_FORMAT_STREAM |
Valid values for carriage control are described in this
table.
Table 4. Carriage control
| Format |
Value |
| ANSI |
ARCCSXIT_CC_ANSI |
| Machine |
ARCCSXIT_CC_MACHINE |
| None |
ARCCSXIT_CC_NONE |
- Carriage control, lrecl, recfm, and record delimiter are only
valid for documents stored as Line data.
- Documents stored as variable in OnDemand are stored with a two-byte
length prefix followed by the data for the record. The length does
not include the two-byte prefix.
Returned values
In addition to updating
the ArsCSXitPrepExit as appropriate, the DLL should set a return code
of zero to indicate success, and a non-zero to indicate failure.