INQUIRE CAPINFOSRCE

Retrieve information about an information source that is defined for a capture specification.

INQUIRE CAPINFOSRCE

Read syntax diagramSkip visual syntax diagramINQUIRE CAPINFOSRCECAPTURESPEC( data-value)EVENTBINDING( data-value)CONTAINER( data-area)FIELDLENGTH( data-area)FIELDOFFSET( data-area)FILENAME( data-area)ITEMNAME( data-area)LOCATION( data-area)STRUCTNAME( data-area)VARIABLENAME( data-area)

Conditions: END, ILLOGIC, INVREQ, NOTAUTH, NOTFND

This command is threadsafe.

For more information about the use of CVDAs, see CICS-value data areas (CVDAs).

Description

The INQUIRE CAPINFOSRCE command returns details of each information source that is defined for a capture specification. The INQUIRE CAPINFOSRCE command can be used only in browse mode.

Browsing

You can browse through all of the information sources for a capture specification by using the browse options (START, NEXT, and END) on the INQUIRE CAPINFOSRCE 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 application data to be captured from the information source which is indicated by the value of the LOCATION option. The FIELDLENGTH option is 0 for all application event context and command option capture items, and for all system event capture items.
FIELDOFFSET(data-area)
Returns a fullword binary field that contains the offset into the application data source, which is indicated by the value of the LOCATION option, that contains the data to be captured by the capture specification. The FIELDOFFSET option is 0 for all application event context and command option capture items, and for all system event capture items.
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 information source. This option contains all blanks for a system event or when an imported language structure was not used to define an application event. Values that are less than 32 characters are padded with blanks. The returned value is encoded in CCSID for the local region.
ITEMNAME(data-area)
Specifies a 32-character data area to receive the name that was specified for this item of emitted business information. Values that are less than 32 characters are padded with blanks.
LOCATION(data-area)
Specifies a 32-character data area to receive the name of the information source. When you use the CICS event binding editor, this value is the same as the value you select from the list of available data when you add or edit an information source for an application or system event. Values that are less than 32 characters are padded with blanks.
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 information source. This field contains all blanks for a system event or when an imported language structure is not used to define an application event. Values that are less than 32 characters are padded with blanks. The returned value is encoded in CCSID for the local region.
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 information source. This field contains all blanks for a system event or when an imported language structure is not used to define an application event. Values that are less than 32 characters are padded with blanks. The returned value is encoded in CCSID for the local region.

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