DML Precompiler-Directive Statements › INCLUDE IDMS MODULE

INCLUDE IDMS MODULE

INCLUDE IDMS (module-name) copies procedure source statements defined by the database administrator as modules in the dictionary.

Syntax

   ┌───────────────────────────────────────────────────────────────────┐
►►─▼─┬───────────────────────────────────────────────────────────────┬─┴──────►◄
     └─ INCLUDE IDMS (module-name ─┬──────────────────────────┬─ ); ─┘
                                   └─ VERSION version-number ─┘

Parameters

INCLUDE IDMS (module-name)

Copies procedure source statements defined by the DBA as modules in the dictionary. Module-name specifies the name of a module previously defined by the DBA using the DDDL compiler (refer to the CA IDMS IDD DDDL Reference Guide). The available PL/I standard modules are:

• IDMS_STATUS
• IDMS_STATUS (mode is IDMS_DC)

The DML precompiler inserts the module into your program at the location of the INCLUDE IDMS MODULE statement, without modification. If the module contains DML statements, the DML precompiler examines and expands them within the context of your program's subschema view and compile mode, as if they were coded directly.

Note: The INCLUDE IDMS MODULE statement can precede the DECLARE SUBSCHEMA statement if the module it copies does not contain DML statements.

You can nest INCLUDE IDMS MODULE statements. This means that code invoked by an INCLUDE IDMS MODULE entry can itself contain INCLUDE IDMS MODULE statements. However, make sure that a copied module does not copy itself.

VERSION version-number

Optionally qualifies module-name with a version number. Version-number must be an integer in the range 1 through 9999.

There are two defaults for version-number, depending on whether:

• There is a version of the module that you name with module-name which is operating-mode-specific. In this case, the default is the version number of this module. If there are two or more mode-specific versions of the module, version-number defaults to the highest version number among these versions.
• There is a version of the module that you name with module-name which is non-operating-mode-specific, and there exists no operating-mode-specific version. In this case, the default is the version number of this module. If there are two or more non-mode-specific versions of the module, version-number defaults to the highest version number among these versions.

If no version of the module exists in the dictionary, an error condition results. For more information, see the CA IDMS Messages and Codes Guide.