Previous Topic: Reserved KeywordsNext Topic: Accessing Tables


Accessing Database and Logical Records

The first 38 bytes of the CA Culprit input buffer contain fields that can be used to determine the contents of the input buffer; the input buffer also contains the db-key value for each record in the input buffer. Users can access these fields by using reserved keywords.

Reserved keywords can be referenced on SORT, edit, process, and SELECT/BYPASS parameters. num=21.Database-Specific Process Parameters, identifies the appropriate keywords for each type of process operation.

Keywords

Each keyword is described separately below:

PATH-ID

Contains the 2-byte alphanumeric path ID of the records currently in the input buffer. The user's procedure logic can test the value of PATH-ID to determine which string CA Culprit returned to the input buffer.

REC-NAME

Contains the 16-byte name of the member record currently being processed; this reserved word applies only when CA Culprit accesses records that participate in a multiple-member set relationship. The user's procedure logic can test the value of REC-NAME to determine which member record type is in the input buffer. The value of REC-NAME is the record name defined to the subschema; it cannot be the record synonym name.

IDMS-STATUS

Contains a 4-byte alphanumeric CA IDMS/DB status code; this value pertains to DB-EXIT retrievals only.

LR-STATUS

Contains a 16-byte alphanumeric status of the most recently retrieved logical record. Possible values for LR-STATUS are the following:

If the logical record status is anything other than the three values listed above, CA Culprit continues as if a status of LR-FOUND were returned.

DBKEY

References a 4-byte binary field containing the database key for the most recently retrieved occurrence of each record type specified on a PATH parameter. This field immediately follows the corresponding record in the input buffer.

DBKEY-PAGE

References the page number of the db-key, as defined in the schema syntax. CA Culprit generates a multi-bit binary field (data type 5).

Note: For more information on database key structures, see the CA IDMS Database Administration Guide.

DBKEY-LINE

References the line number of the db-key, as defined in the schema syntax. CA Culprit generates a multi-bit binary field (data type 5).

Note: For more information on database key structures, see the CA IDMS Database Administration Guide.

DBKEY-ALPHA

References a 4-byte alphanumeric field that redefines DBKEY. This keyword is useful for writing db-key values to a file.

DBKEY, DBKEY-PAGE, and DBKEY-LINE should be treated as zoned decimal values rather than as binary values; CA Culprit converts the values automatically. Any of the db-key reserved words can be qualified by record name and level, as described later in this chapter under Qualified Field Name References. An unqualified reference defaults to the entry record on the PATH parameter.

More information:

The DB-EXIT Facility