INQUIRE MODENAME

Description

The INQUIRE MODENAME command returns information about a group of sessions (sometimes called a mode) that has been defined within a connection to a remote system. (The MODENAME for the group is the name assigned to the SESSIONS resource definition that creates it.)

MODENAMEs are unique within a given connection, but not across connections. Therefore, to look at a particular session group, you must specify data values for both the MODENAME and CONNECTION options.

Browsing

You can also browse through all of the session groups for a particular connection, or all groups for all connections, by using the browse options (START, NEXT, and END) on INQUIRE MODENAME commands.

As in a single INQUIRE MODENAME command, you must include both the MODENAME and CONNECTION options on an INQUIRE MODENAME NEXT command. The data-value for MODENAME is optional; if you provide it, CICS uses it to return the name of the session group. If you want to limit your browse to a single connection specify the data-value for the CONNECTION.

To see all groups, initialize the CONNECTION data-value before running the INQUIRE MODENAME NEXT command. Use the output from the CONNECTION data-value on each INQUIRE MODENAME NEXT command as the input to the next INQUIRE MODENAME NEXT command. You can then browse through all the modenames of all connections.

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

Options

ACTIVE(data-area)

Returns a halfword binary field giving the number of sessions within the group that are currently in use.

AUTOCONNECT(cvda)

Returns a CVDA value indicating whether the sessions within this group are to be bound automatically whenever CICS starts communication with z/OS® Communications Server. CVDA values are:

ALLCONN

CICS tries to bind both contention-winner and contention-loser sessions.

AUTOCONN

CICS tries to bind only sessions for which it is contention winner.

NONAUTOCONN

CICS does not try to bind any sessions.

AVAILABLE(data-area)

Returns a halfword binary field giving the current number of sessions in the group (the number bound).

CONNECTION(data-value)

Specifies the 4-character identifier of the remote system with which this group of sessions is associated (the name of the CONNECTION resource definition for that system).

MAXIMUM(data-area)

Returns a halfword binary field giving the maximum number of sessions that the definition of the session group permits.

MAXWINNERS(data-area)

Returns a halfword binary field giving the maximum number of sessions that the definition of the session group permits to be contention winners. A single-session APPC definition installed by RDO or autoinstall always shows 0 for this field.

MODENAME(data-value)

Specifies the 8-character identifier of the group of sessions about which you are inquiring. Modename is the name of the SESSIONS resource definition for the group.

Conditions

END

RESP2 values:

2

There are no more resource definitions of this type.

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.

NOTAUTH

RESP2 values:

100

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

SYSIDERR

RESP2 values:

1

The connection cannot be found.

2

The modename within the connection cannot be found.

3

The connection specified on an INQUIRE MODENAME NEXT cannot be found.