gtpc2mbiC/C++ Language Support User's Guide

Error Code Summary

The following table contains a list of the TPF collection support (TPFCS) error codes with descriptions and user actions. Not all return codes are possible for every function. The individual TPFCS functions document the most common return codes for that function.

Table 46. Error Code Summary

Value Name of Error Description User Action
1 TO2_SUCCESS

TO2_IS_TRUE

TO2_IS_TRUE This is not an error; it indicates a return value of TO2_IS_TRUE from the original function call.
0 TO2_ERROR

TO2_IS_FALSE

TO2_IS_FALSE This is not an error; it indicates a return value of TO2_IS_FALSE from the original function call.
-1 TO2_ERROR_METHOD The application programming interface (API) or internal method is not known or is not supported for the collection type. Use a valid API for the collection (see Table 47).
-2 TO2_ERROR_ENV The environment pointer passed to a TPFCS API is not valid. Check the program logic.
-3 TO2_ERROR_USER The user token is zero or not valid. Enter a valid user token.
-4 TO2_ERROR_DATA_LGH The data length is too large or is not valid. Enter a valid data length.
-5 TO2_ERROR_LOCATOR_LGH The locator (key/value) length is too large or is not valid. Enter a valid key or value length.
-6 TO2_ERROR_SEQCTR There was an update sequence counter mismatch. When an update is attempted, the update sequence counter that is passed with the update must match the current update sequence counter maintained with the collection. Retrieve the element again for a successful update to take place and repeat the update request.
-7 TO2_ERROR_EXCEED_MAX_INDEX There was an attempt to add an entry beyond the maximum entry. Add the entry again ensuring it is not beyond the defined maximum entry value.
-8 TO2_ERROR_INDEX The index is not valid. The value is 0 or negative. Enter a valid index entry.
-9 TO2_ERROR_UNDEFINED_RECORD_TYPE The specified record type is not known by FACS. Enter a valid record type that is known by FACS or define it to FACS.
-10 TO2_ERROR_EODAD Access was attempted beyond the end of the data or was for an empty collection. This is a normal response when you reach the end of a collection while iterating through it.
-11 TO2_ERROR_CURSOR The cursor is not valid; positioning is required. Enter a valid cursor positioning request. The cursor positioning may have been lost because of an update activity for this collection.
-12 TO2_ERROR_EMPTY Access was attempted to an empty collection. None. This is a normal response.
-13 TO2_ERROR_RECORD_SIZE The specified record type is not defined as 4K. Define the record type as 4K or specify a different record type and try again.
-14 TO2_ERROR_CLASS_NOT_FOUND The specified class name was not found. Enter a valid class name.
-15 TO2_ERROR_PID The persistent identifier (PID) or a pointer is not known or is not valid. Use a valid PID.
-16 TO2_ERROR_PARAMETER The parameter passed is not valid. Use a valid parameter.
-17 TO2_ERROR_DBID The database name is not defined or is not valid. Enter a database name that is defined or that is valid.
-18 TO2_ERROR_USERTKN The user token is not defined or is not valid. Enter a user token that is defined or that is valid.
-19 TO2_ERROR_NOT_INIT TPFCS is not initialized. Initialize TPFCS using the ZOODB INIT command.
-20 TO2_ERROR_ACCESS_MISMATCH An incorrect mode was passed to a TO2_atRBAPut call. Check the logic in the application.
-21 TO2_ERROR_ZERO_PID The TPFCS PID is not valid. The PID is zero. Enter a valid PID.
-22 TO2_ERROR_LOCATOR_NOT_UNIQUE The TPFCS locator (key/value) is not unique. Enter a unique key or value.
-23 TO2_ERROR_LOCATOR_NOT_FOUND The TPFCS locator (key/value) is not found. Enter a valid key or value.
-24 TO2_ERROR_RECID_DEF The record ID is not defined or there is a definition in error. Define the record ID or determine if there is an error in the specified definition.
-25 TO2_ERROR_BUFFER_SIZE The passed buffer length is either too small (<20 bytes) or is negative. Use a valid buffer length.
-28 TO2_ERROR_IO_ERROR_ON_ACCESS There was a TPFCS input/output (I/O) error accessing the collection. TPFCS was unable to access the collection because of an irrecoverable I/O error. A SNAP dump was taken already to inform coverage programmers of the problem. None.
-29 TO2_ERROR_PROPERTY_TYPE The TPFCS property type that was specified was not valid. Specify a valid property type.
-30 TO2_ERROR_PROPERTY_MODE The TPFCS property mode that was specified was not valid. Use a valid property mode.
-31 TO2_ERROR_MODE_MISMATCH This error occurs when there is a property mode mismatch. There was an attempt to change a read-only property or to delete a property that cannot be deleted. Check the program logic.
-32 TO2_ERROR_DELETED_PID The persistent identifier (PID) is marked for deletion. Check the program logic. You should not be attempting to access a deleted PID. Check to see if the delete was valid or if the PID was deleted by mistake.
-33 TO2_ERROR_UPDATE_NOT_ALLOWED_GFS This is a TPFCS error that occurs when there is an attempt to update a collection when the get file storage (GFS) of the data store is not active. Activate GFS by cycling the system to NORM state and try again.
-34 TO2_ERROR_IO_RECID There was a record ID (RECID) error in the input/output (I/O) processing code. TPFCS was unable to access the collection because of an irrecoverable I/O error. A SNAP dump was taken already to inform coverage programmers of the problem. None.
-35 TO2_ERROR_IO_RCC There was a record code check (RCC) error in the input/output (I/O) processing code. TPFCS was unable to access the collection because of an irrecoverable I/O error. A SNAP dump was taken to inform coverage programmers of the problem. None.
-36 TO2_ERROR_IO_HARDWARE There was a record code check (RCC) error in the I/O processing code. TPFCS was unable to access the collection because of an irrecoverable I/O error. A SNAP dump was taken to inform coverage programmers of the problem. None.
-37 TO2_ERROR_DD_NOT_FOUND The specified data definition (DD) name was not defined. Specify a DD name that is defined.
-38 TO2_ERROR_NO_PROPERTY_DEFINED There are no properties defined for the collection. Define properties for the collection, if desired.
-39 TO2_ERROR_PROPERTY_NOT_DEFINED A TPFCS property is not defined for the PID. Define the property for the PID or specify a defined property.
-40 TO2_ERROR_RECID_DEF_MISMATCH There was a pool-type mismatch between assigned record IDs. Correct the pool-type mismatch and try again.
-41 TO2_ERROR_NOT_KEYED There was an attempt to add all the elements from the source collection to the target collection for a nonkeyed collection using the TO2_addAllFrom function. Check to be sure that the collection is a keyed collection and try again.
-42 TO2_ERROR_INITIALIZED There was an attempt to reinitialize TPF collection support and it is already initialized. None.
-43 TO2_ERROR_ADD_SAME_PID There was an attempt to add all the elements from the source collection to the target collection using the TO2_addAllFrom function. The source and target have the same persistent identifier (PID). Check the program logic. The target and source cannot have the same PID.
-48 TO2_ERROR_RECONSTRUCT_CHAIN There was an unrecognized chain given for reconstruction. Check the chain and try again.
-49 TO2_ERROR_INDEX_EXISTS There was an attempt to redefine an existing recoup index. Either delete the existing index and redefine it or, modify the existing index.
-50 TO2_ERROR_INDEX_UNKNOWN There was an attempt to access a recoup index that is not defined. Define the recoup index name or specify a defined one and try again.
-51 TO2_ERROR_OPTION_CODE The passed option code in the list is not defined. Define the option code and try again.
-52 TO2_ERROR_OPTION_LIST No list end is found or there is an option list pointer that is not valid; an internal error occurred.

Do one of the following:

  • Enter a valid option list pointer and try again.
  • Specify a list end and try again.
  • Contact your IBM service representative.

-53 TO2_ERROR_OPTION_VALUE The passed option list value pointer is not valid. Enter a valid option list value pointer.
-54 TO2_ERROR_LIST_TYPE There was an incorrect list type code passed on the TO2_createOptionList function. Enter a correct list type code for the TO2_createOptionList function.
-55 TO2_ERROR_IBMM4 There was an error accessing the required IBMM4 ordinals. Determine the cause of the error and try again.
-56 TO2_ERROR_NOTBSS A ZOODB INIT command request was issued in a subsystem other than the basic subsystem (BSS). The ZOODB INIT command is only supported when issued in the BSS. Enter the ZOODB INIT request again in the BSS.
-57 TO2_ERROR_RESTORE_PID_MISMATCH The persistent identifier (PID) of the restored collection does not match the input PID. Check to be sure the PID of the input and restored collections match.
-58 TO2_ERROR_TIMEOUT The device mount request timed out. The request was cancelled. Try the request again.
-59 TO2_ERROR_TAPE_FORMAT This error code is returned on restores when the record read does not match the expected record. Check the tape that is mounted to be sure it is the right tape. If it is not the correct tape, mount the correct tape. If the tape is the right tape, report the problem to your service representative.
-60 TO2_ERROR_DD_NAME_EXISTS The data definition (DD) name specified already exists. Use a unique DD name.
-61 TO2_ERROR_PID_NOT_DELETED The persistent identifier (PID) to reclaim is not marked for deletion. Mark the PID to be reclaimed for deletion and try again.
-62 TO2_ERROR_OPTION_CONFLICT This error occurs when an option on an option list either conflicts with another option or with an existing definition. Determine why there is a conflict with an option or with an existing definition and try again.
-63 TO2_ERROR_NO_XTERNAL_DEVICES There are no external devices currently available. Wait until the external devices that are in use are available or allocate more external devices. In either case, the application that was attempting to use the external device must reissue the request that needed the device.
-64 TO2_ERROR_NO_XTERNAL_DEFINED There are no external devices defined to the system. Allocate one or more external devices and reissue the request.
-65 TO2_ERROR_PERMANENT_XTERNAL There is a permanent hardware error when an attempt was made to use an external device. The device should be examined to determine the cause of the error.
-66 TO2_ERROR_ADD_FROM_BLOB There was an attempt to add all from a BLOB. You can only copy a BLOB to another BLOB or copy another collection to a BLOB. Enter the request again.
-67 TO2_ERROR_RECOUP_ABORT The recoup abort flag was found set. This error code is only returned for a TO2_recoupCollection function call. None.
-68 TO2_ERROR_DEADLOCK A deadlock condition has been detected. Analyze the locking protocols used to access the collection that received the deadlock error by looking for an access path that does not follow the same locking protocol as the current program. Once the path has been determined, you must determine which protocol is correct and make all the accesses to the collection follow the same locking protocol. If the locking protocol of the application is correct, see your system programmer to make sure that there is no underlying locking problem in TPF collection support.
-69 TO2_ERROR_NODELETE The specified access mode of the persistent identifier (PID) has been set to not allow deletion. To delete the PID, change the access mode to allow deletion.
-70 TO2_ERROR_STORAGE The TO2_getBLOB function was not able to allocate a large enough malloc storage area to hold the specified PID. The PID will have to be read using either the TO2_getBLOBWithBuffer function or in parts by using the TO2_atRBA function.
-71 TO2_ERROR_KEYPATH_BUILD_ACTIVE The process of creating the specified key path has not completed successfully. Therefore, the key path is not usable. Issue the TO2_setKeyPath request again after a delay to allow the build process to end.
-72 TO2_ERROR_CORRUPTED COLLECTION The object part in the control record has a corrupted object identifier (ID). Report this error to your system programmer who may be able to correct the problem by restoring the collection or patching the corrupted control record.
-73 TO2_ERROR_MAX_KEYPATHS The maximum number of key paths for this collection has been reached. Delete an old key path first and then add the new key path.
-74 TO2_ERROR_RESERVED_NAME The name you specified for the function is a TPFCS reserved name. Enter the function again and specify another name.
-75 TO2_ERROR_GFS TPFCS processing could not be completed because get file storage (GFS) is not active. Cycle the system to CRAS state or above and repeat the request.
-76 TO2_ERROR_DS_INUSE An attempt was made to delete, migrate, or re-create a data store by an entry control block (ECB) that is using the data store. Repeat the request after this ECB deletes all environments associated with this data store.
-77 TO2_ERROR_SUBSYSTEM An attempt was made to delete, migrate, or re-create a data store from a subsystem other than the owning subsystem. Repeat the request from the owning subsystem, which can be determined by entering the ZOODB DISPLAY command with the DS parameter specified.
-100 TO2_ERROR_NO_ROOM There is no room in malloc storage to hold the requested collection. Expand storage and try again.
-101 TO2_ERROR_UNASSIGNED_RRN The relative record number (RRN) you requested is unassigned. Assign a RRN and try again.
-102 TO2_ERROR_RRN_ASSIGNED The RRN to be assigned is already assigned. Assign a RRN that isn't already assigned and try again.
-103 TO2_ERROR_REREAD There was a read sequencing error. The collection must be read again. Reissue the request after a short delay. If the request still fails, assume a hard error and take appropriate action for the application being run.
-104 TO2_ERROR_RRN_CHANGED The RRN directory entry value has changed. Determine the correct RRN and try again.
-105 TO2_ERROR_REREAD_PREVIOUS There was a previous read sequencing error. Enter the request again.
-200 TO2_ERROR_LOGIC_COLLECT There is a logic error in the collection processing code. Check the program logic and try again.
-210 TO2_ERROR_LOGIC_CURSOR There is a logic error in the cursor processing code. Check the program logic and try again.
-220 TO2_ERROR_LOGIC_IO There is a logic error in the input/output (I/O) processing code. Check the program logic and try again.
-221 TO2_ERROR_NO_SHADOW There was a logic error when an attempt was made to read a shadow that does not exist. Check the program logic and try again.
-230 TO2_ERROR_LOGIC_STRUCT There is a logic error in the STRUCTURE processing code. Check the program logic and try again.
-240 TO2_ERROR_LOGIC_DIRECT There is a logic error in the DIRECTORY processing code. Try the request again and if the error persists, consider the collection unavailable. TPFCS will dump on any logic error code.
-250 TO2_ERROR_LOGIC_MALOC The requested malloc storage was unable to be allocated. None. TPFCS will exit the entry control block (ECB) if it is unable to allocate maloc storage for its processing requirement.
-300 TO2_ERROR_XTERNAL This is used to offset external device support errors. None.
-301 TO2xd_ERROR_archiveUnavail This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-302 TO2xd_ERROR_levelInUse This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-303 TO2xd_ERROR_maxArchive This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. None.
-304 TO2xd_ERROR_notOpen This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-305 TO2xd_ERROR_noDDN This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-306 TO2xd_ERROR_noPosition This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-307 TO2xd_ERROR_positionIncorrect This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-308 TO2xd_ERROR_readOnly This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-309 TO2xd_ERROR_recordTooLong This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-310 TO2xd_ERROR_recordTooShort This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-311 TO2xd_ERROR_timeOut This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. None.
-312 TO2xd_ERROR_VOLSERmismatch This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-313 TO2xd_ERROR_EOVwarning This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-314 TO2xd_ERROR_HWerror This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-315 TO2xd_ERROR_SDAunavail This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-316 TO2xd_ERROR_SDAwarning This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-317 TO2xd_ERROR_VOLSERinUse This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-318 TO2xd_ERROR_noToken This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-319 TO2xd_ERROR_unableToPosition This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-320 TO2xd_ERROR_writeOnly This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-321 TO2xd_ERROR_EOVerror This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-322 TO2xd_ERROR_alreadyOpen This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-323 TO2xd_ERROR_noBlock This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-324 TO2xd_ERROR_notBaseSSU This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-325 TO2xd_ERROR_noARCHIVEgroup This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. None.
-326 TO2xd_ERROR_noArchiveSDA This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. None.
-327 TO2xd_ERROR_libraryNotFound This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. None.
-328 TO2xd_ERROR_tapeBlocked This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.
-329 TO2xd_ERROR_logic This is used to map the TPFxd_ error numbers out of the TPFCS error numbers. This error code is only returned on a TO2_capture, TO2_restore, TO2_restoreAsTemp, or TO2_restoreWithOptions request. To convert a TPFCS error code to a TPFxd_ error code, subtract 300 from the TPFCS error code. See External Device Support for more information. None.