Caché Basic Reference
Static Version
Contents
Contents
Reference A:
Symbols
Symbols Used in Caché Basic
A table of characters used in Caché Basic as operators, etc.
Reference B:
Caché Basic Commands
Call Statement
Transfers control to a
Sub
procedure or
Function
procedure.
Const Statement
Declares constants for use in place of literal values.
Continue Statement
Jumps to FOR or DO WHILE statements and reexecutes test and loop.
Copy Statement
Copies array elements from source to target.
Dim Statement
Declares variables.
Do...Loop Statement
Repeats a block of statements while a condition is True or until a condition becomes True.
Erase Statement
Removes the named variable and deallocates dynamic-array storage space.
EraseArray Statement
Removes the array elements of a variable and deallocates dynamic-array storage space.
EraseValue Statement
Removes the root node of a variable.
Exit Statement
Exits a block of
Do...Loop
,
For...Next
,
Function
, or
Sub
code.
For Each...Next Statement
Repeats a group of statements for each element in an
array
or
collection
.
For...Next Statement
Repeats a group of statements a specified number of times.
Function Statement
Declares the name, arguments, and code that form the body of a Function procedure.
If...Then...Else Statement
Conditionally executes a group of statements, depending on the value of an expression.
Merge Statement
Merges array elements from source to target.
On Error Goto Statement
Enables an error-handling routine and specifies the location of the routine within a procedure.
Option Explicit Statement
Used at script level to force explicit declaration of all variables in that script.
New Statement
Creates a new instance of an object.
OpenId Statement
Opens a new instance of an object for a given Identifier.
Print Statement
Write a string to the current device.
Randomize Statement
Initializes the random-number generator.
Rem Statement
Used to include explanatory remarks in a program.
Return Statement
Exits from the current function and returns a value from that function.
Select Case Statement
Executes one of several groups of statements, depending on the value of an expression.
Set Statement
Assigns an object reference to a variable or property.
Sub Statement
Declares the name, arguments, and code that form the body of a
Sub
procedure.
TCommit Statement
Marks the successful completion of a transaction
TRollback Statement
Marks the unsuccessful completion of a transaction
TStart Statement
Marks the beginning of a transaction.
While...Wend Statement
Executes a series of statements as long as a given condition is True.
With Statement
Executes a series of statements on a single object.
Reference C:
Caché Basic Functions
Abs Function
Returns the absolute value of a number.
Asc Function
Returns the ANSI character code corresponding to the first letter in a string.
Atn Function
Returns the arctangent of a number.
Case Function
Compares a target to cases and returns the value associated with the first matching case.
Chr Function
Returns the character associated with the specified ANSI character code.
Cos Function
Returns the cosine of an angle.
Date Function
Returns the current system date.
DateAdd Function
Returns a date to which a specified time interval has been added.
DateConvert Function
Converts dates between internal and external formats.
DateDiff Function
Returns the number of intervals between two dates.
DatePart Function
Returns the specified part of a given date.
DateSerial Function
Returns the date for a specified year, month, and day.
DateTimeConvert Function
Converts date/time between internal and external formats.
Day Function
Returns a whole number between 1 and 31, inclusive, representing the day of the month.
Derived Math Functions
The following nonintrinsic math functions can be derived from the intrinsic math functions:
Exists Function
Returns the existence status of nodes in arrays.
Exp Function
Returns e (the base of natural logarithms) raised to a power.
Int/Fix Functions
Returns the integer portion of a number.
Hex Function
Returns a string representing the hexadecimal value of a number.
Hour Function
Returns a whole number between 0 and 23, inclusive, representing the hour of the day.
Increment Function
Atomically increments the value of a variable and returns the new value.
InStr Function
Returns the position of the first occurrence of one string within another.
InStrRev Function
Returns the position of an occurrence of one string within another, from the end of string.
IsObject Function
Returns a value indicating whether an expression references a valid Automation object.
Join Function
Returns a string created by joining a number of substrings contained in an array.
LCase Function
Returns a string that has been converted to lowercase.
Left Function
Returns a specified number of characters from the left side of a string.
Len Function
Returns the number of characters in a string or the number of bytes required to store a variable.
List Function
Returns elements from a list.
ListBuild Function
Creates a list of elements.
ListExists Function
Indicates whether an element is present in the list and has a value.
ListFind Function
Finds an element in a list.
ListGet Function
Returns an element from a list.
ListLength Function
Returns the number of elements in a list.
Lock Function
Obtains a logical lock on a variable name.
Log Function
Returns the natural logarithm of a number.
Mid Function
Returns a specified number of characters from a string.
Minute Function
Returns a whole number between 0 and 59, inclusive, representing the minute of the hour.
Month Function
Returns a whole number between 1 and 12, inclusive, representing the month of the year.
MonthName Function
Returns a string indicating the specified month.
Now Function
Returns the current date and time according to the setting of your computer's system date and time.
Oct Function
Returns a string representing the octal value of a number.
Piece Function
Returns a number of substrings using a delimiter from a string.
Replace Function
Returns a string in which a specified substring has been replaced with another substring a specified number of times.
Right Function
Returns a specified number of characters from the right side of a string.
Rnd Function
Returns a random number.
Round Function
Returns a number rounded to a specified number of decimal places.
Second Function
Returns a whole number between 0 and 59, inclusive, representing the second of the minute.
Sgn Function
Returns an integer indicating the sign of a number.
Sin Function
Returns the sine of an angle.
Space Function
Returns a string consisting of the specified number of spaces.
Split Function
Returns a zero-based, one-dimensional array containing a specified number of substrings.
Sqr Function
Returns the square root of a number.
StrComp Function
Returns a value indicating the result of a string comparison.
String Function
Returns a repeating character string of the length specified.
StrReverse Function
Returns a string in which the character order of a specified string is reversed.
Tan Function
Returns the tangent of an angle.
Time Function
Returns the current system time.
TimeConvert Function
Converts time between internal and external formats.
Timer Function
Returns the number of seconds that have elapsed since 12:00 AM (midnight).
TimeSerial Function
Returns the time for a specific hour, minute, and second.
Traverse Function
Traverses an array and returns the next subscript.
LTrim, RTrim, and Trim Functions
Returns a copy of a string without leading spaces (LTrim), trailing spaces (RTrim), or both leading and trailing spaces (Trim).
UCase Function
Returns a string that has been converted to uppercase.
Unlock Function
Releases a logical lock on a variable name.
Weekday Function
Returns a whole number representing the day of the week.
WeekdayName Function
Returns a string indicating the specified day of the week.
Year Function
Returns a whole number representing the year.
Reference D:
Caché Basic Operators
Caché Basic Operators
Caché Basic Scripting Language in Caché
Operator Precedence
Operator Precedence
Operator Summary
Operator Summary
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:
Caché Basic Constants
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:
Caché Basic Objects
Err Object
Contains information about runtime errors.
System Object
The System object provides access to properties and methods of Caché components.
Reference G:
Caché Basic General Concepts
Glossary
Caché Basic Glossary
Multidimensional Data Model
Introduction to the Multidimensional Data Model in Caché
Reserved words
A list of Basic reserved words.
Copyright
© 1997-2005, InterSystems Corp.
Last updated:
2004-12-30 14:04:16
Source:
RBAS.xml