Caché Basic Reference
Contents
[Home]  [Next]
InterSystems: The power behind what matters   
Class Reference   
Search:    

Preface : 
 
 
Reference A: 
  Symbols Used in Caché Basic — A table of characters used in Caché Basic as operators, etc.
Reference B: 
  Call — Transfers control to a Sub procedure or Function procedure.
Catch — Identifies a block of code to execute when an exception occurs.
Const — Declares constants for use in place of literal values.
Continue — Jumps to FOR or DO WHILE statements and reexecutes test and loop.
Copy — Copies array elements from source to target.
Debug — Interrupts program execution and enters programmer mode.
Dim — Declares variables.
Do...Loop — Repeats a block of statements while a condition is True or until a condition becomes True.
Erase — Removes the named variable and deallocates dynamic-array storage space.
EraseArray — Removes the array elements of a variable and deallocates dynamic-array storage space.
EraseValue — Removes the root node of a variable.
Exit — Exits a block of Do...Loop, For...Next, Function, or Sub code.
For Each...Next — Repeats a group of statements for each element in an array or collection.
For...Next — Repeats a group of statements a specified number of times.
Function — Declares the name, arguments, and code that form the body of a Function procedure.
Goto — Transfers program execution to the specified location.
If...Then...Else — Conditionally executes a group of statements, depending on the value of an expression.
Imports — Imports a package name.
Input — Accepts input and stores it in a variable.
Let — Assigns an object reference to a variable or property.
Merge — Merges array elements from source to target.
New — Creates a new instance of an object.
On Error Goto — Enables an error-handling routine and specifies the location of the routine within a procedure.
OpenId — Opens a new instance of an object for a given Identifier.
Option Explicit — Used at script level to force explicit declaration of all variables in that script.
Print, Println — Writes a string to the current device.
Randomize — Initializes the random-number generator.
Rem — Used to include explanatory remarks in a program.
Return — Exits from the current function and returns a value from that function.
Select Case — Executes one of several groups of statements, depending on the value of an expression.
Set — Assigns an object reference to a variable or property.
Sleep — Causes program execution to delay for the specified number of seconds.
Sub — Declares the name, arguments, and code that form the body of a Sub procedure.
TCommit — Marks the successful completion of a transaction.
Throw — Throws an exception from a Try block to a Catch exception handler.
TRollback — Rolls back (reverts) changes made during the current transaction.
Try — Identifies a block of code to monitor for errors during execution.
TStart — Marks the beginning of a transaction.
While...Wend — Executes a series of statements as long as a given condition is true.
With — Executes a series of statements on a single object.
Reference C: 
  Abs — Returns the absolute value of a number.
Asc — Returns the ANSI character code corresponding to the first character in a string.
Atn — Returns the arctangent of a number.
Case — Compares a target to cases and returns the value associated with the first matching case.
Chr — Returns the character corresponding to the specified ANSI character code.
Cos — Returns the cosine of an angle.
Date — Returns the current system date.
DateAdd — Returns a date to which a specified time interval has been added.
DateConvert — Converts dates between internal and external formats.
DateDiff — Returns the number of intervals between two dates.
DatePart — Returns the specified part of a given date.
DateSerial — Returns the date for a specified year, month, and day.
DateTimeConvert — Converts date/time between internal and external formats.
Day — Returns the day of the month as an integer between 1 and 31, inclusive.
Derived Math Functions — The following non-intrinsic math functions can be derived from the intrinsic math functions:
Exists — Returns the existence status of variables and their array subnodes.
Exp — Returns e (the base of natural logarithms) raised to a power.
Fix — Returns the integer portion of a number.
Hex — Returns a string representing the hexadecimal value of a number.
Hour — Returns a whole number between 0 and 23, inclusive, representing the hour of the day.
Increment — Atomically increments the value of a variable and returns the new value.
InStr — Returns the position of the first occurrence of one string within another.
InStrRev — Returns the position of the first occurrence of one string within another, searching from the end of string.
Int — Returns the integer portion of a number.
IsObject — Returns a value indicating whether an expression references a valid Automation object.
Join — Returns a string created by joining a number of array elements.
LCase — Returns a string that has been converted to lowercase.
Left — Returns or replaces a specified number of characters from the left end of a string.
Len — Returns the number of characters in a string or the number of bytes required to store a variable.
List — Returns elements from a list.
ListBuild — Creates a list of elements.
ListExists — Indicates whether an element is present in the list and has a value.
ListFind — Finds an element in a list.
ListFromString — Creates a list from a string.
ListGet — Returns an element from a list.
ListLength — Returns the number of elements in a list.
ListNext — Retrieves elements sequentially from a list.
ListSame — Compares two lists and returns a boolean value.
ListToString — Creates a string from a list.
ListValid — Determines if an expression is a list.
Lock — Obtains a logical lock on a variable name.
Log — Returns the natural logarithm of a number.
Mid — Returns or replaces a specified number of characters from a string.
Minute — Returns a whole number between 0 and 59, inclusive, representing the minute of the hour.
Month — Returns the month of the year as an integer between 1 and 12, inclusive.
MonthName — Returns a string indicating the specified month.
Now — Returns the current date and time according to the setting of your computer's system date and time.
Oct — Returns a string representing the octal value of a number.
Piece — Returns the specified substring, using a delimiter.
Replace — Returns a string in which a specified substring has been replaced with another substring a specified number of times.
Right — Returns or replaces a specified number of characters from the right end of a string.
Rnd — Returns a random number.
Round — Returns a number rounded to a specified number of decimal places.
Second — Returns a whole number between 0 and 59, inclusive, representing the second of the minute.
Sgn — Returns an integer indicating the sign of a number.
Sin — Returns the sine of an angle.
Space — Returns a string consisting of the specified number of spaces.
Split — Returns a zero-based, one-dimensional array containing a specified number of substrings.
Sqr — Returns the square root of a number.
StrComp — Returns a value indicating the result of a string comparison.
String — Returns a repeating character string of the length specified.
StrReverse — Returns a string in which the character order of a specified string is reversed.
Tan — Returns the tangent of an angle.
Time — Returns the current system time.
TimeConvert — Converts time between internal and external formats.
Timer — Returns the number of seconds that have elapsed since midnight UTC.
TimeSerial — Returns the time for a specific hour, minute, and second.
Traverse — Traverses an array and returns the next subscript.
LTrim, RTrim, and Trim — Returns a copy of a string without leading spaces (LTrim), trailing spaces (RTrim), or both leading and trailing spaces (Trim).
UCase — Returns a string that has been converted to uppercase.
Unlock — Releases a logical lock on a variable name.
Weekday — Returns a whole number representing the day of the week.
WeekdayName — Returns a string indicating the specified day of the week.
Year — Returns the year as a four-digit integer.
Reference D: 
  Operator Summary — A list of Caché Basic operators by type.
Operator Precedence — Operator Precedence
Addition Operator (+) — Used to sum two numbers.
Subtraction Operator (–) — Used to find the difference between two numbers or to indicate the negative value of a numeric expression.
Mod Operator — Used to divide two numbers and return only the remainder.
Multiplication Operator (*) — Used to multiply two numbers.
Division Operator (/) — Used to divide two numbers and return a floating-point result.
Integer Division Operator (\) — Used to divide two numbers and return an integer result.
Exponent Operator (^) — Used to raise a number to the power of an exponent.
Assignment Operator (=) — Used to assign a value to a variable or property.
Comparison Operators — Used to compare expressions.
Concatenation Operator (&) — Used to force string concatenation of two expressions.
Is Operator — Used to compare two object reference variables.
And Operator — Used to perform a logical conjunction on two expressions.
BitAnd Operator — Used to perform a bitwise conjunction on two numeric expressions.
Eqv Operator — Used to perform a logical equivalence on two expressions.
BitEqv Operator — Used to perform a bitwise equivalence on two numeric expressions.
Imp Operator — Used to perform a logical implication on two expressions.
BitImp Operator — Used to perform a bitwise implication on two numeric expressions.
Not Operator — Used to perform logical negation on an expression.
BitNot Operator — Used to perform bitwise negation on a numeric expression.
Or Operator — Used to perform a logical disjunction on two expressions.
BitOr Operator — Used to perform a bitwise disjunction on two numeric expressions.
Xor Operator — Used to perform a logical exclusion on two expressions.
BitXor Operator — Used to perform a bitwise exclusion on two numeric expressions.
Reference E: 
  Comparison Constants  — These constants are always available.
Date Format Constants  — These constants are always available.
Date and Time Constants  — These constants are always available.
Node Constants  — These constants are always available.
String Constants  — These constants are always available.
Reference F: 
  Err Object — Contains information about runtime errors.
System Object — The System object provides access to properties and methods of Caché components.
Reference G: 
  Multidimensional Data Model — Introduction to the Multidimensional Data Model in Caché
Reserved words — A list of Caché Basic reserved words.