System words in alphabetical order
This page lists the system functions, then the system variables.
System function/Invocation Description arrayName.appendAll arrayName.appendAll (appendArray)Acts as follows, but only for dynamic arrays:
- Appends to the array that is referenced by arrayName, adding a copy of the array that is referenced by appendArray
- Increments the array size by the number of added elements
- Assigns an appropriate index value to each of the appended elements
arrayName.appendElement arrayName.appendElement (content)Places an element to the end of a dynamic array and increments the array size by one; arrayName is the name of the array, and content is the new content (a constant or variable of the appropriate type for the array) arrayName.insertElement arrayName.insertElement (content, index)Places an element in front of the element that is now at the specified location in a dynamic array, increments the array size by one, and increments the index of each element that resides after the inserted element; arrayName is the name of the array, content is the new content (a constant or variable of the appropriate type for the array), and index is an integer literal or a numeric variable that indicates the location of the new element arrayName.removeAll arrayName.removeAll()Removes arrayName (a dynamic array) from memory arrayName.removeElement arrayName.removeElement (index)Removes the element at the specified location in arrayName (a dynamic array), decrements the array size by one, and decrements the index of each element that resides after the removed element; index is an integer literal or a numeric variable that indicates the location of the element to be removed recordName.resourceAssociation Contains the system resource name associated with the record recordName and allows for a dynamic change to that name mathLib.abs result = mathLib.abs (numericItem)Returns absolute value of numericItem mathLib.acos result = mathLib.acos (numericItem)Returns arccosine of numericItem mathLib.asin result = mathLib.asin (numericItem)Returns arcsine of numericItem mathLib.atan result = mathLib.atan (numericItem)Returns arctangent of numericItem mathLib.atan2 result = mathLib.atan2 (y, x)Computes the principal value of the arc tangent of y/x, using the signs of both arguments to determine the quadrant of the return value mathLib.ceiling result = mathLib.ceiling (numericItem)Returns smallest integer not less than numericItem mathLib.compareNum result = mathLib.compareNum (numericItem1, numericItem2)Returns a result (-1, 0, or 1) that indicates whether numericItem1 is less than, equal to, or greater than numericItem2 mathLib.cos result = mathLib.cos (numericItem)Returns cosine of numericItem mathLib.cosh result = mathLib.cosh (numericItem)Returns hyperbolic cosine of numericItem mathLib.exp result = mathLib.exp (numericItem)Returns exponential value of numericItem mathLib.floatingAssign result = mathLib.floatingAssign (numericItem)Returns numericItem as a double-precision floating-point number mathLib.floatingDifference result = mathLib.floatingDifference (numericItem1, numericItem2)Returns the difference between numericItem1 and numericItem2 mathLib.floatingMod result = mathLib.floatingMod (numericItem1, numericItem2)Calculates the floating point remainder of numericItem1 divided by numericItem2, with the result having the same sign as numericItem1 mathLib.floatingProduct result = mathLib.floatingProduct (numericItem1, numericItem2)Returns product of numericItem1 and numericItem2 mathLib.floatingQuotient result = mathLib.floatingQuotient (numericItem1, numericItem2)Returns quotient of numericItem1 divided by numericItem2 mathLib.floatingSum result = mathLib.floatingSum (numericItem1, numericItem2)Returns sum of numericItem1 and numericItem2 mathLib.floor result = mathLib.floor (numericItem)Returns the largest integer not greater than numericItem mathLib.frexp result = mathLib.frexp (numericItem, integer)Splits a number into a normalized fraction in the range of .5 to 1 (which is the returned value) and a power of 2 (which is returned in integer mathLib.ldexp result = mathLib.ldexp (numericItem, integer)Returns numericItem multiplied by 2 to the power of integer mathLib.log result = mathLib.log (numericItem)Returns the natural logarithm of numericItem mathLib.log10 result = mathLib.log10 (numericItem)Returns the base 10 logarithm of numericItem mathLib.maximum result = mathLib.maximum (numericItem1, numericItem2)Returns the greater of numericItem1 and numericItem2 mathLib.minimum result = mathLib.minimum (numericItem1, numericItem2)Returns the lesser of numericItem1 and numericItem2 mathLib.modf result = mathLib.modf (numericItem1, numericItem2)Splits numericItem1 into integral and fractional parts, both with the same sign as the number; places the integral part in numericItem2; and returns the fractional part mathLib.pow result = mathLib.pow (numericItem1, numericItem2)Returns numericItem1 raised to the power of numericItem2 mathLib.precision result = mathLib.precision (numericItem)Returns the maximum precision (in decimal digits) for numericItem mathLib.round result = mathLib.round (numericItem, integer)result = mathLib.round (numericExpression)Rounds a number or expression to a nearest value (for example, to the nearest thousands) and returns the result mathLib.sin result = mathLib.sin (numericItem)Returns sine of numericItem mathLib.sinh result = mathLib.sinh (numericItem)Returns hyperbolic sine of numericItem mathLib.sqrt result = mathLib.sqrt (numericItem)Returns the square root of numericItem if numericItem is greater than or equal to zero mathLib.tan result = mathLib.tan (numericItem)Returns the tangent of numericItem mathLib.tanh result = mathLib.tanh (numericItem)Returns the hyperbolic tangent of numericItem strLib.characterAsInt strLib.characterAsInt (characterExpression)Converts a character string into an integer string corresponding to the first character in the character expression strLib.compareStr result = strLib.compareStr (target, targetSubstringIndex, targetSubstringLength, source, sourceSubstringIndex, sourceSubstringLength)Compares two substrings in accordance with their ASCII or EBCDIC order at run time and returns a value (-1, 0, or 1) to indicate which is greater. strLib.concatenate result = strLib.concatenate (target, source)Concatenates target and source; places the new string in target; and returns an integer that indicates whether target was long enough to contain the new string strLib.concatenateWithSeparator result = strLib.concatenateWithSeparator (target, source, separator)Concatenates target and source, inserting separator between them; places the new string in target; and returns an integer that indicates whether target was long enough to contain the new string strLib.copyStr result = strLib.copyStr (target, targetSubstringIndex, targetSubstringLength, source, sourceSubstringIndex, sourceSubstringLength)Copies one substring to another strLib.findStr result = strLib.findStr (source, sourceSubstringIndex, sourceSubstringLength, searchString)Searches for the first occurrence of a substring within a string strLib.getNextToken result = strLib.getNextToken (target, source, sourceSubstringIndex, sourceStringLength, characterDelimiter)Searches a string for the next token and copies the token to target strLib.setBlankTerminator result = strLib.setBlankTerminator (target)Replaces a null terminator and any subsequent characters in a string with spaces, so that a string value returned from a C or C++ program can operate correctly in an EGL-generated program strLib.setNullTerminator result = strLib.setNullTerminator (target)Changes all trailing spaces in a string to nulls strLib.setSubStr result = strLib.setSubStr (target, targetSubstringIndex, targetSubstringLength, source)Replaces each character in a substring with a specified character strLib.strLen result = strLib.strLen (source)Returns the number of bytes in an item, excluding any trailing spaces or nulls sysLib.bytes result = sysLib.bytes (itemOrRecord)Returns the number of bytes in a named area of memory sysLib.calculateChkDigitMod10 sysLib.calculateChkDigitMod10 (input, checkLength, result)Places a modulus-10 check digit in a character item that begins with a series of integers sysLib.calculateChkDigitMod11 sysLib.calculateChkDigitMod11 (input, checkLength, result)Places a modulus-11 check digit in a character item that begins with a series of integers sysLib.clearRequestAttr sysLib.clearRequestAttr (key)Removes the argument that is associated with the specified key in the request object; the function is useful in page handlers and in programs that run in Web applications sysLib.clearScreen sysLib.clearScreen()Clears the screen, as is useful before the program issues a converse statement in a text application sysLib.clearSessionAttr sysLib.clearSessionAttr (key)Removes the argument that is associated with the specified key in the session object; the function is useful in page handlers and in programs that run in Web applications sysLib.commit sysLib.commit()Calls services to save recoverable file, database, and message queue updates since the last commit sysLib.connect sysLib.connect (database, userID, password, disconnectOption, isolationLevel)Allows a program to connect to a database at run time sysLib.connectionService sysLib.connectionService (userID, password, serverName, product, release, connectionOption)Allows a program to connect or disconnect to a database at run time and receives (optionally) the database product name and release level; but this function is supported only when you have requested compatibility with VisualAge Generator sysLib.convert sysLib.convert (target, direction, conversionTable)Converts data between EBCDIC (host) and ASCII (workstation) formats or performs code-page conversion within a single format sysLib.dateValue sysLib.dateValue (dateLiteral)Converts a dateLiteral into a dateValue sysLib.disconnect sysLib.disconnect (database)Disconnects from the specified database or (if no database is specified) from the current database sysLib.disconnectAll sysLib.disconnectAll()Disconnects from all the currently connected databases sysLib.displayMsgNum sysLib.displayMsgNum (msgNumber)Retrieves a value from the program's message table sysLib.extendTimeStampValue sysLib.extendTimeStampValue (extensionItem [, timeSpanPattern] )Converts a timestamp into an extended timestamp value sysLib.fieldInputLength sysLib.displayMsgNum (msgNumber)Returns the number of characters that the user typed in the input field when the text form was last presented sysLib.getRequestAttr sysLib.getRequestAttr (key, variable)Uses a specified key to retrieve an argument from the request object into a specified variable; the function is useful in page handlers and in programs that run in Web applications sysLib.getSessionAttr sysLib.getSessionAttr (key, variable)Uses a specified key to retrieve an argument from the session object into a specified variable; the function is useful in page handlers and in programs that run in Web applications sysLib.getVAGSysType result = sysLib.getVAGSysType()Identifies the target system in which the program is running; but this function is supported only when you have requested compatibility with VisualAge Generator sysLib.intervalValue sysLib.intervalValue (intervalLiteral [, intervalSpanPattern] )Converts an intervalLiteral into an intervalValue sysLib.java result = sysLib.java (identifierOrClass, method, argumentList)Invokes a method on a native Java object or class and may return a value sysLib.javaGetField result = sysLib.javaGetField (identifierOrClass, field)Returns the value of a specified field of a specified object or class sysLib.javaIsNull result = sysLib.javaIsNull(identifier)Returns a value (1 for true, 0 for false) to indicate whether a specified identifier refers to a null object sysLib.javaIsObjID result = sysLib.javaIsObjID (identifier)Returns a value (1 for true, 0 for false) to indicate whether a specified identifier is in the EGL Java object space sysLib.javaRemove sysLib.javaRemove (identifier)Removes the specified identifier from the EGL Java object space and, if no other identifiers refer to the object, removes the object sysLib.javaRemoveAll sysLib.javaRemoveAll()Removes all identifiers and objects from the EGL Java object space sysLib.javaSetField sysLib.javaSetField (identifierOrClass, field, value)Sets the value of a field in a Java object or class sysLib.javaStore sysLib.javaStore (storeID, method, argumentList)Invokes a method and places the returned object (or null) into the EGL Java object space, along with a specified identifier sysLib.javaStoreCopy sysLib.javaStoreCopy (storeID, method, argumentList)Creates a new identifier based on another in the EGL Java object space, so that both refer to the same object sysLib.javaStoreField sysLib.javaStoreField (storeID, identifierOrClass, field)Places the value of a class field or object field into the EGL Java object space sysLib.javaStoreNew sysLib.javaStoreNew (storeID, class, argumentList)Invokes the constructor of a class and places the new object into the EGL Java object space sysLib.javaType result = sysLib.javaType (identifier)Returns the fully qualified name of the class of an object in the EGL Java object space sysLib.maximumSize result = sysLib.maximumSize (arrayName)Returns the maximum number of rows that can be in the specified dynamic array of data items or records sysLib.pageEject sysLib.pageEject()Advances print-form output to the top of the next page, as is useful before the program issues a print statement sysLib.queryCurrentDatabase sysLib.queryCurrentDatabase (product, release)Returns the product and release number of the currently connected database sysLib.rollback sysLib.rollback()Calls system services to back out recoverable file, database, and message queue updates since the last commit point sysLib.setCurrentDatabase sysLib.setCurrentDatabase (database)Makes the specified database the currently active one sysLib.setError sysLib.setError (elementInError, msgKey, msgInsertList)Associates a message with an item in a page handler or with the page handler itself sysLib.setLocale sysLib.setLocale (languageCode, countryCode, variant)Sets the Java locale in page handlers and in programs that run in a Web application sysLib.setRemoteUser sysLib.setRemoteUser (userID, password)Sets the userid and password that are used on calls to remote programs from Java programs sysLib.setRequestAttr sysLib.setRequestAttr (key, argument)Uses a specified key to place a specified argument in the request object; this function is used in page handlers and in programs that run in a Web application sysLib.setSessionAttr sysLib.setSessionAttr (key, argument)Uses a specified key to place a specified argument in the session object; this function is used in page handlers and in programs that run in a Web application sysLib.size result = sysLib.size (arrayName)Returns the number of elements in the array arrayName, which may be a structure-item array, a static array of data items or records, or a dynamic array of data items or records; alternatively, arrayName may be a data table, in which case the function returns the number of rows sysLib.startTransaction sysLib.startTransaction (request, prID, termID)Invokes a main program asynchronously, associates that program with a printer or terminal device, and passes a record sysLib.timeValue sysLib.timeValue (timeLiteral)Converts a timeLiteral into a timeValue sysLib.timeStampValue sysLib.timeStampValue (timeStampLiteral [, timeSpanPattern])Converts a timeStampLiteral into a timeStampValue sysLib.validationFailed sysLib.validationFailed (msgNumber)Involved in message presentation on a text or print form sysLib.verifyChkDigitMod10 sysLib.verifyChkDigitMod10 (input, checkLength, result)Verifies a modulus-10 check digit in a character item that begins with a series of integers sysLib.verifyChkDigitMod11 sysLib.verifyChkDigitMod11 (input, checkLength, result)Verifies a modulus-11 check digit in a character item that begins with a series of integers sysLib.wait sysLib.wait (timeInSeconds)Suspends execution for the specified number of seconds. The next table lists the system variables.
System variable Description arrayName.maximumSize The maximum number of elements in the array arrayName, which must be a dynamic array sysVar.arrayIndex One of these:
- Number of the first element in an array that matches the search condition of a simple logical expression with an in operator
- Zero, if no array element matches the search condition
sysVar.callConversionTable Name of the conversion table used to dynamically convert data for calling remote programs, for starting remote asynchronous transactions, or for accessing remote files sysVar.commitOnConverse Determines whether to cause a commit and a release of resources in a text application, before a non-segmented program issues a converse statement sysVar.currentDate Contains the current system date in eight-digit Gregorian format (YYYYMMDD) sysVar.currentFormattedDate Contains the current system date in the system default long Gregorian format sysVar.currentFormattedJulianDate Contains the current system date in the system default long Julian format sysVar.currentFormattedTime Retrieves the current system time in HH:MM:SS format sysVar.currentJulianDate Contains the current system date in seven-digit Julian format (YYYYDDD) sysVar.currentShortDate Contains the current system date in six-digit Gregorian format (YYMMDD) sysVar.currentShortJulianDate Contains the current system date in five-digit Julian format (YYDDD) sysVar.currentTime Retrieves the current system time in six-digit Julian format (HHMMSS) sysVar.currentTimeStamp Retrieves the current system time and date as a timestamp in twenty-digit Julian format (YYYYMMDDHHMMSSFFFFFF) sysVar.errorCode Receives a status code after any of the following events:
- The invocation of a call statement, if that statement is in a try block
- An I/O operation on an indexed, MQ, relative, or serial file
- The invocation of almost any system function in these cases--
- The invocation is within a try block; or
- The program is running in VisualAge Generator Compatibility mode and sysVar.handleSysLibErrors is set to 1
(For an overview that includes details on sysVar.errorCode, see Exception handling.)
sysVar.eventKey Identifies the key that the user pressed to return a form to an EGL text program sysVar.formConversionTable Name of the conversion table used to dynamically convert data in text and print forms sysVar.handleHardIOErrors Controls whether a program continues to run after a hard I/O error occurs on an I/O operation sysVar.handleOverflow Controls error processing after an arithmetic overflow sysVar.handleSysLibErrors Specifies whether the value of the system variable sysVar.errorCode is affected by the invocation of a system function sysVar.mqConditionCode Completion code from an MQSeries API call following an add or scan I/O operation for an MQ record sysVar.overflowIndicator Set to 1 when arithmetic overflow occurs sysVar.printerAssociation Allows you to specify, at run time, the destination of the output that is associated with the file name printer sysVar.returnCode Contains the external return code to be checked when the program ends; the check is by the command processor or by the calling high-level language program sysVar.segmentedMode Changes the effect of the converse statement in a text application sysVar.sessionID System-dependent user identifier or terminal identifier for your program sysVar.sqlca Contains the entire SQL communication area (SQLCA) returned for the last SQL I/O operation sysVar.sqlcode Contains the return code for the most recently completed SQL I/O operation sysVar.sqlerrd sysVar.sqlerrd[index]Is a static 6-element array, where each element contains the corresponding SQL communication area (SQLCA) value that was returned from the last SQL I/O option sysVar.sqlerrmc Contains the substitution variables for the error message associated with the return code in sysVar.sqlcode sysVar.sqlIsolationLevel Indicates the level of independence of one database transaction from another sysVar.sqlstate Contains the SQL state value for the most recently completed SQL I/O operation sysVar.sqlwarn sysVar.sqlwarn[index]Is a static 11-element array, where each element contains a warning byte returned in the SQL communications area (SQLCA) for the last SQL I/O operation and where the index is one greater that the warning number in the SQL SQLCA description; sqlwarn[1], for example, refers to SQLWARN0 sysVar.systemType Identifies environment in which program is running sysVar.terminalID Contains the terminal identifier in environments where one is available sysVar.transactionID Contains the name of the current transaction ID or the name of the next transaction to be used after a converse statement sysVar.transferName Allows you to specify, at run time, the name of the program or transaction to which you want to transfer sysVar.userID Contains the user identifier in environments where one is available sysVar.validationMsgNum Contains the value assigned by sysLib.validationFailed
Related reference
Arrays
EGL statements
System words