The INQUIRE_FEATUREKEY call

INQUIRE_FEATUREKEY obtains the value for a feature toggle.

For a list of toggle-enabled features by CICS release, see Toggle-enabled features, support by release. Follow the links in the feature list table to locate the information that describes the feature toggles for enabling and setting configuration options for a specific toggle-enabled feature.

INQUIRE_FEATUREKEY


DFHPAIQX [CALL,]
      [CLEAR,]
      [IN,
      FUNCTION(INQUIRE_FEATUREKEY),
      OPTION(name255|'string'),
      [STRING(buffer-descriptor),]
      [UPPERCASE (YES|NO),]
      [OUT,
      [NUMBER(name4),]
      [BOOLEAN(name1)]
      RESPONSE(name1 | *),
      REASON(name1 | *)]

This command is threadsafe.

OPTION(name255|'string')

Specifies the name of the feature toggle.

STRING(buffer-descriptor)

Specifies the address and the length of a buffer to contain the returned character string value of the toggle. See XPI syntax for a full definition of a buffer-descriptor.

UPPERCASE (YES|NO)

Specifies if the value returned in STRING is changed to uppercase.

NUMBER(name4)

Returns a numeric toggle value in binary.

BOOLEAN(name1)

Returns a boolean toggle value in boolean.

TRUE: The value is true.
FALSE: The value is false.

RESPONSE and REASON values for INQUIRE

RESPONSE	REASON
OK	None
EXCEPTION	NOT_FOUND BUFFER_TOO_SMALL BAD_OPTION NOT_BOOLEAN NOT_NUMBER NO_LIST
DISASTER	None
INVALID	None
KERNERROR	None
PURGED	None