Predefined REXX variables

Predefined REXX variables make symbolic references easier and more consistent. Instead of using a numeric or non-numeric value, you can use the predefined variable, which defines that value for you. Table 1 shows the data type and value for each predefined variable. The predefined variables are created on the first CREATE request issued by a REXX program.

Requirement: The REXX program must treat the predefined variables as read-only, and must not assign any values to them.

The predefined variables, listed alphabetically, are shown in Table 1.

Table 1. Predefined REXX variables
Name Type Description Additional Information
FCAI_CEC_ALREADY_CONNECTED Decimal 6 Can be stored in stem.FCAI_CEC
FCAI_CEC_AUTHENTICATION Decimal 17 Can be stored in stem.FCAI_CEC
FCAI_CEC_CLIENT_ERR Decimal 24 Can be stored in stem.FCAI_CEC
FCAI_CEC_CONNECT_FAILED Decimal 8 Can be stored in stem.FCAI_CEC
FCAI_CEC_CONVERSION Decimal 21 Can be stored in stem.FCAI_CEC
FCAI_CEC_EOD_BEFORE_EOF Decimal 25 Can be stored in stem.FCAI_CEC
FCAI_CEC_EXIT_EZAFCCMD_PREVENT Decimal 27 Can be stored in stem.FCAI_CEC
FCAI_CEC_EXIT_EZAFCCMD_TERM Decimal 28 Can be stored in stem.FCAI_CEC
FCAI_CEC_EXIT_EZAFCCMD_WRONG_RC Decimal 29 Can be stored in stem.FCAI_CEC
FCAI_CEC_EXIT_EZAFCREP_TERM Decimal 30 Can be stored in stem.FCAI_CEC
FCAI_CEC_EXIT_EZAFCREP_WRONG_RC Decimal 31 Can be stored in stem.FCAI_CEC
FCAI_CEC_FILE_ACCESS Decimal 18 Can be stored in stem.FCAI_CEC
FCAI_CEC_FILE_READ Decimal 19 Can be stored in stem.FCAI_CEC
FCAI_CEC_FILE_WRITE Decimal 20 Can be stored in stem.FCAI_CEC
FCAI_CEC_INPUT_ERR Decimal 12 Can be stored in stem.FCAI_CEC
FCAI_CEC_INTERNAL_ERROR Decimal 1 Can be stored in stem.FCAI_CEC
FCAI_CEC_INVALID_ENVIRONMENT Decimal 15 Can be stored in stem.FCAI_CEC
FCAI_CEC_INVALID_PARAM Decimal 4 Can be stored in stem.FCAI_CEC
FCAI_CEC_LOGIN_FAILED Decimal 11 Can be stored in stem.FCAI_CEC
FCAI_CEC_NEEDS_CONNECTION Decimal 26 Can be stored in stem.FCAI_CEC
FCAI_CEC_NOT_ENABLED Decimal 16 Can be stored in stem.FCAI_CEC
FCAI_CEC_NOTFOUND Decimal 14 Can be stored in stem.FCAI_CEC
FCAI_CEC_OPEN_IOSTREAM_FAILED Decimal 5 Can be stored in stem.FCAI_CEC
FCAI_CEC_PROXY_ERR Decimal 22 Can be stored in stem.FCAI_CEC
FCAI_CEC_SERVER_ERROR Decimal 2 Can be stored in stem.FCAI_CEC
FCAI_CEC_SESSION_ERROR Decimal 10 Can be stored in stem.FCAI_CEC
FCAI_CEC_SQL_ERR Decimal 23 Can be stored in stem.FCAI_CEC
FCAI_CEC_TIMEOUT Decimal 9 Can be stored in stem.FCAI_CEC
FCAI_CEC_USAGE Decimal 7 Can be stored in stem.FCAI_CEC
FCAI_ERROR_CEC Decimal -3 Can be returned by FTPAPI call
FCAI_ERROR_IE Decimal -2 Can be returned by FTPAPI call
FCAI_GETL_ANY_LINE Char A Value for type parameter on GETL_FIND or GETL_COPY requests
FCAI_GETL_FIND_FIRST Char F Value for sequence parameter on GETL_FIND requests
FCAI_GETL_FIND_LAST Char L Value for sequence parameter on GETL_FIND requests
FCAI_GETL_FIND_NEXT Char N Value for sequence parameter on GETL_FIND requests
FCAI_GETL_LIST_LINE Char L Value for sequence parameter on GETL_FIND requests
FCAI_GETL_MESSAGE_LINE Char M Value for type parameter on GETL_FIND or GETL_COPY requests
FCAI_GETL_REPLY_LINE Char R Value for type parameter on GETL_FIND or GETL_COPY requests
FCAI_GETL_TRACE_LINE Char T Value for type parameter on GETL_FIND or GETL_COPY requests
FCAI_IE_ACCTPROMPTERR Decimal 35 Can be stored in stem.FCAI_IE
FCAI_IE_ALREADYINPROGRESS Decimal 37 Can be stored in stem.FCAI_IE
FCAI_IE_APIALREADYINIT Decimal 16 Can be stored in stem.FCAI_IE
FCAI_IE_APILOADFAILED Decimal 18 Can be stored in stem.FCAI_IE
FCAI_IE_BADTOKENADDR Decimal 20 Can be stored in stem.FCAI_IE
FCAI_IE_BUFFERTOOSMALL Decimal 68 Can be stored in stem.FCAI_IE
FCAI_IE_CLIPROCESSBROKEN Decimal 47 Can be stored in stem.FCAI_IE
FCAI_IE_CLIPROCESSSTOPPED Decimal 38 Can be stored in stem.FCAI_IE
FCAI_IE_CONTROLERR Decimal 6 Can be stored in stem.FCAI_IE
FCAI_IE_CREATEPIPEERR Decimal 26 Can be stored in stem.FCAI_IE
FCAI_IE_ENVVARSTORAGEERR Decimal 77 Can be stored in stem.FCAI_IE
FCAI_IE_GETWORKAREAFAILED Decimal 21 Can be stored in stem.FCAI_IE
FCAI_IE_INITPARMTOOBIG Decimal 17 Can be stored in stem.FCAI_IE
FCAI_IE_INTERNALERR Decimal 7 Can be stored in stem.FCAI_IE
FCAI_IE_LENGTHINVALID Decimal 8 Can be stored in stem.FCAI_IE
FCAI_IE_LINESPARMTOOBIG Decimal 73 Can be stored in stem.FCAI_IE
FCAI_IE_NOTINPROGRESS Decimal 48 Can be stored in stem.FCAI_IE
FCAI_IE_NOTOKENADDR Decimal 19 Can be stored in stem.FCAI_IE
FCAI_IE_PARMMISSING Decimal 3 Can be stored in stem.FCAI_IE
FCAI_IE_PARMSTORAGEERR Decimal 4 Can be stored in stem.FCAI_IE
FCAI_IE_PASSPROMPTERR Decimal 34 Can be stored in stem.FCAI_IE
FCAI_IE_POLLWAITINVALID Decimal 74 Can be stored in stem.FCAI_IE
FCAI_IE_READERR Decimal 42 Can be stored in stem.FCAI_IE
FCAI_IE_REQTIMEREXPIRED Decimal 22 Can be stored in stem.FCAI_IE
FCAI_IE_REQTIMERINVALID Decimal 72 Can be stored in stem.FCAI_IE
FCAI_IE_REQUESTMISSING Decimal 1 Can be stored in stem.FCAI_IE
FCAI_IE_REQUESTUNKNOWN Decimal 2 Can be stored in stem.FCAI_IE
FCAI_IE_SCMDPARMTOOBIG Decimal 32 Can be stored in stem.FCAI_IE
FCAI_IE_SPAWNERR Decimal 27 Can be stored in stem.FCAI_IE
FCAI_IE_STEMINUSE Decimal 90 Can be stored in stem.FCAI_IE
FCAI_IE_SYSOUTCLASSERR Decimal 78 Can be stored in fcaiMap.FCAI_IE
FCAI_IE_TOOMANYENVVARS Decimal 24 Can be stored in stem.FCAI_IE
FCAI_IE_TOOMANYINITPARMS Decimal 23 Can be stored in stem.FCAI_IE
FCAI_IE_TOOMANYPARAMETERS Decimal 5 Can be stored in stem.FCAI_IE
FCAI_IE_TRACEIDTOOBIG Decimal 69 Can be stored in stem.FCAI_IE
FCAI_IE_TRACESCLASSTOOBIG Decimal 70 Can be stored in stem.FCAI_IE
FCAI_IE_UNKMODE Decimal 33 Can be stored in stem.FCAI_IE
FCAI_IE_UNKNOWNOPERATION Decimal 64 Can be stored in stem.FCAI_IE
FCAI_IE_UNKNOWNSEQUENCE Decimal 66 Can be stored in stem.FCAI_IE
FCAI_IE_UNKNOWNTRACEIT Decimal 71 Can be stored in stem.FCAI_IE
FCAI_IE_UNKNOWNTYPE Decimal 65 Can be stored in stem.FCAI_IE
FCAI_IE_VECTORSTORAGEERR Decimal 67 Can be stored in stem.FCAI_IE
FCAI_IE_WRITEERR Decimal 41 Can be stored in stem.FCAI_IE
FCAI_MODE_NOWAIT Char N Can be stored in stem.FCAI_IE
FCAI_MODE_WAIT Char W Can be stored in stem.FCAI_IE
FCAI_RESULT_CEC Decimal -3 Can be returned by an FTPAPI call
FCAI_RESULT_IE Decimal -2 Can be returned by an FTPAPI call
FCAI_RESULT_INPROGRESS Decimal 1 Can be stored in stem.FCAI_IE
FCAI_RESULT_NOMATCH Decimal 4 Can be stored in stem.FCAI_Result or can be returned by an FTPAPI call
FCAI_RESULT_OK Decimal 0 Can be stored in stem.FCAI_Result or returned by an FTPAPI call
FCAI_RESULT_PROMPTACCT Decimal 3 Can be stored in stem.FCAI_Result or returned by an FTPAPI call
FCAI_RESULT_PROMPTPASS Decimal 2 Can be stored in stem.FCAI_Result or returned by an FTPAPI call
FCAI_RESULT_REXXERROR Decimal -19 Can be returned by an FTPAPI call
FCAI_RESULT_UNUSABLEFCAI Decimal -17 Can be returned by an FTPAPI call
FCAI_SCMD_ACCT Decimal 3 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_AMBIGUOUS Decimal 1 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_APPE Decimal 4 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_ASCII Decimal 5 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_BIG5 Decimal 57 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_BINARY Decimal 6 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_BLOCK Decimal 58 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_CCC Decimal 77 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_CD Decimal 7 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_CDUP Decimal 51 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_CLEAR Decimal 72 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_CLOSE Decimal 8 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_COMPRESS Decimal 59 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_CPROTECT Decimal 73 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_DEBUG Decimal 11 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_DELE Decimal 13 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_DELIMIT Decimal 12 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_DIR Decimal 14 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_DUMP Decimal 70 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_EBCDIC Decimal 15 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_EUCKANJI Decimal 46 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_FEAT Decimal 78 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_FILE Decimal 60 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_GENHELP Decimal 2 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_GET Decimal 16 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_GLOB Decimal 65 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_HANGEUL Decimal 53 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_HELP Decimal 17 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_IBMKANJI Decimal 47 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_JIS78KJ Decimal 48 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_JIS83KJ Decimal 49 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_KSC5601 Decimal 54 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_LANG Decimal 79 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_LCD Decimal 41 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_LMKDIR Decimal 45 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_LOCSITE Decimal 42 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_LOCSTAT Decimal 18 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_LPWD Decimal 43 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_LS Decimal 20 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_MDELETE Decimal 21 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_MGET Decimal 22 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_MKD Decimal 44 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_MKFIFO Decimal 82 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_MODE Decimal 23 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_MPUT Decimal 24 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_MVSGET Decimal 83 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_MVSPUT Decimal 84 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_NOOP Decimal 25 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_OEEXCL Decimal 68 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_OPEN Decimal 10 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_PASS Decimal 26 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_PRIVATE Decimal 74 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_PROMPT Decimal 66 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_PROTECT Decimal 75 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_PROXY Decimal 61 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_PUT Decimal 27 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_PWD Decimal 28 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_QUIT Decimal 29 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_QUOTE Decimal 30 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_RECORD Decimal 62 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_RENAME Decimal 31 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_REST Decimal 56 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_RMD Decimal 52 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_SAFE Decimal 76 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_SCHINESE Decimal 63 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_SENDPORT Decimal 32 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_SENDSITE Decimal 33 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_SITE Decimal 34 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_SJISKJ Decimal 50 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_SREST Decimal 80 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_STAT Decimal 35 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_STREAM Decimal 64 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_STRU Decimal 36 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_SUNIQUE Decimal 37 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_SYST Decimal 38 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_TCHINESE Decimal 55 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_TSO Decimal 9 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_TYPE Decimal 40 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_UCS2 Decimal 67 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_UNKNOWN Decimal 99 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_USER Decimal 19 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_SCMD_VERBOSE Decimal 71 Can be stored in fcaiMap.FCAI_SCMD by a GET_FCAI_MAP request
FCAI_STATUS_INPROGRESS Decimal 1 Can be returned by an FTPAPI call
FCAI_STATUS_PROMPTACCT Decimal 3 Can be returned by an FTPAPI call
FCAI_STATUS_PROMPTPASS Decimal 2 Can be returned by an FTPAPI call
FCAI_STATUS_TRACEFAILED Decimal 200 Can be returned by an FTPAPI call
FCAI_TASK_CLIPROCESSKILL Decimal -32 Can be stored in stem.FCAI_Result or returned by an FTPAPI function call
FCAI_TASK_TASKMISMATCH Decimal -18 Can be stored in stem.FCAI_Result or returned by an FTPAPI function call
FCAI_TRACE_DATASET_NAME String   Data set name to which the REXX FTP Client trace is written if the FTP client API for REXX is active, or an empty string ('') if the trace is not active.
FCAI_TRACE_DATASET_RETCODE Integer   Return code from FTP client API for REXX tracing from the last invocation of the FTP client API for REXX
FCAI_TRACE_WORKAREA Binary   Binary data used by the FTP client API for REXX when writing trace records.
Rule: This variable must not be modified by the REXX program.
FCAI_TRACECAPI_A Decimal 1 Can be stored in fcaiMap.FCAI_TraceCAPI by a GET_FCAI_MAP request
FCAI_TRACECAPI_C Decimal 0 Can be stored in fcaiMap.FCAI_TraceCAPI by a GET_FCAI_MAP request
FCAI_TRACECAPI_N Decimal 2 Can be stored in fcaiMap.FCAI_TraceCAPI by a GET_FCAI_MAP request
FCAI_TRACESTATUS_ALLOCERR Decimal 2 Can be stored in fcaiMap.FCAI_TraceStatus by a GET_FCAI_MAP request
FCAI_TRACESTATUS_CLOSEERR Decimal 5 Can be stored in fcaiMap.FCAI_TraceStatus by a GET_FCAI_MAP request
FCAI_TRACESTATUS_OK Decimal 0 Can be stored in fcaiMap.FCAI_TraceStatus by a GET_FCAI_MAP request
FCAI_TRACESTATUS_OPENERR Decimal 3 Can be stored in fcaiMap.FCAI_TraceStatus by a GET_FCAI_MAP request
FCAI_TRACESTATUS_STORAGEERR Decimal 1 Can be stored in fcaiMap.FCAI_TraceStatus by a GET_FCAI_MAP request
FCAI_TRACESTATUS_WRITEERR Decimal 4 Can be stored in fcaiMap.FCAI_TraceStatus by a GET_FCAI_MAP request