z/OS MVS Programming: Sysplex Services Reference
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


Parameter Descriptions

z/OS MVS Programming: Sysplex Services Reference
SA38-0658-00

The parameter descriptions are listed in alphabetical order. Default values are underlined:
,ADJUNCT=NO
,ADJUNCT=CAPTURE
,ADJUNCT=DIRECTIO
Use this input parameter to specify whether or not the system should include adjunct data in the dump for all entries within the specified range. If the structure contains adjunct data, ADJUNCT specifies whether the adjunct data should be dumped.
NO
Do not dump adjunct data.
CAPTURE
While serialization is held, capture the adjunct data along with the entry controls.
DIRECTIO
After serialization is released, dump the adjunct data via direct I/O to the dump data set after the controls are captured.
,CONNAME=conname
Use this input parameter to specify the name of the connected user. When this keyword is specified for a cache structure, the VECTORINDEX with which the indicated user has registered interest in each entry that is dumped, will be included in the dump along with the directory entry information. When this keyword is specified for a list structure, it is ignored.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 16-character field that contains the name of the connected user.

,CONTOKEN=NONE
,CONTOKEN=contoken
Use this input parameter to specify the connect token that was returned by the IXLCONN service. The CONTOKEN uniquely identifies a user's connection to a structure. When this keyword is specified for a cache structure, the VECTORINDEX with which the indicated user has registered interest in each entry that is dumped, will be included in the dump along with the directory entry information. When this keyword is specified for a list structure, it is ignored.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 16-character field that contains the connect token returned by the IXLCONN service.

,DUMP=ALL
,DUMP=RANGE
Use this input parameter to specify the ranges to be dumped of a specified object.
ALL
All values of the specified object are to be dumped. If you also specify SUMMARY=NO (the default), the system dumps all the object controls and their associated entry controls. If you specify SUMMARY=YES, then only the object controls are dumped. For example:
  • If you specify OBJECT=COCLASS with DUMP=ALL and SUMMARY=NO, the system dumps all of the object controls and their associated entries in all of the cast-out classes.
  • If you specify OBJECT=COCLASS with DUMP=ALL and SUMMARY=YES, the system dumps only the object controls for all cast-out classes.
RANGE
A range of values of the specified object are to be dumped. If you also specify SUMMARY=NO (the default), the system dumps all the object controls and their associated entry controls. For example:
  • If you specify OBJECT=COCLASS with DUMP=RANGE and SUMMARY=NO, the system dumps the object controls for the range of cast-out classes and also the cast-out classes' entry controls.
  • If you specify OBJECT=COCLASS with DUMP=RANGE and SUMMARY=YES, the system dumps all of the object controls for the range of cast-out classes and no entries for any of the cast-out classes.
,ENDVAL=NONE
,ENDVAL=endval
Use this input parameter to specify the ending range value. If you do not specify ENDVAL or if you specify ENDVAL=NONE, then only the value specified for STARTVAL is dumped for this range.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a fullword field that contains the ending range value.

,ENTRYDATA=NO
,ENTRYDATA=UNSERIALIZE
,ENTRYDATA=SERIALIZE
Use this input parameter to specify whether or not entry data should be included in the dump for all the entries in the specified range.
NO
Do not dump the entry data.
UNSERIALIZE
Release structure dump serialization before writing entry data to the dump data set.
SERIALIZE
Keep structure dump serialization until after the entry data has been written to the dump data set.
,OBJECT=COCLASS
,OBJECT=STGCLASS
,OBJECT=LISTNUM
,OBJECT=EMCONTROLS
Use this input parameter to specify what type range should be dumped.
COCLASS
The requested range is a range of cast-out classes. Use COCLASS only if the requested structure is a cache structure. If the requested structure is not a cache structure, the system dumps nothing for this entry.
STGCLASS
The requested range is a range of storage classes. Use STGCLASS only if the requested structure is a cache structure. If the requested structure is not a cache structure, the system dumps nothing for this entry.
Note: If a data entry appears in both a castout class and a storage class and you request that both classes are to be dumped in two IHABLDP parameter list entries, the system dumps the entry twice.
LISTNUM
The requested range is a range of list numbers. Use LISTNUM only if the requested structure is a list structure. If the requested structure is not a list structure, the system dumps nothing for this entry.
EMCONTROLS
The requested range is a range of list numbers for which event monitor controls should be dumped. Use EMCONTROLS only if the requested structure is a keyed list structure allocated in a coupling facility with CFLEVEL=4 or higher. If the requested structure is not such a list structure, the system dumps nothing for this entry.
,OPTION=LOCKENTRIES
,OPTION=USERCNTLS
,OPTION=EVENTQS
Use this input parameter to specify the option you want in the dump.
LOCKENTRIES
Include the lock table entries associated with the requested structure in the dump. Use LOCKENTRIES only when the requested structure is a list structure.
USERCNTLS
Include the user attach controls in the dump.
EVENTQS
Include in the dump the user event queues for a list structure allocated in a coupling facility with CFLEVEL=4 or higher.
PARMAREA=parmarea
Use this output parameter to specify the name of the storage area that is to be used for building the dump parameter list. This storage area eventually will be passed as input to the SDUMPX macro.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the storage area that is to be used for building the dump parameter list.

,PARMLENGTH=parmlength
Use this input parameter to specify the length of the storage area used for the dump parameter list.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a fullword field containing the length, in bytes, of the storage area used for the dump parameter list.

,PLISTVER=IMPLIED_VERSION
,PLISTVER=MAX
,PLISTVER=plistver
Use this input parameter to specify the version of the macro. See Understanding IHABLDP Version Support for a description of the options available with PLISTVER.
,RETCODE=retcode
Use this output parameter to specify the location in which the system is to copy the return code from GPR 15.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a fullword field to contain the return code.

,RSNCODE=rsncode
Use this output parameter to specify the location in which the system is to copy the reason code from GPR 0.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a fullword field to contain the reason code.

,STARTVAL=startval
Use this input parameter to specify the starting range value.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a fullword field that contains the starting range value.

,STRNAME=strname
Use this input parameter to specify the name of the cache or list structure for which information is being requested.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 16-character field that contains the name of the cache or list structure for which information is being requested.

,SUMMARY=NO
,SUMMARY=YES
Use this input parameter to specify whether or not the dump should include only a summary of the object requested. If SUMMARY=YES, the entry control information is not included; only structure and class information is included in the dump.
NO
Do not do a summary dump of the requested object; include entry controls.
YES
Do a summary dump of the requested object; do not include entry controls.
,TYPE=INITIAL
,TYPE=STRUCTURE
,TYPE=STRRNG
,TYPE=STROPT
,TYPE=ENDLIST
Use this input parameter to specify the type of operation to be performed on the dump parameter list.
INITIAL
Initialize the storage to binary zeros and generate an initialized header for the STRLIST dump parameter list. The header for the dump parameter list is 24 bytes long.
STRUCTURE
Generate a structure entry in the STRLIST dump parameter list. The structure entry is 48 bytes long.
STRRNG
Generate a structure range entry in the STRLIST dump parameter list. The structure range entry is 12 bytes long.
STROPT
Generate a structure option entry in the STRLIST dump parameter list. The structure option entry is 12 bytes long.
ENDLIST
End building the STRLIST dump parameter list. You must specify ENDLIST when you complete building the STRLIST dump parameter list.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014