INQUIRE CAPDATAPRED

Description

The INQUIRE CAPDATAPRED command returns details of each application data predicate that is defined for a capture specification. The INQUIRE CAPDATAPRED command can be used only in browse mode.

Browsing

You can browse through all of the application data predicates for a capture specification by using the browse options (START, NEXT, and END) on the INQUIRE CAPDATAPRED command.

See Browsing resource definitions for general information about browsing, including syntax, exception conditions, and examples.

Options

CONTAINER(data-area)

Specifies a 16-character data area to receive the name of the container that contains the data when the value of the LOCATION option is equal to CHANNEL or FROMCHANNEL; otherwise, this option contains blanks. Values that are less than 16 characters are padded with blanks.

FIELDLENGTH(data-area)

Returns a fullword binary field that contains the length, in bytes, of the data to be tested by this predicate. The value of the LOCATION option identifies the data source.

FIELDOFFSET(data-area)

Returns a fullword binary field that contains the offset into the data source, which is indicated by the value of the LOCATION option, that contains the data to be tested by this predicate.

FILENAME(data-area)

Specifies a 32-character data area to receive the first 32 characters of the name of the file that contains the imported language structure that defines this predicate. This option contains all blanks if an imported language structure was not used. Values that are less than 32 characters are padded with blanks. Data that is returned as a result of this option is encoded in your local coded character set identifier (CCSID).

FILTERVALUE(data-area)

Specifies a 255-character data area to receive the value of the application data predicate. Predicates that are not characters are converted to their character representation. Values that are less than 255 characters are padded with blanks. Data that is returned as a result of this option is encoded in your local coded character set identifier (CCSID).

LOCATION(data-area)

Specifies a 32-character data area to receive the location of the data to be tested. For the CICS event binding editor, this value is the same as the value for the Location field in the Variable location and format section of the Application Data predicate dialog when you add or edit application data predicates for an application event. Values that are less than 32 characters are padded with blanks.

OPERATOR(cvda)

Returns a CVDA that defines the operator that is used with the value of the FILTERVALUE option to evaluate the predicate. Possible CVDA values are as follows:

DOESNOTEQUAL

The predicate evaluates true when the value of the data item that is defined by the LOCATION, FIELDOFFSET, and FIELDLENGTH values is not equal to the value of the FILTERVALUE option.

DOESNOTEXIST

The predicate evaluates true when the data source that is specified for the LOCATION option does not exist.

DOESNOTSTART

The predicate evaluates true when the value of the data item that is defined by the LOCATION, FIELDOFFSET, and FIELDLENGTH values does not start with the value of the FILTERVALUE option.

EQUALS

The predicate evaluates true when the value of the data item that is defined by the LOCATION, FIELDOFFSET, and FIELDLENGTH values is equal to the value of the FILTERVALUE option.

EXISTS

The predicate evaluates true when the data source that is specified for the LOCATION option exists.

GREATERTHAN

The predicate evaluates true when the value of the data item that is defined by the LOCATION, FIELDOFFSET, and FIELDLENGTH values is greater than the value of the FILTERVALUE option.

ISNOTGREATER

The predicate evaluates true when the value of the data item that is defined by the LOCATION, FIELDOFFSET, and FIELDLENGTH values is equal to or less than the value of the FILTERVALUE option.

ISNOTLESS

The predicate evaluates true when the value of the data item that is defined by the LOCATION, FIELDOFFSET, and FIELDLENGTH values is equal to or greater than the value of the FILTERVALUE option.

LESSTHAN

The predicate evaluates true when the value of the data item that is defined by the LOCATION, FIELDOFFSET, and FIELDLENGTH values is less than the value of the FILTERVALUE option.

STARTSWITH

The predicate evaluates true when the value of the data item that is defined by the LOCATION, FIELDOFFSET, and FIELDLENGTH values starts with the value of the FILTERVALUE option.

STRUCTNAME(data-area)

Specifies a 32-character data area to receive the first 32 characters of the name of the imported language structure used to define this predicate. This field contains all blanks when an imported language structure is not used. Values that are less than 32 characters are padded with blanks. Data that is returned as a result of this option is encoded in your local coded character set identifier (CCSID).

VARIABLENAME(data-area)

Specifies a 32-character data area to receive the first 32 characters of the name of the variable in the imported language structure used to define this predicate. This field contains all blanks when an imported language structure is not used. Values that are less than 32 characters are padded with blanks. Data that is returned as a result of this option is encoded in your local coded character set identifier (CCSID).

Conditions

END

RESP2 values:

2

There are no more resource definitions of this type.

8

The event binding has been deleted so browse has been terminated early.

ILLOGIC

RESP2 values:

1

You have issued a START command when a browse of this resource type is already in progress, or you have issued a NEXT or an END command when a browse of this resource type is not in progress.

INVREQ

4

An EVENTBINDING name has not been specified for the START CAPDATAPRED browse.

5

A CAPTURESPEC name has not been specified for the START CAPDATAPRED browse.

NOTAUTH

RESP2 values:

100

The user associated with the issuing task is not authorized to use this command.

101

The user associated with the issuing task is not authorized to read the event binding.

NOTFND

RESP2 values:

2

The specified capture specification cannot be found.

3

The specified event binding cannot be found.