CICS common area fields

The AMD2CCPX-CA fields are defined for COBOL/CICS in Table 7-5.

Table 7-5: CICS common area fields

Field

Description

EYECATCHER

This value is set by AMD2. If it is altered by the parse exit routine, unpredictable results occur.

USERID

The user ID of the client sending the request. This field should not be altered by the parse exit routine.

PASSWORD

The password of the client sending the request. This field should not be altered by the parse exit routine.

NETGWNAME

The name of DirectConnect specified by the client. These fields should not be altered by the parse exit routine.

CHARSETCLT

Reserved for future use.

CHARSETSRV

Reserved for future use.

ATLANGCLT

Reserved for future use.

DBCS

Reserved for future use.

STMT-PTR

A pointer to a single SQL statement beginning with the 2-byte SQL length. The parse exit routine should alter the pointer to hold the new address of the SQL text area when this address is changed by the exit routine. It is only necessary to acquire a new SQL text area if the existing area is not large enough for the SQL text after it is altered by the user.

AMD2 uses this pointer to determine whether the exit routine allocated storage that AMD2 must deallocate.

RETCODE

A full-word return code. The user-written parse exit routine should alter this field. Valid values are:

0 – Passes the SQL text to DB2 UDB.

+1 – Does not pass the SQL text to DB2 UDB and continues with the next statement in the batch, if there is one.

+2 – Aborts the batch and returns an error message using the message code in the next parse Exit Communication Area field.

MSGCODE

A fullword message code. This field should be altered by the user-written parse exit routine if the return code was set to +2. AMD2 ignores it in all other cases.

RESERVED

Reserved for future use.