-
Notifications
You must be signed in to change notification settings - Fork 8
/
rddads.html
1367 lines (1316 loc) · 119 KB
/
rddads.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<meta charset="utf-8">
<meta name="referrer" content="origin">
<meta name="viewport" content="initial-scale=1">
<meta http-equiv="Content-Security-Policy" content="upgrade-insecure-requests; block-all-mixed-content">
<meta name="generator" content="hbdoc">
<meta name="keywords" content="Harbour, Clipper, xBase, database, Free Software, GPL, compiler, cross-platform, 32-bit, 64-bit">
<title>Harbour Reference Guide · rddads lib</title>
<style>
/**
* Minified by jsDelivr using clean-css v4.2.1.
* Original file: /gh/PrismJS/[email protected]/themes/prism-okaidia.css
*
* Do NOT use SRI with dynamically generated files! More information: https://www.jsdelivr.com/using-sri-with-dynamic-files
*/
code[class*=language-],pre[class*=language-]{color:#f8f8f2;background:0 0;text-shadow:0 1px rgba(0,0,0,.3);font-family:Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace;font-size:1em;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none}pre[class*=language-]{padding:1em;margin:.5em 0;overflow:auto;border-radius:.3em}:not(pre)>code[class*=language-],pre[class*=language-]{background:#272822}:not(pre)>code[class*=language-]{padding:.1em;border-radius:.3em;white-space:normal}.token.cdata,.token.comment,.token.doctype,.token.prolog{color:#708090}.token.punctuation{color:#f8f8f2}.namespace{opacity:.7}.token.constant,.token.deleted,.token.property,.token.symbol,.token.tag{color:#f92672}.token.boolean,.token.number{color:#ae81ff}.token.attr-name,.token.builtin,.token.char,.token.inserted,.token.selector,.token.string{color:#a6e22e}.language-css .token.string,.style .token.string,.token.entity,.token.operator,.token.url,.token.variable{color:#f8f8f2}.token.atrule,.token.attr-value,.token.class-name,.token.function{color:#e6db74}.token.keyword{color:#66d9ef}.token.important,.token.regex{color:#fd971f}.token.bold,.token.important{font-weight:700}.token.italic{font-style:italic}.token.entity{cursor:help}
/*# sourceMappingURL=/sm/40fbac8c090a0ea2949bef662c4dc8f61e9fdf4136e4615ec312d47b6c8d4578.map */
</style>
<link rel="stylesheet" href="hbdoc.css">
<body>
<header>
<svg viewBox="0 0 2260 2260" xmlns="http://www.w3.org/2000/svg">
<path d="m900 1908c137.17-53.265 443.4-77.006 600-52.437-27.114-474.75-34.113-758.18-7.68-1116.3 2.056-27.195 4.283-54.9 6.68-83.245-34.633 68.628-579.45 1206.4-599 1252z"/>
<path d="m1503 297c-123.84 327.12-161.3 844.46-213.46 1389.5-169.5-13.113-449.01 19.795-659.3 108.82 13.528-23.75 771.23-1330.1 872.77-1498.3z"/>
<path d="m1172 1270c-224.3-65.046-473.09 64.996-694 204 153.35-235.43 613.25-936.89 1011-1474-301.51 419.86-317.18 1087.9-317 1270z"/>
<path d="m620.8 2258.7c0.662-1.037 1.36-2.165 2.068-3.191 36.736-55.29 105.69-101.18 205.1-96.72 193.8 8.619 357.24 25.577 652.18 7.207-290.1-9.342-643.35-48.142-1069.1-124.55 105.83 77.98 193.83 195.4 209.76 217.25"/>
<path d="m2259.2 2007.9c-351.83 85.376-1111.3 54.312-2014.2-105.24 59.534 32.024 105.24 68.44 160.57 113.87 884.55 158.71 1465.7 153.54 1808.7 60.37 31.307-22.43 35.385-37.956 44.934-69.006"/>
<path d="m2250.8 1985.6c-316.53 76.867-976 46.6-1793.5-72.332-79.588-11.605-308.23-46.57-445.63-69.063-7.464-15.506-11.282-40.462-11.282-70.79 509.45 68.675 1799.6 275.42 2244 168.26 2.015 12.02 7.115 18.487 6.527 43.929"/>
</svg>
<div>
<div><a href="index.html">Harbour Reference Guide</a></div>
<div>
<nav class="menu">
<nav class="dropdown">
<span class="dropbtn" onclick="">rddads lib</span>
<nav class="dropdown-content">
<a href="harbour.html">Harbour core</a>
<hr>
<a href="clc53.html">Clipper 5.3</a>
<a href="clct3.html">Clipper Tools 3</a>
<hr>
<a href="gtwvw.html">gtwvw</a>
<a href="hbct.html">hbct</a>
<a href="hbcups.html">hbcups</a>
<a href="hbgd.html">hbgd</a>
<a href="hbgt.html">hbgt</a>
<a href="hbmisc.html">hbmisc</a>
<a href="hbnf.html">hbnf</a>
<a href="hbxpp.html">hbxpp</a>
<a href="hbziparc.html">hbziparc</a>
<a href="rddads.html">rddads</a>
</nav>
</nav>
<nav class="dropdown lang">
<span class="dropbtn lang">EN</span><nav class="dropdown-content lang">
<a href="rddads.html">EN</a>
<a href="pt-br/index.html">pt-BR</a>
</nav>
</nav>
</nav>
</div>
</div>
</header>
<aside>
<a href="#ads-overview" title="ADS Overview">ADS Overview</a>
<a href="#adsblob2file" title="AdsBlob2File()"><code>AdsBlob2File()</code></a>
<a href="#adscacheopencursors" title="AdsCacheOpenCursors()"><code>AdsCacheOpenCursors()</code></a>
<a href="#adscacheopentables" title="AdsCacheOpenTables()"><code>AdsCacheOpenTables()</code></a>
<a href="#adsclearaof" title="AdsClearAOF()"><code>AdsClearAOF()</code></a>
<a href="#adsclosecachedtables" title="AdsCloseCachedTables()"><code>AdsCloseCachedTables()</code></a>
<a href="#adsclrcallback" title="AdsClrCallback()"><code>AdsClrCallback()</code></a>
<a href="#adsconnect60" title="AdsConnect60()"><code>AdsConnect60()</code></a>
<a href="#adscustomizeaof" title="AdsCustomizeAOF()"><code>AdsCustomizeAOF()</code></a>
<a href="#adsddaddtable" title="AdsDDAddTable()"><code>AdsDDAddTable()</code></a>
<a href="#adsevalaof" title="AdsEvalAOF()"><code>AdsEvalAOF()</code></a>
<a href="#adsfile2blob" title="AdsFile2Blob()"><code>AdsFile2Blob()</code></a>
<a href="#adsgetaof" title="AdsGetAOF()"><code>AdsGetAOF()</code></a>
<a href="#adsgetaofnoopt" title="AdsGetAOFNoOpt()"><code>AdsGetAOFNoOpt()</code></a>
<a href="#adsgetaofoptlevel" title="AdsGetAOFOptLevel()"><code>AdsGetAOFOptLevel()</code></a>
<a href="#adsgetconnectiontype" title="AdsGetConnectionType()"><code>AdsGetConnectionType()</code></a>
<a href="#adsgetlasterror" title="AdsGetLastError()"><code>AdsGetLastError()</code></a>
<a href="#adsgetrelkeypos" title="AdsGetRelKeyPos()"><code>AdsGetRelKeyPos()</code></a>
<a href="#adsgettablecontype" title="AdsGetTableConType()"><code>AdsGetTableConType()</code></a>
<a href="#adsisexprvalid" title="AdsIsExprValid()"><code>AdsIsExprValid()</code></a>
<a href="#adsisindexed" title="AdsIsIndexed()"><code>AdsIsIndexed()</code></a>
<a href="#adsisrecordinaof" title="AdsIsRecordInAOF()"><code>AdsIsRecordInAOF()</code></a>
<a href="#adskeycount" title="AdsKeyCount()"><code>AdsKeyCount()</code></a>
<a href="#adskeyno" title="AdsKeyNo()"><code>AdsKeyNo()</code></a>
<a href="#adslocking" title="AdsLocking()"><code>AdsLocking()</code></a>
<a href="#adsrefreshaof" title="AdsRefreshAOF()"><code>AdsRefreshAOF()</code></a>
<a href="#adsregcallback" title="AdsRegCallback()"><code>AdsRegCallback()</code></a>
<a href="#adsrightscheck" title="AdsRightsCheck()"><code>AdsRightsCheck()</code></a>
<a href="#adssetaof" title="AdsSetAOF()"><code>AdsSetAOF()</code></a>
<a href="#adssetchartype" title="AdsSetCharType()"><code>AdsSetCharType()</code></a>
<a href="#adssetdefault-" title="AdsSetDefault() *"><code>AdsSetDefault() *</code></a>
<a href="#adssetdeleted-" title="AdsSetDeleted() *"><code>AdsSetDeleted() *</code></a>
<a href="#adssetexact-" title="AdsSetExact() *"><code>AdsSetExact() *</code></a>
<a href="#adssetrelkeypos" title="AdsSetRelKeyPos()"><code>AdsSetRelKeyPos()</code></a>
<a href="#adssetsearchpath-" title="AdsSetSearchPath() *"><code>AdsSetSearchPath() *</code></a>
<a href="#adstestreclocks" title="AdsTestRecLocks()"><code>AdsTestRecLocks()</code></a>
</aside>
<main>
<section>
<h4><a href="#ads-overview" class="d-id" id="ads-overview" title="∞">ADS Overview</a><span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/readme.txt">Improve this doc</a></span></h4>
<div class="d-ol">Advantage Database Server RDD</div>
<div class="d-d">Description</div>
<div class="d-it">
<div><p>rddads is an RDD for the Advantage Database Server, an xBase data server by Extended Systems <a href="https://devzone.advantagedatabase.com/">https://devzone.advantagedatabase.com/</a>. The RDD was written by Alexander Kresin <code>alex/at/belacy.belgorod.su</code> Additional code and documentation was added by Brian Hays <code>bhays/at/abacuslaw.com</code>.</div>
<div><p>Your Harbour application can access a remote database server for a true client/server architecture, or it can use the "local server" for stand-alone or even small network installations.</div>
<div><p>For using this RDD you need to have all required dynamic libraries installed on your system.</div>
<div><p>For building executables don't forget to include <code>rddads.hbc</code> in your hbmk2 project.</div>
<div><p>You also need to include in your prg file following lines:</div>
<pre><code class="language-c">REQUEST ADS
rddRegister( "ADS", 1 )
rddSetDefault( "ADS" )
</code></pre>
<div><p>By default rddads is tuned for remote server and CDX indexes. To change this you may use these commands defined in <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code>:</div>
<pre><code class="language-c">SET SERVER LOCAL
SET SERVER REMOTE
SET FILETYPE TO NTX
SET FILETYPE TO ADT
SET FILETYPE TO CDX
</code></pre>
<div><p>or functions <code>AdsSetServerType()</code>, <code>AdsSetFileType()</code>. See the header file <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code> for details.</div>
<div><p>Note that the default local server is usable for file sharing on a small network. The default DLL is limited to 5 users, but an unlimited version is available from Extended Systems.</div>
<div><p><code>MAX <code>OPEN</code> TABLES</code>: The server (even local) has its own setting for Max Tables allowed open. For the Local Server, it can be set in <code>adslocal.cfg</code>. The default is only 50! For the Windows Remote Servers, use the Configuration Utility, or increase the setting for the <code>TABLES</code> configuration value in the Advantage Database Server configuration registry key using the Registry Editor. For NetWare, edit the configuration file <code>ads.cfg</code>.</div>
<div><p>See <code>ace.hlp</code> under <code>adslocal.cfg</code>, or the Advantage Error Guide for error 7005.</div>
<div><p><strong>Speed and Performance Issues</strong></div>
<div><p>If you have sluggish browsers, one issue could be the scrollbar. If it's fast with the scrollbar disabled, the browse/scrolling logic may not be as optimized as it could be. Scrollbars should always use <code><a href="#adsgetrelkeypos">AdsGetRelKeyPos()</a></code> and <code><a href="#adssetrelkeypos">AdsSetRelKeyPos()</a></code> instead of key counting functions.</div>
<div><p>If filtered data seems slower than expected, check these things: First, optimization is not on by default, so at the top of the app call</div>
<pre><code class="language-c">Set( _SET_OPTIMIZE, .T. )
</code></pre>
<div><p>or its command equivalent. rddads will use an AOF whenever <code><a href="harbour.html#dbsetfilter" title="harbour">dbSetFilter()</a></code> is called <strong>if it can</strong>.</div>
<div><p>Second, make sure the filter is one ADS can understand. UDFs are out, as are references to public or private variables. It's also best to remove field aliases from the string. ADS cannot reference aliases for other related tables, so they're superfluous. You can call</div>
<pre><code class="language-c">? AdsIsExprValid( cFilter )
</code></pre>
<div><p>to check. If this returns False, neither the Local Server nor the Remote Server can process it, so optimization will never occur (but the Harbour RDD will process the filtering locally by evaluating the codeblock and testing each record). The only way to speed it up is to fix the filter so ADS understands it.</div>
<div><p>You can also use <code>dbOrderInfo( <code>DBOI_OPTLEVEL</code> )</code> to see if the current filter is optimized or not. <code>COMIX</code> users can use:</div>
<pre><code class="language-c">FUNCTION rlOptLevel()
RETURN dbOrderInfo( DBOI_OPTLEVEL )
</code></pre>
<div><p>This returns the Clipper/COMIX values (not ADS-defined values) because this is an RDD call, not just a wrapper to the ADS call, which uses different numbers).</div>
</div>
<div class="d-d">Compliance</div>
<div class="d-it">
<div>Every attempt has been made to make the RDD compliant with the standard <code>DBFCDX RDD</code> at the .prg level. One important difference is the handling of structural indexes. ACE will <strong>always</strong> automatically open an index with the same name as the data file. There is no way to turn this feature off.</div>
<div>You can use the <code><a href="harbour.html#set" title="harbour">Set()</a></code> function call as well as the equivalent commands for <code>SET <code>DEFAULT</code> TO</code>, <code>DATEFORMAT</code>, <code>DELETE</code>, and <code>EPOCH</code>. Harbour automatically makes the call to ADS to change its internal setting to match Harbour's.</div>
<div><code>INDEXING</code> and Progress Displays: Remote server does not support the <code>EVAL/EVERY</code> clauses. Remember, there is an external process doing the indexing that knows nothing of Harbour expressions or codeblocks. Even with Local Server it's the DLLs doing all the indexing. So to do progress meters you need to implement <code>AdsRegCallback( bEval )</code>. It lets you set a codeblock that is evaluated every 2 seconds. A numeric value of the "percent completed" is passed to the codeblock by the ADS server.</div>
<pre><code class="language-c">#include "inkey.ch"
PROCEDURE Main()
...
AdsRegCallback( {| nPercent | outputstuff( nPercent ) } )
/* The above codeblock will be called approximately
every 2 seconds while indexing.
The codeblock can return .T. to abort. */
INDEX ON FIRST + LAST + LABEL1 + LABEL2 TAG First
AdsClrCallback()
RETURN
STATIC FUNCTION outputstuff( nPercent ) /* The "callback" function */
? "output stuff", nPercent
RETURN hb_keyStd( Inkey() ) == K_ESC /* If <Esc> pressed, returns .T. to abort. */
</code></pre>
<div>For programmers who are already familiar with the ACE engine, Harbour's compatibility with <code>DBFCDX</code> means there are some differences between the rddads in Harbour and the parallel ACE documentation:</div>
<div>1) In ACE, skipping backwards to BOF goes to the phantom record and sets the record number to 0. In rddads, the record pointer stays at the Top record and only the BOF flag is set to True.</div>
<div>2) In rddads, a filter expression can be used that may not be valid on the server (because of references to public variables or User-Defined Functions). In these cases, all data will come back from the server but will be filtered by the application running on the client. These situations lose the benefits of having a data server and should be avoided, but they will function as they would in a Clipper program.</div>
<div>One problem with this scenario is that index key counting functions that are supposed to give an accurate count respecting the filter (e.g. <code>dbOrderInfo( <code>DBOI_KEYCOUNT</code> )</code> will return the values the Server knows about, so the counts may be inaccurate.</div>
<div>3) When setting a relation, the expression must be one that can be evaluated by the Advantage Expression Engine. UDFs will fail.</div>
</div>
<div class="d-d">Platforms</div>
<div class="d-it">Available on all platforms</div>
<div class="d-d">Tag</div>
<div class="d-it">Document</div>
</section>
<section>
<h4><a href="#adsblob2file" class="d-id" id="adsblob2file" title="∞"><code>AdsBlob2File()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L559" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsBlob2File">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsBlob2File">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Write a Binary (memo) field's contents to a file</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsBlob2File( <cFileName>, <cFieldName> ) → lSuccess</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it">
<div><code>cFileName</code> File to create. If it already exists, it will be overwritten on success and destroyed on error.</div>
<div><code>cFieldName</code> Field in the current workarea that contains binary data.</div>
</div>
<div class="d-d">Returns</div>
<div class="d-it"><code>lSuccess</code> True if the file is successfully written.</div>
<div class="d-d">Description</div>
<div class="d-it">See <code>ace.hlp</code> for full details about the Advantage Database Server. <code>AdsBlob2File()</code> is a wrapper for <code>AdsBinaryToFile()</code>.</div>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">Available on Windows</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code><a href="#adsfile2blob">AdsFile2Blob()</a></code></div>
</section>
<section>
<h4><a href="#adscacheopencursors" class="d-id" id="adscacheopencursors" title="∞"><code>AdsCacheOpenCursors()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L1759" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsCacheOpenCursors">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsCacheOpenCursors">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Provides caching of open cursors</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsCacheOpenCursors( <nOpen> ) → nRetVal</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it"><code>nOpen</code> Number of cursors to cache.</div>
<div class="d-d">Returns</div>
<div class="d-it"><code>nRetVal</code> ???</div>
<div class="d-d">Description</div>
<div class="d-it"><code>AdsCacheOpenCursors()</code> allows cursor closes to be cached in order for subsequent <code>SELECTS</code> to occur faster. A call to <code>AdsCloseTable()</code> with the cursor cache greater than zero results in the cursor appearing closed to an application, but still open on the Advantage server. <code>AdsCacheOpenCursors()</code> is a global setting that affects the behavior of the entire application. The default number of open cursors that are cached is 25.</div>
<div class="d-d">Examples</div>
<section class="d-ex"><div class="playground"><pre contenteditable="true" spellcheck="false"><code class="language-c">? AdsCacheOpenCursors( 0 )
</code></pre></div></section>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">
<div>Available on Linux</div>
<div>Available on Windows</div>
</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code><a href="#adscacheopentables">AdsCacheOpenTables()</a></code></div>
</section>
<section>
<h4><a href="#adscacheopentables" class="d-id" id="adscacheopentables" title="∞"><code>AdsCacheOpenTables()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L1754" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsCacheOpenTables">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsCacheOpenTables">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Provides caching of open tables</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsCacheOpenTables( <nOpen> ) → nRetVal</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it"><code>nOpen</code> Number of tables to cache.</div>
<div class="d-d">Returns</div>
<div class="d-it"><code>nRetVal</code> ???</div>
<div class="d-d">Description</div>
<div class="d-it"><code>AdsCacheOpenTables()</code> allows table closes to be cached in order for subsequent opens to occur faster. A call to <code>AdsCloseTable()</code> with the table cache greater than zero results in the table appearing closed to an application, but still open on the Advantage server. <code>AdsCacheOpenTables()</code> is a global setting that affects the behavior of the entire application. The default number of open tables that are cached is 0.</div>
<div class="d-d">Examples</div>
<section class="d-ex"><div class="playground"><pre contenteditable="true" spellcheck="false"><code class="language-c">? AdsCacheOpenTables( 25 )
</code></pre></div></section>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">
<div>Available on Linux</div>
<div>Available on Windows</div>
</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code><a href="#adscacheopencursors">AdsCacheOpenCursors()</a></code></div>
</section>
<section>
<h4><a href="#adsclearaof" class="d-id" id="adsclearaof" title="∞"><code>AdsClearAOF()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L838" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsClearAOF">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsClearAOF">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Clears an Advantage Optimized Filter in the current workarea.</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsClearAOF()</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it">None</div>
<div class="d-d">Returns</div>
<div class="d-it"><code>NIL</code></div>
<div class="d-d">Description</div>
<div class="d-it">See <code>ace.hlp</code> for full details about the Advantage Database Server.</div>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">Available on Windows</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code><a href="#adscustomizeaof">AdsCustomizeAOF()</a></code>, <code><a href="#adsevalaof">AdsEvalAOF()</a></code>, <code><a href="#adsgetaof">AdsGetAOF()</a></code>, <code><a href="#adsgetaofoptlevel">AdsGetAOFOptLevel()</a></code>, <code><a href="#adsisrecordinaof">AdsIsRecordInAOF()</a></code>, <code><a href="#adsrefreshaof">AdsRefreshAOF()</a></code></div>
</section>
<section>
<h4><a href="#adsclosecachedtables" class="d-id" id="adsclosecachedtables" title="∞"><code>AdsCloseCachedTables()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L2399" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsCloseCachedTables">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsCloseCachedTables">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Close all cached tables on the given connection</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsCloseCachedTables( [<hConnection>] ) → nRetVal</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it"><code>hConnection</code> A connection handle retrieved via <code>AdsConnect()</code> or <code><a href="#adsconnect60">AdsConnect60()</a></code>. If omitted, the RDD's current connection handle is used, but this only exists if <code>AdsConnect()</code> or <code><a href="#adsconnect60">AdsConnect60()</a></code> were previously called.</div>
<div class="d-d">Returns</div>
<div class="d-it"><code>nRetVal</code> ???</div>
<div class="d-d">Description</div>
<div class="d-it"><code>AdsCloseCachedTables()</code> can be used to close all cached tables on a given connection. All cached closed tables on the client will be closed, as well as all cache closed tables on the server that might have been used when executing SQL statements.</div>
<div class="d-d">Examples</div>
<section class="d-ex"><div class="playground"><pre contenteditable="true" spellcheck="false"><code class="language-c">? AdsCloseCachedTables()
</code></pre></div></section>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">
<div>Available on Linux</div>
<div>Available on Windows</div>
<div>ADS 7.x and above</div>
</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code><a href="#adscacheopencursors">AdsCacheOpenCursors()</a></code>, <code><a href="#adscacheopentables">AdsCacheOpenTables()</a></code></div>
</section>
<section>
<h4><a href="#adsclrcallback" class="d-id" id="adsclrcallback" title="∞"><code>AdsClrCallback()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L1555" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsClrCallback">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsClrCallback">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Clears the callback set by AdsRegCallback().</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsClrCallback() → NIL</code></pre></div>
<div class="d-d">Returns</div>
<div class="d-it"><code>NIL</code></div>
<div class="d-d">Description</div>
<div class="d-it">See <code><a href="#adsregcallback">AdsRegCallback()</a></code>.</div>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">
<div>Available on Linux</div>
<div>Available on Windows</div>
</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code><a href="#adsregcallback">AdsRegCallback()</a></code></div>
</section>
<section>
<h4><a href="#adsconnect60" class="d-id" id="adsconnect60" title="∞"><code>AdsConnect60()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L1924" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsConnect60">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsConnect60">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Connect to a local/remote/internet server</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsConnect60( <cFilePath>, <nServertype>, [<cUserName>], [<cUserPass>], [<nOptions>] ) → lSuccess</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it"><code>cFilePath</code> Name of data dictionary to connect to. <code>nServertype</code> The server type to connect (<code>LOCAL</code>, <code>REMOTE</code>, AIS or all together) <code>cUserName</code> Optional Name of the user connecting to the server <code>cUserPass</code> Optional password for the user Name <code>nOptions</code> The optional connection options</div>
<div class="d-d">Returns</div>
<div class="d-it"><code>lSuccess</code> True if connected, otherwise False.</div>
<div class="d-d">Description</div>
<div class="d-it"><code>AdsConnect60()</code> makes the connection to an advantage database server. See <code>ace.hlp</code> for full details about the Advantage Database Server.</div>
<div class="d-d">Examples</div>
<section class="d-ex"><div class="playground"><pre contenteditable="true" spellcheck="false"><code class="language-c">IF AdsConnect60( "harbour.add", 7 /* All types of connection */, "ADSSYS", "", )
// Add one user
AdsDDCreateUser( , "Luiz", "papael", "This is Luiz user" )
ENDIF
</code></pre></div></section>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">
<div>Available on Linux</div>
<div>Available on Windows</div>
</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code><a href="#adsddaddtable">AdsDDAddTable()</a></code></div>
</section>
<section>
<h4><a href="#adscustomizeaof" class="d-id" id="adscustomizeaof" title="∞"><code>AdsCustomizeAOF()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads1.c#L5819" class="d-so" title="contrib/rddads/ads1.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsCustomizeAOF">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsCustomizeAOF">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Add or remove records from an existing AOF</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsCustomizeAOF( [<nRecno | aRecNos>] [, <nType>] ) → nSuccess</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it">
<div><code>nRecno | aRecNos</code> Can be either a single record number or an array of record numbers to add or delete from the AOF. If omitted, defaults to the current record.</div>
<div><code>nType</code> The type of operation:</div>
<div class="d-t d-t0">
<div>ADS_AOF_ADD_RECORD Add the record to the AOF (set the bit). This is the default operation.</div>
<div>ADS_AOF_REMOVE_RECORD Remove the record from the AOF (clear the bit).</div>
<div>ADS_AOF_TOGGLE_RECORD Switch the record into or out of the AOF.</div>
</div>
<div></div>
</div>
<div class="d-d">Returns</div>
<div class="d-it"><code>nError</code> ADS error code, or 0 for success.</div>
<div class="d-d">Description</div>
<div class="d-it">
<div><p>An Advantage Optimized Filter (AOF) consists of a bitmap of the records in the database. If bit 5 is on, record 5 is considered a visible record. If bit 5 is off, record 5 is not visible. It does not "pass the test". Initially, the bits are set by the Server according to a filter expression from <code>SET <code>FILTER</code> TO</code> or <code><a href="#adssetaof">AdsSetAOF()</a></code>. But by using <code>AdsCustomizeAOF()</code> you can add or remove records at will from the visible set. This is useful for tagging records or for refining a result set after the data has been retrieved from the server.</div>
<div><p>The maximum number of records that can be customized in a single call is 16, 383, so <code>aRecNos</code> must not be longer than this.</div>
<div><p>Calls to <code>AdsCustomizeAOF()</code> must be made after an application has created a filter with a call to <code><a href="#adssetaof">AdsSetAOF()</a></code>. To create a completely empty record set (to which records can be added with calls to <code>AdsCustomizeAOF()</code>), use "<code>.F.</code>" as the filter expression given to <code><a href="#adssetaof">AdsSetAOF()</a></code>. To create a completely full record set (from which records can be removed), use "<code>.T.</code>" as the filter expression.</div>
<div><p>WARNING: Always start with a <code>FULLY</code> optimized AOF! If an application must use a filter expression that is not fully optimized as the starting point for customization, the <code>ADS_RESOLVE_IMMEDIATE</code> option should be used with the call to <code><a href="#adssetaof">AdsSetAOF()</a></code>. Otherwise, the dynamic filter resolution that occurs on the server will automatically remove records that have been added through the <code>AdsCustomizeAOF()</code> calls. The filter expressions "<code>.T.</code>" and "<code>.F.</code>" both result in fully optimized AOFs regardless of available indexes.</div>
<div><p>See <code>ace.hlp</code> for full details about the Advantage Database Server.</div>
</div>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">Available on Windows</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code><a href="#adsclearaof">AdsClearAOF()</a></code>, <code><a href="#adsevalaof">AdsEvalAOF()</a></code>, <code><a href="#adsgetaof">AdsGetAOF()</a></code>, <code><a href="#adsgetaofoptlevel">AdsGetAOFOptLevel()</a></code>, <code><a href="#adsisrecordinaof">AdsIsRecordInAOF()</a></code>, <code><a href="#adsrefreshaof">AdsRefreshAOF()</a></code></div>
</section>
<section>
<h4><a href="#adsddaddtable" class="d-id" id="adsddaddtable" title="∞"><code>AdsDDAddTable()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L1852" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsDDAddTable">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsDDAddTable">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Add a new table to a Data dictionary</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsDDAddTable( <cTableName>, <cFileName>, <cIndexFileName> ) → lSuccess</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it"><code>cTableName</code> Name of the table inside the data dictionary <code>cFileName</code> Name of the ADT or dbf file name <code>cIndexFileName</code> Optional name of the index file</div>
<div class="d-d">Returns</div>
<div class="d-it"><code>lSuccess</code> - <code>.T.</code> if file was added, otherwise <code>.F.</code></div>
<div class="d-d">Description</div>
<div class="d-it">See <code>ace.hlp</code> for full details about the Advantage Database Server. <code>AdsDDAddTable()</code> adds a new table to an ADS data dictionary. To add the table you must be connected as <code>ADSSYS</code> user using the <code><a href="#adsconnect60">AdsConnect60()</a></code> function</div>
<div class="d-d">Examples</div>
<section class="d-ex"><div class="playground"><pre contenteditable="true" spellcheck="false"><code class="language-c">IF AdsConnect60( "harbour.add", 7 /* All types of connection */, "ADSSYS", "", )
// Add one user
AdsDDCreateUser( , "Luiz", "papael", "This is luiz User" )
// Add the tables
AdsDDAddTable( "Table1", "table1.adt", "table1.adi" )
// ...
ENDIF
</code></pre></div></section>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">
<div>Available on Linux</div>
<div>Available on Windows</div>
</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code><a href="#adsconnect60">AdsConnect60()</a></code></div>
</section>
<section>
<h4><a href="#adsevalaof" class="d-id" id="adsevalaof" title="∞"><code>AdsEvalAOF()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L848" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsEvalAOF">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsEvalAOF">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Evaluate a filter expression to determine its optimization level</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsEvalAOF( <cFilter> ) → nOptimizationLevel</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it"><code>cFilter</code> Expression to test.</div>
<div class="d-d">Returns</div>
<div class="d-it"><code>nOptimizationLevel</code> values are defined in <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code>: <code>ADS_OPTIMIZED_FULL</code>, <code>ADS_OPTIMIZED_PART</code>, <code>ADS_OPTIMIZED_NONE</code>. <code>IMPORTANT NOTE</code>: These values are NOT the same as those returned by <code><a href="clc53.html#dborderinfo" title="clc53">dbOrderInfo()</a></code>.</div>
<div class="d-d">Description</div>
<div class="d-it">See <code>ace.hlp</code> for full details about the Advantage Database Server.</div>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">Available on Windows</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code><a href="#adsclearaof">AdsClearAOF()</a></code>, <code><a href="#adsgetaof">AdsGetAOF()</a></code>, <code><a href="#adsgetaofoptlevel">AdsGetAOFOptLevel()</a></code>, <code><a href="#adsisrecordinaof">AdsIsRecordInAOF()</a></code>, <code><a href="#adsrefreshaof">AdsRefreshAOF()</a></code></div>
</section>
<section>
<h4><a href="#adsfile2blob" class="d-id" id="adsfile2blob" title="∞"><code>AdsFile2Blob()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L579" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsFile2Blob">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsFile2Blob">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Save a Binary file to a field</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsFile2Blob( <cFileName>, <cFieldName>, <nBinaryType> ) → lSuccess</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it">
<div><code>cFileName</code> File to read. Can be in UNC format. A common example is an image file.</div>
<div><code>cFieldName</code> Field in the current workarea to contain the binary data.</div>
<div><code>nBinaryType</code> Either <code>ADS_BINARY</code> (the default) or <code>ADS_IMAGE</code>. This parameter is for fields in DBF files. ADT tables cannot store binary and image data in standard character memo fields (they have specific field types for that).</div>
</div>
<div class="d-d">Returns</div>
<div class="d-it"><code>lSuccess</code> True if the file is successfully written.</div>
<div class="d-d">Description</div>
<div class="d-it">See <code>ace.hlp</code> for full details about the Advantage Database Server. <code>AdsFile2Blob()</code> is a wrapper for <code>AdsFileToBinary()</code>. Use of this function is illegal in an ADS transaction.</div>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">Available on Windows</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code><a href="#adsblob2file">AdsBlob2File()</a></code></div>
</section>
<section>
<h4><a href="#adsgetaof" class="d-id" id="adsgetaof" title="∞"><code>AdsGetAOF()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L893" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsGetAOF">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsGetAOF">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Retrieve the filter expression used in the call to AdsSetAOF()</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsGetAOF() → cFilter</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it">None</div>
<div class="d-d">Returns</div>
<div class="d-it"><code>cFilter</code> The filter expression used in the call to <code><a href="#adssetaof">AdsSetAOF()</a></code>.</div>
<div class="d-d">Description</div>
<div class="d-it">See <code>ace.hlp</code> for full details about the Advantage Database Server.</div>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">Available on Windows</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code><a href="#adsclearaof">AdsClearAOF()</a></code>, <code><a href="#adsgetaofoptlevel">AdsGetAOFOptLevel()</a></code>, <code><a href="#adsisrecordinaof">AdsIsRecordInAOF()</a></code>, <code><a href="#adsrefreshaof">AdsRefreshAOF()</a></code></div>
</section>
<section>
<h4><a href="#adsgetaofnoopt" class="d-id" id="adsgetaofnoopt" title="∞"><code>AdsGetAOFNoOpt()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L948" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsGetAOFNoOpt">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsGetAOFNoOpt">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Return the non-optimized portion of the current filter expression</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsGetAOFNoOpt() → cFilterFragment</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it">None</div>
<div class="d-d">Returns</div>
<div class="d-it"><code>cFilterFragment</code> If an AOF filter expression is not fully optimizable, the non-optimizable part of the expression can be retrieved with this function.</div>
<div class="d-d">Description</div>
<div class="d-it">See <code>ace.hlp</code> for full details about the Advantage Database Server.</div>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">Available on Windows</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code><a href="#adsclearaof">AdsClearAOF()</a></code>, <code><a href="#adsisrecordinaof">AdsIsRecordInAOF()</a></code>, <code><a href="#adsrefreshaof">AdsRefreshAOF()</a></code></div>
</section>
<section>
<h4><a href="#adsgetaofoptlevel" class="d-id" id="adsgetaofoptlevel" title="∞"><code>AdsGetAOFOptLevel()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L931" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsGetAOFOptLevel">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsGetAOFOptLevel">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Returns optimization level of the current AOF filter</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsGetAOFOptLevel() → nOptimizationLevel</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it">None</div>
<div class="d-d">Returns</div>
<div class="d-it"><code>nOptimizationLevel</code> values are defined in <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code>: <code>ADS_OPTIMIZED_FULL</code>, <code>ADS_OPTIMIZED_PART</code>, <code>ADS_OPTIMIZED_NONE</code>.</div>
<div class="d-d">Description</div>
<div class="d-it">See <code>ace.hlp</code> for full details about the Advantage Database Server.</div>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">Available on Windows</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code><a href="#adsclearaof">AdsClearAOF()</a></code>, <code><a href="#adsgetaof">AdsGetAOF()</a></code>, <code><a href="#adsisrecordinaof">AdsIsRecordInAOF()</a></code>, <code><a href="#adsrefreshaof">AdsRefreshAOF()</a></code></div>
</section>
<section>
<h4><a href="#adsgetconnectiontype" class="d-id" id="adsgetconnectiontype" title="∞"><code>AdsGetConnectionType()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L310" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsGetConnectionType">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsGetConnectionType">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Returns the type of Server used by the given connection handle.</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsGetConnectionType( [<hConnection>] ) → nConnectionType</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it"><code>hConnection</code> A connection handle retrieved via <code>AdsConnect()</code> or <code><a href="#adsconnect60">AdsConnect60()</a></code>. If omitted, the RDD's current connection handle is used, but this only exists if <code>AdsConnect()</code> or <code><a href="#adsconnect60">AdsConnect60()</a></code> were previously called.</div>
<div class="d-d">Returns</div>
<div class="d-it">The type of Advantage Server that the connection uses, either <code>ADS_REMOTE_SERVER</code>, <code>ADS_AIS_SERVER</code>, or <code>ADS_LOCAL_SERVER</code>.</div>
<div class="d-d">Description</div>
<div class="d-it">Advantage uses Handles to control connections to various servers. It's possible that an app may open some files via the Remote server, but others via the Local server or an Internet connection. This function identifies the type of server used by a connection handle. Note that after a table is opened, the type of connection used for that workarea can be retrieved with <code><a href="#adsgettablecontype">AdsGetTableConType()</a></code>. See <code>ace.hlp</code> for full details.</div>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">
<div>Available on Linux</div>
<div>Available on Windows</div>
</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code>AdsConnect()</code>, <code><a href="#adsconnect60">AdsConnect60()</a></code>, <code><a href="#adsgettablecontype">AdsGetTableConType()</a></code></div>
</section>
<section>
<h4><a href="#adsgetlasterror" class="d-id" id="adsgetlasterror" title="∞"><code>AdsGetLastError()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L1631" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsGetLastError">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsGetLastError">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Returns any error code generated by the most recent ADS API call</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsGetLastError() → nErrorCode</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it">None.</div>
<div class="d-d">Returns</div>
<div class="d-it">The error code generated by the most recent <code>ADS API</code> call. Zero for success.</div>
<div class="d-d">Description</div>
<div class="d-it">See <code>ace.hlp</code> for full details about the Advantage Database Server.</div>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">
<div>Available on Linux</div>
<div>Available on Windows</div>
</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
</section>
<section>
<h4><a href="#adsgetrelkeypos" class="d-id" id="adsgetrelkeypos" title="∞"><code>AdsGetRelKeyPos()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads1.c#L5799" class="d-so" title="contrib/rddads/ads1.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsGetRelKeyPos">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsGetRelKeyPos">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Estimated key position of current record within the current index</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsGetRelKeyPos() → nKeyPos</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it">None. Only accesses the current index, if any.</div>
<div class="d-d">Returns</div>
<div class="d-it">A value between 0.0 and 1.0, inclusive.</div>
<div class="d-d">Description</div>
<div class="d-it">
<div><p>This function estimates the relative key position within the current index, respecting any scope setting. It also works with no active index to yield the relative position of the current record number. The value returned is between 0.0 and 1.0, inclusive.</div>
<div><p>This is the recommended function for positioning a scrollbar or other "coarse" position interface. See <code>ace.hlp</code> for full details about the Advantage Database Server.</div>
</div>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">Available on Windows</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code><a href="#adskeycount">AdsKeyCount()</a></code>, <code><a href="#adskeyno">AdsKeyNo()</a></code>, <code><a href="#adssetrelkeypos">AdsSetRelKeyPos()</a></code></div>
</section>
<section>
<h4><a href="#adsgettablecontype" class="d-id" id="adsgettablecontype" title="∞"><code>AdsGetTableConType()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L364" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsGetTableConType">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsGetTableConType">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Returns the type of Server used by current workarea.</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsGetTableConType() → nConnectionType</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it">None.</div>
<div class="d-d">Returns</div>
<div class="d-it">The type of Advantage Server that the current workarea uses, either <code>ADS_REMOTE_SERVER</code>, <code>ADS_AIS_SERVER</code>, or <code>ADS_LOCAL_SERVER</code>. Returns zero if the current workarea does not have an Advantage table opened.</div>
<div class="d-d">Description</div>
<div class="d-it">Advantage uses Handles to control connections to various servers. It's possible that an app may open some files via the Remote server, but others via the Local server or an internet connection. This function identifies the type of server used in the current workarea.</div>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">
<div>Available on Linux</div>
<div>Available on Windows</div>
</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code>AdsConnect()</code>, <code><a href="#adsconnect60">AdsConnect60()</a></code>, <code><a href="#adsgetconnectiontype">AdsGetConnectionType()</a></code></div>
</section>
<section>
<h4><a href="#adsisexprvalid" class="d-id" id="adsisexprvalid" title="∞"><code>AdsIsExprValid()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L1577" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsIsExprValid">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsIsExprValid">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Determine if the ADS server can parse an expression</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsIsExprValid( <cExp> ) → lSuccess</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it"><code>cExp</code> Any hopefully valid expression; often a filter string</div>
<div class="d-d">Returns</div>
<div class="d-it"><code>.T.</code> if the expression is understood by ADS.</div>
<div class="d-d">Description</div>
<div class="d-it">
<div><p>ADS has its own limitations for the logical or string expressions used in indexes, filters, scopes, etc. Unlike internal RDDs like <code>DBFNTX</code>, the server is independent of the applications code, so it cannot understand references to <code>PUBLIC</code> variables or User-Defined Functions (UDFs). (See <code>ace.hlp</code> under Advantage Expression Engine for a list of functions allowed by ADS.) Call <code>AdsIsExprValid()</code> to determine if the server can process the expression.</div>
<div><p>For illustration, consider filter expressions. Since Harbour attempts to be as compatible with Clipper as possible, you <em>can</em> set a filter that ADS <strong>does not</strong> understand, but the filtering will be done by the RDD layer itself and ADS will be unaware of the filter setting. This means more data will be sent "across the wire" from the server to the client, and the client (in rddads) will be doing the processing. Since the value of a database server is to have more processing done by the server itself to reduce network traffic, it is better to only use filter expressions ADS can understand.</div>
</div>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">
<div>Available on Linux</div>
<div>Available on Windows</div>
</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
</section>
<section>
<h4><a href="#adsisindexed" class="d-id" id="adsisindexed" title="∞"><code>AdsIsIndexed()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L1569" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsIsIndexed">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsIsIndexed">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Fast determination for if current workarea has a selected index</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsIsIndexed() → lActiveIndex</code></pre></div>
<div class="d-d">Returns</div>
<div class="d-it"><code>lActiveIndex</code></div>
<div class="d-d">Description</div>
<div class="d-it">Equivalent to <code>Empty( <code><a href="clc53.html#ordsetfocus" title="clc53">ordSetFocus()</a></code> )</code>, but faster.</div>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">
<div>Available on Linux</div>
<div>Available on Windows</div>
</div>
<div class="d-d">File</div>
<div class="d-it">Library is rddads</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
</section>
<section>
<h4><a href="#adsisrecordinaof" class="d-id" id="adsisrecordinaof" title="∞"><code>AdsIsRecordInAOF()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L981" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsIsRecordInAOF">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsIsRecordInAOF">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Determine if a record is in the current AOF</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsIsRecordInAOF( [<nRecNo>] ) → lSatisfiesFilter</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it"><code>nRecNo</code> Record number to test. Default is current record.</div>
<div class="d-d">Returns</div>
<div class="d-it">True if the record satisfies the filter criteria.</div>
<div class="d-d">Description</div>
<div class="d-it">See <code>ace.hlp</code> for full details about the Advantage Database Server.</div>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">Available on Windows</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code><a href="#adsclearaof">AdsClearAOF()</a></code>, <code><a href="#adsrefreshaof">AdsRefreshAOF()</a></code></div>
</section>
<section>
<h4><a href="#adskeycount" class="d-id" id="adskeycount" title="∞"><code>AdsKeyCount()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L687" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsKeyCount">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsKeyCount">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Retrieve the number of keys in a specified index</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsKeyCount( [<xTag>], <cIgnoredIndexFile>, [<nFilterOption>] ) → nKeyCount</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it">
<div><code>xTag</code> Numeric order number OR index tag name. Default is current index.</div>
<div><code>cIgnoredIndexFile</code> This parameter is not processed. In other Harbour RDDs, the second parameter to "ordKeyCount" takes a second argument to identify a particular Index File in cases where two files are open that contain orders with the same name. The ADS driver does not support this and will select the first order with the requested name. To stay consistent with other RDDs, therefore, the second parameter is reserved and the <code>nFilterOption</code> is passed as a third parameter.</div>
<div><code>nFilterOption</code> Indicates if filters and/or scopes are to be respected if set.</div>
<div>Options are defined in <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code>:</div>
<div class="d-t d-t0">
<div> ADS_RESPECTFILTERS Respect filters and scopes</div>
<div> ADS_IGNOREFILTERS Ignore filters and scopes</div>
<div> ADS_RESPECTSCOPES Respect scopes only</div>
</div>
<div></div>
</div>
<div class="d-d">Returns</div>
<div class="d-it"><code>nKeyCount</code> The number of keys within the current index.</div>
<div class="d-d">Description</div>
<div class="d-it">See <code>ace.hlp</code> for full details about the Advantage Database Server.</div>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">Available on Windows</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code><a href="#adsgetrelkeypos">AdsGetRelKeyPos()</a></code>, <code><a href="#adskeyno">AdsKeyNo()</a></code></div>
</section>
<section>
<h4><a href="#adskeyno" class="d-id" id="adskeyno" title="∞"><code>AdsKeyNo()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L632" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsKeyNo">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsKeyNo">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Get the logical key number of the current record in the given index</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsKeyNo( [<xTag>], <cIgnoredIndexFile>, [<nFilterOption>] ) → nKeyNo</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it">
<div><code>xTag</code> Numeric order number OR index tag name. Default is current index.</div>
<div><code>cIgnoredIndexFile</code> This parameter is not processed. In other Harbour RDDs, the second parameter to "ordKeyNo" takes a second argument to identify a particular Index File in cases where two files are open that contain orders with the same name. The ADS driver does not support this and will select the first order with the requested name. To stay consistent with other RDDs, therefore, the second parameter is reserved and the <code>nFilterOption</code> is passed as a third parameter.</div>
<div><code>nFilterOption</code> Indicates if filters and/or scopes are to be respected if set.</div>
<div>Options are defined in <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code>:</div>
<div class="d-t d-t0">
<div> ADS_RESPECTFILTERS Respect filters and scopes</div>
<div> ADS_IGNOREFILTERS Ignore filters and scopes</div>
<div> ADS_RESPECTSCOPES Respect scopes only</div>
</div>
<div></div>
</div>
<div class="d-d">Returns</div>
<div class="d-it"><code>nKeyNo</code> The logical key number of the current record in the given index.</div>
<div class="d-d">Description</div>
<div class="d-it">See <code>ace.hlp</code> for full details about the Advantage Database Server. Wrapper for <code>AdsGetKeyNum()</code>. This function may be slow on a large database with <code>ADS_RESPECTFILTERS</code> set because it walks through the keys to get the current position. Compare to <code><a href="#adsgetrelkeypos">AdsGetRelKeyPos()</a></code>.</div>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">Available on Windows</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code><a href="#adsgetrelkeypos">AdsGetRelKeyPos()</a></code>, <code><a href="#adskeycount">AdsKeyCount()</a></code></div>
</section>
<section>
<h4><a href="#adslocking" class="d-id" id="adslocking" title="∞"><code>AdsLocking()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L454" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsLocking">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsLocking">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Turns on/off the Advantage proprietary locking mode</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsLocking( <lMode> ) → lPriorSetting</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it"><code>lMode</code> <code>.T.</code> to use the Advantage proprietary locking mode (this is the default setting if a remote server is used) or pass <code>.F.</code> to use "compatibility" locking.</div>
<div class="d-d">Returns</div>
<div class="d-it"><code>lPriorSetting</code> <code>.T.</code> if prior setting was for the proprietary mode.</div>
<div class="d-d">Description</div>
<div class="d-it">
<div><p>See <code>ace.hlp</code> for full details about the Advantage Database Server. The Advantage Database Server has a fast Proprietary locking mode that is more efficient than traditional network locking. It is only available when using the remote server (not the local server).</div>
<div><p>If a file is opened in the proprietary mode, other applications cannot open it in a "write" mode. So if non-Advantage applications need concurrent access to the data files, use the Compatibility locking mode by calling <code>AdsLocking( .F. )</code>.</div>
<div><p><code>AdsLocking()</code> is a Get/Set function for the locking mode. It affects files at the time they are opened. So when a data file is opened, the current setting is used for that file until it is closed. Different files can have different locking modes by changing the setting before opening a second file.</div>
</div>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">Available on Windows</div>
<div class="d-d">Files</div>
<div class="d-it">
<div>Library is rddads</div>
<div>Header is <code><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/ads.ch">ads.ch</a></code></div>
</div>
<div class="d-d">Tag</div>
<div class="d-it">Advantage Database RDD</div>
<div class="d-d">See also</div>
<div class="d-it"><code><a href="#adsrightscheck">AdsRightsCheck()</a></code></div>
</section>
<section>
<h4><a href="#adsrefreshaof" class="d-id" id="adsrefreshaof" title="∞"><code>AdsRefreshAOF()</code></a><a href="https://github.com/vszakats/hb/blob/096e855/contrib/rddads/adsfunc.c#L1023" class="d-so" title="contrib/rddads/adsfunc.c">Source code</a><span class="d-so"><nav class="dropdown d-ebi">🔎<nav class="dropdown-content d-dd"><a href="https://github.com/vszakats/hb/search?type=Code&q=AdsRefreshAOF">in Repository</a><a href="https://google.com/search?q=site:groups.google.com/d/msg/harbour+AdsRefreshAOF">in Discussions</a></nav></nav></span>
<span class="d-eb"><a href="#" title="Top" class="d-ebi">⌃</a> | <a href="index.html" title="Index" class="d-ebi">☰</a> | <a href="https://github.com/vszakats/hb/edit/main/contrib/rddads/doc/en/adsfunc.txt">Improve this doc</a></span></h4>
<div class="d-ol">Update the filter snapshot</div>
<div class="d-d">Syntax</div>
<div class="d-sy"><pre><code>AdsRefreshAOF()</code></pre></div>
<div class="d-d">Arguments</div>
<div class="d-it">None</div>
<div class="d-d">Returns</div>
<div class="d-it"><code>NIL</code></div>
<div class="d-d">Description</div>
<div class="d-it">See <code>ace.hlp</code> for full details about the Advantage Database Server. If record updates occur after an AOF is set, the updated records may or may not be valid records for the filter. <code>AdsRefreshAOF()</code> re-evaluates the data to include or exclude changed records.</div>
<div class="d-d">Status</div>
<div class="d-it">Ready</div>
<div class="d-d">Compliance</div>
<div class="d-it">Harbour specific</div>
<div class="d-d">Platforms</div>
<div class="d-it">Available on Windows</div>
<div class="d-d">Files</div>