Defining the SQL communications area, SQLSTATE, and SQLCODE in assembler

Assembler programs that contain SQL statements can include an SQL communications area (SQLCA) to check whether an SQL statement executed successfully. Alternatively, these programs can declare individual SQLCODE and SQLSTATE host variables.

About this task

If you specify the SQL processing option STDSQL(YES), do not define an SQLCA. If you do, Db2 ignores your SQLCA, and your SQLCA definition causes compile-time errors. If you specify the SQL processing option STDSQL(NO), include an SQLCA explicitly.

If your application contains SQL statements and does not include an SQL communications area (SQLCA), you must declare individual SQLCODE and SQLSTATE host variables. Your program can use these variables to check whether an SQL statement executed successfully.

Procedure

To define the SQL communications area, SQLSTATE, and SQLCODE:

Choose one of the following actions:

Option Description

To define the SQL communications area:

Option	Description
To define the SQL communications area:	Code the SQLCA directly in the program or use the following SQL INCLUDE statement to request a standard SQLCA declaration: `EXEC SQL INCLUDE SQLCA` If your program is reentrant, you must include the SQLCA within a unique data area that is acquired for your task (a DSECT). For example, at the beginning of your program, specify the following code: `PROGAREA DSECT EXEC SQL INCLUDE SQLCA` As an alternative, you can create a separate storage area for the SQLCA and provide addressability to that area. Db2 sets the SQLCODE and SQLSTATE values in the SQLCA after each SQL statement executes. Your application should check these values to determine whether the last SQL statement was successful.
To declare SQLCODE and SQLSTATE host variables:	Declare the SQLCODE variable within a BEGIN DECLARE SECTION statement and an END DECLARE SECTION statement in your program declarations as a fullword integer. Declare the SQLSTATE variable within a BEGIN DECLARE SECTION statement and an END DECLARE SECTION statement in your program declarations as a character string of length 5 (CL5). Restriction: Do not declare an SQLSTATE variable as an element of a structure. Requirement: After you declare the SQLCODE and SQLSTATE variables, ensure that all SQL statements in the program are within the scope of the declaration of these variables.

Code the SQLCA directly in the program or use the following SQL INCLUDE statement to request a standard SQLCA declaration:
```
EXEC SQL INCLUDE SQLCA
```
If your program is reentrant, you must include the SQLCA within a unique data area that is acquired for your task (a DSECT). For example, at the beginning of your program, specify the following code:
```
PROGAREA DSECT
         EXEC SQL INCLUDE SQLCA
```
As an alternative, you can create a separate storage area for the SQLCA and provide addressability to that area.

Db2 sets the SQLCODE and SQLSTATE values in the SQLCA after each SQL statement executes. Your application should check these values to determine whether the last SQL statement was successful.

To declare SQLCODE and SQLSTATE host variables:

Declare the SQLCODE variable within a BEGIN DECLARE SECTION statement and an END DECLARE SECTION statement in your program declarations as a fullword integer.
Declare the SQLSTATE variable within a BEGIN DECLARE SECTION statement and an END DECLARE SECTION statement in your program declarations as a character string of length 5 (CL5).

Restriction: Do not declare an SQLSTATE variable as an element of a structure.

Requirement: After you declare the SQLCODE and SQLSTATE variables, ensure that all SQL statements in the program are within the scope of the declaration of these variables.