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:
,ACTUALVECLEN=actualveclen
Use this output parameter to specify a fullword field to receive the count of the new number of entries for the list notification vector or local cache vector after your MODIFYVECTORSIZE request has been processed. This field is valid only when a return code of X'4' is returned.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the fullword field to contain the new vector length if it differs from the requested vector length.

,ALLEMPVAL=allempval
Use this input parameter to specify the label to branch to if all monitored objects (comprised of lists and/or the user's event queue) in the range of vector entries are EMPTY (list notification vector), or if all vector entries are VALID (local cache vector).

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

,BITSTRING=bitstring
BITSTRING is a required output field that contains vector entry state information for the range of vector entries specified. This field contains 32 bits. The first bit represents the first vector index entry specified on the VECTORINDEX parameter and continues up to a maximum of 32 vector index entries. The bits are interpreted as follows:
  • 0 - the vector entry corresponding to this bit position indicates that the monitored list or event queue is NON-EMPTY (list notification vector) or that the local cache entry is INVALID (local cache vector).
  • 1 - the vector entry corresponding to this bit position indicates that the monitored list or event queue is EMPTY (list notification vector) or that the local cache entry is VALID (local cache vector).

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

,BRANCHTABLE=NO
,BRANCHTABLE=YES
Use BRANCHTABLE=NO to specify that IXLVECTR should not generate a branch table.

With the MODIFYVECTORSIZE request, use BRANCHTABLE=YES to specify that IXLVECTR should generate a branch table using the labels you specify for MODIFYDONE, LESSTHAN, NOSTORAGE, INVALIDTOKN, and INVALIDLEN.

With the LTVECENTRIES request, use BRANCHTABLE=YES to specify that IXLVECTR should generate a branch table using the labels you specify for ALLEMPVAL, SOMENEINV, INDXINVALID, and INVALIDTOKN.

With the TESTLISTSTATE request, use BRANCHTABLE=YES to specify that IXLVECTR should generate a branch table for you using the labels you specify for LSTEMPTY, LSTNONEMPTY, INDXINVALID, and INVALIDTOKN.

Note: When BRANCHTABLE=YES is specified, the return code will only be available in register 15.
,INDXINVALID=indxinvalid
Use this input parameter to specify the label to branch to if the IXLVECTR service detects that the index value you specified is not valid.

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

,INVALIDLEN=invalidlen
Use this input parameter to specify the label to branch to if the value you specify using the VECTORLEN parameter is not valid.

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

,INVALIDTOKN=invalidtokn
Use this input parameter to specify the label to branch to if the vector token you specified was not valid.

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

,LESSTHAN=lessthan
Use this input parameter to specify the label to branch to if the IXLVECTR service cannot obtain sufficient storage to enlarge your list notification vector or local cache vector to the size you requested.

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

,LSTEMPTY=lstempty
Use this input parameter to specify the label to branch to if the IXLVECTR service finds the list or event queue of interest empty.

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

,LSTNONEMPTY=lstnonempty
Use this input parameter to specify the label to branch to if the IXLVECTR service finds the list or event queue of interest non-empty.

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

,MODIFYDONE=modifydone
Use this input parameter to specify the label to branch to if the IXLVECTR service is able to modify the list notification vector or local cache vector as requested.

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

,NOSTORAGE=nostorage
Use this input parameter to specify the label to branch to if the IXLVECTR service cannot obtain any storage to enlarge your list notification vector or local cache vector to the size you requested. The vector's size remains the same.

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

,REQUEST=MODIFYVECTORSIZE
,REQUEST=LTVECENTRIES
,REQUEST=TESTLISTSTATE
,REQUEST=TESTLOCALCACHE
Use REQUEST=MODIFYVECTORSIZE to modify the size of your list notification vector or local cache vector.

Use REQUEST=LTVECENTRIES to load and test a range of vector entries associated with a local vector for either a list or cache structure.

Use REQUEST=TESTLISTSTATE to test whether a list or an event queue you are monitoring is empty or non-empty.

Use REQUEST=TESTLOCALCACHE to test whether a data item in your local cache buffer is valid.

,RETCODE=retcode
Use this output parameter to specify a fullword field to contain the return code, which is also returned in register 15.

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

,SOMENEINV=someneinv
Use this input parameter to specify the label to branch to if some monitored objects (comprised of lists and/or the user's event queue) in the range of vector entries are NON-EMPTY (list notification vector), or if some entries in the range of vector entries are INVALID (local cache vector).

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

,VALIDATE=YES
,VALIDATE=NO
Use VALIDATE=YES with TESTLOCALCACHE as follows:
  • When you omit VECTORINDEX, to request that the system validate connectivity to the coupling facility
  • When you specify VECTORINDEX, to request that the system validate connectivity to the coupling facility and check the validity of a particular data item

Use VALIDATE=NO with TESTLOCALCACHE and VECTORINDEX to request that the system check the validity of a particular data item without validating connectivity to the coupling facility. You would choose this option only if a previous serialized request was done with VALIDATE=YES and the serialization has not yet been released.

,VECTORINDEX=vectorindex
With the LTVECENTRIES request, use this input parameter to specify the starting index of the range of vector entries that are to be loaded and tested. The index specified must be evenly divisible by 32. Thirty two consecutive vector entries will be loaded and tested. The vector index for a given vector size of N goes from zero to N-1.

With the TESTLISTSTATE request, use this input parameter to specify a fullword field that contains the vector index entry associated with the list or event queue of interest. For a vector with N entries, valid vector index values range from zero to N-1. The association between the particular index number and the list or event queue must already be established using the IXLLIST macro.

With the TESTLOCALCACHE request, use this input parameter to specify a fullword field that contains the vector index entry to be tested for validity. For a vector with N entries, valid vector index values range from zero to N-1. The association between the particular index number and the data item must already be established using the IXLCACHE macro.

For more information about the IXLLIST or IXLCACHE macros, see z/OS MVS Programming: Sysplex Services Guide.

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

,VECTORLEN=vectorlen
Use this input parameter to specify a fullword field containing the new total number of entries in the list notification vector or local cache vector. The new number of entries can be greater than or less than the current number of entries but must be greater than zero and be a multiple of 32. If you specify a number that is not a multiple of 32, the system will round up the number to a multiple of 32.

The system will attempt to expand or contract your vector to the size you specify.

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

VECTORTOKEN=vectortoken
Use this input parameter to identify the list notification vector or local cache vector on which the specified request is to be performed.

The local vector was initially created by the IXLCONN service, if requested, and the vector token was returned in the connect answer area (IXLYCONA) in the field CONAVECTORTOKEN.

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

,WORKAREA=workarea
Use this input parameter to specify a 20-byte save area to be used by the IXLVECTR service.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 20-character field that begins on a word boundary.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014