The possible return codes for CPIC commands are listed here in numerical order. The
mnemonics provided with the description are not TSD Script system-defined constants. They
are provided here as models for any constants you wish to define.
Return Code |
Description |
1 |
CPIC_SUCCESS. This value is returned by all CPIC commands which complete
successfully. |
-1 |
CM_ALLOCATE_FAILURE_NO_RETRY. The attempted conversation allocations
failed. The condition probably requires user intervention to fix the node services
configuration. The current (LU, mode) session limit for the specified (LU-name, mode-name)
pair might be 0 or there might be a system definition error. Try changing to a different
mode name for the conversation. |
-2 |
CM_ALLOCATE_FAILURE_RETRY. The attempted conversation allocation failed
due to a condition that may be temporary. Usually this is caused by a temporary lack of
resources at one of the LUs involved in the conversation. The application retries the
command automatically. |
-3 |
CM_CONVERSATION_TYPE_MISMATCH. The partner LU rejected the request
because the partner does not support the conversation type of the conversation. This code
is returned on a call subsequent to CPICAllocate. |
-5 |
CM_PIP_NOT_SPECIFIED_CORRECTLY. The partner LU rejected the allocation
request because the remote application has one or more application initialization
parameters (PIP) variables defined. This type of call would have to be made to a non-CPIC
API. |
-6 |
CM_SECURITY_NOT_VALID. The remote LU rejected the request because the
access security information is invalid. This information is provided by the local node
services system. Usually, this occurs when you have set security required in the CPIC side
information, but have not yet logged on to the local node services. Alternatively, your
logon password is not valid on the remote machine. |
-7 |
CM_SYNC_LVL_NOT_SUPPORTED_LU. The sync level your application has
requested is not supported by the remote LU. CPIC only supports sync levels of $CPICNone
and $CPICConfirm. It does not support a sync level of SYNC_POINT. |
-8 |
CM_SYNC_LVL_NOT_SUPPORTED_PGM. The sync level your application requested
is not supported by the partner application. CPIC only supports sync levels of $CPICNone
and $CPICConfirm; it does not support a sync level of SYNC_POINT. |
-9 |
CM_TPN_NOT_RECOGNIZED. The remote LU rejected the request because the
local application specified a TP name that the remote LU does not recognize. |
-10 |
CM_TP_NOT_AVAILABLE_NO_RETRY The remote LU rejected the allocation
request because the local application specified a TP that the remote LU recognizes but
cannot start. Some user intervention is required. |
-11 |
CM_TP_NOT_AVAILABLE_RETRY. The remote LU rejected the request because the
local application specified a TP that the remote LU recognizes but currently cannot start.
This condition may be temporary. |
-17 |
CM_DEALLOCATED_ABEND. The remote application deallocated with the
deallocate type set to abend, or else the remote LU deallocated because the remote
application ended abnormally. |
-18 |
CM_DEALLOCATED_NORMAL. The remote application deallocated the
conversation in a normal state. |
-19 |
CM_PARAMETER_ERROR. The local application issued a CPIC command
specifying an invalid parameter. Note that the term "parameter" includes
characteristics associated with the conversation ID. Therefore, the problem could lie
within some values in the CPIC side information. |
-20 |
CM_PRODUCT_SPECIFIC_ERROR. Indicates that the calling application (in
this case, Tivoli Service Desk (TSD) Developer's Toolkit) has detected an error and cannot
continue the conversation. Often this is caused in OS/2 when you have not set the APPCTPN
environment variable before starting a CPIC application. |
-21 |
CM_PROGRAM_ERROR_NO_TRUNC. The remote application issued a SendError
call on a mapped or basic conversation. No data was truncated in the operation. |
-22 |
CM_PROGRAM_ERROR_PURGING. The remote application issued SendError.
If the remote application was in Receive or Confirm state, information may be purged. |
-23 |
CM_PROGRAM_ERROR_TRUNC. The remote application issued SendError
on a basic conversation and the call truncated a logical record. |
-24 |
CM_PROGRAM_PARAMETER_CHECK. Your CPIC application issued a CPIC command
with invalid parameter information. The most common occurrences of this return code are
caused by bad SDNs (such as wrong case) or a conversation ID which as not yet been
initialized. This could include characteristics associated with the conversation ID. In
this case, the source of the problem is under control of the local application. |
-25 |
CM_PROGRAM_STATE_CHECK. Your application issued a CPIC command which is
invalid in the current state. For example, your application attempted to send data when
the application was in Receive state. |
-26 |
CM_RESOURCE_FAILURE_NO_RETRY. A failure has caused the conversation to be
prematurely terminated. The condition is not temporary, for instance, the application
should not attempt the command again without outside intervention. |
-27 |
CM_RESOURCE_FAILURE_RETRY. A failure has caused the conversation to be
prematurely terminated. The condition could be temporary, meaning that the application may
attempt the command again without outside intervention. |
-28 |
CM_UNSUCCESSFUL. The CPIC command did not execute successfully. |
-30 |
CM_DEALLOCATED_ABEND_SVC. The remote application may have deallocated the
basic conversation with an ABEND_SVC type. Alternatively, the remote application ended
abnormally and the node services system for the partner LU deallocated the conversation on
behalf of the remote application. This type of call would have to be made to a non-CPIC
API. |
-31 |
CM_DEALLOCATED_ABEND_TIMER. The remote application deallocated the basic
conversation with an ABEND_TIMER type. This type of call would have to be made to a
non-CPIC API. |
-32 |
CM_SVC_ERROR_NO_TRUNC. The remote application issued SendError
with a type of SVC and the verb did not cause truncation of a data record. Note that this
type of call would have to be made to a non-CPIC API. |
-33 |
CM_SVC_ERROR_PURGING. The remote application issued SendError
with a type of SVC and a data record may have been truncated. Note that this type of call
would have to be made to a non-CPIC API. |
-34 |
CM_SVC_ERROR_TRUNC. The remote application issued SendError
with a type of SVC and a data record was truncated. Note that this type of call would have
to be made to a non-CPIC API. |
-37 |
CM_OPERATION_NOT_ACCEPTED. A previous operation on the specified
conversation is not complete. This can occur in a multi-threaded application. |
-100 |
CM_TAKE_BACKOUT. The remote application issued an SAA resource recovery Backout
call. The local application must issue a Backout call to the last
synchronization point. This code is returned only for a conversation of type SYNC_POINT. |
-130 |
CM_DEALLOCATED_ABEND_BO. The remote application deallocated with a type
of DEALLOCATE_ABEND and the local application must issue a Backout call
to the last synchronization point. This code is returned only for a conversation of type
SYNC_POINT. |
-131 |
CM_DEALLOCATED_ABEND_SVC_BO. The remote application may have deallocated
the basic conversation with an ABEND_SVC type. Alternatively, the remote application ended
abnormally and the node services system for the partner LU deallocated the conversation on
behalf of the remote application. This type of call would have to have been to some
non-CPIC API. The local application must issue a Backout call to the last
synchronization point. This code is returned only for a conversation of type SYNC_POINT. |
-132 |
CM_DEALLOCATED_ABEND_TIMER_BO. The remote application deallocated the
basic conversation with an ABEND_TIMER type. This code is returned only for a conversation
of type SYNC_POINT. This type of call would have to be made to a non-CPIC API. |
-133 |
CM_RESOURCE_FAIL_NO_RETRY_BO. A failure caused the premature termination
of the conversation. This condition is not temporary, so the application should not retry
the command without outside intervention. The local application must issue a Backout
call to the last synchronization point. This code is returned only for a conversation of
type SYNC_POINT. |
-134 |
CM_RESOURCE_FAILURE_RETRY_BO. A failure has caused the premature
termination of the conversation. This condition may be temporary. This code is returned
only for a conversation of type SYNC_POINT. |
-135 |
CM_DEALLOCATED_NORMAL_BO. The remote application has deallocated the
conversation. The local application must now issue a Backout call to the last
synchronization point. This code is returned only for a conversation of type SYNC_POINT. |
Return Code |
Description |
-501 |
CPIC_GET_CONVTYPE_FAILED. During CPICAccept processing,
TSD Developer's Toolkit inquires about the type of incoming conversation (mapped or
basic). If this operation fails, TSD Developer's Toolkit does not support the incoming
conversation. |
-502 |
CPIC_OUT_OF_MEMORY. During processing of a CPIC command, a memory
allocation failed. |
-503 |
CPIC_SET_FILL_FAILED. During CPICAccept processing for
an incoming basic conversation, TSD Developer's Toolkit attempts to set the fill type to
FILL_LL. If this operation fails, TSD Developer's Toolkit does not support the incoming
conversation. |
-504 |
CPIC_TPNAME_CONV_FAILED. The process of converting the SNA service TP
names to service TP format failed. |
-505 |
CPIC_TPNAME_TOO_SHORT. The given TPName for the CPICSetSideInfo
command is too short to be a SNA service TP name. |
-506 |
CPIC_DEFAULT_CONVTYPE_FAILED. During processing of a CPICInitialize,
TSD Developer's Toolkit attempts to set the conversation type to mapped. This return code
results if the operation does not work. |
-507 |
CPIC_VARLEN_FOR_BASIC. TSD Developer's Toolkit detected a VAR field in a
DDF on a basic conversation. TSD Developer's Toolkit does not support variable length
fields for basic conversations. |
-508 |
CPIC_INVALID_CONVERSATION. The conversation ID passed into the CPIC is
not valid. A conversation must be initialized before it can be allocated. |
-509 |
CPIC_INVALID_SDN. The SDN specified in the CPIC command is invalid. |
-510 |
CPIC_INVALID_DDF_NAME. The parameter passed as the DDF name is invalid. |
-511 |
CPIC_INVALID_TP_NAME. The parameter passed as the TP name is not valid.
It may be $Unknown. |
-512 |
CPIC_INVALID_PLU_NAME. The parameter passed as the TP name is invalid. It
may be $Unknown. |
-513 |
CPIC_INVALID_PARAMETER. One of the reference parameters passed to the
CPIC command is invalid. It may be $Unknown. |
-514 |
CPIC_INVALID_VALUE. One of the value parameters passed to the CPIC
command is invalid. It may be $Unknown. |
Return Code |
Description |
-2501 |
CPIC_DDF_INVALID_TYPE. The type name specified for a field in the DDF is
invalid. |
-2502 |
CPIC_DDF_INVALID_FIELD_DECIMALS. A field decimal width specification is
incorrect in the DDF. |
-2503 |
CPIC_DDF_INVALID_FIELD_WIDTH. A field width specified in the DDF is
incorrect. |
-2504 |
CPIC_DDF_NO_FIELD_TYPE. No type was specified for a field in the DDF. |
-2505 |
CPIC_DDF_UNKNOWN_PARTNER_ATTRIB. An attribute in the Partner section of
the DDF is unrecognized. |
-2506 |
CPIC_DDF_UNRECOGNIZED_SECTION. There is an unrecognized section in the
DDF. |
-2507 |
CPIC_DDF_FILE_OPEN_ERROR. The DDF could not be opened. Make sure that the
name is spelled correctly, and that either you have specified the full PATH, or else the
PATH is in your DPATH environment variable. |
-2508 |
CPIC_DDF_FILE_READ_ERROR. The DDF was opened, but TSD Developer's Toolkit
could not read the file. Make sure you have read rights to the file. |
-2509 |
CPIC_DDF_FILE_CLOSE_ERROR. After reading from the DDF, TSD Developer's
Toolkit could not close the file. |
-2510 |
CPIC_DDF_NOT_SPECIFIED. No DDF was specified in the command. This occurs
when you have used the $SIZEOF or $INCLUDE commands in
your DDF but did not pass the DDF name to those commands. |
-2511 |
CPIC_DDF_DUPLICATE_FIELD. One of the fields in the DDF is defined twice. |
-2512 |
CPIC_DDF_INVALID_VAR_LEN. One of the fields in the DDF is declared as
type VAR, yet it is not the last field in the DDF. |
-2513 |
CPIC_BAD_VAR_LEN_PARAM. The TSD Script record field, which in the DDF was
of type VAR, is not a string field. |
Several of the CPIC commands use integer parameters as indicators for behavior. In
order to help make these commands more readable, TSD Script system constants are listed
which provide mnemonic names for these values.