Return Codes

When the IXLVECTR macro returns control to your program, GPR 15 (and retcode if you coded RETCODE) contains a hexadecimal return code with the following exception. If you coded BRANCHTABLE=YES, the return code will be available only in GPR 15.

The IXLYCON macro provides equate symbols for the return and reason codes.

The following tables contain hexadecimal return codes, their associated equate symbols, and the meaning and suggested action for each return code issued by each type of IXLVECTR REQUEST.

Table 1. Return Codes for the IXLVECTR Macro with the MODIFYVECTORSIZE Parameter
Hexadecimal Return Code	Equate Symbol Meaning and Action
0	Equate Symbol: IXLRETCODEMODIFYDONE Meaning: The list notification vector or local cache vector was modified as requested. Action: None.
4	Equate Symbol: IXLRETCODELESSTHAN Meaning: System error. The list notification vector or local cache vector is smaller than the size you requested because insufficient storage was available. The new number of vector entries is returned in the field specified by ACTUALVECLEN. Action: If you require a larger list notification vector, retry the request later when more storage might be available. If the problem persists, notify the system programmer so that the cause of the problem can be determined and corrected.
8	Equate Symbol: IXLRETCODENOSTORAGE Meaning: System error. Storage could not be obtained to increase the list notification vector or local cache vector size. The size remains unchanged. Action: Retry the request later when more storage might be available. If the problem persists, notify the system programmer so that the cause of the problem can be determined and corrected.
C	Equate Symbol: IXLRETCODEINVALIDTOKN Meaning: Program error. The vector token you specified is not valid. Action: Check your program for errors such as: You specified the address of the vector token incorrectly. The vector token has been overlaid or corrupted between the time you received it and the time you specified it on the IXLVECTR macro. You disconnected from the cache structure (using the IXLDISC macro) before issuing the IXLVECTR macro. You must be a connected user to issue IXLVECTR. The connector's task failed and the vector was cleaned up. Correct the error, and rerun the program.
10	Equate Symbol: IXLRETCODEINVALIDLEN Meaning: Program error. The vector length you specified is not valid. Action: The vector length must be greater than, or equal to, 1. Correct the error, and rerun the program.

Table 2. Return Codes for the IXLVECTR Macro with the LTVECENTRIES Parameter
Hexadecimal Return Code	Equate Symbol Meaning and Action
0	Equate Symbol: IXLRETCODEALLEMPVAL Meaning: All monitored objects in the range of vector entries are empty (list notification vector), or all local cache entries in the range of vector entries are valid (local cache vector). Action: None.
4	Equate Symbol: IXLRETCODESOMENEINV Meaning: Some list or event queue in the range of vector entries is non-empty (list notification vector), or some local cache entry in the range of vector entries is invalid (local cache vector). Action: None.
8	Equate Symbol: IXLRETCODEINDXINVALID Meaning: Program error. The vector index you specified is not valid. Action: Check your program for errors such as: You specified a vector index that is not a multiple of 32. You specified a vector index value less than zero. You specified a vector index value greater than, or equal to, the number of vector entries. Vector index values for a vector with N entries range from zero to N-1. You specified the address of the vector index value incorrectly. Correct the error, and rerun the program.
C	Equate Symbol: IXLRETCODEINVALIDTOKN Meaning: Program error. The vector token you specified is not valid. Action: Check your program for errors such as: You specified the address of the vector token incorrectly. The vector token has been overlaid or corrupted between the time you received it and the time you specified it on the IXLVECTR macro. You disconnected from the list structure (using the IXLDISC macro) before issuing the IXLVECTR macro. You must be a connected user to issue IXLVECTR. The connector's task failed and the vector was cleaned up. Correct the error, and rerun the program.

Table 3. Return Codes for the IXLVECTR Macro with the TESTLISTSTATE Parameter
Hexadecimal Return Code	Equate Symbol Meaning and Action
0	Equate Symbol: IXLRETCODELSTEMPTY Meaning: The list or event queue is empty. Action: None.
4	Equate Symbol: IXLRETCODELSTNONEMPTY Meaning: The list or event queue is not empty. Action: None.
8	Equate Symbol: IXLRETCODEINDXINVALID Meaning: Program error. The vector index you specified is not valid. Action: Check your program for errors such as: You specified a vector index value greater than, or equal to, the number of vector entries. Vector index values for a vector with N entries range from zero to N-1. You specified the address of the vector index value incorrectly. Another unit of work modified the vector size while this TESTLISTSTATE was being processed. Correct the error, and rerun the program.
C	Equate Symbol: IXLRETCODEINVALIDTOKN Meaning: Program error. The vector token you specified is not valid. Action: Check your program for errors such as: You specified the address of the vector token incorrectly. The vector token has been overlaid or corrupted between the time you received it and the time you specified it on the IXLVECTR macro. You disconnected from the list structure (using the IXLDISC macro) before issuing the IXLVECTR macro. You must be a connected user to issue IXLVECTR. The connector's task failed and the vector was cleaned up. Correct the error, and rerun the program.

Table 4. Return Codes for the IXLVECTR Macro with the TESTLOCALCACHE Parameter
Hexadecimal Return Code	Equate Symbol Meaning and Action
0	If you specified the VECTORINDEX parameter: Equate Symbol: IXLRETCODEBUFVALID Meaning: The data item in the local cache buffer is valid. Action: None. If you omitted the VECTORINDEX parameter: Equate Symbol: IXLRETCODECONNECTED Meaning: There has been no interruption of connectivity to the coupling facility. Cross invalidation is reflected for data items in the cache structure. Action: None.
4	If you specified the VECTORINDEX parameter: Equate Symbol: IXLRETCODEBUFNOTVALID Meaning: The data item in the local cache buffer is not valid. Action: Obtain new copy if the data item. If you omitted the VECTORINDEX parameter: Equate Symbol: IXLRETCODENOTCONNECTED Meaning: All vector index entries are invalid. Action: Obtain new copies of data items.
8	Equate Symbol: IXLRETCODEINDXINVALID Meaning: Program error. TESTLOCALCACHE was specified with a VECTORINDEX value that is not valid. Action: Check your program for errors such as: You specified a vector index value greater than, or equal to, the number of vector entries. You specified the address of the vector index value incorrectly. Another unit of work modified the vector size while this TESTLOCALCACHE was being processed. Correct the error, and rerun the program.
C	Equate Symbol: IXLRETCODEINVALIDTOKN Meaning: Program error. The vector token you specified is not valid. Action: Check your program for errors such as: You specified the address of the vector token incorrectly. You disconnected from the cache structure (using the IXLDISC macro) before issuing the IXLVECTR macro. You must be a connected user to issue IXLVECTR. The vector token has been overlaid or corrupted between the time you received it and the time you specified it on the IXLVECTR macro. The connector's task failed and the vector was cleaned up. Correct the error, and rerun the program.