REWIND COUNTER and REWIND DCOUNTER

Rewind a named counter that has reached its limit (that is, the maximum number has been assigned).

Read syntax diagramSkip visual syntax diagram
REWIND COUNTER

>>-REWIND--COUNTER(name)--+------------+------------------------>
                          '-POOL(name)-'   

>--+-----------------------+-----------------------------------><
   '-INCREMENT(data-value)-'   

Conditions: INVREQ, SUPPRESSED

Read syntax diagramSkip visual syntax diagram
REWIND DCOUNTER

>>-REWIND--DCOUNTER(name)--+------------+----------------------->
                           '-POOL(name)-'   

>--+----------------------+------------------------------------><
   '-INCREMENT(data-area)-'   

Conditions: INVREQ, SUPPRESSED

 

Description

These counter commands reset the current value of the named counter to its defined mimimum number. COUNTER operates on fullword counters and DCOUNTER operates on doubleword counters.

For information about specifying fullword and doubleword variables on these named counter commands, see CICS command argument values.

Options

COUNTER(name)
specifies the name of the named counter that is to be reset to its minimum value. The name can be up to 16 alphanumeric characters. If name is a variable that contains a name that is less than 16 characters, the name must be padded with trailing blanks.
DCOUNTER(name)
specifies the name of the named counter that is to be reset to its minimum value. The name can be up to 16 alphanumeric characters. If name is a variable that contains a name that is less than 16 characters, the name must be padded with trailing blanks.
INCREMENT(data-value)
specifies, as a fullword signed binary value (doubleword unsigned binary value for DCOUNTER), an increment to be used in determining whether the named counter is in a valid state to be reset. If a previous GET command (which did not specify the REDUCE option) specified an increment that caused the GET command to fail, specify the same increment on the REWIND. The named counter server applies the increment before testing whether the counter is in a counter-at-limit condition.

See the the INCREMENT option on the GET command for more details.

POOL(poolname)
specifies an 8-character string to be used as a pool selection parameter to select the pool in which the named counter resides. The string can be a logical pool name, or the actual pool name.

Valid characters for the pool selector string are A through Z, 0 through 9, $ @ # and _ (underscore). If name is a variable that contains a name that is less than 8 characters, the name must be padded with trailing blanks.

This parameter is optional. If you omit the name of the pool, a pool selector value of 8 blanks is assumed.

If there is no matching entry in the DFHNCOPT options table, CICS uses the name specified on the NCPLDFT system initialization parameter, which specifies the default named counter pool.

For information about generating a named counter options table using the DFHNCO macro, see the CICS Application Programming Guide.

Conditions

INVREQ
RESP2 values:
201
Named counter not found.
301
The server has reported an error code that is not understood by the named counter interface. Generally, this is not possible unless the interface load module, DFHNCIF, is at a lower maintenance or release level than the server itself.
303
An unexpected error, such as structure failure or loss of connectivity, has occurred on a macro used to access the coupling facility. Further information can be found in message DFHNC0441 in the CICS job log.
304
The pool selection parameter specified in the program cannot be resolved to a valid server name using the current options table.
305
The interface is unable to establish a connection to the server for the selected named counter pool. Further information can be found in an AXM services message (AXMSCnnnn) in the CICS job log.
306
An abend occurred during server processing of a request. Further information can be found in a message in the CICS job log and the server job log.
308
The DFHNCOPT options table module, required for resolving a pool name, could not be loaded.
309
During processing of the options table, the named counter interface encountered an unknown entry format. Either the options table is not correctly generated, or the DFHNCIF interface load module is not at the same release level as the options table.
310
An options table entry matching the given pool name specified a user exit program, but the user exit program is not link-edited with the options table and cannot be loaded.
311
A response from the named counter server to the client region interface module, DFHNCIF, indicates that a system-managed rebuild is in progress but the EXEC CICS interface does not recognize the condition. This means that the CICS region is at CICS TS 2.1 or earlier.
403
The POOL parameter contains invalid characters or embedded spaces.
404
The COUNTER parameter contains invalid characters or embedded spaces.
406
The INCREMENT value is invalid. The value specified cannot be greater than the total range of the counter ((maximum value - minimum value) + 1).

Default action: terminate the task abnormally.

SUPPRESSED
RESP2 values:
102
The named counter has not yet reached its limit (that is, the current value is not equal to the maximum value plus 1, giving the counter-at-limit condition). This error condition is returned if the named counter is not at its limit even after applying any specified increment.

Default action: terminate the task abnormally.