The INCLUDE preprocessor directive is used in an application program
to declare the SQLCA or the SQLDA.
Scope
Application Programs Only
SQL Syntax
INCLUDE {SQLCA [[IS]EXTERNAL]
SQLDA }
Parameters
SQLCA and SQLDA
identify data structures with special predefined
meaning as follows:
SQLCA is an
area for ALLBASE/SQL output messages concerning the status of each
SQL statement.
SQLDA is an area for use in conjunction with dynamic
preprocessing of SELECT statements.
Refer to the ALLBASE/SQL Application Programming Guide for the language you are using for more information
on these data structures.
IS EXTERNAL
for the COBOL preprocessor only; declares the SQLCA
structure as EXTERNAL. Then the SQLCA will not have to be passed
explicitly to subprograms.
Description
This directive cannot
be used interactively or in procedures.
You must always include the SQLCA in your ALLBASE/SQL
application programs by using the INCLUDE statement or explicitly declaring the SQLCA yourself.
At run time, ALLBASE/SQL puts information into the SQLCA that describes
how SQL statements in the program executed.
Authorization
You do not need authorization to use the INCLUDE statement.