The put-message exit – IBM SC34-6814-04 User Manual

Page 849

Advertising
background image

data is being extracted. This value is set on ‘group start’, ‘group
end’, ‘object start’, ‘object end’, and ‘keyword’ calls.

EXTRACT_CSD_OBJECT_TYPE_PTR

Address of a 12-byte field that identifies the type of object (such as
TRANSACTION, PROGRAM, and so on). This value is set only on
‘object start’, ‘object end’, and ‘keyword’ calls.

EXTRACT_CSD_OBJECT_NAME_PTR

Address of an 8-byte field containing the name of the object. This
value is set only on ‘object start’, ‘object end’, and ‘keyword’ calls.

EXTRACT_KEYWORD_NAME_PTR

Address of an 12-byte field containing the name of the keyword
being processed. This value is set on ‘keyword’ calls only.

EXTRACT_KEYWORD_LENGTH_PTR

Address of a halfword containing the length of the value associated
with the keyword. This value is set on ‘keyword’ calls only.

EXTRACT_KEYWORD_VALUE_PTR

Address of a character string which contains the value associated
with the keyword. This value is set on ‘keyword’ calls only.

Note that these parameters are similar to those passed when DFHCSDUP
is invoked as a batch program. (See “Parameters passed from DFHCSDUP
to the user program” on page 815.)
However, when DFHCSDUP is invoked
from a user program, the parameter list also includes the standard
parameters mentioned under “Parameters passed to the user exit routines”
on page 824.

Return codes

UERCNORM (X'00')

Continue processing.

UERCERR

Irrecoverable error. This causes DFHCSDUP to terminate with a
return code of ‘8’.

XPI calls

Must not be used.

The put-message exit

The put-message exit is invoked whenever a message is to be issued. If you are
running under TSO, you could use this exit to terminate DFHCSDUP after the
operator inputs an ATTENTION interrupt. (See “Invoking DFHCSDUP from a user
program” on page 821.)
Or you could use it to provide messages in the operator’s
national language.

Even if this exit is supplied, messages are always additionally written to the default
output file (that is, to SYSPRINT, or to the replacement ddname specified on the
entry linkage to DFHCSDUP).

When invoked

Invoked when a message is to be issued.

Exit-specific parameters

UEPMNUM

Address of a 4-character field containing the message number

Chapter 34. User programs for the system definition utility program (DFHCSDUP)

827

Advertising