Parameter Descriptions

The parameter descriptions are listed in alphabetical order. Default values are underlined.

,ABDPLPTR=abdplptr

Use this input parameter to specify the address of the ABDUMP parameter list (ABDPL) that the system currently is using.

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

,ADJUNCT=NO

,ADJUNCT=YES

Use this input parameter to specify whether the adjunct data associated with the requested entries should be returned with the entries. The STRBENTRY mapping for each entry points to the adjunct data and also provides the length of the adjunct data.

NO: Do not return adjunct data.
YES: Do return adjunct data.

ANSAREA=ansarea

Use this output parameter to identify the answer area.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the answer area.

,ANSLEN=anslen

Use this input parameter to specify the length of the answer area.

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

,CLASSLEVEL=SUMMARY

,CLASSLEVEL=DETAIL

,CLASSLEVEL=ENTRY

Use this input parameter to specify the level of the CLASS type request.

SUMMARY: Information about a requested class, a range of classes, or all classes (castout or storage) in the dump. The STRBSUMMARY mapping of IXLZSTRB maps the entries in the answer area.
DETAIL: Detailed information about a requested class, a range of classes, or all classes (castout or storage) in the dump. The STRBDETAIL mapping of IXLZSTRB maps the entries in the answer area. The entry also contains a pointer to the class controls information. For storage class information, the DSCC mapping in IXLYDSCC maps the storage class controls. For castout class information, the DCCC mapping in IXLYDCCC maps the castout class controls.
ENTRY: An entry at a requested position, a group of entries at a requested range of positions, or the entries at all entry positions that were dumped in a requested class. The STRBENTRY mapping of IXLZSTRB maps the entries in the answer area. The entry also contains a pointer to the entry control information. The DDIC mapping in IXLYDDIB maps the entry controls.

,CLASSTYPE=CASTOUT

,CLASSTYPE=STORAGE

Use this input parameter to specify the type of class that should be retrieved.

CASTOUT: Castout classes
STORAGE: Storage classes

,CLASSVAL=classval

Use this input parameter to identify the class for which data entries will be retrieved.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the fullword field that contains the class for which data entries will be retrieved.

,CONIDVAL=conidval

Use this input parameter to specify the connection ID for which the system will retrieve event monitor control entries on the event queue.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a one-byte field that contains the connection ID for which event monitor control information is being requested.

,EMCLEVEL=SUMMARY

,EMCLEVEL=EMC

Use this input parameter to specify the level of the EMCONTROLS type request.

SUMMARY: The list of event monitor controls in the list structure that was requested to be dumped. The system returns information for a list number, a range of list numbers, or all list numbers in the dump. The STRBSUMMARY mapping of the IXLZSTRB macro maps the entries in the answer area.
EMC: Event monitor controls that were dumped for the requested list structure. The STRBEMCDETAIL mapping of the IXLZSTRB macro maps the entries in the answer area. The STRBEMCDETAIL contains a pointer to the event monitor controls in the answer area. The DEMC mapping of the IXLYDDIB macro maps the event monitor controls entry.

,ENDPOS=STARTPOS

,ENDPOS=endpos

Use this input parameter to specify the end of the requested entry position range. If you do not specify this keyword, the ending range position will be equal to the starting range position specified on the STARTPOS keyword.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a fullword field that contains the end of the requested entry position range. ENDPOS is an optional keyword. The default is STARTPOS.

,ENDVAL=STARTVAL

,ENDVAL=endval

Use this input parameter to specify the end of the requested class range. If you do not specify this keyword, the ending range value will be equal to the starting range value specified on the STARTVAL keyword.

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

,ENTRYDATA=NO

,ENTRYDATA=YES

Use this input parameter to specify whether the entry data associated with the requested entries should be returned with the entries. The STRBENTRY mapping for each entry points to the entry data and also provides the total length of the entry data. If the buffer fills up before all entry data is returned, the STRBENTRY mapping provides the length of the entry data that has been returned.

NO: Do not return entry data.
YES: Do return entry data.

,ENTRYID=entryid

Use this input parameter to specify the list entry identifier of the list entry to be retrieved. This keyword should be used only if the requested structure is a list structure.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the 12-character field that contains the list entry identifier of the list entry to be retrieved.

,ENTRYKEY=entrykey

Use this input parameter to identify the key to be used for retrieving list entries. If this keyword is specified, only list entries with the requested key will be returned.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the 16-character field that contains the key to be used for retrieving list entries.

,ENTRYNAME=entryname

Use this input parameter to specify the name of the data entry or list entry to be retrieved.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the 16-character field that contains the name of the data entry or list entry to be retrieved.

,EQLEVEL=DETAIL

,EQLEVEL=EMC

Use this input parameter to specify the level of the EVENTQS type request.

DETAIL: Detailed information about a requested connection ID, a range of connection IDs, or all connection IDs in the dump. The STRBDETAIL mapping of the IXZLSTRB macro maps the entries in the answer area. In the STRBDETAIL entry, there is a pointer to the event queue controls in the answer area. The DEQC mapping of the IXLYDEQC macro maps the event queue controls. The STRBDETAIL entry also contains the length of the event queue controls.
EMC: Event monitor controls entries associated with the event queue of the requested connection ID. The STRBEMCDETAIL mapping of the IXLZSTRB macro maps the entries in the answer area. In the STRBEMCDETAIL entry, there is a pointer to the event monitor controls in the answer area. The DEMC mapping of the IXLYDDIB macro maps the event monitor controls.

,LISTNUMLEVEL=SUMMARY

,LISTNUMLEVEL=DETAIL

,LISTNUMLEVEL=ENTRY

Use this input parameter to specify the level of the LISTNUM request. You can request summary information about all list numbers, detail information about specific list numbers, or information about entry positions.

SUMMARY: Information about the list numbers in the requested structure that was dumped. You can specify a specific list number, a range of list numbers, or all list numbers in the dump. The STRBSUMMARY mapping of IXLZSTRB maps the entries in the answer area.
DETAIL: Detailed information about a specific list number, a range of list numbers, or all list numbers in the dump. The STRBDETAIL mapping of IXLZSTRB maps the entries in the answer area. The STRBDETAIL mapping includes a pointer to the list controls in the answer area and the length of the list controls. The DLC mapping of IXLYDLC maps the list controls.
ENTRY: Information for a particular list number about an entry at a specific position, a group of entries at a range of positions, or the entries at all positions in the dump. The STRBENTRY mapping of IXLZSTRB maps the entries in the answer area. The STRBENTRY also contains a pointer to the entry controls in the answer area. The DDIL mapping of IXLYDDIB maps the entry controls.

,LISTNUMVAL=listnumval

Use this input parameter to specify the list number for which list entries are to be retrieved.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a fullword field that contains the list number for which entries are to be retrieved.

,MF=S

,MF=(L,mfctrl)

,MF=(L,mfctrl,mfattr)

,MF=(L,mfctrl,0D)

,MF=(E,mfctrl)

,MF=(E,mfctrl,COMPLETE)

Use MF=S to specify the standard form of the macro, which builds an inline parameter list and generates the macro invocation to transfer control to the service.

Use MF=L to specify the list form of the macro. Use the list form together with the execute form of the macro for applications that require reentrant code. The list form defines an area of storage that the execute form uses to store the parameters. Only the PLISTVER parameter can be coded with the list form of the macro.

Use MF=E to specify the execute form of the macro. Use the execute form together with the list form of the macro for applications that require reentrant code. The execute form stores the parameters into the storage area defined by the list form, and generates the macro invocation to transfer control to the service.

,mfctrl: Use this output parameter to specify a storage area to contain the parameters.
To Code: Specify the RS-type name or address (using a register from 2 to 12) of the parameter list.
,mfattr: Use this input parameter to specify the name of a 1- to 60-character string that can contain any value that is valid on an assembler DS pseudo-op. You can use this parameter to force boundary alignment of the parameter list. If you do not code mfattr, the system provides a value of 0D, which forces the parameter list to a doubleword boundary.
,COMPLETE: Use this input parameter to require that the system check for required parameters and supply defaults for omitted optional parameters.
Note: In the macro expansion you might see some defaults for optional parameters that are not documented here. The ones that are not documented do not have any effect on the macro. For example, if SMILE=var were an optional parameter and the default is SMILE=NO_SMILE then it would not be documented. However, if the default was SMILE=:-), then it would be documented because a value would be the default.

,ORDER=HEAD

,ORDER=TAIL

Use this input parameter to specify the order in which entries for the requested class are to be returned. For a storage class, the head of the queue represents the least recently referenced entry and the tail of the queue represents the most recently referenced entry. For a castout class, the head of the queue represents the most recently changed entry and the tail of the queue represents the least recently changed entry.

HEAD: Entries are in head-to-tail order. If you also specify the keywords STARTPOS/ENDPOS, the system returns the entries in head-to-tail order.
TAIL: Entries are in tail-to-head order. If you also specify the keywords STARTPOS/ENDPOS, the system returns the entries in tail-to-head order.

,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.

,RESTOKEN=restoken

Use this input parameter to specify a 64-byte token that must be passed on all IXLZSTR requests. The token allows a request to be continued across multiple calls if all the requested data could not be returned in the answer area. Before your first request to access the data, you must initialize the field to binary zeros. On every request, the IXLZSTR service initializes RESTOKEN with information required on subsequent IXLZSTR requests. Therefore, the user who is requesting the data must not modify the contents of RESTOKEN.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the 64-character field that must be passed on all IXLZSTR requests.

,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.

,STARTPOS=ALL

,STARTPOS=startpos

Use this input parameter to specify the start of the requested entry position range. If you do not specify this keyword, all of the entries in the dump for the requested class will be returned.

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

,STARTVAL=ALL

,STARTVAL=startval

Use this input parameter to specify the start of the requested class range. If you do not specify this keyword, all of the classes requested to be dumped will be returned.

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

,STRDUMPID=strdumpid

Use this input parameter to specify the structure dump ID of structure being requested.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a halfword field that contains the structure dump ID.

,STRLEVEL=SUMMARY

,STRLEVEL=DETAIL

Use this input parameter to specify the level of the STRUCTURE request.

SUMMARY: A list of all the structures and their types that are in the dump. STRBSTRSUMMARY maps the entries in the answer area.
DETAIL: Detailed information about a requested structure. STRBSTRDETAIL maps the entry in the answer area. The entry also contains a pointer to the structure control information. For a cache structure, the DCAC mapping in IXLYDCAC maps the structure controls. For a list structure, the DLIC mapping in IXLYDLIC maps the structure controls.

,STRNAME=strname

Use this input parameter to specify the name of the 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 structure for which information is being requested.

,TYPE=STRUCTURE

,TYPE=CLASS

,TYPE=LISTNUM

,TYPE=LOCKINDEX

,TYPE=USER

,TYPE=ENTRY

,TYPE=EMCONTROLS

,TYPE=EVENTQS

Use this input parameter to specify the type of information to be retrieved by the IXLZSTR macro from the dump data set.

STRUCTURE: Structure information.
CLASS: Castout class or storage class information. Use CLASS only for a cache structure.
LISTNUM: List number information. Use LISTNUM only for a list structure.
LOCKENTRIES: Detailed information about a requested lock entry, a range of lock entries, or all entries in the lock table for a requested list structure. IXLZSTR returns only the non-zero lock table entries. Use LOCKENTRIES only for a list structure. The DLTE mapping in IXLYDDIB maps the entries in the answer area.
USERCNTLS: Detailed information about a requested connection ID, a range of connection IDs, or all connection IDs for a requested structure. For a cache structure, the DLCCB mapping in IXLYDDIB maps the entries in the answer area. For a list structure, the DLUCB mapping in IXLYDDIB maps the entries in the answer area.
ENTRY: Detailed information about a requested entry name or entry ID in a requested structure. The STRBENTRY mapping in IXLZSTRB maps the entry in the answer area. The entry also contains a pointer to the entry controls. For a cache structure, the DDIC mapping in IXLYDDIB maps the entry controls. For a list structure, the DDIL mapping in IXLYDDIB maps the entry controls.
EMCONTROLS: Event monitor control information. Use EMCONTROLS only for a keyed list structure allocated in a coupling facility with CFLEVEL=4 or higher. The DEMC mapping in IXLYDDIB maps the event montitor controls.
EVENTQS: Event queue control informaton. Use EVENTQS only for a keyed list structure allocated in a coupling facility with CFLEVEL=4 or higher. IXLYDEQC maps the event queue controls.