Language Reference Guide
1. Introduction
About This Guide
Intended Audience
Conventions
Database-related Examples
Syntax
User Input Examples
Path Notation in This Guide
Your Support Options
2. Language Elements
Introduction
OpenROAD Names
Dynamic Names
Name Resolution
Dynamic Frame and Procedure Name Resolution
Variables
Simple Variables
How You Can Declare Simple Variables
How You Can Use Simple Variables
Reference Variables
How You Can Declare Reference Variables
How You Can Use Reference Variables
Null Reference Variables
How You Can Create Objects for Reference Variables
Dynamic Array Variables
How You Can Declare Dynamic Array Variables
How You Can Reference Dynamic Array Variables
Field and Menu Item Variables
How You Can Initialize Variables
Data Types
Character Data Types
Char Data Types
Varchar Data Types
Long Varchar Data Types
Unicode Data Types
Numeric Data Types
Integer Data Types
Decimal Data Types
Floating Point Data Types
Date/Time Data Types
Date/Time Input Formats
Date Data Type
Date(Ingresdate) Data Types
Coercion Between Date/Time Data Types
Abstract Data Types
Money Data Type
Numeric String Data Type
Logical Key Data Type
Storage Formats of Data Types
Nulls
Nulls and Comparisons
Nulls and Aggregate Functions
Nulls and Integrity Constraints
Expressions
Literals
String Literals
Numeric Literals
Named Constants
System Variables
Operators
Arithmetic Operators
String Operator
Logical Operators
Truth table for AND comparisons:
Comparison (Boolean) Operators
SQL Operators
SQL Operations
Like Operator and Pattern Matching
charvar
pattern
escapechar
Is [Not] Null Operator
Variables in Expressions
Procedures in Expressions
Methods in Expressions
Nulls in Expressions
Expressions in SQL Statements
System-defined Functions
SQL Functions
Scalar Functions
String Functions and the UTF-8 Character Set
String Functions Supported
Aggregate Functions
IFNULL Function
Dbmsinfo Function
Field Function
Comments
Predicates in SQL
Comparison Predicate
LIKE Predicate
BETWEEN Predicate
IN Predicate
Any-or-All Predicate
EXISTS Predicate
IS NULL Predicate
Search Conditions in SQL Statements
Subqueries
Subqueries in the WHERE Clause
Subqueries in the FROM Clause (Derived Tables)
Derived Table Syntax
3. Statements
Commonly Used Elements in Statements
BeginEndBlock
Condition
DeclareBlock
DeclareBlockWithProcedures
localvariabledeclaration
localproceduredeclaration
LocalProcedureDeclaration
LocalVariableDeclaration
NamedParameterList
NamedParameterListDefinition
parametername
type
NamedParameterListWithoutByref
StatementList
statement
Type
TypeWithoutDefault
UnnamedParameterList
WithClause
OpenROAD Language Statements
Assignment Statement
Parameters—Assignment Statement
variable
expression
Simple Assignment Statements
Reference Assignment Statements
Examples—Assignment Statement
Call Statement
Parameters—Call Statement
subsystem
parametername
value
Flag Parameters
Subsystem Types
Call Application Statement
Examples—Call Statement
Call System Statement
Parameters—Call System Statement
Example—Call System Statement
Callframe Statement
Parameters—Callframe Statement
returnvariable
framename
parameterlist
withclause
Examples—Callframe Statement
Callproc Statement
Parameters—Callproc Statement
procname
parameterlist
Example—Callproc Statement
Case Statement
Parameters—Case Statement
key
valuelist
Examples—Case Statement
Continue Statement
Parameters—Continue Statement
label
Examples—Continue Statement
Endloop Statement
Parameters—Endloop Statement
Examples—Endloop Statement
Exit Statement
For Statement
Breaking Out of For Loops
Parameters—For Statement
label
indexvariable
startexpression
endexpression
Example—For Statement
Gotoframe Statement
Parameters—Gotoframe Statement
framename
parameterlist
withclause
Example—Gotoframe Statement
If-Then-Else Statement
Parameters—If-Then-Else Statement
Variants—If-Then-Else Statement
Examples—If-Then-Else Statement
Initialize Statement
Parameters—Initialize Statement
declareblockwithprocedures
beginendblock
Examples—Initialize Statement
User Class Constructors
Message Statement
Parameters—Message Statement
varcharstringexpr
Example—Message Statement
Method Statement
Parameters—Method Statement
Example—Method Statement
Method Invocation Statement
Parameters—Method Invocation Statement
returnvariable
referencevariable
method
Examples—Method Invocation Statement
On Statement
Parameters—On Statement
eventtype
eventname
fieldname
parameterlist
Sending User-named Parameters with Userevents
Examples—On Statement
Openframe Statement
Parameters—Openframe Statement
GhostExec_object
framename
parameterlist
withclause
Examples—Openframe Statement
Procedure Statement
Parameters—Procedure Statement
procname
parameterlist
Examples—Procedure Statement
Prompt Statement
Parameters—Prompt Statement
variable
varcharstringexpr
Examples—Prompt Statement
Resume Statement
Examples—Resume Statement
Return Statement
Parameters—Return Statement
expression
Example—Return Statement
Sleep Statement
Parameters—Sleep Statement
Example—Sleep Statement
While Statement
Parameters—While Statement
label
condition
Breaking Out of While Loops
Examples—While Statement
OpenROAD SQL Statements
Distributed Ingres (Ingres STAR) Statements
Enterprise Access OpenSQL Statements
Alter Group Statement
Parameters—Alter Group Statement
Permissions
Locking
Related Statements
Examples—Alter Group Statement
Alter Role Statement
Parameters—Alter Role Statement
role_id
role_password
Permissions
Locking
Related Statements
Examples—Alter Role Statement
Close Statement
Parameters—Close Statement
Example—Close Statement
Commit Statement
Examples—Commit Statement
Copy Statement
Parameters—Copy Statement
table_name
column_name
format
filename
type
with_clause
Unformatted Copying
Formatted Copying
Bulk Copying
Column Formats for Copy
Filename Specification for Copy
With Clause for Copy
Permissions
Locking
Restrictions and Considerations
Related Statements
Examples—Copy Statement
Create Dbevent Statement
Parameters—Create Dbevent Statement
event_name
Permissions: All Users
Create Dbevent Locking
Create Dbevent Related Statements
Create Group Statement
Parameters—Create Group Statement
group id
user id
Create Group Permissions
Create Group Locking
Create Group Related Statements
Examples—Create Group Statement
Create Index Statement
Parameters--Create Index Statement
index_name
table_name
column_name
Create Index Description
Index Storage Structure
Unique Indexes
Effect of the Unique_Scope Option on Updates
Index Location
Create Index Permissions
Create Index Locking
Create Index Related Statements
Examples--Create Index Statement
Create Integrity Statement
Parameters—Create Integrity Statement
table_name
corr name
search_condition
Create Integrity Locking
Create Integrity Performance
Permissions: Own the table
Create Integrity Related Statements
Examples—Create Integrity Statement
Create Role Statement
Parameters—Create Role Statement
role_id
Create Role Permissions
Create Role Locking
Create Role Related Statements
Examples—Create Role Statement
Create Table Statement
Parameters—Create Table Statement
table_name
subselect
Create Table Description
Column Specification—Define Column Characteristics
column_name
datatype
With|Not Null and With|Not Default Combinations
Using Create Table...As Select
With_Clause for Create Table
encryption type
With_Clause for Create Table...As Select
Create Table Permissions
Create Table Locking
Create Table Related Statements
Examples—Create Table Statement
Create View Statement
Parameters—Create View Statement
view_name
select_stmt
Create View Description
With Check Option Clause
Create View Permissions
Create View Locking
Create View Related Statements
Examples—Create View Statement
Declare Global Temporary Table Statement
Restrictions on Temporary Tables
Examples—Declare Global Temporary Table Statement
Delete Statement
Non-cursor Version
Cursor Version
Parameters—Delete Statement
tablename
corrname
cursor_variable
Examples—Delete Statement
Direct Execute Immediate Statement
Parameters—Direct Execute Immediate Statement
Drop Statement
Parameters—Drop Statement
Drop Description
Drop Permissions
Drop Locking
Drop Related Statements
Examples—Drop Statement
Drop Dbevent Statement
Parameters—Drop Dbevent Statement
Drop Dbevent Permissions
Drop Dbevent Related Statements
Examples—Drop Dbevent Statement
Drop Group Statement
Parameters—Drop Group Statement
Drop Group Permissions
Drop Group Locking
Drop Group Related Statements
Examples—Drop Group Statement
Drop Integrity Statement
Parameters—Drop Integrity Statement
table_name
integer (,integer)
Drop Integrity Permissions
Drop Integrity Related Statements
Examples—Drop Integrity Statement
Drop Role Statement
Parameters—Drop Role Statement
role_id
Drop Role Permissions
Drop Role Locking
Drop Role Related Statements
Examples—Drop Role Statement
Drop Rule Statement
Parameters—Drop Rule Statement
Drop Rule Permissions
Examples—Drop Rule Statement
Execute Immediate Statement
Parameters—Execute Immediate Statement
Execute Immediate Description
Permissions: All Users
Execute Immediate Locking
Examples—Execute Immediate Statement
Execute Procedure Statement
Parameters—Execute Procedure Statement
variable
procname
parameterlist
Execute Procedure Permissions
Execute Procedure Locking
Execute Procedure Performance
Execute Procedure Related Statements
Examples—Execute Procedure Statement
Example—Exit Statement
Fetch Statement
Parameters—Fetch Statement
cursor_variable
variable_list
Examples—Fetch Statement
Grant (privilege) Statement
Parameters—Grant (privilege) Statement
privilege
object_type
object_name
auth_type
auth_id
Object Privileges
Privilege Defaults
Grant All Privileges Option
Grant (privilege) Permissions
Grant (privilege) Locking
Grant (privilege) Related Statements
Examples—Grant (privilege) Statement
Inquire_sql Statement
Parameters—Inquire_sql Statement
variablename
inquire_sql_constant
Example—Inquire_sql Statement
Insert Statement
Parameters—Insert Statement
tablename
columnname
expression
subselect
Values Clause and Subselect
Examples—Insert Statement
Modify Statement
Parameters—Modify Statement
modify-action
with_clause
Modify Description
Syntax for Modify Operations
Storage Structure Specification
Modify...to Reconstruct
Modify...to Merge
Modify...to Relocate
Modify...to Reorganize
Modify...to Truncated
Modify...to Add_extend
Modify...with Blob_extend
Modify...to Phys_consistent|Phys_inconsistent
Modify...to Log_consistent|Log_inconsistent
Modify...to Table_recovery_allowed|Table_recovery_disallowed
Modify…to [No]Readonly
With Clause Options for Modify
Modify Permissions
Modify Locking
Modify Related Statements
Examples—Modify Statement
Open Statement
Parameters—Open Statement
cursor_variable
select_statement
update_clause
column
How You Can Define the Cursor Mode
Examples—Open Statement
Raise Dbevent Statement
Parameters—Raise Dbevent Statement
event_name
Raise Dbevent Description
Raise Dbevent Permissions
Raise Dbevent Related Statements
Register Dbevent Statement
Parameters—Register Dbevent Statement
event_name
Register Dbevent Permissions
Register Dbevent Related Statements
Register Table Statement
Parameters—Register Table Statement
table_name
Register Table Description
Security Log File Format
Register Table Permissions
Register Table Locking
Related Statements
Examples—Register Table Statement
Relocate Statement
Parameters—Relocate Statement
location_name
Examples—Relocate Statement
Remove Dbevent Statement
Parameters—Remove Dbevent Statement
Remove Table Statement
Parameters—Remove Table Statement
Remove Table Permissions
Remove Table Locking
Remove Table Related Statements
Examples—Remove Table Statement
Revoke Statement
Parameters—Revoke Statement
privilege
object_type
object_name
auth_type
auth_id
Revoke Permissions
Revoke Locking
Revoke Related Statements
Examples—Revoke Statement
Rollback Statement
Parameters—Rollback Statement
Permissions: All Users
Rollback Locking
Rollback Performance
Example—Rollback Statement
Save Statement
Parameters—Save Statement
month
day
Permissions: Own the table
Save Locking
Examples—Save Statement
Savepoint Statement
Parameters—Savepoint Statement
savepoint_name
Permissions: All Users
Savepoint Related Statements
Examples—Savepoint Statement
Select Statement
Parameters—Select Statement
dbexpression
simple_variable
resultname
tablename
corrname
searchcondition
columnname
orderspecification
fromvariable
groupvariable
ordervariable
Union Clause
Outer Joins
source
join_type
search_condition
Where Clause
searchcondition
Order By Clause
Using a Select Loop
Examples—Select Statement
Set Statement
Parameters—Set Statement
Set Permissions
Autocommit
[No]Batch_Copy_Optim
[No]Cache_dynamic
[No]Cardinality_check
Cpufactor
Date_format
Decimal
[No]Flatten
[No]Hash
[No]Io_trace
Joinop [No]Timeout
Joinop Timeoutabort
Joinop [No]Greedy
[No]Journaling
Lockmode
n
n
[No]Lock_Trace
[No]Logdbevents
[No]Logging
[No]Log_trace
[No]Maxconnect
[No]Maxcost
[No]Maxcpu
[No]Maxidle
[No]Maxio
[No]Maxpage
[No]Maxquery
[No]Maxrow
Money_format
Money_prec
[No]Ojflatten
[No]Optimizeonly
[No]Parallel
[No]Printdbevents
[No]Printqry
[No]Printrules
[No]Qep
Random_seed
Result_Structure
Role
[No]Rules
Session With On_error
Session With On_user_error
Session Authorization
username
Session [No]Cache_Dynamic
[No]Statistics table_name
[No]Trace Output
[No]Trace Point
Transaction Access Mode
Transaction Isolation Level
[No]Unicode_substitution
Update_Rowcount
Examples—Set Statement
Update Statement
Parameters—Update Statement
tablename
corrname
columnname
dbexpression
searchcondition
cursor_variable
fromvariable
Set Clause
Where Clause
Update Mode
Examples—Update Statement
EXEC 4GL Statements for 3GL
Clear Array Statement
arr
Describe Statement
object
descriptor
Get Attribute Statement
object
array
var
ind
attribute
index
descriptor
Get Global/Set Global Statement
var
ind
name
GetRow Statement
array
index
object
Inquire_4gl Statement
variable
array
4gl_constant
ind
Insertrow Statement
array
integer
Removerow Statement
array
integer
Send Userevent Statement
frame
eventname
strvar
objvar
intvar
fltvar
Set Attribute Statement
object
array
index
attribute
var
ind
descriptor
Set_4gl Statement
value
Setrow Statement
array
index
object
Setrow Deleted Statement
array
integer
4. System Classes
Inheritance: Subclasses and Superclasses
How You Can Use This Chapter
Attribute Abbreviations
ActiveField Class
Declared Attribute
DragObject Attribute
DropObject Attribute
FocusBehavior Attribute
IsDragSource Attribute
IsPropOptInherited Attribute
OutlineColor Attribute
OutlineStyle Attribute
OutlineWidth Attribute
PropertyOptMenu Attribute
TabSeqNum Attribute
WidgetID Attribute
CheckFailedMandatory Method
DeclareData Method
SetToDefault Method
UndeclareData Method
UpdField Method
AnalogField Class
MaxValue Attribute
MinValue Attribute
AppFlag Class
FlagValues Attribute
Name Attribute
AppSource Class
WindowIcon Attribute
ExportApp Method
FetchComponent Method
ImportComp Method
Array Class
Row_Class Attribute
ArrayObject Class
_RowSelected Attribute
_RowState Attribute
AllRows Attribute
ClientInteger Attribute
FirstRow Attribute
LastRow Attribute
AllRows Method
Clear Method
Find Method
FirstRow Method
InsertRow Method
LastRow Method
RemoveRow Method
SetRowDeleted Method
Sort Method
AttributeObject Class
DataType Attribute
DefaultString Attribute
DefaultValue Attribute
IsArray Attribute
IsNullable Attribute
IsPrivate Attribute
Name Attribute
BarField Class
FgBitmap Attribute
FgPattern Attribute
GrowFrom Attribute
UpdForeground Method
BitmapObject Class
DBHandle Attribute
ErrorStatus Attribute
FileHandle Attribute
HeightPixels Attribute
Picture Attribute
WidthPixels Attribute
DeleteFromDB Method
InsertIntoDB Method
LoadLong Method
UpdateInDB Method
WriteToFile Method
BoxTrim Class
BreakSpec Class
ColumnIndex Attribute
FormatString Attribute
Level Attribute
ButtonField Class
BitmapLabel Attribute
BmpDisplayBehavior Attribute
ButtonStyle Attribute
IsAutoSized Attribute
IsBold Attribute
IsItalic Attribute
IsPlain Attribute
IsUnderlined Attribute
TextAlignment Attribute
TextDisplayBehavior Attribute
TextLabel Attribute
TypeFace Attribute
TypeFaceName Attribute
TypeSize Attribute
CellAttribute Class
BgBitmap Attribute
BgColor Attribute
BgPattern Attribute
Cursor Attribute
FgBitmap Attribute
FgColor Attribute
FgPattern Attribute
FormatString Attribute
HasDataChanged Attribute
IsBold Attribute
IsItalic Attribute
IsPlain Attribute
IsReverse Attribute
IsUnderlined Attribute
OutlineColor Attribute
TypeFace Attribute
TypeFaceName Attribute
TypeSize Attribute
UpdBackground Method
UpdForeground Method
ChoiceBitmap Class
EnumBitmap Attribute
ChoiceDetail Class
EnumSubText Attribute
ImageIndex Attribute
ChoiceField Class
CurEnumDisplay Attribute
CurEnumText Attribute
CurEnumValue Attribute
ValueList Attribute
UpdChoiceList Method
ChoiceItem Class
EnumDisplay Attribute
EnumText Attribute
EnumValue Attribute
IsSelected Attribute
ToolTipText Attribute
ChoiceList Class
ChoiceItems Attribute
AddBitmapItem Method
AddItem Method
AddTextItem Method
BitmapByDisplay Method
BitmapByIndex Method
BitmapByText Method
BitmapByValue Method
DisplayByBitmap Method
DisplayByIndex Method
DisplayByText Method
DisplayByValue Method
IndexByBitmap Method
IndexByDisplay Method
IndexByText Method
IndexByValue Method
TextByBitmap Method
TextByDisplay Method
TextByIndex Method
TextByValue Method
ValueByBitmap Method
ValueByDisplay Method
ValueByIndex Method
ValueByText Method
Class Class
Create Method
ClassSource Class
Attributes Attribute
Methods Attribute
SuperClass Attribute
CreateClass Method
ColumnCross Class
ColumnField Class
ColumnNumber Attribute
HasCellAttributes Attribute
HasSingleCharFind Attribute
ParentTable Attribute
ProtoField Attribute
Title Attribute
TitleTrim Attribute
CellAttribute Method
CompositeField Class
ChildFields Attribute
GroupBoxLabel Attribute
IsMoveBounded Attribute
IsResizeBounded Attribute
FieldByName Method
IsAncestorOf Method
SelectAll Method
CompSource Class
AlterBy Attribute
AlterCount Attribute
AlterDate Attribute
AssistantProc Attribute
Compile_Errors Attribute
CreateDate Attribute
Creator Attribute
DataType Attribute
EntityID Attribute
IsNullable Attribute
IsStale Attribute
Name Attribute
ObjectShortRemarks Attribute
ParentApplication Attribute
Queries Attribute
Script Attribute
VersionNumber Attribute
VersShortRemarks Attribute
ExportComp Method
ControlButton Class
CrossTable Class
AcrossValues Attribute
Aggregate Attribute
CrossColumn Attribute
CursorBitmap Class
SysCursor Attribute
CursorObject Class
DBSession Attribute
RowCount Attribute
State Attribute
DataStream Class
Breaks Attribute
ClientInteger Attribute
Columns Attribute
CurBreakLevel Attribute
CurRow Attribute
ErrorNo Attribute
IsDBError Attribute
MaxRow Attribute
Name Attribute
NextBreakLevel Attribute
QueryMode Attribute
Scope Attribute
State Attribute
SuppressErrorTrace Attribute
TargetArray Attribute
TargetPrefix Attribute
AddBreak Method
ClearBreaks Method
Close Method
FetchRow Method
Load Method
NextRow Method
Open Method
PrevRow Method
SetCols Method
DateObject Class
Value Attribute
DBEventObject Class
DBEventDatabase Attribute
DBEventName Attribute
DBEventOwner Attribute
DBEventText Attribute
DBEventTime Attribute
DBSessionObject Class
Database Attribute
DBMSError Attribute
ErrorNumber Attribute
Flags Attribute
Ingres Attribute
PreFetchRows Attribute
n
RowCount Attribute
ServerClass Attribute
ServerType Attribute
SessionID Attribute
State Attribute
CommitWork Method
Connect Method
Disconnect Method
NewDBComponent Method
OpenNewConnection Method
RaiseDBEvent Method
RegisterDBEvent Method
RemoveDBEvent Method
RollbackWork Method
SequenceValue Method
SetAutoCommit Method
WriteDBComponent Method
DecimalObject Class
Precision Attribute
Scale Attribute
Value Attribute
DisplayForm Class
DragInfo Class
KeyState Attribute
Source Attribute
Target Attribute
X Attribute
Y Attribute
DynExpr Class
Assign Method
GetField Method
GetValue Method
SetValue Method
StringValue Method
EllipseShape Class
EntryField Class
BufferString Attribute
BufferText Attribute
CharsPerLine Attribute
CurMarkedText Attribute
CursorPosition Attribute
ExactWidth Attribute
ExitBehavior Attribute
FirstMarked Attribute
ForceCase Attribute
FormatString Attribute
HasHorizontalScrollBar Attribute
HasScrollBar Attribute
InputMasking Attribute
IsBold Attribute
IsItalic Attribute
IsMandatory Attribute
IsMultiLine Attribute
IsPassword Attribute
IsPlain Attribute
IsUnderlined Attribute
LastMarked Attribute
Lines Attribute
MaxCharacters Attribute
StringValue Attribute
TextLength Attribute
TextValue Attribute
TypeFace Attribute
TypeFaceName Attribute
TypeSize Attribute
UseWidestCharacter Attribute
MarkAllText Method
MarkSubText Method
UnmarkAllText Method
EnumField Class
ExactWidth Attribute
IsBold Attribute
IsItalic Attribute
IsPlain Attribute
IsUnderlined Attribute
MinimumWidth Attribute
TypeFace Attribute (EnumField)
TypeFaceName Attribute
TypeSize Attribute
Event Class
EventName Attribute
MessageErrorCode Attribute
MessageFloat Attribute
MessageInteger Attribute
MessageObject Attribute
MessageVarchar Attribute
ExtObject Class
ExtObjField Class
InsertObject Method
FieldObject Class
BgColor Attribute
ClientText Attribute
ControlField Attribute
DataType Attribute
DefaultString Attribute
DefaultValue Attribute
FgColor Attribute
FullName Attribute
HasDataChanged Attribute
IsNullable Attribute
Name Attribute
ParentExec Attribute
Script Attribute
GetFieldValue Method
IsDescendantOf Method
SetFieldValue Method
UpdValue Method
WhichTableField Method
FlexibleForm Class
FloatObject Class
Value Attribute
FormField Class
AbsXLeft Attribute
AbsXRight Attribute
AbsYBottom Attribute
AbsYTop Attribute
AllBias Attribute
AnchorPoint Attribute
BgBitmap Attribute
BgDisplayPolicy Attribute
BgPattern Attribute
CurBias Attribute
Cursor Attribute
Gravity Attribute
HasFieldChanged Attribute
Height Attribute
IsCurField Attribute
IsReverse Attribute
IsSelected Attribute
LayerSequence Attribute
MouseDownText Attribute
MouseMoveText Attribute
OuterHeight Attribute
OuterWidth Attribute
ParentField Attribute
QueryBias Attribute
ReadBias Attribute
RequireRealField Attribute
ToolTipText Attribute
UpdateBias Attribute
User1Bias Attribute
User2Bias Attribute
User3Bias Attribute
Width Attribute
XAnchorPoint Attribute
XLeft Attribute
XRight Attribute
YAnchorPoint Attribute
YBottom Attribute
YTop Attribute
UpdBackground Method
FrameExec Class
AutoUpdField Attribute
BgBitmap Attribute
BgColor Attribute
BgPattern Attribute
CurMode Attribute
DefaultButton Attribute
GridX Attribute
GridY Attribute
HasScrollBars Attribute
HasStatusBar Attribute
HeightConstrained Attribute
InputFocusField Attribute
IsAutoSized Attribute
IsBordered Attribute
IsClosable Attribute
IsGridOn Attribute
IsLassoActive Attribute
IsMaximizable Attribute
IsMaximized Attribute
How to Change the IsMaximized Setting at Runtime
How to Change the IsMaximized Setting While a Frame is Invisible
How to Execute an Openframe Using a With Clause to Set the IsMaximized Attribute
IsMinimizable Attribute
IsPopup Attribute
IsResizeable Attribute
IsTitled Attribute
IsToolWindow Attribute
IsTopmost Attribute
NextTargetField Attribute
OriginatorField Attribute
PortletBlocking Attribute
PreviousField Attribute
ReasonCode Attribute
SelectedList Attribute
StartMenu Attribute
StatusText Attribute
TargetField Attribute
TopForm Attribute
TriggerField Attribute
WidgetID Attribute
WidthConstrained Attribute
WindowHeight Attribute
WindowPlacement Attribute
WindowTitle Attribute
WindowVisibility Attribute
WindowWidth Attribute
WindowXLeft Attribute
WindowYTop Attribute
XEnd Attribute
XStart Attribute
YEnd Attribute
YStart Attribute
Activate Method
BringToFront Method
FieldByName Method
SendToBack Method
SetWindowIcon Method
SnapToGrid Method
UpdBackground Method
FrameForm Class
FieldByFullName Method
FrameSource Class
BgBitmap Attribute
BgColor Attribute
BgPattern Attribute
CurMode Attribute
HasScrollBars Attribute
HasStatusBar Attribute
IsAutoSized Attribute
IsBordered Attribute
IsClosable Attribute
IsGridOn Attribute
IsMaximizable Attribute
IsMaximized Attribute
IsMinimizable Attribute
IsPopup Attribute
IsResizeable Attribute
IsTitled Attribute
IsToolWindow Attribute
IsTopmost Attribute
StartMenu Attribute
StatusText Attribute
TopForm Attribute
WindowHeight Attribute
WindowIcon Attribute
WindowPlacement Attribute
WindowTitle Attribute
WindowWidth Attribute
WindowXLeft Attribute
WindowYTop Attribute
FreeTrim Class
GhostExec Class
DBEvent Attribute
EventName Attribute
EventType Attribute
MessageErrorCode Attribute
MessageFloat Attribute
MessageInteger Attribute
MessageObject Attribute
MessageVarchar Attribute
ParentFrame Attribute
PurgeDBEvent Method
PurgeUserEvent Method
RegisterUserEvent Method
SendUserEvent Method
Terminate Method
UnRegisterUserEvent Method
GhostSource Class
HashTable Class
AllowSubclassObjects Attribute
AutoResizeThreshold Attribute
ObjectClass Attribute
ObjectCount Attribute
Size Attribute
UniqueKey Attribute
IconFile Class
Count Attribute
ErrorStatus Attribute
FileHandle Attribute
GetBitmap Method
ImageField Class
BmpDisplayBehavior Attribute
DisplayPolicy Attribute
ImageTrim Class
Image Attribute
IntegerHashTable Class
Clear Method
Contains Method
Find Method
FindAll Method
InsertObject Method
RemoveObject Method
Setup Method
IntegerHashTable Examples
IntegerObject Class
Value Attribute
KeyDownData Class
CharacterValue Attribute
IsExtended Attribute
Modifiers Attribute
PreviousState Attribute
ScanCode Attribute
VirtualKey Attribute
KeyPressInfo Class
ANSICode Attribute
Character Attribute
ListField Class
HasSingleCharFind Attribute
SelectionType Attribute
VisibleRows Attribute
ListviewColAttr Class
ColumnWidth Attribute
HeaderText Attribute
TextAlignment Attribute
ListviewField Class
ColAttributes Attribute
DragItem Attribute
Drag_Row Attribute
Drop_Row Attribute
EditLabel Attribute
FullRowSelect Attribute
HasColumnHeaders Attribute
LargeImageHeight Attribute
LargeImageList Attribute
LargeImageWidth Attribute
SmallImageHeight Attribute
SmallImageList Attribute
SmallImageWidth Attribute
Style Attribute
TopRow Attribute
VisibleRows Attribute
LongByteObject Class
ErrorStatus Attribute
FileHandle Attribute
Length Attribute
Value Attribute
ConvertFromString Method
format
FetchFromDB Method
LoadValue Method
UpdateInDB Method
WriteToFile Method
LongVcharObject Class
ErrorStatus Attribute
FileHandle Attribute
Length Attribute
Value Attribute
FetchFromDB Method
LoadString Method
UpdateInDB Method
WriteToFile Method
MatrixField Class
ChildBottomMargin Attribute
ChildGravity Attribute
ChildLeftMargin Attribute
ChildRightMargin Attribute
ChildTopMargin Attribute
CollapsePolicy Attribute
Columns Attribute
Rows Attribute
SeparatorColor Attribute
SeparatorStyle Attribute
SeparatorWidth Attribute
FieldByPosition Method
InsertChild Method
WhichCell Method
MenuBar Class
HelpMenu Attribute
FieldByFullName Method
MenuButton Class
IsBold Attribute
IsItalic Attribute
IsPlain Attribute
SpeedKey Attribute
TextLabel Attribute
TypeFace Attribute
TypeSize Attribute
MenuField Class
AllBias Attribute
CurBias Attribute
IsReverse Attribute
ParentMenuGroup Attribute
QueryBias Attribute
ReadBias Attribute
StatusText Attribute
UpdateBias Attribute
User1Bias Attribute
User2Bias Attribute
User3Bias Attribute
WidgetID Attribute
SetToDefault Method
MenuGroup Class
ChildMenuFields Attribute
IsBold Attribute
IsItalic Attribute
IsPlain Attribute
TextLabel Attribute
TypeFace Attribute
TypeSize Attribute
FieldByName Method
UpdMenu Method
MenuItem Class
FocusBehavior Attribute
MenuList Class
CurEnumDisplay Attribute
CurEnumText Attribute
CurEnumValue Attribute
IsBold Attribute
IsItalic Attribute
IsPlain Attribute
TypeFace Attribute
TypeSize Attribute
ValueList Attribute
UpdChoiceList Method
MenuSeparator Class
MenuStack Class
MenuToggle Class
HasIndicator Attribute
OffTextLabel Attribute
OnTextLabel Attribute
MethodExec Class
SendSuperClass Method
MethodObject Class
DataType Attribute
IsArray Attribute
IsNullable Attribute
IsPrivate Attribute
Name Attribute
MoneyObject Class
Value Attribute
Object Class
ClassName Attribute
ClientData Attribute
InstanceIdentifier Attribute
InstanceReferences Attribute
Duplicate Method
GetAttribute Method
IsA Method
SetAttribute Method
OptionField Class
InnerShadowWidth Attribute
Style Attribute
TextLabel Attribute
VisibleRows Attribute
OptionMenu Class
PaletteField Class
BmpDisplayBehavior Attribute
ButtonStyle Attribute
Columns Attribute
CurEnumBitmap Attribute
Orientation Attribute
PopupButton Class
OptionMenu Attribute
PopupAlignment Attribute
Proc4GLSource Class
ProcExec Class
BlocksFrames Attribute
DataEntryErrorHandler Attribute
DBSession Attribute
LineNumber Attribute
LocalScope Attribute
Name Attribute
ObjectSource Attribute
Parent Attribute
Queries Attribute
Scope Attribute
Beep Method
ConfirmPopup Method
DeferConfigure Method
FilePopup Method
Using the reply parameter
filename
filespec
filespeclist
ccfilefilter
filterlist
Flush Method
InfoPopup Method
ReplyPopup Method
SetExitTrap Method
Trace Method
WaitFor Method
ProcHandle Class
Call Method
QueryCol Class
AsName Attribute
ClientInteger Attribute
ColumnName Attribute
DataType Attribute
DataTypeCode Attribute
DataTypeLength Attribute
DataTypeNullable Attribute
DataTypePrecision Attribute
Expression Attribute
FromTable Attribute
GroupBy Attribute
IsExpression Attribute
OrderBy Attribute
Targets Attribute
Value Attribute
DBIdentifier Method
QueryObject Class
DesignTimeWhere Attribute
HavingClause Attribute
IsDistinct Attribute
RunTimeWhere Attribute
Tables Attribute
CommitToCache Method
DBDelete Method
DBInsert Method
DBUpdate Method
QueryParm Class
CompiledExpression Attribute
CompiledResult Attribute
Expression Attribute
IsDBHandleField Attribute
IsDefault Attribute
IsDeleteWhere Attribute
IsFileHandleField Attribute
IsInsertTarget Attribute
IsSelectTarget Attribute
IsUpdateTarget Attribute
IsUpdateWhere Attribute
ResultAssignment Attribute
UsePrefix Attribute
QueryTable Class
ClientInteger Attribute
CorrName Attribute
OwnerName Attribute
TableName Attribute
RadioField Class
Columns Attribute
ColumnHeightCompressed Attribute
ColumnWidthCompressed Attribute
Orientation Attribute
RectangleShape Class
RemoteServer Class
Errorcode Attribute
Errortext Attribute
Flags Attribute
Image Attribute
Location Attribute
ServerType Attribute
Call4GL Method
Initiate Method
Release Method
RowCross Class
ScalarField Class
Scope Class
CreateDynExpr Method
GetProcHandle Method
ScrollBarField Class
ElevatorSize Attribute
Orientation Attribute
PageSize Attribute
StepSize Attribute
SegmentShape Class
Point1X Attribute
Point1Y Attribute
Point2X Attribute
Point2Y Attribute
SetEndPoints Method
SeparatorMoveInfo Class
SeparatorNumber Attribute
SeparatorPosition Attribute
SessionObject Class
AppFlags Attribute
CallSystemStatus Attribute
DBEventPollrate Attribute
DBMSErrorPrinting Attribute
DBMSMessagePrinting Attribute
DisplayCapability Attribute
ExitCode Attribute
ExternalError Attribute
OperatingSystem Attribute
PixelScreenHeight Attribute
PixelScreenWidth Attribute
ProcessWait Attribute
ProcessWindow Attribute
Runtime Attribute
Scope Attribute
ScreenHeight Attribute
ScreenWidth Attribute
TimeZone Attribute
UserName Attribute
Version Attribute
WindowSystem Attribute
CheckFeature Method
ClearErrorFlag Method
CreateDirectory Method
DirectoryExists Method
FileExists Method
GenerateGUID Method
GetColorName Method
GetEnv Method
SetEnv Method
WinHelp Method
ShapeField Class
LineColor Attribute
LineStyle Attribute
LineWidth Attribute
SliderField Class
DisplayValues Attribute
IsBold Attribute
IsItalic Attribute
IsPlain Attribute
IsUnderlined Attribute
Orientation Attribute
PageSize Attribute
StepSize Attribute
Style Attribute
TickIntervals Attribute
TypeFace Attribute
TypeFaceName Attribute
TypeSize Attribute
SQLSelect Class
DBSession Attribute
Query Attribute
QueryName Attribute
StackField Class
ChildBottomMargin Attribute
ChildGravity Attribute
ChildLeftMargin Attribute
ChildRightMargin Attribute
ChildTopMargin Attribute
Orientation Attribute
SeparatorColor Attribute
SeparatorMoving Attribute
SeparatorStyle Attribute
SeparatorWidth Attribute
InsertChild Method
StringHashTable Class
IgnoreCase Attribute
Clear Method
Contains Method
Find Method
FindAll Method
InsertObject Method
RemoveObject Method
Setup Method
StringHashTable Examples
StringObject Class
DBHandle Attribute
ErrorStatus Attribute
FileHandle Attribute
Length Attribute
Value Attribute
AppendToFile Method
ConcatString Method
ConcatVarchar Method
ConvertFromBinary Method
DeleteFromDB Method
ExpandParm Method
ExtractString Method
InsertIntoDB Method
Join Method
LeftTruncate Method
LoadLong Method
LocateString Method
RightTruncate Method
Split Method
SubString Method
UpdateInDB Method
WriteToFile Method
SubForm Class
ChildGravity Attribute
IsBold Attribute
IsItalic Attribute
IsPlain Attribute
IsUnderlined Attribute
TypeFace Attribute
TypeFaceName Attribute
TypeSize Attribute
TabBar Class
BarPosition Attribute
BitmapPosition Attribute
DisplayBitmap Attribute
DisplayText Attribute
IsBold Attribute
IsFixedWidth Attribute
IsItalic Attribute
IsPlain Attribute
IsUnderlined Attribute
MultiTabStyle Attribute
NormalTabColor Attribute
NormalTextColor Attribute
OutlineColor Attribute
SelectedIsBold Attribute
SelectedIsItalic Attribute
SelectedIsPlain Attribute
SelectedIsUnderlined Attribute
SelectedTabColor Attribute
SelectedTextColor Attribute
SelectedTypeFace Attribute
SelectedTypeFaceName Attribute
SelectedTypeSize Attribute
Separation Attribute
ShadowColor Attribute
TabFieldArray Attribute
TabGap Attribute
TabJustification Attribute
TabShape Attribute
TypeFace Attribute
TypeFaceName Attribute
TypeSize Attribute
XMargin Attribute
YMargin Attribute
TabField Class
HasBitmap Attribute
HasTextLabel Attribute
NormalBitmap Attribute
SelectedBitmap Attribute
TextLabel Attribute
TabFolder Class
CurPageIndex Attribute
CurTabPage Attribute
IsShadowed Attribute
PrevPageIndex Attribute
TabBar Attribute
TabPageArray Attribute
TargetPageIndex Attribute
AddTabPage Method
DeleteTabPage Method
TableField Class
_RowSelected Attribute
ActiveRow Attribute
AlwaysHighlighted Attribute
ColSeparatorColor Attribute
ColSeparatorStyle Attribute
ColSeparatorWidth Attribute
ColumnResizable Attribute
ColumnsDisplayed Attribute
ControlButton Attribute
CurOps Attribute
CurRow Attribute
Drag_Row Attribute
Drop_Row Attribute
HasHeader Attribute
HasHeaderButtons Attribute
HasHorizontalScrollBar Attribute
HasScrollBar Attribute
IsHighlighted Attribute
NumVisibleRows Attribute
Orientation Attribute
QueryOps Attribute
ReadOps Attribute
RowSeparatorColor Attribute
RowSeparatorStyle Attribute
RowSeparatorWidth Attribute
ScrollingChangesSelection Attribute
SelectionType Attribute
TableBody Attribute
TableHeader Attribute
TargetRow Attribute
Title Attribute
TitleTrim Attribute
TopRow Attribute
UpdateOps Attribute
User1Ops Attribute
User2Ops Attribute
User3Ops Attribute
CopyToClipboard Method
DeleteColumn Method
InsertColumn Method
SetInputFocus Method
WhichRow Method
TabPage Class
DelayMkwidget Attribute
TabField Attribute
ToggleField Class
HasImageAndText Attribute
HasIndicator Attribute
OffBitmapLabel Attribute
OnBitmapLabel Attribute
OffTextLabel Attribute
OnTextLabel Attribute
Tree Class
Nodes Attribute
RootNode Attribute
AddNode Method
DeleteNode Method
NextNode Method
NodeByKey Method
NodeByName Method
StartTraverse Method
StopTraverse Method
TreeNode Class
BmpLblIndx Attribute
Children Attribute
Descendants Attribute
FirstChild Attribute
HasChildren Attribute
IsExpanded Attribute
IsSelected Attribute
IsVisible Attribute
LastChild Attribute
NextSibling Attribute
ParentNode Attribute
PrevSibling Attribute
SelBmpLblIndx Attribute
TextLabel Attribute
TreeviewField Class
AllowLabelEdit Attribute
CurNode Attribute
HasButtons Attribute
HasLines Attribute
HasRootLine Attribute
ImageList Attribute
IsBold Attribute
IsItalic Attribute
IsPlain Attribute
IsUnderlined Attribute
ShowSelection Attribute
Tree Attribute
TriggerNode Attribute
TypeFaceName Attribute
TypeSize Attribute
EditLabel Method
UserClassObject Class
UserObject Class
ViewportField Class
ClipHeight Attribute
ClipWidth Attribute
ScrollBarWidth Attribute
XOffset Attribute
YOffset Attribute
XMLAttribute Class
ClientInteger Attribute
ClientText Attribute
Name Attribute
Value Attribute
XMLCDATA Class
Value Attribute
XMLComment Class
Value Attribute
XMLDocument Class
ErrorText Attribute
ParsedXMLEncoding Attribute
ParsedXMLStandalone Attribute
ParsedXMLVersion Attribute
RootElement Attribute
AbortWrite Method
IsValidXMLName Method
ParseString Method
ParseURL Method
WriteCDATA Method
WriteComment Method
WriteElement Method
WriteEndDocument Method
WriteEndElement Method
WriteProcessingInstruction Method
WriteStartDocument Method
WriteStartElement Method
WriteTextData Method
WriteToFile Method
XMLElement Class
Attributes Attribute
Children Attribute
Name Attribute
AddAttribute Method
AddChild Method
AddChildElement Method
GetAttributeValue Method
GetCharacterValue Method
GetChildElementCharacterValue Method
RemoveAttribute Method
RemoveChild Method
SetAttributeValue Method
XMLNode Class
ClientInteger Attribute
ClientText Attribute
ParentElement Attribute
XMLPI Class
Target Attribute
Value Attribute
XMLSchemaCache Class
AddSchema Method
RemoveSchema Method
XMLText Class
Value Attribute
5. Events
BufferChanged Event
ChildBufferChanged Event
ChildClick Event
Event Block Execution
ChildClickPoint Event
ChildCollapsed Event
ChildDetails Event
ChildDoubleClick Event
ChildDragBox Event
ChildDragDrop Event
ChildDragLeave Event
ChildDragOver Event
ChildDragSegment Event
ChildEntry Event
ChildExit Event
ChildExpanded Event
ChildHeaderClick Event
ChildKeyDown Event
ChildKeyPress Event
ChildLabelChanged Event
ChildMouseEnter Event
ChildMouseExit Event
ChildMoved Event
ChildPageActivated Event
ChildPageChanged Event
ChildPageDeactivated Event
ChildProperties Event
ChildResized Event
ChildScroll Event
ChildSelect Event
ChildSelectionChanged Event
ChildSeparatorMove Event
ChildSetValue Event
ChildSliderMove Event
ChildUnSelect Event
ChildValidate Event
Click Event
ClickPoint Event
Collapsed Event
DBEvent Event
Details Event
DoubleClick Event
DragBox Event
DragDrop Event
DragLeave Event
DragOver Event
DragSegment Event
Entry Event
Exit Event
Expanded Event
ExtClassEvent Event
fieldname
eventname
parameterlist
variablename
FrameActivate Event
FrameDeactivate Event
HeaderClick Event
InsertRow Event
KeyDown Event
KeyPress Event
LabelChanged Event
MouseEnter Event
MouseExit Event
Moved Event
PageActivated Event
PageChanged Event
PageDeactivated Event
Properties Event
Resized Event
Scroll Event
Select Event
SelectionChanged Event
SeparatorMove Event
SetValue Event
SliderMove Event
Terminate Event
UnSelect Event
UserEvent Event
Validate Event
WindowClose Event
WindowIcon Event
WindowMoved Event
WindowResized Event
WindowVisible Event
Events Table
6. Functions
Overview
Core Library Functions
RGB Function
Example—RGB function:
StdList Function
Example—StdList function:
ToString Function
Example—ToString function:
Finance Library Functions
CTERM Function
Example—CTERM function:
DDB Function
Example—DDB function:
DEPR Function
Example—DEPR function:
FV Function
Example—FV function:
FVC Function
Example—FVC function:
IPER Function
Example—IPER function:
IPMT Function
IRATE Function
Example—IRATE function:
NPER Function
Example—NPER function:
PC Function
Example—PC function:
PMT Function
Example—PMT function:
PPMT Function
Example—PPMT function:
PV Function
Example—PV function:
SLN Function
Example—SLN function:
SYD Function
Example—SYD function:
Stat Library Functions
AVERAGE Function
Example—AVERAGE function:
LSQ Function
Example—LSQ function:
MAXIMUM Function
Example—MAXIMUM function:
MEDIAN Function
Example—MEDIAN function:
MINIMUM Function
Example—MINIMUM function:
MODAL Function
Example—MODAL function:
STD Function
Example—STD function:
STDS Function
Example—STDS function:
VAR Function
Example—VAR function:
VARS Function
7. Preprocessing Your 4GL Code
Overview
Preprocessor
Include Scripts
The #include Statement
scriptname
General Preprocessor Statement Rules
Comments in Preprocessor Statements
User-defined Macro Variables
Built-in Macro Variables
The #define Statement
$variable
$variable
expr
bool_expr
Guidelines for Using the #define Statement
The #undef Statement
$variable
The #if - #endif Statement
bool_expr
bool_expr
Guidelines for Using the #if – #endif Statement
The #ifdef – #endif Statement
The #ifndef - #endif Statement
Error Processing
Example—Error Processing
A. System Constants and Keywords
Introduction
System Constants
For the Exit, ChildExit, SetValue, ChildSetValue, Entry, ChildEntry, Validate, and ChildValidate Events
For the Click, ChildClick, Details, ChildDetails, ClickPoint, ChildClickPoint, Properties, ChildProperties, DoubleClick, and ChildDoubleClick Events
For the DragSegment, ChildDragSegment, DragBox, ChildDragBox, Resized, ChildResized, Moved, and ChildMoved Events
For Select and ChildSelect Events
For UnSelect and ChildUnSelect Events
For the SelectionChanged Event
For the DeleteAllRow, InsertRow, DeleteRow, WindowClosed, WindowIcon, WindowMoved, WindowResized, and WindowVisible Events
Other Reason Codes Unassociated with any Particular Event
4GL Keywords
B. Dedicated User Classes for .INI File Support
Introduction
ProfileObject User Class
Contents Attribute
IniContent Attribute
Modified Attribute
GetLine Method
GetProfileVarchar Method
GetString Method
ReadProfile Method
SetProfileVarchar Method
SetString Method
WriteProfile Method
SectionObject User Class
Entries Attribute
Section Attribute
GetString Method
SetString Method
EntryObject User Class
Entry Attribute
Keyword Attribute
GetString Method
SetString Method
How You Can Use the INI File Facility
C. Generated User Classes
Introduction
_PictureField User Class
Bitmap Attribute
Handle Attribute
DeleteFromDB Method
InsertIntoDB Method
SetBitmapNull Method
SetDBHandle Method
SetDBHandles Method
SetFileHandle Method
SetFileHandles Method
_StringField User Class
DataChanged Attribute
Handle Attribute
String Attribute
DeleteFromDB Method
SetDBHandle Method
SetFileHandle Method
UpdateDB Method
UpdateFile Method
Calendar_Object User Class
DateValue Attribute
DefaultValue Attribute
Month Attribute
Month_Dwn Attribute
Month_Up Attribute
ScreenField Attribute
Year Attribute
Year_Dwn Attribute
Year_Up Attribute
UpdField Method
UserSetValue Method
Edit_Object User Class
OnEditCopy Method
OnEditCut Method
OnEditPaste Method
OnFileClose Method
OnFileNew Method
OnFileOpen Method
OnFileSave Method
OnFileSaveAs Method
Setup Method
Font_Object User Class
SetFont Method
Setup Method
TrackField Method
Indicator_Manager User Class
CurrentValue Attribute
DisplayForm Attribute
DivisionIndex Attribute
MaxValue Attribute
MetricType Attribute
MinValue Attribute
MoveDir Attribute
QuadHump Attribute
TheBox Attribute
InitDataForm Method
InitPhysicalForm Method
UpdateGaugeValue Method
Query_Control User Class
CloseQuery Method
FindRow Method
FirstRow Method
HandleSelect Method
LastRow Method
NextRow Method
OpenQuery Method
PrevRow Method
Setup Method
Spin_Object User Class
Display Attribute
Increment Attribute
Maximum Attribute
Minimum Attribute
Wrap Attribute
GetValue Method
HandleDn Method
HandleUp Method
Setup Method
SetValue Method
UpdField Method
Timer_Manager User Class
DisplayForm Attribute
pIconAlarm Attribute
pTimeDisplayBox Attribute
StartUp Method
UpdateTime Method
D. Virtual Key Values
OpenROAD 6.0
D. Virtual Key Values