NQIB gate, GET_NEXT_ENQUEUE function

This functions returns information about the next enqueue owner or waiter in a browse.

Input Parameters

BROWSE_TOKEN
The token for the current browse.

Output Parameters

RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
REASON
Values for the parameter are:
  • ABEND
  • LOOP
  • BROWSE_END
  • INVALID_BROWSE_TOKEN
ENQUEUE_NAME_OUT
A buffer into which the enqueue name is returned. The caller specifies the address and maximum length of the data area into which the enqueue name will be returned. If the enqueue name is too big for the buffer then the data is truncated and an OK response is returned. The actual length of the name is returned in enqueue_name_out_n.
ENQUEUE_NAME2_LENGTH

The length of the second part of the enqueue name if the enqueue was originally specified in two parts (i.e. ENQUEUE_NAME1 and ENQUEUE_NAME2).

If the ENQUEUE_NAME2 parameter wasn't originally specified for this enqueue then zero will be returned.

ENQUEUE_TOKEN
Token returned only when the enqueue is owned by the caller. Parameter is set to zero for all other enqueues returned on the browse.
INTERPRETER_ADDRESS

The address of a routine which should be called with the INTERPRET_ENQUEUE function in order to interpret the enqueue for the EXEC CICS INQUIRE UOWENQ command.

If a zero address is returned then the enqueue isn't to be returned by the INQUIRE UOWENQ command.

RESOURCE_FILTER
The resource filter as specified in the RESOURCE option on the ENQUIRE UOWENQ command.
RESOURCE_FILTER_LEN
The length of the RESOURCE_FILTER parameter.
LOCAL_UOWID
The local UOWID of the UOW which owns or is waiting for the enqueue.
NUM_LOCKED_FAILURES
Returns the number of failed requests for this enqueue whilst it is held in retained state.
NUM_WAITERS
The number of transactions waiting for this enqueue.
POOL_NAME
The name of the pool containing the enqueue.
POOL_TOKEN
Token which identifies the pool which the enqueue owner or waiter belongs.
RELATION
Indicates whether the data being returned is associated with owner or a UOW waiting for the enqueue.
OWNER
The data is associated with the owner of the returned enqueue.
WAITER
The data is associated with a waiter of the returned enqueue.
SHUNT_ACTION
The action that would be performed to this enqueue should its owning UOW be shunted. The possible values are as follows:
RELEASE
The enqueue will be released.
RETAIN
The enqueue will be retained.
IGNORE
The shunt will be ignored and the enqueue will remain in the same state.
STATE
The state that the enqueue is held in.
ACTIVE
The enqueue is held in active state.
RETAINED
The enqueue is held in retained state.
TRANSACTION_LIFETIME

For an enqueue returned with RELATION(OWNER) the number of times it is held with TRANSACTION lifetime.

For an enqueue returned with RELATION(WAITER) a count of one indicates that the enqueue was requested with TRANSACTION lifetime.

UOW_LIFETIME

For an enqueue returned with RELATION(OWNER) the number of times it is held with UOW lifetime.

For an enqueue returned with RELATION(WAITER) a count of one indicates that the enqueue was requested with UOW lifetime.



dfhs3_NQIBget_next_enqueue.html | Timestamp icon Last updated: Monday, 5 June 2017