INQUIRE CAPOPTPRED

Retrieve information about a capture option predicate that is defined for a capture specification.

Syntax

Warning: System commands are powerful as they provide information about the state of the system and allow changes to be made to it. System commands should be used only by authorized applications and users.

Activate security checks on commands by specifying the XCMD system initialization parameter and by ensuring that command security checking is active for the transaction (either by specifying CMDSEC(YES) on the TRANSACTION resource definition or by specifying ALWAYS on the CMDSEC system initialization parameter).

INQUIRE CAPOPTPRED

Read syntax diagramSkip visual syntax diagramINQUIRE CAPOPTPREDCAPTURESPEC( data-value)EVENTBINDING( data-value)FILTERVALUE( data-area)OPERATOR( cvda)OPTIONNAME( data-area)

Conditions: END, ILLOGIC, INVREQ, NOTAUTH, NOTFND

NOHANDLE, RESP, and RESP2 are common options that can be added to all EXEC CICS commands to process error conditions. They are not explicitly included in the command syntax diagram and option descriptions. For information about these common options and EXEC CICS command syntax, see EXEC CICS command format and programming considerations. For more information about the use of CVDAs, see CVDA values for the DEVICE option.

This command is threadsafe.

Description

The INQUIRE CAPOPTPRED command returns details of each capture option predicate, including the primary predicate, that is defined for a capture specification. The INQUIRE CAPOPTPRED command can be used only in browse mode.

Browsing

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

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

Options

FILTERVALUE(data-area)
Specifies a 255-character data area to receive the value of the application or system event option named in the OPTIONNAME option. Values that are less than 255 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 OPTIONNAME option is not equal to the value of the FILTERVALUE option.
DOESNOTEXIST
The predicate evaluates true when the OPTIONNAME option is not specified on the EXEC CICS® command.
DOESNOTSTART
The predicate evaluates true when the value of the OPTIONNAME option does not start with the value of the FILTERVALUE option.
EQUALS
The predicate evaluates true when the value of the OPTIONNAME option is equal to the value of the FILTERVALUE option.
EXISTS
The predicate evaluates true when the OPTIONNAME option is specified on the EXEC CICS command.
GOHIGHERTHAN
The predicate evaluates true when the value of the threshold option named in OPTIONNAME crosses above the threshold percentage returned in FILTERVALUE.
GOLOWERTHAN
The predicate evaluates true when the value of the threshold option named in OPTIONNAME crosses below the threshold percentage returned in FILTERVALUE.
GREATERTHAN
The predicate evaluates true when the value of the OPTIONNAME option is greater than the value of the FILTERVALUE option.
ISNOTGREATER
The predicate evaluates true when the value of the OPTIONNAME option is equal to or less than the value of the FILTERVALUE option.
ISNOTLESS
The predicate evaluates true when the value of the OPTIONNAME option is equal to or greater than the value of the FILTERVALUE option.
LESSTHAN
The predicate evaluates true when the value of the OPTIONNAME option is less than the value of the FILTERVALUE option.
STARTSWITH
The predicate evaluates true when the value of the OPTIONNAME option starts with FILTERVALUE.
OPTIONNAME(data-area)
Specifies a 32-character data area to receive the name of the capture option predicate that is specified in the event specification. In the CICS event binding editor, this value matches one of the capture options for the capture point. Values that are less than 32 characters are padded with blanks.

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 CAPOPTPRED browse.
5
A CAPTURESPEC name has not been specified for the START CAPOPTPRED 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.