Download Progress Language Reference

Survey
yes no Was this document useful for you?
   Thank you for your participation!

* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project

Document related concepts
no text concepts found
Transcript
®
OpenEdge Development:
ABL Reference
Notices
© 2015 Progress Software Corporation and/or its subsidiaries or affiliates. All rights reserved.
®
These materials and all Progress software products are copyrighted and all rights are reserved by Progress Software Corporation. The information in these materials is subject
to change without notice, and Progress Software Corporation assumes no responsibility for any errors that may appear therein. The references in these materials to specific
platforms supported are subject to change.
Business Making Progress, Corticon, DataDirect (and design), DataDirect Cloud, DataDirect Connect, DataDirect Connect64, DataDirect XML Converters, DataDirect XQuery,
Deliver More Than Expected, Easyl, Fathom, Icenium, Kendo UI, Making Software Work Together, OpenEdge, Powered by Progress, Progress, Progress Control Tower,
Progress RPM, Progress Software Business Making Progress, Progress Software Developers Network, Rollbase, RulesCloud, RulesWorld, SequeLink, Sitefinity (and Design),
SpeedScript, Stylus Studio, TeamPulse, Telerik, (Telerik (and Design), Test Studio, and WebSpeed are registered trademarks of Progress Software Corporation or one of its
affiliates or subsidiaries in the U.S. and/or other countries. AccelEvent, AppsAlive, AppServer, BravePoint, BusinessEdge, DataDirect Spy, DataDirect SupportLink, , Future
Proof, High Performance Integration, Modulus, NativeScript, OpenAccess, Pacific, ProDataSet, Progress Arcade, Progress Pacific, Progress Profiles, Progress Results, Progress
RFID, Progress Progress Software, ProVision, PSE Pro, SectorAlliance, Sitefinity, SmartBrowser, SmartComponent, SmartDataBrowser, SmartDataObjects, SmartDataView,
SmartDialog, SmartFolder, SmartFrame, SmartObjects, SmartPanel, SmartQuery, SmartViewer, SmartWindow, WebClient, and Who Makes Progress are trademarks or service
marks of Progress Software Corporation and/or its subsidiaries or affiliates in the U.S. and other countries. Java is a registered trademark of Oracle and/or its affiliates. Any
other marks contained herein may be trademarks of their respective owners.
Please refer to the Release Notes applicable to the particular Progress product release for any third-party acknowledgements required to be provided in the documentation
associated with the Progress product.
The Release Notes can be found in the OpenEdge installation directory and online at:
https://community.progress.com/technicalusers/w/openedgegeneral/1329.openedge-product-documentation-overview.aspx.
For the latest documentation updates see OpenEdge Product Documentation on Progress Communities: (https://community.progress.com/technicalusers/w/openedgegeneral/
1329.openedge-product-documentation-overview.aspx).
October 2015
Last updated with new content: Release 11.6.0
OpenEdge Development: ABL Reference
3
Notices
4
OpenEdge Development: ABL Reference
Table of Contents
Preface...........................................................................................................55
Purpose.................................................................................................................................................55
Audience...............................................................................................................................................56
Organization..........................................................................................................................................56
Using this manual..................................................................................................................................56
References to ABL compiler and run-time features....................................................................56
References to ABL data types....................................................................................................57
Structure of reference entries.....................................................................................................57
Platform-restriction notes............................................................................................................57
Typographical conventions....................................................................................................................58
Examples of syntax descriptions...........................................................................................................59
Long syntax descriptions split across lines................................................................................61
Example procedures.............................................................................................................................61
OpenEdge messages............................................................................................................................62
Obtaining more information about OpenEdge messages...........................................................63
Chapter 1: ABL Syntax Reference..............................................................65
: Punctuation.........................................................................................................................................65
:: Punctuation........................................................................................................................................66
. Punctuation..........................................................................................................................................66
; Punctuation.........................................................................................................................................67
, Punctuation.........................................................................................................................................67
; Special character.................................................................................................................................67
? Special character................................................................................................................................68
\ Special character.................................................................................................................................69
~ Special character...............................................................................................................................69
" Special character................................................................................................................................70
' Special character.................................................................................................................................70
/ Special character.................................................................................................................................70
( ) Expression precedence....................................................................................................................70
[ ] Array reference..................................................................................................................................71
= Special character...............................................................................................................................71
< Special character...............................................................................................................................71
< = Special character............................................................................................................................71
< > Special character............................................................................................................................71
> Special character...............................................................................................................................71
> = Special character............................................................................................................................71
" "Character-string literal.......................................................................................................................72
OpenEdge Development: ABL Reference
5
{ } Argument reference..........................................................................................................................73
{ } Include file reference.........................................................................................................................75
{ } Preprocessor name reference..........................................................................................................79
&GLOBAL-DEFINE preprocessor directive...........................................................................................83
&IF, &THEN, &ELSEIF, &ELSE, and &ENDIF preprocessor directives.................................................84
&MESSAGE preprocessor directive......................................................................................................86
&SCOPED-DEFINE preprocessor directive..........................................................................................87
&UNDEFINE preprocessor directive.....................................................................................................88
/* Multi-line comments */........................................................................................................................88
// Single-line comments.........................................................................................................................89
+ Unary positive operator......................................................................................................................90
+ Addition operator................................................................................................................................91
+ Concatenation operator......................................................................................................................92
+ Date addition operator........................................................................................................................93
+ Datetime addition operator.................................................................................................................94
- Unary negative operator......................................................................................................................96
- Subtraction operator............................................................................................................................96
- Date subtraction operator....................................................................................................................97
- Datetime subtraction operator.............................................................................................................98
* Multiplication operator.......................................................................................................................100
/ Division operator...............................................................................................................................101
ABSOLUTE function............................................................................................................................101
ACCUM function..................................................................................................................................102
ACCUMULATE statement...................................................................................................................103
ACTIVE-FORM system reference.......................................................................................................105
ADD-INTERVAL function.....................................................................................................................106
Aggregate phrase................................................................................................................................107
ALIAS function.....................................................................................................................................110
AMBIGUOUS function.........................................................................................................................110
AND operator (bitwise)........................................................................................................................112
AND operator (logical).........................................................................................................................112
APPLY statement................................................................................................................................113
ASC function.......................................................................................................................................115
Assignment (=) statement...................................................................................................................117
ASSIGN statement..............................................................................................................................122
AT phrase............................................................................................................................................128
AUDIT-ENABLED function...................................................................................................................131
AVAILABLE function............................................................................................................................131
BASE64-DECODE function.................................................................................................................132
BASE64-ENCODE function.................................................................................................................133
BEGINS operator................................................................................................................................133
BELL statement...................................................................................................................................135
BLOCK-LEVEL ON ERROR UNDO, THROW statement....................................................................136
BOX function.......................................................................................................................................138
BUFFER-COMPARE statement..........................................................................................................141
6
OpenEdge Development: ABL Reference
BUFFER-COPY statement..................................................................................................................144
BUFFER-GROUP-ID function.............................................................................................................147
BUFFER-GROUP-NAME function......................................................................................................148
BUFFER-PARTITION-ID function........................................................................................................148
BUFFER-TENANT-ID function............................................................................................................149
BUFFER-TENANT-NAME function......................................................................................................150
CALL statement...................................................................................................................................150
CAN-DO function.................................................................................................................................151
CAN-FIND function..............................................................................................................................155
CAN-QUERY function.........................................................................................................................158
CAN-SET function...............................................................................................................................159
CAPS function.....................................................................................................................................159
CASE statement..................................................................................................................................160
CAST function.....................................................................................................................................162
CATCH statement................................................................................................................................164
CHOOSE statement............................................................................................................................173
CHR function.......................................................................................................................................178
Class-based data member access......................................................................................................179
Class-based method call.....................................................................................................................183
Class-based object reference..............................................................................................................186
Class-based property access..............................................................................................................188
CLASS statement................................................................................................................................193
CLEAR statement................................................................................................................................213
CLOSE QUERY statement..................................................................................................................214
CLOSE STORED-PROCEDURE statement.......................................................................................216
CODEPAGE-CONVERT function........................................................................................................218
COLOR phrase....................................................................................................................................219
COLOR statement...............................................................................................................................223
COMBO-BOX phrase..........................................................................................................................225
COMPARE function.............................................................................................................................229
COMPILE statement...........................................................................................................................232
CONNECT statement..........................................................................................................................262
CONNECTED function........................................................................................................................269
CONSTRUCTOR statement................................................................................................................270
COPY-LOB statement.........................................................................................................................274
COUNT-OF function............................................................................................................................278
CREATE statement.............................................................................................................................279
CREATE ALIAS statement..................................................................................................................283
CREATE automation object statement................................................................................................286
CREATE BROWSE statement.............................................................................................................292
CREATE BUFFER statement..............................................................................................................295
CREATE CALL statement...................................................................................................................298
CREATE CLIENT-PRINCIPAL statement............................................................................................299
CREATE DATABASE statement..........................................................................................................300
CREATE DATASET statement.............................................................................................................303
OpenEdge Development: ABL Reference
7
CREATE DATA-SOURCE statement...................................................................................................304
CREATE QUERY statement................................................................................................................305
CREATE SAX-ATTRIBUTES statement..............................................................................................306
CREATE SAX-READER statement.....................................................................................................310
CREATE SAX-WRITER statement......................................................................................................311
CREATE SERVER statement..............................................................................................................313
CREATE SERVER-SOCKET statement..............................................................................................314
CREATE SOAP-HEADER statement..................................................................................................315
CREATE SOAP-HEADER-ENTRYREF statement..............................................................................316
CREATE SOCKET statement..............................................................................................................317
CREATE TEMP-TABLE statement......................................................................................................318
CREATE widget statement..................................................................................................................320
CREATE WIDGET-POOL statement...................................................................................................323
CREATE X-DOCUMENT statement....................................................................................................326
CREATE X-NODEREF statement.......................................................................................................327
CURRENT-CHANGED function..........................................................................................................328
CURRENT-LANGUAGE function.........................................................................................................330
CURRENT-LANGUAGE statement......................................................................................................331
CURRENT-RESULT-ROW function.....................................................................................................332
CURRENT-VALUE function.................................................................................................................333
CURRENT-VALUE statement..............................................................................................................335
Data types...........................................................................................................................................337
DATASERVERS function.....................................................................................................................357
DATA-SOURCE-MODIFIED function...................................................................................................358
DATE function......................................................................................................................................358
DATETIME function.............................................................................................................................361
DATETIME-TZ function........................................................................................................................363
DAY function........................................................................................................................................365
DBCODEPAGE function......................................................................................................................366
DBCOLLATION function......................................................................................................................367
DBNAME function...............................................................................................................................368
DBPARAM function.............................................................................................................................369
DB-REMOTE-HOST function..............................................................................................................370
DBRESTRICTIONS function...............................................................................................................371
DBTASKID function.............................................................................................................................373
DBTYPE function................................................................................................................................374
DBVERSION function..........................................................................................................................375
DDE ADVISE statement......................................................................................................................376
DDE EXECUTE statement..................................................................................................................378
DDE GET statement............................................................................................................................379
DDE INITIATE statement.....................................................................................................................381
DDE REQUEST statement..................................................................................................................383
DDE SEND statement.........................................................................................................................385
DDE TERMINATE statement...............................................................................................................387
DECIMAL function...............................................................................................................................388
8
OpenEdge Development: ABL Reference
DECRYPT function..............................................................................................................................389
DEFINE BROWSE statement..............................................................................................................391
DEFINE BUFFER statement...............................................................................................................404
DEFINE BUTTON statement...............................................................................................................410
DEFINE DATASET statement..............................................................................................................418
DEFINE DATA-SOURCE statement....................................................................................................427
DEFINE ENUM statement...................................................................................................................429
DEFINE EVENT statement.................................................................................................................429
DEFINE FRAME statement.................................................................................................................436
DEFINE IMAGE statement..................................................................................................................445
DEFINE MENU statement...................................................................................................................449
DEFINE PARAMETER statement.......................................................................................................455
DEFINE PROPERTY statement..........................................................................................................469
DEFINE QUERY statement.................................................................................................................488
DEFINE RECTANGLE statement........................................................................................................494
DEFINE STREAM statement..............................................................................................................498
DEFINE SUB-MENU statement..........................................................................................................500
DEFINE TEMP-TABLE statement.......................................................................................................506
DEFINE VARIABLE statement............................................................................................................519
DEFINE WORK-TABLE statement......................................................................................................533
DEFINE WORKFILE statement...........................................................................................................539
DEFINED preprocessor function.........................................................................................................539
DELETE statement..............................................................................................................................540
DELETE ALIAS statement..................................................................................................................543
DELETE OBJECT statement..............................................................................................................544
DELETE PROCEDURE statement......................................................................................................549
DELETE WIDGET statement..............................................................................................................552
DELETE WIDGET-POOL statement....................................................................................................554
DESTRUCTOR statement...................................................................................................................557
DICTIONARY statement......................................................................................................................558
DISABLE statement............................................................................................................................559
DISABLE TRIGGERS statement.........................................................................................................562
DISCONNECT statement....................................................................................................................564
DISPLAY statement.............................................................................................................................566
DO statement......................................................................................................................................574
DOS statement....................................................................................................................................583
DOWN statement................................................................................................................................584
DYNAMIC-CAST function....................................................................................................................585
DYNAMIC-CURRENT-VALUE function...............................................................................................587
DYNAMIC-CURRENT-VALUE statement............................................................................................589
DYNAMIC-ENUM function...................................................................................................................590
DYNAMIC-FUNCTION function...........................................................................................................591
DYNAMIC-INVOKE function................................................................................................................593
DYNAMIC-NEW statement..................................................................................................................594
DYNAMIC-NEXT-VALUE function.......................................................................................................598
OpenEdge Development: ABL Reference
9
DYNAMIC-PROPERTY function..........................................................................................................599
DYNAMIC-PROPERTY statement......................................................................................................601
EDITING phrase..................................................................................................................................602
EDITOR phrase...................................................................................................................................604
EMPTY TEMP-TABLE statement........................................................................................................608
ENABLE statement.............................................................................................................................609
ENCODE function...............................................................................................................................614
ENCRYPT function..............................................................................................................................615
END statement....................................................................................................................................617
ENTERED function..............................................................................................................................618
ENTRY function...................................................................................................................................619
ENTRY statement................................................................................................................................621
ENUM statement.................................................................................................................................623
Enumeration member access..............................................................................................................632
EQ or = operator.................................................................................................................................633
ERROR function..................................................................................................................................634
ETIME function....................................................................................................................................635
EXP function........................................................................................................................................636
EXPORT statement.............................................................................................................................637
Expression...........................................................................................................................................641
EXTENT function.................................................................................................................................645
EXTENT statement.............................................................................................................................646
FILL function........................................................................................................................................648
FINALLY statement.............................................................................................................................649
FIND statement...................................................................................................................................653
FIRST function....................................................................................................................................663
FIRST-OF function...............................................................................................................................664
FIX-CODEPAGE statement.................................................................................................................664
FOR statement....................................................................................................................................665
FORM statement.................................................................................................................................681
Format phrase.....................................................................................................................................688
Frame phrase......................................................................................................................................697
FRAME-COL function..........................................................................................................................711
FRAME-DB function............................................................................................................................712
FRAME-DOWN function......................................................................................................................713
FRAME-FIELD function.......................................................................................................................714
FRAME-FILE function.........................................................................................................................715
FRAME-INDEX function......................................................................................................................716
FRAME-LINE function.........................................................................................................................717
FRAME-NAME function.......................................................................................................................718
FRAME-ROW function........................................................................................................................720
FRAME-VALUE function.....................................................................................................................721
FRAME-VALUE statement..................................................................................................................722
FUNCTION statement.........................................................................................................................723
GATEWAYS function...........................................................................................................................730
10
OpenEdge Development: ABL Reference
GE or >= operator...............................................................................................................................731
GENERATE-PBE-KEY function...........................................................................................................732
GENERATE-PBE-SALT function.........................................................................................................733
GENERATE-RANDOM-KEY function..................................................................................................733
GENERATE-UUID function.................................................................................................................734
GET statement....................................................................................................................................734
GET-BITS function...............................................................................................................................737
GET-BYTE function.............................................................................................................................738
GET-BYTE-ORDER function...............................................................................................................739
GET-BYTES function...........................................................................................................................739
GET-CLASS function...........................................................................................................................740
GET-CODEPAGE function...................................................................................................................741
GET-CODEPAGES function................................................................................................................741
GET-COLLATION function...................................................................................................................742
GET-COLLATIONS function................................................................................................................742
GET-DB-CLIENT function....................................................................................................................743
GET-DOUBLE function........................................................................................................................745
GET-EFFECTIVE-TENANT-ID function...............................................................................................745
GET-EFFECTIVE-TENANT-NAME function........................................................................................746
GET-FLOAT function............................................................................................................................747
GET-INT64 function.............................................................................................................................747
GET-KEY-VALUE statement................................................................................................................749
GET-LONG function............................................................................................................................752
GET-POINTER-VALUE function..........................................................................................................752
GET-SHORT function..........................................................................................................................754
GET-SIZE function...............................................................................................................................755
GET-STRING function.........................................................................................................................756
GET-UNSIGNED-LONG function........................................................................................................757
GET-UNSIGNED-SHORT function......................................................................................................757
GO-PENDING function........................................................................................................................758
GT or > operator..................................................................................................................................759
GUID function......................................................................................................................................760
HANDLE function................................................................................................................................761
HEX-DECODE function.......................................................................................................................762
HEX-ENCODE function.......................................................................................................................763
HIDE statement...................................................................................................................................763
IF...THEN...ELSE function...................................................................................................................766
IF...THEN...ELSE statement................................................................................................................767
Image phrase......................................................................................................................................768
IMPORT statement..............................................................................................................................771
INDEX function....................................................................................................................................777
INPUT function....................................................................................................................................778
INPUT CLEAR statement....................................................................................................................780
INPUT CLOSE statement....................................................................................................................781
INPUT FROM statement.....................................................................................................................782
OpenEdge Development: ABL Reference
11
INPUT THROUGH statement..............................................................................................................788
INPUT-OUTPUT CLOSE statement....................................................................................................792
INPUT-OUTPUT THROUGH statement..............................................................................................793
INSERT statement..............................................................................................................................797
INT64 function.....................................................................................................................................801
INTEGER function...............................................................................................................................802
INTERFACE statement........................................................................................................................803
INTERVAL function..............................................................................................................................814
IS-ATTR-SPACE function....................................................................................................................814
IS-CODEPAGE-FIXED function..........................................................................................................815
IS-COLUMN-CODEPAGE function.....................................................................................................815
IS-DB-MULTI-TENANT function..........................................................................................................816
IS-LEAD-BYTE function......................................................................................................................816
ISO-DATE function..............................................................................................................................817
KBLABEL function...............................................................................................................................817
KEYCODE function.............................................................................................................................818
KEYFUNCTION function.....................................................................................................................820
KEYLABEL function............................................................................................................................821
KEYWORD function............................................................................................................................822
KEYWORD-ALL function.....................................................................................................................823
LAST function......................................................................................................................................824
LASTKEY function...............................................................................................................................825
LAST-OF function................................................................................................................................826
LC function..........................................................................................................................................827
LDBNAME function.............................................................................................................................828
LE or < = operator...............................................................................................................................830
LEAVE statement................................................................................................................................831
LEFT-TRIM function............................................................................................................................832
LENGTH function................................................................................................................................833
LENGTH statement.............................................................................................................................835
LIBRARY function................................................................................................................................836
LINE-COUNTER function....................................................................................................................837
LIST-EVENTS function........................................................................................................................838
LIST-QUERY-ATTRS function..............................................................................................................840
LIST-SET-ATTRS function...................................................................................................................841
LIST-WIDGETS function......................................................................................................................841
LOAD statement..................................................................................................................................842
LOAD-PICTURE statement.................................................................................................................846
LOCKED function................................................................................................................................847
LOG function.......................................................................................................................................848
LOGICAL function...............................................................................................................................849
Logical values......................................................................................................................................850
LOOKUP function................................................................................................................................851
LT or < operator...................................................................................................................................852
MATCHES operator.............................................................................................................................853
12
OpenEdge Development: ABL Reference
MAXIMUM function.............................................................................................................................855
MD5-DIGEST function.........................................................................................................................856
MEMBER function...............................................................................................................................856
MESSAGE statement..........................................................................................................................857
MESSAGE-DIGEST function..............................................................................................................864
MESSAGE-LINES function.................................................................................................................865
METHOD statement............................................................................................................................866
MINIMUM function...............................................................................................................................875
MODULO operator..............................................................................................................................876
MONTH function..................................................................................................................................877
MTIME function...................................................................................................................................878
NE or <> operator................................................................................................................................879
NEW function (classes).......................................................................................................................880
NEW function (record buffers).............................................................................................................884
NEW statement...................................................................................................................................885
NEXT statement..................................................................................................................................888
NEXT-PROMPT statement..................................................................................................................889
NEXT-VALUE function.........................................................................................................................890
NORMALIZE function..........................................................................................................................892
NOT operator (bitwise)........................................................................................................................893
NOT operator (logical).........................................................................................................................894
NOT ENTERED function.....................................................................................................................894
NOW function......................................................................................................................................895
NUM-ALIASES function......................................................................................................................896
NUM-DBS function..............................................................................................................................897
NUM-ENTRIES function......................................................................................................................897
NUM-RESULTS function.....................................................................................................................899
ON ENDKEY phrase...........................................................................................................................901
ON ERROR phrase.............................................................................................................................903
ON QUIT phrase.................................................................................................................................907
ON statement......................................................................................................................................909
ON STOP phrase................................................................................................................................914
OPEN QUERY statement....................................................................................................................917
OPSYS function..................................................................................................................................923
OR operator (bitwise)..........................................................................................................................924
OR operator (logical)...........................................................................................................................925
OS-APPEND statement......................................................................................................................925
OS-COMMAND statement..................................................................................................................927
OS-COPY statement...........................................................................................................................928
OS-CREATE-DIR statement................................................................................................................930
OS-DELETE statement.......................................................................................................................931
OS-DRIVES function...........................................................................................................................932
OS-ERROR function...........................................................................................................................933
OS-GETENV function..........................................................................................................................935
OS-RENAME statement......................................................................................................................936
OpenEdge Development: ABL Reference
13
OUTPUT CLOSE statement................................................................................................................937
OUTPUT THROUGH statement..........................................................................................................939
OUTPUT TO statement.......................................................................................................................942
OVERLAY statement...........................................................................................................................950
PAGE statement..................................................................................................................................953
PAGE-NUMBER function....................................................................................................................954
PAGE-SIZE function............................................................................................................................954
Parameter definition syntax.................................................................................................................955
Parameter passing syntax...................................................................................................................962
PAUSE statement................................................................................................................................976
PDBNAME function.............................................................................................................................977
PRESELECT phrase...........................................................................................................................978
PROC-HANDLE function.....................................................................................................................981
PROC-STATUS function......................................................................................................................982
PROCEDURE statement.....................................................................................................................983
PROCESS-ARCHITECTURE function................................................................................................989
PROCESS EVENTS statement...........................................................................................................990
PROGRAM-NAME function.................................................................................................................991
PROGRESS function..........................................................................................................................994
PROMPT-FOR statement....................................................................................................................995
PROMSGS function..........................................................................................................................1003
PROMSGS statement.......................................................................................................................1003
PROPATH function............................................................................................................................1004
PROPATH statement.........................................................................................................................1005
PROVERSION function.....................................................................................................................1007
PUBLISH statement..........................................................................................................................1008
PUT CURSOR statement..................................................................................................................1011
PUT SCREEN statement..................................................................................................................1013
PUT statement..................................................................................................................................1016
PUT-BITS statement..........................................................................................................................1020
PUT-BYTE statement........................................................................................................................1021
PUT-BYTES statement......................................................................................................................1022
PUT-DOUBLE statement...................................................................................................................1023
PUT-FLOAT statement.......................................................................................................................1024
PUT-INT64 statement........................................................................................................................1025
PUT-KEY-VALUE statement..............................................................................................................1026
PUT-LONG statement.......................................................................................................................1031
PUT-SHORT statement.....................................................................................................................1032
PUT-STRING statement....................................................................................................................1033
PUT-UNSIGNED-LONG statement...................................................................................................1034
PUT-UNSIGNED-SHORT statement.................................................................................................1035
QUERY-OFF-END function...............................................................................................................1036
QUERY-TUNING phrase...................................................................................................................1037
QUIT statement.................................................................................................................................1040
QUOTER function..............................................................................................................................1041
14
OpenEdge Development: ABL Reference
R-INDEX function..............................................................................................................................1044
RADIO-SET phrase...........................................................................................................................1046
RANDOM function.............................................................................................................................1048
RAW function.....................................................................................................................................1049
RAW statement.................................................................................................................................1050
RAW-TRANSFER statement.............................................................................................................1051
READKEY statement........................................................................................................................1054
RECID function..................................................................................................................................1056
Record phrase...................................................................................................................................1058
RECORD-LENGTH function.............................................................................................................1069
REJECTED function..........................................................................................................................1070
RELEASE statement.........................................................................................................................1070
RELEASE EXTERNAL statement.....................................................................................................1073
RELEASE OBJECT statement..........................................................................................................1073
REPEAT statement............................................................................................................................1076
REPLACE function............................................................................................................................1085
REPOSITION statement...................................................................................................................1086
RETRY function.................................................................................................................................1091
RETURN statement...........................................................................................................................1092
RETURN-VALUE function.................................................................................................................1097
RGB-VALUE function........................................................................................................................1097
RIGHT-TRIM function........................................................................................................................1098
ROUND function................................................................................................................................1100
ROUTINE-LEVEL ON ERROR UNDO, THROW statement..............................................................1100
ROW-STATE function........................................................................................................................1103
ROWID function.................................................................................................................................1104
RUN statement..................................................................................................................................1106
RUN STORED-PROCEDURE statement..........................................................................................1127
RUN SUPER statement....................................................................................................................1130
SAVE CACHE statement...................................................................................................................1133
SCREEN-LINES function..................................................................................................................1136
SCROLL statement...........................................................................................................................1136
SDBNAME function...........................................................................................................................1142
SEARCH function..............................................................................................................................1143
SEEK function...................................................................................................................................1145
SEEK statement................................................................................................................................1146
SELECTION-LIST phrase.................................................................................................................1148
SET statement...................................................................................................................................1152
SET-BYTE-ORDER statement..........................................................................................................1159
SET-DB-CLIENT function..................................................................................................................1161
SET-EFFECTIVE-TENANT function..................................................................................................1165
SET-POINTER-VALUE statement.....................................................................................................1167
SET-SIZE statement..........................................................................................................................1168
SETUSERID function........................................................................................................................1169
SHA1-DIGEST function.....................................................................................................................1172
OpenEdge Development: ABL Reference
15
SHOW-STATS statement...................................................................................................................1173
SIZE phrase......................................................................................................................................1174
SLIDER phrase.................................................................................................................................1175
SQRT function...................................................................................................................................1178
SSL-SERVER-NAME function...........................................................................................................1179
STATUS statement............................................................................................................................1179
STOP statement................................................................................................................................1181
STRING function...............................................................................................................................1182
SUBSCRIBE statement.....................................................................................................................1184
SUBSTITUTE function......................................................................................................................1187
SUBSTRING function........................................................................................................................1189
SUBSTRING statement.....................................................................................................................1190
SUPER function................................................................................................................................1193
SUPER statement.............................................................................................................................1194
SUPER system reference.................................................................................................................1195
SYSTEM-DIALOG COLOR statement..............................................................................................1196
SYSTEM-DIALOG FONT statement.................................................................................................1198
SYSTEM-DIALOG GET-DIR statement.............................................................................................1200
SYSTEM-DIALOG GET-FILE statement...........................................................................................1202
SYSTEM-DIALOG PRINTER-SETUP statement..............................................................................1205
SYSTEM-HELP statement................................................................................................................1207
TENANT-ID function..........................................................................................................................1212
TENANT-NAME function...................................................................................................................1213
TENANT-NAME-TO-ID function........................................................................................................1213
TERMINAL function...........................................................................................................................1214
TERMINAL statement.......................................................................................................................1215
THIS-OBJECT statement..................................................................................................................1216
THIS-OBJECT system reference......................................................................................................1217
TIME function....................................................................................................................................1218
TIMEZONE function..........................................................................................................................1219
TODAY function.................................................................................................................................1220
TO-ROWID function..........................................................................................................................1221
TRANSACTION function...................................................................................................................1223
TRANSACTION-MODE AUTOMATIC statement..............................................................................1223
Trigger phrase...................................................................................................................................1224
TRIGGER PROCEDURE statement.................................................................................................1226
TRIM function....................................................................................................................................1229
TRUNCATE function..........................................................................................................................1232
Type-name syntax.............................................................................................................................1233
TYPE-OF function.............................................................................................................................1239
UNBOX function................................................................................................................................1240
UNDERLINE statement.....................................................................................................................1242
UNDO statement...............................................................................................................................1243
UNIX statement.................................................................................................................................1248
UNLOAD statement...........................................................................................................................1249
16
OpenEdge Development: ABL Reference
UNSUBSCRIBE statement................................................................................................................1251
UP statement.....................................................................................................................................1252
UPDATE statement............................................................................................................................1254
USE statement..................................................................................................................................1262
USERID function...............................................................................................................................1264
USING statement..............................................................................................................................1266
VALID-EVENT function.....................................................................................................................1270
VALID-HANDLE function...................................................................................................................1271
VALID-OBJECT function...................................................................................................................1272
VALIDATE statement.........................................................................................................................1272
VIEW statement................................................................................................................................1275
VIEW-AS phrase...............................................................................................................................1277
WAIT-FOR statement (ABL only).......................................................................................................1283
WAIT-FOR statement (.NET and ABL)..............................................................................................1287
WEEKDAY function...........................................................................................................................1296
WIDGET-HANDLE function...............................................................................................................1297
Widget phrase...................................................................................................................................1298
Working directory..............................................................................................................................1300
XOR operator (bitwise)......................................................................................................................1301
YEAR function...................................................................................................................................1302
Chapter 2: Widget Reference..................................................................1305
BROWSE widget...............................................................................................................................1306
BUTTON widget................................................................................................................................1316
COMBO-BOX widget.........................................................................................................................1318
CONTROL-FRAME widget................................................................................................................1320
DIALOG-BOX widget.........................................................................................................................1323
EDITOR widget.................................................................................................................................1326
FIELD-GROUP widget......................................................................................................................1328
FILL-IN widget...................................................................................................................................1329
FRAME widget..................................................................................................................................1332
IMAGE widget...................................................................................................................................1335
LITERAL widget................................................................................................................................1336
MENU widget....................................................................................................................................1337
MENU-ITEM widget...........................................................................................................................1338
RADIO-SET widget...........................................................................................................................1339
RECTANGLE widget.........................................................................................................................1341
SELECTION-LIST widget..................................................................................................................1343
SHADOW-WINDOW widget..............................................................................................................1345
SLIDER widget..................................................................................................................................1346
SUB-MENU widget............................................................................................................................1347
TEXT widget......................................................................................................................................1348
TOGGLE-BOX widget.......................................................................................................................1350
WINDOW widget...............................................................................................................................1352
OpenEdge Development: ABL Reference
17
Chapter 3: Handle Reference...................................................................1357
ACTIVE-WINDOW system handle....................................................................................................1358
Asynchronous request object handle................................................................................................1359
AUDIT-CONTROL system handle.....................................................................................................1361
AUDIT-POLICY system handle..........................................................................................................1361
Buffer object handle..........................................................................................................................1362
Buffer-field object handle...................................................................................................................1365
Call object handle..............................................................................................................................1366
Client-principal object handle............................................................................................................1373
CLIPBOARD system handle.............................................................................................................1379
CODEBASE-LOCATOR system handle............................................................................................1384
COLOR-TABLE system handle.........................................................................................................1385
COM-SELF system handle................................................................................................................1387
COMPILER system handle...............................................................................................................1388
CURRENT-WINDOW system handle................................................................................................1389
Data-relation object handle...............................................................................................................1390
Data-source object handle................................................................................................................1391
DEBUGGER system handle..............................................................................................................1393
DEFAULT-WINDOW system handle..................................................................................................1396
DSLOG-MANAGER system handle..................................................................................................1397
ERROR-STATUS system handle.......................................................................................................1399
FILE-INFO system handle.................................................................................................................1403
FOCUS system handle......................................................................................................................1404
FONT-TABLE system handle.............................................................................................................1406
LAST-EVENT system handle............................................................................................................1407
LOG-MANAGER system handle.......................................................................................................1409
Procedure object handle...................................................................................................................1409
ProDataSet object handle.................................................................................................................1411
Query object handle..........................................................................................................................1413
RCODE-INFO handle........................................................................................................................1415
SAX-attributes object handle.............................................................................................................1416
SAX-reader object handle.................................................................................................................1417
SAX-writer object handle...................................................................................................................1419
SECURITY-POLICY system handle..................................................................................................1420
SELF system handle.........................................................................................................................1422
Server object handle.........................................................................................................................1424
Server socket object handle..............................................................................................................1425
SESSION system handle..................................................................................................................1426
SOAP-fault object handle..................................................................................................................1432
SOAP-fault-detail object handle........................................................................................................1433
SOAP-header object handle..............................................................................................................1433
SOAP-header-entryref object handle................................................................................................1434
Socket object handle.........................................................................................................................1436
18
OpenEdge Development: ABL Reference
SOURCE-PROCEDURE system handle...........................................................................................1437
Stream object handle........................................................................................................................1439
TARGET-PROCEDURE system handle............................................................................................1440
Temp-table object handle..................................................................................................................1443
THIS-PROCEDURE system handle..................................................................................................1445
Transaction object handle..................................................................................................................1447
WEB-CONTEXT system handle........................................................................................................1448
X-document object handle.................................................................................................................1449
X-noderef object handle....................................................................................................................1451
Chapter 4: Handle Attributes and Methods Reference.........................1453
Accessing handle attributes and methods.........................................................................................1454
Handle-based references.......................................................................................................1454
Object name references..............................................................................................1455
Handle references.......................................................................................................1456
Handle attribute access..........................................................................................................1456
Handle method calls...............................................................................................................1457
Error handling for handle method calls........................................................................1458
Chained handle references...............................................................................................................1458
Widget color, font, and measurement values....................................................................................1459
Accessing COM object properties and methods...............................................................................1459
Syntax for accessing COM object properties and methods....................................................1460
Property write..............................................................................................................1460
Property read...............................................................................................................1460
Method call..................................................................................................................1461
COMProperty...............................................................................................................1461
COMMethod................................................................................................................1462
COMParm....................................................................................................................1462
Data-type.....................................................................................................................1462
ACCELERATOR attribute..................................................................................................................1463
ACCEPT-CHANGES( ) method.........................................................................................................1463
ACCEPT-ROW-CHANGES( ) method...............................................................................................1463
ACTIVE attribute...............................................................................................................................1464
ACTOR attribute................................................................................................................................1464
ADD-BUFFER( ) method...................................................................................................................1465
ADD-CALC-COLUMN( ) method.......................................................................................................1465
ADD-COLUMNS-FROM( ) method...................................................................................................1467
ADD-EVENTS-PROCEDURE( ) method...........................................................................................1468
ADD-FIELDS-FROM( ) method.........................................................................................................1468
ADD-FIRST( ) method.......................................................................................................................1469
ADD-HEADER-ENTRY( ) method.....................................................................................................1470
ADD-INDEX-FIELD( ) method...........................................................................................................1471
ADD-LAST( ) method........................................................................................................................1472
ADD-LIKE-COLUMN( ) method.........................................................................................................1473
OpenEdge Development: ABL Reference
19
ADD-LIKE-FIELD( ) method..............................................................................................................1474
ADD-LIKE-INDEX( ) method.............................................................................................................1475
ADD-NEW-FIELD( ) method.............................................................................................................1476
ADD-NEW-INDEX( ) method.............................................................................................................1477
ADD-PARENT-ID-RELATION( ) method............................................................................................1478
ADD-RELATION( ) method................................................................................................................1479
ADD-SCHEMA-LOCATION( ) method...............................................................................................1481
ADD-SOURCE-BUFFER( ) method..................................................................................................1482
ADD-SUPER-PROCEDURE( ) method.............................................................................................1482
ADM-DATA attribute...........................................................................................................................1487
AFTER-BUFFER attribute.................................................................................................................1487
AFTER-ROWID attribute...................................................................................................................1487
AFTER-TABLE attribute....................................................................................................................1488
ALLOW-COLUMN-SEARCHING attribute.........................................................................................1488
ALWAYS-ON-TOP attribute...............................................................................................................1488
AMBIGUOUS attribute......................................................................................................................1489
APPEND-CHILD( ) method...............................................................................................................1489
APPL-ALERT-BOXES attribute..........................................................................................................1490
APPL-CONTEXT-ID attribute............................................................................................................1490
APPLY-CALLBACK( ) method...........................................................................................................1491
APPSERVER-INFO attribute.............................................................................................................1491
APPSERVER-PASSWORD attribute.................................................................................................1491
APPSERVER-USERID attribute........................................................................................................1492
ASYNCHRONOUS attribute..............................................................................................................1492
ASYNC-REQUEST-COUNT attribute................................................................................................1492
ASYNC-REQUEST-HANDLE attribute..............................................................................................1493
ATTACH-DATA-SOURCE( ) method..................................................................................................1493
ATTACHED-PAIRLIST attribute.........................................................................................................1494
ATTRIBUTE-NAMES attribute...........................................................................................................1495
ATTR-SPACE attribute.......................................................................................................................1495
AUDIT-EVENT-CONTEXT attribute...................................................................................................1496
AUTHENTICATION-FAILED( ) method.............................................................................................1496
AUTO-COMPLETION attribute..........................................................................................................1497
AUTO-DELETE attribute...................................................................................................................1498
AUTO-DELETE-XML attribute...........................................................................................................1498
AUTO-END-KEY attribute.................................................................................................................1498
AUTO-GO attribute............................................................................................................................1498
AUTO-INDENT attribute....................................................................................................................1499
AUTO-RESIZE attribute....................................................................................................................1499
AUTO-RETURN attribute..................................................................................................................1500
AUTO-SYNCHRONIZE attribute.......................................................................................................1500
AUTO-VALIDATE attribute.................................................................................................................1501
AUTO-ZAP attribute..........................................................................................................................1501
AVAILABLE attribute.........................................................................................................................1501
AVAILABLE-FORMATS attribute.......................................................................................................1502
20
OpenEdge Development: ABL Reference
BACKGROUND attribute...................................................................................................................1502
BASE-ADE attribute..........................................................................................................................1503
BASIC-LOGGING attribute................................................................................................................1503
BATCH-MODE attribute.....................................................................................................................1504
BATCH-SIZE attribute.......................................................................................................................1504
BEFORE-BUFFER attribute..............................................................................................................1505
BEFORE-ROWID attribute................................................................................................................1505
BEFORE-TABLE attribute.................................................................................................................1505
BEGIN-EVENT-GROUP( ) method....................................................................................................1506
BGCOLOR attribute..........................................................................................................................1507
BLANK attribute.................................................................................................................................1508
BLOCK-ITERATION-DISPLAY attribute............................................................................................1508
BORDER-BOTTOM-CHARS attribute...............................................................................................1508
BORDER-BOTTOM-PIXELS attribute...............................................................................................1508
BORDER-LEFT-CHARS attribute......................................................................................................1509
BORDER-LEFT-PIXELS attribute......................................................................................................1509
BORDER-RIGHT-CHARS attribute...................................................................................................1509
BORDER-RIGHT-PIXELS attribute...................................................................................................1509
BORDER-TOP-CHARS attribute.......................................................................................................1510
BORDER-TOP-PIXELS attribute.......................................................................................................1510
BOX attribute.....................................................................................................................................1510
BOX-SELECTABLE attribute.............................................................................................................1510
BUFFER-CHARS attribute................................................................................................................1511
BUFFER-COMPARE( ) method.........................................................................................................1511
BUFFER-COPY( ) method................................................................................................................1513
BUFFER-CREATE( ) method............................................................................................................1514
BUFFER-DELETE( ) method............................................................................................................1515
BUFFER-FIELD attribute...................................................................................................................1516
BUFFER-FIELD( ) method................................................................................................................1516
BUFFER-GROUP-ID attribute...........................................................................................................1516
BUFFER-GROUP-NAME attribute....................................................................................................1517
BUFFER-HANDLE attribute..............................................................................................................1517
BUFFER-LINES attribute..................................................................................................................1517
BUFFER-NAME attribute..................................................................................................................1518
BUFFER-PARTITION-ID attribute.....................................................................................................1518
BUFFER-RELEASE( ) method..........................................................................................................1518
BUFFER-TENANT-ID attribute..........................................................................................................1519
BUFFER-TENANT-NAME attribute...................................................................................................1519
BUFFER-VALIDATE( ) method..........................................................................................................1520
BUFFER-VALUE( ) method...............................................................................................................1520
BYTES-READ attribute.....................................................................................................................1521
BYTES-WRITTEN attribute...............................................................................................................1521
CACHE attribute................................................................................................................................1522
CALL-NAME attribute........................................................................................................................1522
CALL-TYPE attribute.........................................................................................................................1523
OpenEdge Development: ABL Reference
21
CANCEL-BREAK( ) method..............................................................................................................1524
CANCEL-BUTTON attribute..............................................................................................................1525
CANCEL-REQUESTS( ) method......................................................................................................1525
CANCEL-REQUESTS-AFTER( ) method.........................................................................................1526
CANCELLED attribute.......................................................................................................................1527
CAN-CREATE attribute.....................................................................................................................1528
CAN-DELETE attribute......................................................................................................................1528
CAN-DO-DOMAIN-SUPPORT attribute............................................................................................1528
CAN-READ attribute..........................................................................................................................1529
CAN-WRITE attribute........................................................................................................................1529
CAREFUL-PAINT attribute................................................................................................................1529
CASE-SENSITIVE attribute...............................................................................................................1529
CENTERED attribute.........................................................................................................................1530
CHARSET attribute...........................................................................................................................1530
CHECKED attribute...........................................................................................................................1530
CHILD-BUFFER attribute..................................................................................................................1530
CHILD-NUM attribute........................................................................................................................1531
CLASS-TYPE attribute......................................................................................................................1531
CLEAR( ) method (Call Object Handle).............................................................................................1531
CLEAR( ) method (DEBUGGER Handle)..........................................................................................1532
CLEAR( ) method (FILL-IN Widget)..................................................................................................1532
CLEAR( ) method (ProDataSet Object Handle)................................................................................1532
CLEAR( ) method (Temp-Table Object Handle)................................................................................1533
CLEAR-APPL-CONTEXT( ) method.................................................................................................1533
CLEAR-LOG( ) method.....................................................................................................................1534
CLEAR-SELECTION( ) method........................................................................................................1535
CLEAR-SORT-ARROWS( ) method..................................................................................................1535
CLIENT-CONNECTION-ID attribute..................................................................................................1535
CLIENT-TTY attribute........................................................................................................................1536
CLIENT-TYPE attribute.....................................................................................................................1536
CLIENT-WORKSTATION attribute.....................................................................................................1537
CLONE-NODE( ) method..................................................................................................................1537
CLOSE-LOG( ) method.....................................................................................................................1538
CODE attribute..................................................................................................................................1538
CODEPAGE attribute........................................................................................................................1539
COLUMN attribute.............................................................................................................................1539
COLUMN-BGCOLOR attribute..........................................................................................................1540
COLUMN-DCOLOR attribute............................................................................................................1540
COLUMN-FGCOLOR attribute..........................................................................................................1540
COLUMN-FONT attribute..................................................................................................................1540
COLUMN-LABEL attribute................................................................................................................1541
COLUMN-MOVABLE attribute...........................................................................................................1541
COLUMN-PFCOLOR attribute..........................................................................................................1541
COLUMN-READ-ONLY attribute.......................................................................................................1542
COLUMN-RESIZABLE attribute........................................................................................................1542
22
OpenEdge Development: ABL Reference
COLUMN-SCROLLING attribute.......................................................................................................1542
COM-HANDLE attribute....................................................................................................................1543
COMPLETE attribute.........................................................................................................................1543
CONFIG-NAME attribute...................................................................................................................1543
CONNECT( ) method (AppServer)....................................................................................................1544
CONNECT( ) method (Pacific Application Server)............................................................................1550
CONNECT( ) method (Socket object)...............................................................................................1554
CONNECT( ) method (Web service).................................................................................................1556
CONNECTED( ) method...................................................................................................................1561
CONTEXT-HELP attribute.................................................................................................................1562
CONTEXT-HELP-FILE attribute........................................................................................................1562
CONTEXT-HELP-ID attribute............................................................................................................1563
CONTROL-BOX attribute..................................................................................................................1563
Control-Name property......................................................................................................................1563
Controls property...............................................................................................................................1564
CONVERT-3D-COLORS attribute.....................................................................................................1564
CONVERT-TO-OFFSET( ) method....................................................................................................1565
COPY-DATASET( ) method...............................................................................................................1565
COPY-SAX-ATTRIBUTES( ) method.................................................................................................1568
COPY-TEMP-TABLE( ) method.........................................................................................................1569
CPCASE attribute..............................................................................................................................1571
CPCOLL attribute..............................................................................................................................1571
CPINTERNAL attribute......................................................................................................................1572
CPLOG attribute................................................................................................................................1572
CPPRINT attribute.............................................................................................................................1572
CPRCODEIN attribute.......................................................................................................................1572
CPRCODEOUT attribute...................................................................................................................1573
CPSTREAM attribute........................................................................................................................1573
CPTERM attribute.............................................................................................................................1573
CRC-VALUE attribute........................................................................................................................1573
CREATE-LIKE( ) method...................................................................................................................1574
CREATE-LIKE-SEQUENTIAL( ) method...........................................................................................1575
CREATE-NODE( ) method................................................................................................................1576
CREATE-NODE-NAMESPACE( ) method.........................................................................................1578
CREATE-RESULT-LIST-ENTRY( ) method........................................................................................1579
CURRENT-CHANGED attribute........................................................................................................1580
CURRENT-COLUMN attribute..........................................................................................................1580
CURRENT-ENVIRONMENT attribute................................................................................................1580
CURRENT-ITERATION attribute (Data Objects)...............................................................................1580
CURRENT-ITERATION attribute (Widget Objects)............................................................................1581
CURRENT-QUERY( ) method...........................................................................................................1581
CURRENT-REQUEST-INFO attribute...............................................................................................1583
CURRENT-RESPONSE-INFO attribute............................................................................................1584
CURRENT-RESULT-ROW attribute...................................................................................................1585
CURRENT-ROW-MODIFIED attribute...............................................................................................1585
OpenEdge Development: ABL Reference
23
CURRENT-WINDOW attribute..........................................................................................................1585
CURSOR-CHAR attribute.................................................................................................................1586
CURSOR-LINE attribute....................................................................................................................1586
CURSOR-OFFSET attribute.............................................................................................................1586
DATA-ENTRY-RETURN attribute.......................................................................................................1587
DATA-SOURCE attribute...................................................................................................................1587
DATA-SOURCE-COMPLETE-MAP attribute.....................................................................................1587
DATA-SOURCE-MODIFIED attribute................................................................................................1588
DATA-SOURCE-ROWID attribute......................................................................................................1588
DATA-TYPE attribute.........................................................................................................................1589
DATASET attribute.............................................................................................................................1589
DATE-FORMAT attribute...................................................................................................................1589
DB-CONTEXT attribute.....................................................................................................................1590
DB-LIST attribute...............................................................................................................................1590
DB-REFERENCES attribute..............................................................................................................1591
DBNAME attribute.............................................................................................................................1591
DCOLOR attribute.............................................................................................................................1592
DDE-ERROR attribute.......................................................................................................................1592
DDE-ID attribute................................................................................................................................1593
DDE-ITEM attribute...........................................................................................................................1593
DDE-NAME attribute.........................................................................................................................1594
DDE-TOPIC attribute.........................................................................................................................1594
DEBLANK attribute............................................................................................................................1594
DEBUG( ) method.............................................................................................................................1595
DEBUG-ALERT attribute...................................................................................................................1595
DECIMALS attribute..........................................................................................................................1596
DECLARE-NAMESPACE( ) method..................................................................................................1596
DEFAULT attribute.............................................................................................................................1597
DEFAULT-BUFFER-HANDLE attribute..............................................................................................1597
DEFAULT-BUTTON attribute..............................................................................................................1598
DEFAULT-COMMIT attribute..............................................................................................................1598
DEFAULT-STRING attribute...............................................................................................................1599
DEFAULT-VALUE attribute.................................................................................................................1599
DELETE( ) method............................................................................................................................1600
DELETE-CHAR( ) method.................................................................................................................1601
DELETE-CURRENT-ROW( ) method................................................................................................1601
DELETE-HEADER-ENTRY( ) method...............................................................................................1602
DELETE-LINE( ) method...................................................................................................................1602
DELETE-NODE( ) method................................................................................................................1602
DELETE-RESULT-LIST-ENTRY( ) method........................................................................................1603
DELETE-SELECTED-ROW( ) method..............................................................................................1604
DELETE-SELECTED-ROWS( ) method............................................................................................1604
DELIMITER attribute.........................................................................................................................1605
DESELECT-FOCUSED-ROW( ) method...........................................................................................1605
DESELECT-ROWS( ) method...........................................................................................................1605
24
OpenEdge Development: ABL Reference
DESELECT-SELECTED-ROW( ) method.........................................................................................1606
DETACH-DATA-SOURCE( ) method.................................................................................................1606
DISABLE( ) method...........................................................................................................................1606
DISABLE-AUTO-ZAP attribute..........................................................................................................1607
DISABLE-CONNECTIONS( ) method...............................................................................................1607
DISABLE-DUMP-TRIGGERS( ) method...........................................................................................1607
DISABLE-LOAD-TRIGGERS( ) method............................................................................................1608
DISCONNECT( ) method (Handle)...................................................................................................1608
DISPLAY-MESSAGE( ) method.........................................................................................................1609
DISPLAY-TIMEZONE attribute..........................................................................................................1610
DISPLAY-TYPE attribute...................................................................................................................1610
DOMAIN-DESCRIPTION attribute....................................................................................................1610
DOMAIN-NAME attribute..................................................................................................................1611
DOMAIN-TYPE attribute...................................................................................................................1612
DOWN attribute.................................................................................................................................1613
DRAG-ENABLED attribute................................................................................................................1613
DROP-TARGET attribute...................................................................................................................1613
DUMP-LOGGING-NOW( ) method...................................................................................................1614
DYNAMIC attribute............................................................................................................................1615
EDGE-CHARS attribute....................................................................................................................1615
EDGE-PIXELS attribute....................................................................................................................1615
EDIT-CAN-PASTE attribute...............................................................................................................1615
EDIT-CAN-UNDO attribute................................................................................................................1616
EDIT-CLEAR( ) method.....................................................................................................................1616
EDIT-COPY( ) method.......................................................................................................................1616
EDIT-CUT( ) method..........................................................................................................................1617
EDIT-PASTE( ) method......................................................................................................................1617
EDIT-UNDO( ) method......................................................................................................................1618
EMPTY attribute................................................................................................................................1618
EMPTY-DATASET( ) method.............................................................................................................1618
EMPTY-TEMP-TABLE( ) method.......................................................................................................1619
ENABLE( ) method............................................................................................................................1619
ENABLE-CONNECTIONS( ) method................................................................................................1619
ENABLE-EVENTS( ) method............................................................................................................1621
ENCODING attribute.........................................................................................................................1622
ENCRYPT-AUDIT-MAC-KEY( ) method.............................................................................................1624
ENCRYPTION-SALT attribute...........................................................................................................1625
END-DOCUMENT( ) method............................................................................................................1626
END-ELEMENT( ) method................................................................................................................1626
END-EVENT-GROUP( ) method.......................................................................................................1627
END-FILE-DROP( ) method..............................................................................................................1628
END-USER-PROMPT attribute.........................................................................................................1628
ENTITY-EXPANSION-LIMIT attribute................................................................................................1628
ENTRY( ) method..............................................................................................................................1629
ENTRY-TYPES-LIST attribute...........................................................................................................1629
OpenEdge Development: ABL Reference
25
ERROR attribute...............................................................................................................................1629
ERROR-COLUMN attribute...............................................................................................................1630
ERROR-OBJECT-DETAIL attribute...................................................................................................1631
ERROR-ROW attribute......................................................................................................................1631
ERROR-STACK-TRACE attribute.....................................................................................................1631
ERROR-STRING attribute.................................................................................................................1632
EVENT-GROUP-ID attribute..............................................................................................................1633
EVENT-PROCEDURE attribute.........................................................................................................1633
EVENT-PROCEDURE-CONTEXT attribute......................................................................................1633
EVENT-TYPE attribute......................................................................................................................1634
EXCLUSIVE-ID attribute...................................................................................................................1634
EXECUTION-LOG attribute...............................................................................................................1634
EXPAND attribute..............................................................................................................................1635
EXPANDABLE attribute.....................................................................................................................1635
EXPORT( ) method...........................................................................................................................1635
EXPORT-PRINCIPAL( ) method........................................................................................................1636
EXTENT attribute..............................................................................................................................1637
FETCH-SELECTED-ROW( ) method................................................................................................1637
FGCOLOR attribute...........................................................................................................................1638
FILE-CREATE-DATE attribute...........................................................................................................1638
FILE-CREATE-TIME attribute............................................................................................................1639
FILE-MOD-DATE attribute.................................................................................................................1639
FILE-MOD-TIME attribute.................................................................................................................1639
FILE-NAME attribute.........................................................................................................................1639
FILE-OFFSET attribute.....................................................................................................................1640
FILE-SIZE attribute............................................................................................................................1640
FILE-TYPE attribute..........................................................................................................................1640
FILL( ) method...................................................................................................................................1641
FILLED attribute................................................................................................................................1642
FILL-MODE attribute.........................................................................................................................1643
FILL-WHERE-STRING attribute........................................................................................................1643
FIND-BY-ROWID( ) method...............................................................................................................1644
FIND-CURRENT( ) method...............................................................................................................1645
FIND-FIRST( ) method......................................................................................................................1646
FIND-LAST( ) method.......................................................................................................................1647
FIND-UNIQUE( ) method..................................................................................................................1648
FIRST-ASYNC-REQUEST attribute..................................................................................................1650
FIRST-BUFFER attribute...................................................................................................................1650
FIRST-CHILD attribute......................................................................................................................1650
FIRST-COLUMN attribute..................................................................................................................1651
FIRST-DATASET attribute..................................................................................................................1651
FIRST-DATA-SOURCE attribute........................................................................................................1651
FIRST-FORM attribute.......................................................................................................................1651
FIRST-OBJECT attribute...................................................................................................................1652
FIRST-OF( ) method..........................................................................................................................1653
26
OpenEdge Development: ABL Reference
FIRST-PROCEDURE attribute..........................................................................................................1653
FIRST-QUERY attribute.....................................................................................................................1654
FIRST-SERVER attribute...................................................................................................................1654
FIRST-SERVER-SOCKET attribute...................................................................................................1655
FIRST-SOCKET attribute..................................................................................................................1655
FIRST-TAB-ITEM attribute.................................................................................................................1655
FIT-LAST-COLUMN attribute.............................................................................................................1656
FLAT-BUTTON attribute.....................................................................................................................1657
FOCUSED-ROW attribute.................................................................................................................1657
FOCUSED-ROW-SELECTED attribute.............................................................................................1657
FONT attribute...................................................................................................................................1658
FOREGROUND attribute..................................................................................................................1658
FOREIGN-KEY-HIDDEN attribute.....................................................................................................1658
FORM-INPUT attribute......................................................................................................................1659
FORM-LONG-INPUT attribute..........................................................................................................1659
FORMAT attribute..............................................................................................................................1659
FORMATTED attribute......................................................................................................................1660
FORWARD-ONLY attribute................................................................................................................1660
FRAGMENT attribute........................................................................................................................1661
FRAME attribute................................................................................................................................1661
FRAME-COL attribute.......................................................................................................................1661
FRAME-NAME attribute....................................................................................................................1662
FRAME-ROW attribute......................................................................................................................1662
FRAME-SPACING attribute...............................................................................................................1662
FRAME-X attribute............................................................................................................................1662
FRAME-Y attribute............................................................................................................................1663
FREQUENCY attribute......................................................................................................................1663
FULL-HEIGHT-CHARS attribute.......................................................................................................1663
FULL-HEIGHT-PIXELS attribute.......................................................................................................1664
FULL-PATHNAME attribute...............................................................................................................1664
FULL-WIDTH-CHARS attribute.........................................................................................................1664
FULL-WIDTH-PIXELS attribute.........................................................................................................1664
FUNCTION attribute..........................................................................................................................1665
GET-ATTRIBUTE( ) method..............................................................................................................1665
GET-ATTRIBUTE-NODE( ) method...................................................................................................1666
GET-BINARY-DATA( ) method...........................................................................................................1666
GET-BLUE-VALUE( ) method............................................................................................................1667
GET-BROWSE-COLUMN( ) method.................................................................................................1667
GET-BUFFER-HANDLE( ) method....................................................................................................1667
GET-BYTES-AVAILABLE( ) method..................................................................................................1668
GET-CALLBACK-PROC-CONTEXT( ) method.................................................................................1668
GET-CALLBACK-PROC-NAME( ) method........................................................................................1669
GET-CGI-LIST( ) method...................................................................................................................1669
GET-CGI-VALUE( ) method...............................................................................................................1670
GET-CGI-LONG-VALUE( ) method...................................................................................................1670
OpenEdge Development: ABL Reference
27
GET-CHANGES( ) method................................................................................................................1670
GET-CHILD( ) method.......................................................................................................................1671
GET-CHILD-RELATION( ) method....................................................................................................1672
GET-CLIENT( ) method.....................................................................................................................1672
GET-COLUMN( ) method..................................................................................................................1673
GET-CONFIG-VALUE( ) method.......................................................................................................1673
GET-CURRENT( ) method................................................................................................................1673
GET-DATASET-BUFFER( ) method...................................................................................................1674
GET-DOCUMENT-ELEMENT( ) method...........................................................................................1674
GET-DROPPED-FILE( ) method.......................................................................................................1675
GET-DYNAMIC( ) method..................................................................................................................1675
GET-ERROR-COLUMN( ) method....................................................................................................1676
GET-ERROR-ROW( ) method...........................................................................................................1676
GET-FILE-NAME( ) method...............................................................................................................1677
GET-FILE-OFFSET( ) method...........................................................................................................1677
GET-FIRST( ) method.......................................................................................................................1678
GET-GREEN-VALUE( ) method........................................................................................................1678
GET-HEADER-ENTRY( ) method......................................................................................................1679
GET-INDEX-BY-NAMESPACE-NAME( ) method...............................................................................1679
GET-INDEX-BY-QNAME( ) method...................................................................................................1680
GET-ITERATION( ) method (Data Objects).......................................................................................1680
GET-ITERATION( ) method (Widget Objects)...................................................................................1681
GET-LAST( ) method.........................................................................................................................1681
GET-LOCALNAME-BY-INDEX( ) method..........................................................................................1682
GET-MESSAGE( ) method (Handle).................................................................................................1683
GET-MESSAGE-TYPE( ) method......................................................................................................1683
GET-NEXT( ) method........................................................................................................................1684
GET-NODE( ) method.......................................................................................................................1684
GET-NUMBER( ) method..................................................................................................................1685
GET-PARENT( ) method....................................................................................................................1686
GET-PREV( ) method........................................................................................................................1686
GET-PROPERTY( ) method..............................................................................................................1687
GET-PRINTERS( ) method................................................................................................................1688
GET-QNAME-BY-INDEX( ) method...................................................................................................1688
GET-RED-VALUE( ) method..............................................................................................................1688
GET-RELATION( ) method................................................................................................................1689
GET-REPOSITIONED-ROW( ) method.............................................................................................1689
GET-RGB-VALUE( ) method.............................................................................................................1690
GET-ROW( ) method.........................................................................................................................1690
GET-SELECTED-WIDGET( ) method...............................................................................................1690
GET-SERIALIZED( ) method.............................................................................................................1691
GET-SIGNATURE( ) method.............................................................................................................1691
GET-SOCKET-OPTION( ) method.....................................................................................................1693
GET-SOURCE-BUFFER( ) method...................................................................................................1695
GET-TAB-ITEM( ) method.................................................................................................................1695
28
OpenEdge Development: ABL Reference
GET-TEXT-HEIGHT-CHARS( ) method.............................................................................................1696
GET-TEXT-HEIGHT-PIXELS( ) method.............................................................................................1696
GET-TEXT-WIDTH-CHARS( ) method..............................................................................................1696
GET-TEXT-WIDTH-PIXELS( ) method..............................................................................................1697
GET-TOP-BUFFER( ) method...........................................................................................................1698
GET-TYPE-BY-INDEX( ) method.......................................................................................................1698
GET-TYPE-BY-NAMESPACE-NAME( ) method................................................................................1698
GET-TYPE-BY-QNAME( ) method.....................................................................................................1699
GET-URI-BY-INDEX( ) method..........................................................................................................1699
GET-VALUE-BY-INDEX( ) method.....................................................................................................1700
GET-VALUE-BY-NAMESPACE-NAME( ) method..............................................................................1700
GET-VALUE-BY-QNAME( ) method..................................................................................................1701
GET-WAIT-STATE( ) method..............................................................................................................1701
GRAPHIC-EDGE attribute.................................................................................................................1702
GRID-FACTOR-HORIZONTAL attribute............................................................................................1702
GRID-FACTOR-VERTICAL attribute.................................................................................................1702
GRID-SNAP attribute........................................................................................................................1703
GRID-UNIT-HEIGHT-CHARS attribute..............................................................................................1703
GRID-UNIT-HEIGHT-PIXELS attribute..............................................................................................1703
GRID-UNIT-WIDTH-CHARS attribute...............................................................................................1703
GRID-UNIT-WIDTH-PIXELS attribute...............................................................................................1704
GRID-VISIBLE attribute.....................................................................................................................1704
GROUP-BOX attribute.......................................................................................................................1704
HANDLE attribute..............................................................................................................................1705
HANDLER attribute...........................................................................................................................1706
HAS-LOBS attribute..........................................................................................................................1706
HAS-RECORDS attribute..................................................................................................................1707
Height property..................................................................................................................................1707
HEIGHT-CHARS attribute.................................................................................................................1707
HEIGHT-PIXELS attribute.................................................................................................................1708
HELP attribute...................................................................................................................................1708
HIDDEN attribute...............................................................................................................................1708
HonorProKeys property.....................................................................................................................1709
HonorReturnKey property.................................................................................................................1710
HORIZONTAL attribute......................................................................................................................1710
HTML-CHARSET attribute................................................................................................................1711
HTML-END-OF-LINE attribute..........................................................................................................1711
HTML-END-OF-PAGE attribute.........................................................................................................1711
HTML-FRAME-BEGIN attribute........................................................................................................1712
HTML-FRAME-END attribute............................................................................................................1712
HTML-HEADER-BEGIN attribute......................................................................................................1712
HTML-HEADER-END attribute..........................................................................................................1712
HTML-TITLE-BEGIN attribute...........................................................................................................1713
HTML-TITLE-END attribute...............................................................................................................1713
HWND attribute.................................................................................................................................1713
OpenEdge Development: ABL Reference
29
ICFPARAMETER attribute.................................................................................................................1713
ICON attribute...................................................................................................................................1714
IGNORE-CURRENT-MODIFIED attribute.........................................................................................1714
IMAGE attribute.................................................................................................................................1714
IMAGE-DOWN attribute....................................................................................................................1714
IMAGE-INSENSITIVE attribute.........................................................................................................1715
IMAGE-UP attribute...........................................................................................................................1715
IMMEDIATE-DISPLAY attribute.........................................................................................................1715
IMPORT-NODE( ) method.................................................................................................................1715
IMPORT-PRINCIPAL( ) method.........................................................................................................1716
INCREMENT-EXCLUSIVE-ID( ) method...........................................................................................1717
INDEX attribute.................................................................................................................................1717
INDEX-INFORMATION attribute.......................................................................................................1717
INDEX-INFORMATION( ) method.....................................................................................................1718
IN-HANDLE attribute.........................................................................................................................1719
INHERIT-BGCOLOR attribute...........................................................................................................1721
INHERIT-FGCOLOR attribute...........................................................................................................1721
INITIAL attribute................................................................................................................................1722
INITIALIZE( ) method........................................................................................................................1723
INITIALIZE-DOCUMENT-TYPE( ) method........................................................................................1724
INITIATE( ) method............................................................................................................................1726
INNER-CHARS attribute...................................................................................................................1726
INNER-LINES attribute......................................................................................................................1727
INPUT-VALUE attribute.....................................................................................................................1727
INSERT( ) method.............................................................................................................................1728
INSERT-ATTRIBUTE( ) method.........................................................................................................1729
INSERT-BACKTAB( ) method............................................................................................................1731
INSERT-BEFORE( ) method.............................................................................................................1731
INSERT-FILE( ) method.....................................................................................................................1732
INSERT-ROW( ) method....................................................................................................................1732
INSERT-STRING( ) method...............................................................................................................1733
INSERT-TAB( ) method......................................................................................................................1733
INSTANTIATING-PROCEDURE attribute..........................................................................................1734
INTERNAL-ENTRIES attribute..........................................................................................................1735
INVOKE( ) method (Handle)..............................................................................................................1736
IS-CLASS attribute............................................................................................................................1737
IS-JSON attribute..............................................................................................................................1737
IS-MULTI-TENANT attribute..............................................................................................................1738
IS-OPEN attribute..............................................................................................................................1738
IS-PARAMETER-SET attribute..........................................................................................................1738
IS-PARTITIONED attribute................................................................................................................1739
IS-ROW-SELECTED( ) method.........................................................................................................1739
IS-SELECTED( ) method..................................................................................................................1739
IS-XML attribute................................................................................................................................1740
ITEMS-PER-ROW attribute...............................................................................................................1740
30
OpenEdge Development: ABL Reference
KEEP-CONNECTION-OPEN attribute..............................................................................................1740
KEEP-FRAME-Z-ORDER attribute...................................................................................................1740
KEEP-SECURITY-CACHE attribute..................................................................................................1741
KEY attribute.....................................................................................................................................1741
KEYS attribute...................................................................................................................................1741
LABEL attribute.................................................................................................................................1742
LABEL-BGCOLOR attribute..............................................................................................................1743
LABEL-DCOLOR attribute.................................................................................................................1743
LABEL-FGCOLOR attribute..............................................................................................................1743
LABEL-FONT attribute......................................................................................................................1744
LABELS attribute...............................................................................................................................1744
LABELS-HAVE-COLONS attribute....................................................................................................1744
LANGUAGES attribute......................................................................................................................1744
LARGE attribute................................................................................................................................1745
LARGE-TO-SMALL attribute.............................................................................................................1745
LAST-ASYNC-REQUEST attribute....................................................................................................1745
LAST-BATCH attribute.......................................................................................................................1746
LAST-CHILD attribute........................................................................................................................1746
LAST-FORM attribute........................................................................................................................1746
LAST-OBJECT attribute....................................................................................................................1747
LAST-OF( ) method...........................................................................................................................1748
LAST-PROCEDURE attribute............................................................................................................1748
LAST-SERVER attribute....................................................................................................................1749
LAST-SERVER-SOCKET attribute....................................................................................................1749
LAST-SOCKET attribute....................................................................................................................1749
LAST-TAB-ITEM attribute..................................................................................................................1750
Left property......................................................................................................................................1750
LENGTH attribute..............................................................................................................................1751
LIBRARY attribute.............................................................................................................................1751
LIBRARY-CALLING-CONVENTION attribute....................................................................................1751
LINE attribute....................................................................................................................................1752
LIST-ITEM-PAIRS attribute................................................................................................................1752
LIST-ITEMS attribute.........................................................................................................................1753
LIST-PROPERTY-NAMES( ) method.................................................................................................1753
LITERAL-QUESTION attribute..........................................................................................................1754
LOAD( ) method (Handle).................................................................................................................1754
LoadControls( ) method.....................................................................................................................1756
LOAD-DOMAINS( ) method..............................................................................................................1756
LOAD-ICON( ) method......................................................................................................................1757
LOAD-IMAGE( ) method....................................................................................................................1759
LOAD-IMAGE-DOWN( ) method.......................................................................................................1760
LOAD-IMAGE-INSENSITIVE( ) method............................................................................................1761
LOAD-IMAGE-UP( ) method.............................................................................................................1762
LOAD-MOUSE-POINTER( ) method.................................................................................................1763
LOAD-SMALL-ICON( ) method.........................................................................................................1765
OpenEdge Development: ABL Reference
31
LOCAL-HOST attribute.....................................................................................................................1766
LOCAL-NAME attribute.....................................................................................................................1767
LOCAL-PORT attribute.....................................................................................................................1767
LOCAL-VERSION-INFO attribute.....................................................................................................1767
LOCATOR-COLUMN-NUMBER attribute..........................................................................................1768
LOCATOR-LINE-NUMBER attribute..................................................................................................1768
LOCATOR-PUBLIC-ID attribute.........................................................................................................1768
LOCATOR-SYSTEM-ID attribute.......................................................................................................1769
LOCATOR-TYPE attribute.................................................................................................................1769
LOCKED attribute..............................................................................................................................1769
LOCK-REGISTRATION( ) method....................................................................................................1770
LOG-AUDIT-EVENT( ) method..........................................................................................................1770
LOG-ENTRY-TYPES attribute...........................................................................................................1771
LOG-THRESHOLD attribute.............................................................................................................1777
LOGFILE-NAME attribute..................................................................................................................1778
LOGGING-LEVEL attribute...............................................................................................................1779
LOGIN-EXPIRATION-TIMESTAMP attribute.....................................................................................1780
LOGIN-HOST attribute......................................................................................................................1781
LOGIN-STATE attribute.....................................................................................................................1781
LOGOUT( ) method...........................................................................................................................1782
LONGCHAR-TO-NODE-VALUE( ) method.......................................................................................1783
LOOKUP( ) method...........................................................................................................................1784
MANDATORY attribute......................................................................................................................1784
MANUAL-HIGHLIGHT attribute.........................................................................................................1784
MARK-NEW( ) method......................................................................................................................1785
MARK-ROW-STATE( ) method..........................................................................................................1785
MAX-BUTTON attribute.....................................................................................................................1786
MAX-CHARS attribute.......................................................................................................................1787
MAX-DATA-GUESS attribute.............................................................................................................1787
MAX-HEIGHT-CHARS attribute........................................................................................................1788
MAX-HEIGHT-PIXELS attribute........................................................................................................1788
MAXIMUM-LEVEL attribute...............................................................................................................1788
MAX-VALUE attribute........................................................................................................................1788
MAX-WIDTH-CHARS attribute..........................................................................................................1789
MAX-WIDTH-PIXELS attribute..........................................................................................................1789
MD5-VALUE attribute........................................................................................................................1789
MEMPTR-TO-NODE-VALUE( ) method............................................................................................1789
MENU-BAR attribute.........................................................................................................................1790
MENU-KEY attribute.........................................................................................................................1790
MENU-MOUSE attribute...................................................................................................................1790
MERGE-BY-FIELD attribute..............................................................................................................1791
MERGE-CHANGES( ) method..........................................................................................................1791
MERGE-ROW-CHANGES( ) method................................................................................................1792
MESSAGE-AREA attribute................................................................................................................1793
MESSAGE-AREA-FONT attribute.....................................................................................................1794
32
OpenEdge Development: ABL Reference
MIN-BUTTON attribute......................................................................................................................1794
MIN-COLUMN-WIDTH-CHARS attribute..........................................................................................1794
MIN-COLUMN-WIDTH-PIXELS attribute..........................................................................................1795
MIN-HEIGHT-CHARS attribute..........................................................................................................1795
MIN-HEIGHT-PIXELS attribute..........................................................................................................1795
MIN-SCHEMA-MARSHAL attribute...................................................................................................1796
MIN-VALUE attribute.........................................................................................................................1796
MIN-WIDTH-CHARS attribute...........................................................................................................1796
MIN-WIDTH-PIXELS attribute...........................................................................................................1797
MODIFIED attribute...........................................................................................................................1797
MOUSE-POINTER attribute..............................................................................................................1797
MOVABLE attribute...........................................................................................................................1798
MOVE-AFTER-TAB-ITEM( ) method.................................................................................................1798
MOVE-BEFORE-TAB-ITEM( ) method..............................................................................................1799
MOVE-COLUMN( ) method...............................................................................................................1799
MOVE-TO-BOTTOM( ) method.........................................................................................................1800
MOVE-TO-EOF( ) method.................................................................................................................1800
MOVE-TO-TOP( ) method.................................................................................................................1801
MULTI-COMPILE attribute.................................................................................................................1801
MULTIPLE attribute...........................................................................................................................1802
MULTITASKING-INTERVAL attribute................................................................................................1803
MUST-UNDERSTAND attribute.........................................................................................................1803
Name property..................................................................................................................................1803
NAME attribute..................................................................................................................................1804
NAMESPACE-PREFIX attribute........................................................................................................1805
NAMESPACE-URI attribute...............................................................................................................1805
NEEDS-APPSERVER-PROMPT attribute........................................................................................1806
NEEDS-PROMPT attribute...............................................................................................................1806
NESTED attribute..............................................................................................................................1806
NEW attribute....................................................................................................................................1807
NEW-ROW attribute..........................................................................................................................1807
NEXT-COLUMN attribute..................................................................................................................1807
NEXT-ROWID attribute......................................................................................................................1807
NEXT-SIBLING attribute....................................................................................................................1808
NEXT-TAB-ITEM attribute..................................................................................................................1810
NO-CURRENT-VALUE attribute........................................................................................................1810
NO-EMPTY-SPACE attribute.............................................................................................................1810
NO-FOCUS attribute.........................................................................................................................1811
NONAMESPACE-SCHEMA-LOCATION attribute.............................................................................1812
NO-SCHEMA-MARSHAL attribute....................................................................................................1812
NO-VALIDATE attribute.....................................................................................................................1813
NODE-VALUE attribute.....................................................................................................................1813
NODE-VALUE-TO-LONGCHAR( ) method.......................................................................................1813
NODE-VALUE-TO-MEMPTR( ) method............................................................................................1814
NORMALIZE( ) method.....................................................................................................................1815
OpenEdge Development: ABL Reference
33
NUM-BUFFERS attribute..................................................................................................................1815
NUM-BUTTONS attribute..................................................................................................................1816
NUM-CHILD-RELATIONS attribute...................................................................................................1816
NUM-CHILDREN attribute.................................................................................................................1816
NUM-COLUMNS attribute.................................................................................................................1816
NUM-DROPPED-FILES attribute......................................................................................................1817
NUM-ENTRIES attribute...................................................................................................................1817
NUM-FIELDS attribute......................................................................................................................1817
NUM-FORMATS attribute..................................................................................................................1817
NUM-HEADER-ENTRIES attribute...................................................................................................1818
NUM-ITEMS attribute........................................................................................................................1818
NUM-ITERATIONS attribute (data objects).......................................................................................1818
NUM-ITERATIONS attribute (widget objects)....................................................................................1818
NUM-LINES attribute.........................................................................................................................1819
NUM-LOCKED-COLUMNS attribute.................................................................................................1819
NUM-LOG-FILES attribute................................................................................................................1819
NUM-MESSAGES attribute...............................................................................................................1820
NUM-PARAMETERS attribute...........................................................................................................1820
NUM-REFERENCES attribute..........................................................................................................1821
NUM-RELATIONS attribute...............................................................................................................1821
NUM-REPLACED attribute................................................................................................................1821
NUM-RESULTS attribute...................................................................................................................1822
NUM-SELECTED-ROWS attribute....................................................................................................1822
NUM-SELECTED-WIDGETS attribute..............................................................................................1822
NUM-SOURCE-BUFFERS attribute..................................................................................................1822
NUM-TABS attribute..........................................................................................................................1823
NUM-TO-RETAIN attribute................................................................................................................1823
NUM-TOP-BUFFERS attribute..........................................................................................................1823
NUM-VISIBLE-COLUMNS attribute..................................................................................................1823
NUMERIC-DECIMAL-POINT attribute..............................................................................................1824
NUMERIC-FORMAT attribute............................................................................................................1824
NUMERIC-SEPARATOR attribute.....................................................................................................1824
ON-FRAME-BORDER attribute.........................................................................................................1824
ORDINAL attribute............................................................................................................................1825
ORIGIN-HANDLE attribute................................................................................................................1825
ORIGIN-ROWID attribute..................................................................................................................1825
OVERLAY attribute............................................................................................................................1826
OWNER attribute...............................................................................................................................1826
OWNER-DOCUMENT attribute.........................................................................................................1826
PAGE-BOTTOM attribute...................................................................................................................1827
PAGE-TOP attribute..........................................................................................................................1827
PARAMETER attribute......................................................................................................................1827
PARENT attribute..............................................................................................................................1827
PARENT-BUFFER attribute...............................................................................................................1828
PARENT-FIELDS-AFTER attribute....................................................................................................1829
34
OpenEdge Development: ABL Reference
PARENT-FIELDS-BEFORE attribute.................................................................................................1829
PARENT-ID-RELATION attribute.......................................................................................................1829
PARENT-RELATION attribute............................................................................................................1830
PARSE-STATUS attribute..................................................................................................................1830
PASSWORD-FIELD attribute............................................................................................................1831
PATHNAME attribute.........................................................................................................................1831
PBE-HASH-ALGORITHM attribute...................................................................................................1831
PBE-KEY-ROUNDS attribute.............................................................................................................1832
PERSISTENT attribute......................................................................................................................1832
PERSISTENT-CACHE-DISABLED attribute......................................................................................1833
PERSISTENT-PROCEDURE attribute..............................................................................................1833
PFCOLOR attribute...........................................................................................................................1833
PIXELS-PER-COLUMN attribute......................................................................................................1834
PIXELS-PER-ROW attribute.............................................................................................................1834
POPUP-MENU attribute....................................................................................................................1834
POPUP-ONLY attribute.....................................................................................................................1834
POSITION attribute...........................................................................................................................1835
PREFER-DATASET attribute.............................................................................................................1835
PREPARED attribute.........................................................................................................................1835
PREPARE-STRING attribute.............................................................................................................1836
PREV-COLUMN attribute..................................................................................................................1836
PREV-SIBLING attribute...................................................................................................................1836
PREV-TAB-ITEM attribute.................................................................................................................1837
PRIMARY attribute............................................................................................................................1837
PRIMARY-PASSPHRASE attribute...................................................................................................1838
PRINTER-CONTROL-HANDLE attribute..........................................................................................1839
PRINTER-HDC attribute....................................................................................................................1839
PRINTER-NAME attribute.................................................................................................................1840
PRINTER-PORT attribute.................................................................................................................1840
PRIVATE-DATA attribute....................................................................................................................1840
PROCEDURE-NAME attribute..........................................................................................................1841
PROCEDURE-TYPE attribute...........................................................................................................1841
PROGRESS-SOURCE attribute.......................................................................................................1842
PROXY attribute................................................................................................................................1842
PROXY-PASSWORD attribute...........................................................................................................1842
PROXY-USERID attribute..................................................................................................................1843
PUBLIC-ID attribute...........................................................................................................................1843
PUBLISHED-EVENTS attribute........................................................................................................1843
QUALIFIED-USER-ID attribute..........................................................................................................1844
QUERY attribute................................................................................................................................1845
QUERY-CLOSE( ) method................................................................................................................1846
QUERY-OFF-END attribute...............................................................................................................1847
QUERY-OPEN( ) method..................................................................................................................1847
QUERY-PREPARE( ) method............................................................................................................1848
QUIT attribute....................................................................................................................................1849
OpenEdge Development: ABL Reference
35
RADIO-BUTTONS attribute...............................................................................................................1849
RAW-TRANSFER( ) method.............................................................................................................1850
READ( ) method (Socket)..................................................................................................................1850
READ-FILE( ) method.......................................................................................................................1852
READ-JSON( ) method.....................................................................................................................1852
READ-ONLY attribute........................................................................................................................1855
READ-XML( ) method.......................................................................................................................1855
READ-XMLSCHEMA( ) method........................................................................................................1862
RECID attribute.................................................................................................................................1868
RECORD-LENGTH attribute.............................................................................................................1868
RECURSIVE attribute.......................................................................................................................1868
REFRESH( ) method (Handle)..........................................................................................................1868
REFRESHABLE attribute..................................................................................................................1869
REFRESH-AUDIT-POLICY( ) method...............................................................................................1869
REGISTER-DOMAIN( ) method........................................................................................................1870
REJECT-CHANGES( ) method.........................................................................................................1871
REJECT-ROW-CHANGES( ) method................................................................................................1872
REJECTED attribute.........................................................................................................................1872
RELATION-FIELDS attribute.............................................................................................................1872
RELATIONS-ACTIVE attribute..........................................................................................................1873
REMOTE attribute.............................................................................................................................1874
REMOTE-HOST attribute..................................................................................................................1874
REMOTE-PORT attribute..................................................................................................................1874
REMOVE-ATTRIBUTE( ) method......................................................................................................1875
REMOVE-CHILD( ) method...............................................................................................................1876
REMOVE-EVENTS-PROCEDURE( ) method...................................................................................1876
REMOVE-SUPER-PROCEDURE( ) method.....................................................................................1877
REPLACE( ) method.........................................................................................................................1878
REPLACE-CHILD( ) method.............................................................................................................1880
REPLACE-SELECTION-TEXT( ) method.........................................................................................1881
REPOSITION attribute......................................................................................................................1882
REPOSITION-BACKWARD( ) method..............................................................................................1882
REPOSITION-FORWARD( ) method................................................................................................1882
REPOSITION-TO-ROW( ) method....................................................................................................1883
REPOSITION-TO-ROWID( ) method................................................................................................1884
REQUEST-INFO attribute..................................................................................................................1885
RESET( ) method..............................................................................................................................1886
RESIZABLE attribute.........................................................................................................................1887
RESIZE attribute...............................................................................................................................1887
RESPONSE-INFO attribute...............................................................................................................1887
RESTART-ROW attribute...................................................................................................................1889
RESTART-ROWID attribute...............................................................................................................1890
RETAIN-SHAPE attribute..................................................................................................................1891
RETURN-INSERTED attribute..........................................................................................................1891
RETURN-VALUE attribute.................................................................................................................1891
36
OpenEdge Development: ABL Reference
RETURN-VALUE-DATA-TYPE attribute............................................................................................1892
RETURN-VALUE-DLL-TYPE attribute..............................................................................................1893
ROLE attribute...................................................................................................................................1894
ROLES attribute................................................................................................................................1894
ROUNDED attribute..........................................................................................................................1894
ROW attribute....................................................................................................................................1895
ROW-HEIGHT-CHARS attribute........................................................................................................1895
ROW-HEIGHT-PIXELS attribute........................................................................................................1896
ROW-STATE attribute........................................................................................................................1896
ROWID attribute................................................................................................................................1897
ROW-MARKERS attribute.................................................................................................................1897
ROW-RESIZABLE attribute...............................................................................................................1897
SAVE( ) method.................................................................................................................................1898
SAVE-FILE( ) method........................................................................................................................1899
SAVE-ROW-CHANGES( ) method....................................................................................................1900
SAVE-WHERE-STRING attribute......................................................................................................1901
SAX-PARSE( ) method......................................................................................................................1902
SAX-PARSE-FIRST( ) method..........................................................................................................1902
SAX-PARSE-NEXT( ) method...........................................................................................................1903
SCHEMA-CHANGE attribute............................................................................................................1903
SCHEMA-LOCATION attribute..........................................................................................................1904
SCHEMA-MARSHAL attribute..........................................................................................................1905
SCHEMA-PATH attribute...................................................................................................................1905
SCREEN-LINES attribute..................................................................................................................1906
SCREEN-VALUE attribute.................................................................................................................1906
SCROLL-BARS attribute...................................................................................................................1907
SCROLL-TO-CURRENT-ROW( ) method.........................................................................................1907
SCROLL-TO-ITEM( ) method............................................................................................................1908
SCROLL-TO-SELECTED-ROW( ) method........................................................................................1908
SCROLLABLE attribute.....................................................................................................................1909
SCROLLBAR-HORIZONTAL attribute...............................................................................................1909
SCROLLBAR-VERTICAL attribute....................................................................................................1909
SEAL( ) method.................................................................................................................................1910
SEAL-TIMESTAMP attribute.............................................................................................................1912
SEARCH( ) method...........................................................................................................................1912
SELECT-ALL( ) method.....................................................................................................................1913
SELECT-FOCUSED-ROW( ) method................................................................................................1914
SELECT-NEXT-ROW( ) method........................................................................................................1914
SELECT-PREV-ROW( ) method........................................................................................................1915
SELECT-ROW( ) method...................................................................................................................1915
SELECTABLE attribute......................................................................................................................1915
SELECTED attribute.........................................................................................................................1916
SELECTION-END attribute...............................................................................................................1916
SELECTION-START attribute...........................................................................................................1916
SELECTION-TEXT attribute..............................................................................................................1917
OpenEdge Development: ABL Reference
37
SENSITIVE attribute..........................................................................................................................1917
SEPARATORS attribute.....................................................................................................................1918
SEPARATOR-FGCOLOR attribute....................................................................................................1918
SERIALIZE-HIDDEN attribute...........................................................................................................1918
SERIALIZE-NAME attribute..............................................................................................................1919
SERIALIZE-ROW( ) method..............................................................................................................1919
SERVER attribute..............................................................................................................................1922
SERVER-CONNECTION-BOUND attribute......................................................................................1923
SERVER-CONNECTION-BOUND-REQUEST attribute....................................................................1923
SERVER-CONNECTION-CONTEXT attribute..................................................................................1924
SERVER-CONNECTION-ID attribute................................................................................................1925
SERVER-OPERATING-MODE attribute............................................................................................1925
SESSION-END attribute....................................................................................................................1926
SESSION-ID attribute........................................................................................................................1926
SET-ACTOR( ) method......................................................................................................................1927
SET-APPL-CONTEXT( ) method.......................................................................................................1928
SET-ATTRIBUTE( ) method...............................................................................................................1929
SET-ATTRIBUTE-NODE( ) method...................................................................................................1930
SET-BLUE-VALUE( ) method............................................................................................................1930
SET-BREAK( ) method......................................................................................................................1931
SET-BUFFERS( ) method.................................................................................................................1932
SET-CALLBACK( ) method................................................................................................................1932
SET-CALLBACK-PROCEDURE( ) method.......................................................................................1933
SET-CLIENT( ) method.....................................................................................................................1934
SET-COMMIT( ) method....................................................................................................................1937
SET-CONNECT-PROCEDURE( ) method.........................................................................................1937
SET-DYNAMIC( ) method..................................................................................................................1938
SET-GREEN-VALUE( ) method.........................................................................................................1938
SET-INPUT-SOURCE( ) method.......................................................................................................1939
SET-MUST-UNDERSTAND( ) method...............................................................................................1940
SET-NODE( ) method........................................................................................................................1940
SET-NUMERIC-FORMAT( ) method.................................................................................................1941
SET-OUTPUT-DESTINATION( ) method...........................................................................................1942
SET-PARAMETER( ) method (Handle).............................................................................................1943
SET-PROPERTY( ) method...............................................................................................................1946
SET-READ-RESPONSE-PROCEDURE( ) method...........................................................................1947
SET-RED-VALUE( ) method..............................................................................................................1947
SET-REPOSITIONED-ROW( ) method.............................................................................................1948
SET-RGB-VALUE( ) method..............................................................................................................1949
SET-ROLE( ) method.........................................................................................................................1949
SET-ROLLBACK( ) method...............................................................................................................1950
SET-SELECTION( ) method..............................................................................................................1950
SET-SERIALIZED( ) method.............................................................................................................1951
SET-SOCKET-OPTION( ) method.....................................................................................................1952
SET-SORT-ARROW( ) method..........................................................................................................1953
38
OpenEdge Development: ABL Reference
SET-WAIT-STATE( ) method..............................................................................................................1955
SHOW-IN-TASKBAR attribute...........................................................................................................1955
SIDE-LABEL-HANDLE attribute........................................................................................................1956
SIDE-LABELS attribute.....................................................................................................................1956
SINGLE-RUN attribute......................................................................................................................1957
SINGLETON attribute........................................................................................................................1957
SKIP-DELETED-RECORD attribute..................................................................................................1957
SMALL-ICON attribute......................................................................................................................1957
SMALL-TITLE attribute......................................................................................................................1958
SOAP-FAULT-ACTOR attribute..........................................................................................................1958
SOAP-FAULT-CODE attribute............................................................................................................1958
SOAP-FAULT-DETAIL attribute..........................................................................................................1959
SOAP-FAULT-MISUNDERSTOOD-HEADER attribute......................................................................1959
SOAP-FAULT-NODE attribute............................................................................................................1959
SOAP-FAULT-ROLE attribute............................................................................................................1959
SOAP-FAULT-STRING attribute........................................................................................................1960
SOAP-FAULT-SUBCODE attribute....................................................................................................1960
SOAP-VERSION attribute.................................................................................................................1960
SORT attribute..................................................................................................................................1961
SORT-ASCENDING attribute............................................................................................................1961
SORT-NUMBER attribute..................................................................................................................1961
SSL-SERVER-NAME attribute..........................................................................................................1962
STANDALONE attribute.....................................................................................................................1962
START-DOCUMENT( ) method.........................................................................................................1963
START-ELEMENT( ) method.............................................................................................................1963
STARTUP-PARAMETERS attribute...................................................................................................1965
STATE-DETAIL attribute....................................................................................................................1967
STATUS-AREA attribute....................................................................................................................1968
STATUS-AREA-FONT attribute.........................................................................................................1968
STOP attribute...................................................................................................................................1968
STOP-PARSING( ) method...............................................................................................................1969
STOPPED attribute...........................................................................................................................1969
STREAM attribute.............................................................................................................................1970
STRETCH-TO-FIT attribute...............................................................................................................1970
STRICT attribute...............................................................................................................................1970
STRICT-ENTITY-RESOLUTION attribute..........................................................................................1971
STRING-VALUE( ) method................................................................................................................1971
SUBTYPE attribute............................................................................................................................1971
SUPER-PROCEDURES attribute.....................................................................................................1972
SUPPRESS-NAMESPACE-PROCESSING attribute........................................................................1973
SUPPRESS-WARNINGS attribute....................................................................................................1973
SUPPRESS-WARNINGS-LIST attribute...........................................................................................1973
SYMMETRIC-ENCRYPTION-ALGORITHM attribute........................................................................1973
SYMMETRIC-ENCRYPTION-IV attribute..........................................................................................1974
SYMMETRIC-ENCRYPTION-KEY attribute......................................................................................1974
OpenEdge Development: ABL Reference
39
SYMMETRIC-SUPPORT attribute....................................................................................................1975
SYNCHRONIZE( ) method................................................................................................................1976
SYSTEM-ALERT-BOXES attribute....................................................................................................1976
SYSTEM-ID attribute.........................................................................................................................1976
TAB-POSITION attribute...................................................................................................................1977
TAB-STOP attribute...........................................................................................................................1977
TABLE attribute.................................................................................................................................1977
TABLE-CRC-LIST attribute................................................................................................................1978
TABLE-HANDLE attribute..................................................................................................................1978
TABLE-LIST attribute.........................................................................................................................1978
TABLE-NUMBER attribute.................................................................................................................1979
Tag property (ActiveX control)...........................................................................................................1979
TEMP-DIRECTORY attribute............................................................................................................1979
TEMP-TABLE-PREPARE( ) method..................................................................................................1979
TENANT-ID( ) method.......................................................................................................................1980
TENANT-NAME( ) method................................................................................................................1981
TEXT-SELECTED attribute...............................................................................................................1982
THREAD-SAFE attribute...................................................................................................................1982
THREE-D attribute............................................................................................................................1982
TIC-MARKS attribute.........................................................................................................................1983
TIME-SOURCE attribute...................................................................................................................1984
TIMEZONE attribute..........................................................................................................................1984
TITLE attribute...................................................................................................................................1985
TITLE-BGCOLOR attribute...............................................................................................................1985
TITLE-DCOLOR attribute..................................................................................................................1985
TITLE-FGCOLOR attribute................................................................................................................1985
TITLE-FONT attribute........................................................................................................................1986
TOGGLE-BOX attribute.....................................................................................................................1986
TOOLTIP attribute.............................................................................................................................1986
TOOLTIPS attribute...........................................................................................................................1986
Top property......................................................................................................................................1987
TOP-NAV-QUERY attribute...............................................................................................................1987
TOP-ONLY attribute...........................................................................................................................1988
TRACKING-CHANGES attribute.......................................................................................................1988
TRANSACTION attribute...................................................................................................................1989
TRANSPARENT attribute..................................................................................................................1990
TRANS-INIT-PROCEDURE attribute.................................................................................................1990
TYPE attribute...................................................................................................................................1990
UNDO attribute..................................................................................................................................1992
UNDO-THROW-SCOPE attribute.....................................................................................................1992
UNIQUE-ID attribute..........................................................................................................................1992
UNIQUE-MATCH attribute.................................................................................................................1993
UPDATE-ATTRIBUTE( ) method.......................................................................................................1993
URL attribute.....................................................................................................................................1994
URL-DECODE( ) method..................................................................................................................1995
40
OpenEdge Development: ABL Reference
URL-ENCODE( ) method..................................................................................................................1995
URL-PASSWORD attribute...............................................................................................................1995
URL-USERID attribute......................................................................................................................1995
USER-ID attribute..............................................................................................................................1995
V6DISPLAY attribute.........................................................................................................................1996
VALIDATE( ) method.........................................................................................................................1997
VALIDATE-EXPRESSION attribute...................................................................................................1998
VALIDATE-MESSAGE attribute.........................................................................................................1998
VALIDATE-SEAL( ) method...............................................................................................................1998
VALIDATE-XML attribute...................................................................................................................2000
VALIDATION-ENABLED attribute......................................................................................................2000
VALUE attribute.................................................................................................................................2000
VERSION attribute............................................................................................................................2001
VIEW-AS attribute.............................................................................................................................2001
VIEW-FIRST-COLUMN-ON-REOPEN attribute................................................................................2002
VIRTUAL-HEIGHT-CHARS attribute.................................................................................................2002
VIRTUAL-HEIGHT-PIXELS attribute.................................................................................................2003
VIRTUAL-WIDTH-CHARS attribute...................................................................................................2003
VIRTUAL-WIDTH-PIXELS attribute...................................................................................................2003
VISIBLE attribute...............................................................................................................................2003
WARNING attribute...........................................................................................................................2005
WC-ADMIN-APP attribute.................................................................................................................2005
WHERE-STRING attribute................................................................................................................2005
Widget-Handle property....................................................................................................................2006
WIDGET-ENTER attribute.................................................................................................................2007
WIDGET-ID attribute..........................................................................................................................2007
WIDGET-LEAVE attribute..................................................................................................................2009
Width property...................................................................................................................................2009
WIDTH-CHARS attribute...................................................................................................................2009
WIDTH-PIXELS attribute...................................................................................................................2010
WINDOW attribute.............................................................................................................................2011
WINDOW-STATE attribute.................................................................................................................2011
WINDOW-SYSTEM attribute.............................................................................................................2012
WORD-WRAP attribute.....................................................................................................................2012
WORK-AREA-HEIGHT-PIXELS at