Tivoli Service Desk 6.0 Developer's Toolkit Interface Designer Guide
It is a convention in TSD Script that a return code of one or greater is considered success, while a return code less than 0 indicates an error.
The following return codes are listed in numeric order for easier look-up. Note that the mnemonic is provided merely as a convention-these mnemonics are not TSD Script system-defined constants.
Return Code | Mnemonic |
5008 | KML_BLANK_STRING. This is returned by EMUClrTypeIn and EMUTypeIn when the given string contains ''. This is considered success, even though the TSD Script Interpreter does not type anything into the host screen for a blank string. |
6 | HARC_TRUNCATION. The operation was successful, but some truncation occurred. |
5 | HARC_LOCKED. The operation was successful, but the host keyboard is locked-meaning $EMUReset must be pressed before any typein commands are called. |
4 | HARC_BUSY. The operation was successful, but the host is displaying the Input Inhibited Indicator in the OIA. |
1 | KMLEMU_SUCCESS. The default return code for successful completion of a command. |
-1 | HARC_INVALID_PS. An EMU function was attempted with a CONNECTION which has not been initialized with the EMUConnect command. |
-2 | HARC_BAD_PARM. Internally a bad parameter has been submitted to the EHLLAPI system. |
-4 | HARC_BUSY. The session with which you are attempting to interact has the Input Inhibited Indicator displayed in the OIA. |
-5 | HARC_LOCKED. The host locked the terminal "keyboard," meaning no input is allowed until $EMUReset is pressed. |
-6 | HARC_TRUNCATION. Truncation of data occurred during the operation. |
-7 | HARC_INVALID_PS_POS. An invalid host screen position has been specified in the command. |
-9 | EMUAPI_SYSTEM_ERROR. A system error has been encountered. Most often, this indicates that a terminal session has not yet started. |
-11 | HARC_UNAVAILABLE. The resource (session) specified is unavailable at this time. Since EHLLAPI cannot "share" a terminal session with other applications. |
-12 | HARC_SESSION_STOPPED. The specified session has stopped. |
-31 | HARC_QUEUE_OVERFLOW. The terminal key buffer was filled past the limit. Keystrokes were lost. |
-32 | HARC_ANOTHER_CONNECTION. Another application has already established a connection to the indicated session. |
-36 | HARC_CONTACT_LOST. The connection to the host has been lost. |
-37 | HARC_INBOUND_DISABLED. Inbound communication to the host has been disabled. |
-38 | HARC_FUNCTION_INCOMPLETE. The requested function is not complete. This occurs if an TSD Script application is stopped while waiting for a condition. |
-1001 | EMUAPI_CALLOC_FAILURE. The TSD Script Interpreter was unable to allocate enough memory to carry out the action. For OS/2 this is an extremely serious condition-it means the virtual memory swap file is out of space. Abort immediately. |
-1002 | EMUAPI_INCORRECT_ROW_COL. An incorrect position was specified for the command. |
-1003 | EMUAPI_EMUAPI_ERROR. An internal error has occurred within EHLLAPI. |
-1004 | EMUAPI_UNEXPECTED_RETURNCODE. An internal error has occurred within EHLLAPI. |
-1005 | EMUAPI_FILEOPENERROR. The map function was unable to open the specified map file. Check the path and file name, and make sure no other processes have locked the file. |
-1007 | EMUAPI_TIMER_START_FAILURE. Internally, the TSD Script Interpreter was unable to start a timer necessary for a watch command. |
-1008 | EMUAPI_TIMER_SEMAPHORE_CREATION_FAILURE. Internally, the TSD Script Interpreter was unable to create system semaphores. |
-1009 | EMUAPI_NEGATIVE_TIME. A negative time was specified where only positive integers are allowed. |
-1010 | EMUAPI_TIME_ELAPSED. The watch time limit expired before the criteria for the watch were satisfied. This is the "wait giveup" error for watch commands except EMUWaitForNoX. |
-1011 | EMUAPI_TIME_ELAPSED_WHILE_II. The watch time limit expired for EMUWaitForNoX while the Input Inhibited Indicator was displayed. |
-1012 | EMUAPI_TIME_ELAPSED_WHILE_KEYBOARD_LOCKED. The watch time limit expired for EMUWaitForNoX while the keyboard was locked. |
-5001 | KMLERR_INVALID_CONNECTION. A connection was specified which was not initialized with EMUConnect. |
-5002 | KMLERR_UNKNOWN_STRING. A parameter that was passed was $Unknown. |
-5003 | KMLERR_INVALID_PARAMETER. One of the parameters specified is not valid for the command. |
-5004 | KMLERR_UNEXPECTED_ERROR. An unexpected error has occurred. |
-5005 | KMLERR_MEM_ALLOC_ERROR. The TSD Script Interpreter was unable to allocate additional memory storage. This is a serious condition-it means OS/2 may run out of swap space. |
-5006 | KMLERR_INVALID_KEYCODE. The integer passed to the command is not a valid key code. |
-5007 | KMLERR_NOT_IMPLEMENTED. The function specified has not been implemented. |
-6000 | EMU_DDF_UNKNOWN_HEADER_ATTRIB. The map file contains a header attribute keyword which is not recognized. |
-6001 | EMU_DDF_UNKNOWN_HEADER_ATTRIB_VALUE. The value for a header attribute is not valid for the keyword. An example would be CLEAR_FIRST=BLUE instead of CLEAR_FIRST=TRUE. |
-6002 | EMU_OUT_OF_MEMORY. The TSD Script Interpreter was unable to allocate additional memory storage. This is a serious condition-it means OS/2 may run out of swap space. |
-6003 | EMU_DDF_INVALID_ROW_VALUE. The row value specified in the map entry is invalid. |
-6004 | EMU_DDF_INVALID_COLUMN_VALUE. The column value specified in a map entry is invalid. |
-6005 | EMU_DDF_INVALID_LENGTH_VALUE. The length specified in a map entry for a field is invalid. |
-6006 | EMU_GENERAL_ERROR. The TSD Script Interpreter encountered an unexpected error during a map operation. |
-6007 | EMU_DDF_NOT_SPECIFIED. The map file name has not been specified properly. |
-6008 | EMU_CANNOT_CREATE_SEM. Internally, the TSD Script Interpreter was unable to create necessary system semaphores. |
-6009 | EMU_CANNOT_GET_SEM. Internally, the TSD Script Interpreter was unable to get access to a requested semaphore. |
-6010 | EMU_DDF_FILE_OPEN_ERROR. The map file could not be opened. |
-6011 | EMU_DDF_FILE_READ_ERROR. The map file could not be read. |
-6012 | EMU_DDF_DUPLICATE_FIELD. The map file contains an entry that is a duplicate of another entry. |
-6013 | EMU_DDF_FILE_CLOSE_ERROR. The map file could not be closed properly upon completion of the command. |
-6014 | EMU_DDF_UNRECOGNIZED_SECTION. The map file contains a section title that is not recognized. Currently, the only sections allowed are *HEADER and *FIELDS. |
-6015 | EMU_DDF_FORMAT_ERROR. The format of the map file is not correct. |
-6016 | EMU_DDF_SYSTEM_FORMAT_NAME_ERROR. An unrecognized system format name was encountered during the processing of a map file. |
-7001 | EMUERR_UNKNOWN_VALUE_FROM_FORMAT_FN. During processing of a map function, a user-defined system format function returned $Unknown instead of TRUE or FALSE. |
-7002 | EMUERR_UNSUPPORTED_TYPE. A map entry specifies a TSD Script variable (not a field of a record) of a non-simple TSD Script type (simple types are INTEGER, REAL, STRING, BOOLEAN, DATE, TIME). If it were a field of a record, it would be skipped (no error). |
-7003 | EMUERR_MAPENTRY_NOT_FOUND. The map file specified a TSD Script variable or record field which could not be found. |
-7004 | EMUERR_ILLEGAL_LENGTH_IN_MAP. The map file contains an illegal length in one of its entries. |
-7005 | EMUERR_FORMAT_FN_FAILURE. One of the user-defined format functions returned FALSE instead of TRUE. |
-8001 | SAI_ERROR_INVALID_TYPE. General type conversion error. The requested target type for conversion is invalid. |
-8002 | SAI_ERROR_INVALID_STRING. The value to be placed into a STRING type is not a valid string. |
-8003 | SAI_ERROR_INVALID_TIME. The value to be placed into a TIME type is not a valid time. |
-8004 | SAI_ERROR_INVALID_DATE. The value to be placed into a DATE type is not a valid date. |
-8006 | SAI_ERROR_INVALID_WIDTH. |
-8007 | SAI_ERROR_INVALID_PRECISION. |
-8008 | SAI_ERROR_INVALID_RADIX. The radix must be greater than or equal to two and less than or equal to 36. |
-9998 | HARC99_INVALID_PS |
-9999 | HARC99_INVALID_CONV_OPT |
Tivoli Service Desk 6.0 Developer's Toolkit Legacy APIs Guide