From 104bce9689b5e4eb0f3d4244d50f3b424b8de480 Mon Sep 17 00:00:00 2001 From: Viktor Szakats Date: Tue, 23 Oct 2012 22:43:55 +0000 Subject: [PATCH] 2012-10-24 00:18 UTC+0200 Viktor Szakats (harbour syenar.net) * src/rtl/hbdoc.prg % changed to save NFDOCs without the '*' prepended in each line. It was making editing much more difficult. Padding also changed to 3 chars like in every Harbour source. * contrib/hbct/doc/en/*.txt * contrib/hbgd/doc/en/*.txt * contrib/hbgt/doc/en/*.txt * contrib/hbmisc/doc/en/*.txt * contrib/hbnf/doc/en/*.txt * contrib/hbziparc/doc/en/*.txt * contrib/rddads/doc/en/*.txt * regenerated using hbdoc API * doc/en/*.txt * regenerated using hbdoc API * restored copyright headers manually * src/rtl/tlabel.prg * src/rtl/treport.prg ! unicode fixes (untested) % SubStr( x, 1, y ) -> Left( x, y ) --- harbour/ChangeLog | 26 + harbour/contrib/hbct/doc/en/addascii.txt | 124 +- harbour/contrib/hbct/doc/en/asciisum.txt | 72 +- harbour/contrib/hbct/doc/en/ascpos.txt | 156 +- harbour/contrib/hbct/doc/en/atadjust.txt | 84 +- harbour/contrib/hbct/doc/en/atnum.txt | 322 +- harbour/contrib/hbct/doc/en/atrepl.txt | 126 +- harbour/contrib/hbct/doc/en/charevod.txt | 134 +- harbour/contrib/hbct/doc/en/charlihb.txt | 148 +- harbour/contrib/hbct/doc/en/charlist.txt | 144 +- harbour/contrib/hbct/doc/en/charmirr.txt | 86 +- harbour/contrib/hbct/doc/en/charmix.txt | 98 +- harbour/contrib/hbct/doc/en/charone.txt | 162 +- harbour/contrib/hbct/doc/en/charonly.txt | 294 +- harbour/contrib/hbct/doc/en/charop.txt | 460 +- harbour/contrib/hbct/doc/en/charophb.txt | 448 +- harbour/contrib/hbct/doc/en/charrepl.txt | 124 +- harbour/contrib/hbct/doc/en/charsort.txt | 158 +- harbour/contrib/hbct/doc/en/charswap.txt | 156 +- harbour/contrib/hbct/doc/en/color.txt | 408 +- harbour/contrib/hbct/doc/en/count.txt | 120 +- harbour/contrib/hbct/doc/en/ct.txt | 136 +- harbour/contrib/hbct/doc/en/ctc.txt | 206 +- harbour/contrib/hbct/doc/en/ctmath.txt | 124 +- harbour/contrib/hbct/doc/en/ctmath2.txt | 346 +- harbour/contrib/hbct/doc/en/ctpad.txt | 120 +- harbour/contrib/hbct/doc/en/ctstr.txt | 324 +- harbour/contrib/hbct/doc/en/datetime.txt | 360 +- harbour/contrib/hbct/doc/en/dattime2.txt | 886 +- harbour/contrib/hbct/doc/en/dattime3.txt | 418 +- harbour/contrib/hbct/doc/en/exponent.txt | 170 +- harbour/contrib/hbct/doc/en/finan.txt | 486 +- harbour/contrib/hbct/doc/en/ftoc.txt | 158 +- harbour/contrib/hbct/doc/en/justify.txt | 120 +- harbour/contrib/hbct/doc/en/keyset.txt | 240 +- harbour/contrib/hbct/doc/en/misc1.txt | 92 +- harbour/contrib/hbct/doc/en/num1.txt | 212 +- harbour/contrib/hbct/doc/en/numat.txt | 60 +- harbour/contrib/hbct/doc/en/numconv.txt | 240 +- harbour/contrib/hbct/doc/en/pos1.txt | 242 +- harbour/contrib/hbct/doc/en/pos2.txt | 240 +- harbour/contrib/hbct/doc/en/posdiff.txt | 120 +- harbour/contrib/hbct/doc/en/print.txt | 120 +- harbour/contrib/hbct/doc/en/range.txt | 142 +- harbour/contrib/hbct/doc/en/relation.txt | 126 +- harbour/contrib/hbct/doc/en/remove.txt | 180 +- harbour/contrib/hbct/doc/en/replace.txt | 180 +- harbour/contrib/hbct/doc/en/screen1.txt | 672 +- harbour/contrib/hbct/doc/en/strdiff.txt | 132 +- harbour/contrib/hbct/doc/en/strswap.txt | 60 +- harbour/contrib/hbct/doc/en/tab.txt | 188 +- harbour/contrib/hbct/doc/en/token1.txt | 638 +- harbour/contrib/hbct/doc/en/token2.txt | 750 +- harbour/contrib/hbct/doc/en/trig.txt | 1034 +- harbour/contrib/hbct/doc/en/video.txt | 268 +- harbour/contrib/hbct/doc/en/wordrepl.txt | 124 +- harbour/contrib/hbct/doc/en/wordtoch.txt | 62 +- harbour/contrib/hbgd/doc/en/hbgd.txt | 3934 ++-- harbour/contrib/hbgt/doc/en/hbgt.txt | 1361 +- harbour/contrib/hbmisc/doc/en/dates2.txt | 616 +- harbour/contrib/hbmisc/doc/en/ht_class.txt | 167 +- harbour/contrib/hbmisc/doc/en/ht_conv.txt | 424 +- harbour/contrib/hbmisc/doc/en/ht_dbf.txt | 239 +- harbour/contrib/hbmisc/doc/en/ht_doc.txt | 487 +- harbour/contrib/hbmisc/doc/en/ht_file.txt | 156 +- harbour/contrib/hbmisc/doc/en/ht_str.txt | 99 +- harbour/contrib/hbnf/doc/en/aading.txt | 90 +- harbour/contrib/hbnf/doc/en/aavg.txt | 66 +- harbour/contrib/hbnf/doc/en/acctadj.txt | 110 +- harbour/contrib/hbnf/doc/en/acctmnth.txt | 104 +- harbour/contrib/hbnf/doc/en/acctqtr.txt | 104 +- harbour/contrib/hbnf/doc/en/acctweek.txt | 104 +- harbour/contrib/hbnf/doc/en/acctyear.txt | 86 +- harbour/contrib/hbnf/doc/en/adapter.txt | 84 +- harbour/contrib/hbnf/doc/en/adessort.txt | 60 +- harbour/contrib/hbnf/doc/en/aemaxlen.txt | 86 +- harbour/contrib/hbnf/doc/en/aeminlen.txt | 80 +- harbour/contrib/hbnf/doc/en/alt.txt | 50 +- harbour/contrib/hbnf/doc/en/amedian.txt | 74 +- harbour/contrib/hbnf/doc/en/anomatch.txt | 82 +- harbour/contrib/hbnf/doc/en/any2any.txt | 62 +- harbour/contrib/hbnf/doc/en/aredit.txt | 140 +- harbour/contrib/hbnf/doc/en/asum.txt | 62 +- harbour/contrib/hbnf/doc/en/at2.txt | 148 +- harbour/contrib/hbnf/doc/en/bitclr.txt | 80 +- harbour/contrib/hbnf/doc/en/bitset.txt | 82 +- harbour/contrib/hbnf/doc/en/blink.txt | 52 +- harbour/contrib/hbnf/doc/en/byt2bit.txt | 74 +- harbour/contrib/hbnf/doc/en/byt2hex.txt | 68 +- harbour/contrib/hbnf/doc/en/byteand.txt | 68 +- harbour/contrib/hbnf/doc/en/byteneg.txt | 64 +- harbour/contrib/hbnf/doc/en/bytenot.txt | 64 +- harbour/contrib/hbnf/doc/en/byteor.txt | 66 +- harbour/contrib/hbnf/doc/en/bytexor.txt | 66 +- harbour/contrib/hbnf/doc/en/calendar.txt | 138 +- harbour/contrib/hbnf/doc/en/caplock.txt | 54 +- harbour/contrib/hbnf/doc/en/chdir.txt | 56 +- harbour/contrib/hbnf/doc/en/cint86.txt | 294 +- harbour/contrib/hbnf/doc/en/clrsel.txt | 194 +- harbour/contrib/hbnf/doc/en/cntryset.txt | 56 +- harbour/contrib/hbnf/doc/en/color2n.txt | 52 +- harbour/contrib/hbnf/doc/en/ctrl.txt | 50 +- harbour/contrib/hbnf/doc/en/d2e.txt | 60 +- harbour/contrib/hbnf/doc/en/datecnfg.txt | 146 +- harbour/contrib/hbnf/doc/en/dayofyr.txt | 116 +- harbour/contrib/hbnf/doc/en/daytobow.txt | 70 +- harbour/contrib/hbnf/doc/en/dectobin.txt | 40 +- harbour/contrib/hbnf/doc/en/default.txt | 54 +- harbour/contrib/hbnf/doc/en/descendn.txt | 42 +- harbour/contrib/hbnf/doc/en/dfile.txt | 160 +- harbour/contrib/hbnf/doc/en/diskfunc.txt | 90 +- harbour/contrib/hbnf/doc/en/dispc.txt | 118 +- harbour/contrib/hbnf/doc/en/dispmsg.txt | 180 +- harbour/contrib/hbnf/doc/en/dosver.txt | 60 +- harbour/contrib/hbnf/doc/en/e2d.txt | 50 +- harbour/contrib/hbnf/doc/en/easter.txt | 48 +- harbour/contrib/hbnf/doc/en/elapmil.txt | 48 +- harbour/contrib/hbnf/doc/en/elapsed.txt | 80 +- harbour/contrib/hbnf/doc/en/eltime.txt | 48 +- harbour/contrib/hbnf/doc/en/findith.txt | 66 +- harbour/contrib/hbnf/doc/en/firstday.txt | 52 +- harbour/contrib/hbnf/doc/en/floptst.txt | 98 +- harbour/contrib/hbnf/doc/en/ftattr.txt | 140 +- harbour/contrib/hbnf/doc/en/fttext.txt | 1364 +- harbour/contrib/hbnf/doc/en/gcd.txt | 50 +- harbour/contrib/hbnf/doc/en/getenvrn.txt | 122 +- harbour/contrib/hbnf/doc/en/hex2dec.txt | 44 +- harbour/contrib/hbnf/doc/en/iamidle.txt | 72 +- harbour/contrib/hbnf/doc/en/idle.txt | 76 +- harbour/contrib/hbnf/doc/en/inp.txt | 54 +- harbour/contrib/hbnf/doc/en/invclr.txt | 42 +- harbour/contrib/hbnf/doc/en/isbit.txt | 80 +- harbour/contrib/hbnf/doc/en/isbiton.txt | 58 +- harbour/contrib/hbnf/doc/en/isprint.txt | 120 +- harbour/contrib/hbnf/doc/en/isshare.txt | 54 +- harbour/contrib/hbnf/doc/en/kspeed.txt | 126 +- harbour/contrib/hbnf/doc/en/lastday.txt | 52 +- harbour/contrib/hbnf/doc/en/linked.txt | 80 +- harbour/contrib/hbnf/doc/en/madd.txt | 88 +- harbour/contrib/hbnf/doc/en/menu1.txt | 336 +- harbour/contrib/hbnf/doc/en/menutonf.txt | 378 +- harbour/contrib/hbnf/doc/en/metaph.txt | 62 +- harbour/contrib/hbnf/doc/en/miltime.txt | 242 +- harbour/contrib/hbnf/doc/en/min2dhm.txt | 42 +- harbour/contrib/hbnf/doc/en/mkdir.txt | 60 +- harbour/contrib/hbnf/doc/en/month.txt | 112 +- harbour/contrib/hbnf/doc/en/mouse1.txt | 1610 +- harbour/contrib/hbnf/doc/en/n2color.txt | 44 +- harbour/contrib/hbnf/doc/en/netpv.txt | 82 +- harbour/contrib/hbnf/doc/en/nooccur.txt | 66 +- harbour/contrib/hbnf/doc/en/ntow.txt | 88 +- harbour/contrib/hbnf/doc/en/numlock.txt | 80 +- harbour/contrib/hbnf/doc/en/nwlstat.txt | 58 +- harbour/contrib/hbnf/doc/en/nwsem.txt | 664 +- harbour/contrib/hbnf/doc/en/nwuid.txt | 84 +- harbour/contrib/hbnf/doc/en/ontick.txt | 88 +- harbour/contrib/hbnf/doc/en/origin.txt | 68 +- harbour/contrib/hbnf/doc/en/outp.txt | 60 +- harbour/contrib/hbnf/doc/en/page.txt | 102 +- harbour/contrib/hbnf/doc/en/pchr.txt | 174 +- harbour/contrib/hbnf/doc/en/peek.txt | 56 +- harbour/contrib/hbnf/doc/en/pegs.txt | 40 +- harbour/contrib/hbnf/doc/en/pending.txt | 96 +- harbour/contrib/hbnf/doc/en/pickday.txt | 36 +- harbour/contrib/hbnf/doc/en/poke.txt | 62 +- harbour/contrib/hbnf/doc/en/popadder.txt | 156 +- harbour/contrib/hbnf/doc/en/proper.txt | 68 +- harbour/contrib/hbnf/doc/en/prtesc.txt | 56 +- harbour/contrib/hbnf/doc/en/prtscr.txt | 52 +- harbour/contrib/hbnf/doc/en/putkey.txt | 86 +- harbour/contrib/hbnf/doc/en/pvid.txt | 106 +- harbour/contrib/hbnf/doc/en/qtr.txt | 112 +- harbour/contrib/hbnf/doc/en/rand1.txt | 54 +- harbour/contrib/hbnf/doc/en/reboot.txt | 64 +- harbour/contrib/hbnf/doc/en/restsets.txt | 50 +- harbour/contrib/hbnf/doc/en/rmdir.txt | 60 +- harbour/contrib/hbnf/doc/en/round.txt | 122 +- harbour/contrib/hbnf/doc/en/savearr.txt | 196 +- harbour/contrib/hbnf/doc/en/savesets.txt | 50 +- harbour/contrib/hbnf/doc/en/scancode.txt | 90 +- harbour/contrib/hbnf/doc/en/scregion.txt | 298 +- harbour/contrib/hbnf/doc/en/setdate.txt | 78 +- harbour/contrib/hbnf/doc/en/setkeys.txt | 70 +- harbour/contrib/hbnf/doc/en/setlastk.txt | 70 +- harbour/contrib/hbnf/doc/en/settime.txt | 74 +- harbour/contrib/hbnf/doc/en/shadow.txt | 59 +- harbour/contrib/hbnf/doc/en/shift.txt | 50 +- harbour/contrib/hbnf/doc/en/sinkey.txt | 60 +- harbour/contrib/hbnf/doc/en/sleep.txt | 92 +- harbour/contrib/hbnf/doc/en/sqzn.txt | 130 +- harbour/contrib/hbnf/doc/en/stod.txt | 42 +- harbour/contrib/hbnf/doc/en/sysmem.txt | 48 +- harbour/contrib/hbnf/doc/en/tbwhile.txt | 170 +- harbour/contrib/hbnf/doc/en/tempfile.txt | 88 +- harbour/contrib/hbnf/doc/en/vertmenu.txt | 84 +- harbour/contrib/hbnf/doc/en/vidcur.txt | 138 +- harbour/contrib/hbnf/doc/en/video1.txt | 368 +- harbour/contrib/hbnf/doc/en/vidmode.txt | 104 +- harbour/contrib/hbnf/doc/en/wda.txt | 82 +- harbour/contrib/hbnf/doc/en/week.txt | 112 +- harbour/contrib/hbnf/doc/en/workdays.txt | 58 +- harbour/contrib/hbnf/doc/en/woy.txt | 160 +- harbour/contrib/hbnf/doc/en/xbox.txt | 148 +- harbour/contrib/hbnf/doc/en/year.txt | 94 +- harbour/contrib/hbziparc/doc/en/hbziparc.txt | 1110 +- harbour/contrib/rddads/doc/en/adsfuncs.txt | 2836 +-- harbour/contrib/rddads/doc/en/readme.txt | 325 +- harbour/doc/en/1stread.txt | 94 +- harbour/doc/en/array.txt | 1128 +- harbour/doc/en/binnum.txt | 902 +- harbour/doc/en/browse.txt | 696 +- harbour/doc/en/cmdline.txt | 228 +- harbour/doc/en/command.txt | 924 +- harbour/doc/en/compiler.txt | 771 +- harbour/doc/en/datetime.txt | 1073 +- harbour/doc/en/dbdelim.txt | 142 +- harbour/doc/en/dbsdf.txt | 132 +- harbour/doc/en/dbstrux.txt | 1354 +- harbour/doc/en/dir.txt | 372 +- harbour/doc/en/diskspac.txt | 200 +- harbour/doc/en/errsys.txt | 60 +- harbour/doc/en/eval.txt | 104 +- harbour/doc/en/file.txt | 2160 +- harbour/doc/en/garbage.txt | 540 +- harbour/doc/en/gnulice.txt | 788 +- harbour/doc/en/harbext.txt | 164 +- harbour/doc/en/hashes.txt | 2162 +- harbour/doc/en/hb_api.txt | 15508 +++++++-------- harbour/doc/en/hb_apier.txt | 2856 +-- harbour/doc/en/hb_apifs.txt | 2698 +-- harbour/doc/en/hb_apigt.txt | 9041 +++++---- harbour/doc/en/hb_apiit.txt | 4332 ++-- harbour/doc/en/hb_apiln.txt | 700 +- harbour/doc/en/hb_apird.txt | 17657 ++++++++--------- harbour/doc/en/hb_compa.txt | 11466 +++++------ harbour/doc/en/hb_date.txt | 964 +- harbour/doc/en/hb_macro.txt | 2114 +- harbour/doc/en/hb_set.txt | 405 +- harbour/doc/en/hb_vm.txt | 1958 +- harbour/doc/en/hbflock.txt | 210 +- harbour/doc/en/hbinet.txt | 3390 ++-- harbour/doc/en/hvm.txt | 728 +- harbour/doc/en/idle.txt | 376 +- harbour/doc/en/input.txt | 883 +- harbour/doc/en/lang.txt | 807 +- harbour/doc/en/license.txt | 287 +- harbour/doc/en/macro.txt | 156 +- harbour/doc/en/math.txt | 1373 +- harbour/doc/en/memo.txt | 678 +- harbour/doc/en/memvar2.txt | 333 +- harbour/doc/en/menu.txt | 750 +- harbour/doc/en/misc.txt | 656 +- harbour/doc/en/nation.txt | 212 +- harbour/doc/en/objfunc.txt | 1504 +- harbour/doc/en/rdddb.txt | 2405 ++- harbour/doc/en/rddmisc.txt | 1956 +- harbour/doc/en/rddord.txt | 936 +- harbour/doc/en/readme.txt | 199 +- harbour/doc/en/sayget.txt | 400 +- harbour/doc/en/set.txt | 2748 +-- harbour/doc/en/setmode.txt | 140 +- harbour/doc/en/string.txt | 2802 +-- harbour/doc/en/strotype.txt | 194 +- harbour/doc/en/subcodes.txt | 2963 ++- harbour/doc/en/tbrowse.txt | 597 +- harbour/doc/en/tclass.txt | 114 +- harbour/doc/en/terminal.txt | 1680 +- harbour/doc/en/tgetlist.txt | 106 +- harbour/doc/en/tlabel.txt | 134 +- harbour/doc/en/treport.txt | 190 +- harbour/doc/en/var.txt | 1730 +- harbour/src/rtl/hbdoc.prg | 8 +- harbour/src/rtl/tlabel.prg | 22 +- harbour/src/rtl/treport.prg | 100 +- 274 files changed, 78563 insertions(+), 78684 deletions(-) diff --git a/harbour/ChangeLog b/harbour/ChangeLog index 6389c69634..0ec39e9548 100644 --- a/harbour/ChangeLog +++ b/harbour/ChangeLog @@ -16,6 +16,32 @@ The license applies to all entries newer than 2009-04-28. */ +2012-10-24 00:18 UTC+0200 Viktor Szakats (harbour syenar.net) + * src/rtl/hbdoc.prg + % changed to save NFDOCs without the '*' + prepended in each line. It was making + editing much more difficult. Padding also + changed to 3 chars like in every Harbour + source. + + * contrib/hbct/doc/en/*.txt + * contrib/hbgd/doc/en/*.txt + * contrib/hbgt/doc/en/*.txt + * contrib/hbmisc/doc/en/*.txt + * contrib/hbnf/doc/en/*.txt + * contrib/hbziparc/doc/en/*.txt + * contrib/rddads/doc/en/*.txt + * regenerated using hbdoc API + + * doc/en/*.txt + * regenerated using hbdoc API + * restored copyright headers manually + + * src/rtl/tlabel.prg + * src/rtl/treport.prg + ! unicode fixes (untested) + % SubStr( x, 1, y ) -> Left( x, y ) + 2012-10-23 23:33 UTC+0200 Viktor Szakats (harbour syenar.net) * config/detect.mk * contrib/hbct/print.c diff --git a/harbour/contrib/hbct/doc/en/addascii.txt b/harbour/contrib/hbct/doc/en/addascii.txt index d7a50585aa..39951d3cf7 100644 --- a/harbour/contrib/hbct/doc/en/addascii.txt +++ b/harbour/contrib/hbct/doc/en/addascii.txt @@ -2,66 +2,66 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * ADDASCII() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Add an integer value to an ascii value of a string - * $SYNTAX$ - * ADDASCII( <[@]cString>, , [], [] ) --> cString - * $ARGUMENTS$ - * <[@]cString> is the string that should be edited - * is a integer value that should be added to the - * ASCII value of the character at the th position - * [] is the position of the character that should be edited. - * If not supplied, the last character of <[@]cString> is - * edited. - * [] NEW: is set to .T. if the substring from position 1 to - * position should be treated as an integer - * written to the base 256. Thus, the addition of - * can affect to whole substring (see EXAMPLES). - * Default is .F., the original behaviour of this function. - * $RETURNS$ - * The edited string is returned. The return value can be suppressed by - * using the CSETREF() function. The string must then be passed by - * reference [@]. - * $DESCRIPTION$ - * ADDASCII() can be used to add or subtract integer values from - * ASCII values in a string. The new parameter allows - * to treat a string as an integer written to the base 256. Since - * is limited to a signed long, only substrings 4 characters - * long can be affected by one ADDASCII() call. - * If the length of <[@]cString> is smaller than , the - * string remains unchanged. The same happens, if uninterpretable - * parameters are passed to this function. - * $EXAMPLES$ - * // Add 32 to the ASCII value of the character at the last position - * // in the string - * - * ? addascii( "SmitH", 32 ) // --> "Smith" - * $TESTS$ - * addascii( "0000", 1, 1 ) == "1000" - * addascii( "0000", 1 ) == "0001" - * addascii( "AAAA", -255, 1 ) == "BAAA" - * addascii( "AAAA", -255 ) == "AAAB" - * addascii( "AAAA", 1, 2, .T. ) == "ABAA" - * addascii( "AAAA", 257, 2, .T. ) == "BBAA" - * addascii( "AAAA", 257, 2, .F. ) == "ABAA" - * addascii( "AAAA", 258,, .T. ) == "AABC" - * addascii( "ABBA", -257, 3, .T. ) == "AAAA" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * ADDASCII() is compatible with CT3's ADDASCII(). - * A new, 4th, parameter has been added who defaults to the original - * behaviour if omitted. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADDASCII() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Add an integer value to an ascii value of a string + $SYNTAX$ + ADDASCII( <[@]cString>, , [], [] ) --> cString + $ARGUMENTS$ + <[@]cString> is the string that should be edited + is a integer value that should be added to the + ASCII value of the character at the th position + [] is the position of the character that should be edited. + If not supplied, the last character of <[@]cString> is + edited. + [] NEW: is set to .T. if the substring from position 1 to + position should be treated as an integer + written to the base 256. Thus, the addition of + can affect to whole substring (see EXAMPLES). + Default is .F., the original behaviour of this function. + $RETURNS$ + The edited string is returned. The return value can be suppressed by + using the CSETREF() function. The string must then be passed by + reference [@]. + $DESCRIPTION$ + ADDASCII() can be used to add or subtract integer values from + ASCII values in a string. The new parameter allows + to treat a string as an integer written to the base 256. Since + is limited to a signed long, only substrings 4 characters + long can be affected by one ADDASCII() call. + If the length of <[@]cString> is smaller than , the + string remains unchanged. The same happens, if uninterpretable + parameters are passed to this function. + $EXAMPLES$ + // Add 32 to the ASCII value of the character at the last position + // in the string + + ? addascii( "SmitH", 32 ) // --> "Smith" + $TESTS$ + addascii( "0000", 1, 1 ) == "1000" + addascii( "0000", 1 ) == "0001" + addascii( "AAAA", -255, 1 ) == "BAAA" + addascii( "AAAA", -255 ) == "AAAB" + addascii( "AAAA", 1, 2, .T. ) == "ABAA" + addascii( "AAAA", 257, 2, .T. ) == "BBAA" + addascii( "AAAA", 257, 2, .F. ) == "ABAA" + addascii( "AAAA", 258,, .T. ) == "AABC" + addascii( "ABBA", -257, 3, .T. ) == "AAAA" + $STATUS$ + Ready + $COMPLIANCE$ + ADDASCII() is compatible with CT3's ADDASCII(). + A new, 4th, parameter has been added who defaults to the original + behaviour if omitted. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CSETREF() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/asciisum.txt b/harbour/contrib/hbct/doc/en/asciisum.txt index 885924c4b6..400a8a4223 100644 --- a/harbour/contrib/hbct/doc/en/asciisum.txt +++ b/harbour/contrib/hbct/doc/en/asciisum.txt @@ -2,40 +2,40 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * ASCIISUM() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * calculate the sum of the ASCII values of the characters in a string - * $SYNTAX$ - * ASCIISUM( ) --> nAsciiSum - * $ARGUMENTS$ - * the string to be processed - * $RETURNS$ - * sum of the ASCII values in - * $DESCRIPTION$ - * The ASCIISUM() function sums up the ASCII values of the characters - * in . Be aware that the function is not position sensitive, - * i.e. a change of position of a certain character in the string does - * not change the ascii sum. - * $EXAMPLES$ - * ? asciisum( "ABC" ) // --> 197 - * ? asciisum( "ACB" ) // --> 197 - * $TESTS$ - * asciisum( Replicate( "A", 10000 ) ) == 650000 - * asciisum( "0123456789" ) == 525 - * asciisum( NIL ) == 0 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * ASCIISUM() is compatible with CT3's ASCIISUM(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHECKSUM() - * $END$ +/* $DOC$ + $FUNCNAME$ + ASCIISUM() + $CATEGORY$ + CT3 string functions + $ONELINER$ + calculate the sum of the ASCII values of the characters in a string + $SYNTAX$ + ASCIISUM( ) --> nAsciiSum + $ARGUMENTS$ + the string to be processed + $RETURNS$ + sum of the ASCII values in + $DESCRIPTION$ + The ASCIISUM() function sums up the ASCII values of the characters + in . Be aware that the function is not position sensitive, + i.e. a change of position of a certain character in the string does + not change the ascii sum. + $EXAMPLES$ + ? asciisum( "ABC" ) // --> 197 + ? asciisum( "ACB" ) // --> 197 + $TESTS$ + asciisum( Replicate( "A", 10000 ) ) == 650000 + asciisum( "0123456789" ) == 525 + asciisum( NIL ) == 0 + $STATUS$ + Ready + $COMPLIANCE$ + ASCIISUM() is compatible with CT3's ASCIISUM(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHECKSUM() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/ascpos.txt b/harbour/contrib/hbct/doc/en/ascpos.txt index b3765e8a94..3b0db2e7ef 100644 --- a/harbour/contrib/hbct/doc/en/ascpos.txt +++ b/harbour/contrib/hbct/doc/en/ascpos.txt @@ -2,84 +2,84 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * ASCPOS() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * ASCII value of a character at a certain position - * $SYNTAX$ - * ASCPOS( , [] ) --> nAsciiValue - * $ARGUMENTS$ - * is the processed string - * [] is an optional position within - * Default: last position in - * $RETURNS$ - * the ASCII value of the character at the specified - * position - * $DESCRIPTION$ - * The ASCPOS() function returns the ASCII value of the character that - * can be found at the position in . If - * is larger than the length of , 0 is returned. - * $EXAMPLES$ - * ? ascpos( "0123456789" ) // --> 57 - * ? ascpos( "0123456789", 1 ) // --> 48 - * $TESTS$ - * ascpos( "0123456789" ) == 57 - * ascpos( "0123456789", 1 ) == 48 - * ascpos( "0123456789", 11 ) == 0 // to large ! - * $STATUS$ - * Ready - * $COMPLIANCE$ - * ASCPOS() is compatible with CT3's ASCPOS(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * VALPOS() - * $END$ +/* $DOC$ + $FUNCNAME$ + ASCPOS() + $CATEGORY$ + CT3 string functions + $ONELINER$ + ASCII value of a character at a certain position + $SYNTAX$ + ASCPOS( , [] ) --> nAsciiValue + $ARGUMENTS$ + is the processed string + [] is an optional position within + Default: last position in + $RETURNS$ + the ASCII value of the character at the specified + position + $DESCRIPTION$ + The ASCPOS() function returns the ASCII value of the character that + can be found at the position in . If + is larger than the length of , 0 is returned. + $EXAMPLES$ + ? ascpos( "0123456789" ) // --> 57 + ? ascpos( "0123456789", 1 ) // --> 48 + $TESTS$ + ascpos( "0123456789" ) == 57 + ascpos( "0123456789", 1 ) == 48 + ascpos( "0123456789", 11 ) == 0 // to large ! + $STATUS$ + Ready + $COMPLIANCE$ + ASCPOS() is compatible with CT3's ASCPOS(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + VALPOS() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * VALPOS() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Numerical value of a character at a certain position - * $SYNTAX$ - * VALPOS( , [] ) --> nDigitValue - * $ARGUMENTS$ - * is the processed string - * [] is an optional position within - * Default: last position in - * $RETURNS$ - * the numerical value of the character at the specified - * position - * $DESCRIPTION$ - * The VALPOS() function returns the numerical value of the character that - * can be found at the position in . If no digit - * can be found at this position or if - * is larger than the length of , 0 is returned. - * $EXAMPLES$ - * ? valpos( "1234x56789" ) // --> 9 - * ? valpos( "1234x56789", 1 ) // --> 1 - * $TESTS$ - * valpos( "1234x56789" ) == 9 - * valpos( "1234x56789", 1 ) == 1 - * valpos( "1234x56789", 11 ) == 0 // to large ! - * valpos( "1234x56789", 5 ) == 0 // "x" is not a digit ! - * $STATUS$ - * Ready - * $COMPLIANCE$ - * VALPOS() is compatible with CT3's VALPOS(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * ASCPOS() - * $END$ +/* $DOC$ + $FUNCNAME$ + VALPOS() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Numerical value of a character at a certain position + $SYNTAX$ + VALPOS( , [] ) --> nDigitValue + $ARGUMENTS$ + is the processed string + [] is an optional position within + Default: last position in + $RETURNS$ + the numerical value of the character at the specified + position + $DESCRIPTION$ + The VALPOS() function returns the numerical value of the character that + can be found at the position in . If no digit + can be found at this position or if + is larger than the length of , 0 is returned. + $EXAMPLES$ + ? valpos( "1234x56789" ) // --> 9 + ? valpos( "1234x56789", 1 ) // --> 1 + $TESTS$ + valpos( "1234x56789" ) == 9 + valpos( "1234x56789", 1 ) == 1 + valpos( "1234x56789", 11 ) == 0 // to large ! + valpos( "1234x56789", 5 ) == 0 // "x" is not a digit ! + $STATUS$ + Ready + $COMPLIANCE$ + VALPOS() is compatible with CT3's VALPOS(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + ASCPOS() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/atadjust.txt b/harbour/contrib/hbct/doc/en/atadjust.txt index cda0795f67..6ee3479a1d 100644 --- a/harbour/contrib/hbct/doc/en/atadjust.txt +++ b/harbour/contrib/hbct/doc/en/atadjust.txt @@ -2,46 +2,46 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * ATADJUST() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Adjusts a sequence within a string to a specified position - * $SYNTAX$ - * ATADJUST( , , , - * [], [], - * [] ) -> cString - * $ARGUMENTS$ - * is the sequence to be adjusted within - * is the string that contains - * specifies the position to that - * will be adjusted - * [] specifies which occurence of - * in is to be adjusted - * Default: last occurence - * [] specifies how many characters should be omitted - * in the scan - * [] specifies the character that is used for the - * adjustment - * $RETURNS$ - * cString the changed string - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * ATADJUST() works like CT3's ATADJUST() - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * SETATLIKE(),CSETATMUPA() - * $END$ +/* $DOC$ + $FUNCNAME$ + ATADJUST() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Adjusts a sequence within a string to a specified position + $SYNTAX$ + ATADJUST( , , , + [], [], + [] ) -> cString + $ARGUMENTS$ + is the sequence to be adjusted within + is the string that contains + specifies the position to that + will be adjusted + [] specifies which occurence of + in is to be adjusted + Default: last occurence + [] specifies how many characters should be omitted + in the scan + [] specifies the character that is used for the + adjustment + $RETURNS$ + cString the changed string + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + ATADJUST() works like CT3's ATADJUST() + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + SETATLIKE(),CSETATMUPA() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/atnum.txt b/harbour/contrib/hbct/doc/en/atnum.txt index 265c76fe1e..92ff758765 100644 --- a/harbour/contrib/hbct/doc/en/atnum.txt +++ b/harbour/contrib/hbct/doc/en/atnum.txt @@ -2,169 +2,169 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * AFTERATNUM() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Returns string portion after nth occurence of substring - * $SYNTAX$ - * AFTERATNUM( , , [], - * [] ) --> cRestString - * $ARGUMENTS$ - * is the substring scanned for - * is the scanned string - * [] determines how many occurences are of - * in are searched - * Default: search last occurence - * [] determines how many character from the start - * should be ignored in the search - * Default: 0 - * $RETURNS$ - * the portion of after the th - * occurence of in - * If such a rest does not exist, an empty string - * is returned. - * $DESCRIPTION$ - * This function scans for . After the - * th match (or the last one, depending on the value of - * ) has been found, the portion of - * after that match will be returned. If there aren't enough - * matches or the last match is identical to the end of , an - * empty string will be returned. - * After a match has been found, the function continues to scan after - * that match if the CSETATMUPA() switch is turned off, with the - * second character of the matched substring otherwise. - * The function will also consider the settings of SETATLIKE(). - * $EXAMPLES$ - * ? AFTERATNUM( "!", "What is the answer ? 4 ! 5 !" ) // -> "" - * ? AFTERATNUM( "!", "What is the answer ? 4 ! 5 ?" ) // -> " 5 ?" - * - * $TESTS$ - * AFTERATNUM( "..", "..This..is..a..test!" ) == "test!" - * AFTERATNUM( "..", "..This..is..a..test!", 2 ) == "is..a..test!" - * AFTERATNUM( "..", "..This..is..a..test!", 2, 2 ) == "a..test!" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * AFTERATNUM() is compatible with CT3's AFTERATNUM(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * ATNUM(),BEFORATNUM(),CSETATMUPA(),SETATLIKE() - * $END$ +/* $DOC$ + $FUNCNAME$ + AFTERATNUM() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Returns string portion after nth occurence of substring + $SYNTAX$ + AFTERATNUM( , , [], + [] ) --> cRestString + $ARGUMENTS$ + is the substring scanned for + is the scanned string + [] determines how many occurences are of + in are searched + Default: search last occurence + [] determines how many character from the start + should be ignored in the search + Default: 0 + $RETURNS$ + the portion of after the th + occurence of in + If such a rest does not exist, an empty string + is returned. + $DESCRIPTION$ + This function scans for . After the + th match (or the last one, depending on the value of + ) has been found, the portion of + after that match will be returned. If there aren't enough + matches or the last match is identical to the end of , an + empty string will be returned. + After a match has been found, the function continues to scan after + that match if the CSETATMUPA() switch is turned off, with the + second character of the matched substring otherwise. + The function will also consider the settings of SETATLIKE(). + $EXAMPLES$ + ? AFTERATNUM( "!", "What is the answer ? 4 ! 5 !" ) // -> "" + ? AFTERATNUM( "!", "What is the answer ? 4 ! 5 ?" ) // -> " 5 ?" + + $TESTS$ + AFTERATNUM( "..", "..This..is..a..test!" ) == "test!" + AFTERATNUM( "..", "..This..is..a..test!", 2 ) == "is..a..test!" + AFTERATNUM( "..", "..This..is..a..test!", 2, 2 ) == "a..test!" + $STATUS$ + Ready + $COMPLIANCE$ + AFTERATNUM() is compatible with CT3's AFTERATNUM(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + ATNUM(),BEFORATNUM(),CSETATMUPA(),SETATLIKE() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * BEFORATNUM() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Returns string portion before nth occurence of substring - * $SYNTAX$ - * BEFORATNUM( , , [], - * [] ) --> cRestString - * $ARGUMENTS$ - * is the substring scanned for - * is the scanned string - * [] determines how many occurences are of - * in are searched - * Default: search last occurence - * [] determines how many character from the start - * should be ignored in the search - * Default: 0 - * $RETURNS$ - * the portion of before the th - * occurence of in - * If such a string does not exist, an empty string - * is returned. - * $DESCRIPTION$ - * This function scans for . After the - * th match (or the last one, depending on the value of - * ) has been found, the portion of - * before that match will be returned. If there aren't enough - * matches or the last match is identical to the start of - * (i.e. the last match is the first match), an empty string will be returned. - * After a match has been found, the function continues to scan after - * that match if the CSETATMUPA() switch is turned off, with the - * second character of the matched substring otherwise. - * The function will also consider the settings of SETATLIKE(). - * $EXAMPLES$ - * ? BEFORATNUM( "!", "What is the answer ? 4 ! 5 !" ) // -> "What is the answer ? 4 ! 5 " - * ? BEFORATNUM( "!", "What is the answer ? 4 ! 5 ?" ) // -> "What is the answer ? 4 " - * - * $TESTS$ - * BEFORATNUM( "..", "..This..is..a..test!" ) == "..This..is..a" - * BEFORATNUM( "..", "..This..is..a..test!", 2 ) == "..This" - * BEFORATNUM( "..", "..This..is..a..test!", 2, 2 ) == "..This..is" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * BEFORATNUM() is compatible with CT3's BEFORATNUM(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * ATNUM() AFTERATNUM() CSETATMUPA() SETATLIKE() - * $END$ +/* $DOC$ + $FUNCNAME$ + BEFORATNUM() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Returns string portion before nth occurence of substring + $SYNTAX$ + BEFORATNUM( , , [], + [] ) --> cRestString + $ARGUMENTS$ + is the substring scanned for + is the scanned string + [] determines how many occurences are of + in are searched + Default: search last occurence + [] determines how many character from the start + should be ignored in the search + Default: 0 + $RETURNS$ + the portion of before the th + occurence of in + If such a string does not exist, an empty string + is returned. + $DESCRIPTION$ + This function scans for . After the + th match (or the last one, depending on the value of + ) has been found, the portion of + before that match will be returned. If there aren't enough + matches or the last match is identical to the start of + (i.e. the last match is the first match), an empty string will be returned. + After a match has been found, the function continues to scan after + that match if the CSETATMUPA() switch is turned off, with the + second character of the matched substring otherwise. + The function will also consider the settings of SETATLIKE(). + $EXAMPLES$ + ? BEFORATNUM( "!", "What is the answer ? 4 ! 5 !" ) // -> "What is the answer ? 4 ! 5 " + ? BEFORATNUM( "!", "What is the answer ? 4 ! 5 ?" ) // -> "What is the answer ? 4 " + + $TESTS$ + BEFORATNUM( "..", "..This..is..a..test!" ) == "..This..is..a" + BEFORATNUM( "..", "..This..is..a..test!", 2 ) == "..This" + BEFORATNUM( "..", "..This..is..a..test!", 2, 2 ) == "..This..is" + $STATUS$ + Ready + $COMPLIANCE$ + BEFORATNUM() is compatible with CT3's BEFORATNUM(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + ATNUM() AFTERATNUM() CSETATMUPA() SETATLIKE() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ATNUM() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Returns the start position of the nth occurence of a substring in a string - * $SYNTAX$ - * ATNUM (, , [], - * [] ) --> nPosition - * $ARGUMENTS$ - * is the substring scanned for - * is the scanned string - * [] determines how many occurences are of - * in are searched - * Default: search last occurence - * [] determines how many character from the start - * should be ignored in the search - * Default: 0 - * $RETURNS$ - * the position of the th - * occurence of in . - * If such an occurence does not exist, 0 - * is returned. - * $DESCRIPTION$ - * This function scans for . After the - * th match (or the last one, depending on the value of - * ) has been found, the position of - * that match will be returned. If there aren't enough - * matches or there is no last match, 0 will be returned. - * After a match has been found, the function continues to scan after - * that match if the CSETATMUPA() switch is turned off, with the - * second character of the matched substring otherwise. - * The function will also consider the settings of SETATLIKE(). - * $EXAMPLES$ - * ? ATNUM( "!", "What is the answer ? 4 ! 5 !" ) // -> 28 - * ? ATNUM( "!", "What is the answer ? 4 ! 5 ?" ) // -> 24 - * - * $TESTS$ - * ATNUM( "..", "..This..is..a..test!" ) == 14 - * ATNUM( "..", "..This..is..a..test!", 2 ) == 7 - * ATNUM( "..", "..This..is..a..test!", 2, 2 ) == 11 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * ATNUM() is compatible with CT3's ATNUM(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * ATNUM() AFTERATNUM() CSETATMUPA() SETATLIKE() - * $END$ +/* $DOC$ + $FUNCNAME$ + ATNUM() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Returns the start position of the nth occurence of a substring in a string + $SYNTAX$ + ATNUM (, , [], + [] ) --> nPosition + $ARGUMENTS$ + is the substring scanned for + is the scanned string + [] determines how many occurences are of + in are searched + Default: search last occurence + [] determines how many character from the start + should be ignored in the search + Default: 0 + $RETURNS$ + the position of the th + occurence of in . + If such an occurence does not exist, 0 + is returned. + $DESCRIPTION$ + This function scans for . After the + th match (or the last one, depending on the value of + ) has been found, the position of + that match will be returned. If there aren't enough + matches or there is no last match, 0 will be returned. + After a match has been found, the function continues to scan after + that match if the CSETATMUPA() switch is turned off, with the + second character of the matched substring otherwise. + The function will also consider the settings of SETATLIKE(). + $EXAMPLES$ + ? ATNUM( "!", "What is the answer ? 4 ! 5 !" ) // -> 28 + ? ATNUM( "!", "What is the answer ? 4 ! 5 ?" ) // -> 24 + + $TESTS$ + ATNUM( "..", "..This..is..a..test!" ) == 14 + ATNUM( "..", "..This..is..a..test!", 2 ) == 7 + ATNUM( "..", "..This..is..a..test!", 2, 2 ) == 11 + $STATUS$ + Ready + $COMPLIANCE$ + ATNUM() is compatible with CT3's ATNUM(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + ATNUM() AFTERATNUM() CSETATMUPA() SETATLIKE() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/atrepl.txt b/harbour/contrib/hbct/doc/en/atrepl.txt index 5b182467e7..18e91e45e7 100644 --- a/harbour/contrib/hbct/doc/en/atrepl.txt +++ b/harbour/contrib/hbct/doc/en/atrepl.txt @@ -2,67 +2,67 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * ATREPL() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Search and replace sequences in a string - * $SYNTAX$ - * ATREPL( , , , [], - * [], [] ) --> cString - * $ARGUMENTS$ - * is the substring searched for in - * is the processed string - * is the replacement for sequences found - * [] specifies the number of replacements - * Default: last occurence - * [] if set to .T., only the th sequence - * of will be replaced, else - * all sequences will be replaced. - * Default: .F. - * []) specifies how many characters in from - * the beginning should be ignored by the function - * Default: 0 - * $RETURNS$ - * - * $DESCRIPTION$ - * The ATREPL() function searches and replaces sequences in a string. - * First, the function ignores the first characters of . - * Then, if is set to .T., it searches for the th - * occurence of in . If successful, the - * sequence will be replaced with . - * If is set to .F., the same search is performed, but EVERY - * occurence of till the th (inclusive) will - * be replaced with . Note that, in this case, - * the replacements are performed even if the th occurence - * does not exist. - * By using the CSETATMUPA() switch you can decide whether the - * function restarts searching after a found sequence of after - * the first character of that sequence. - * The function allows the use of wildcards in - * and looks for the settings of SETATLIKE(). - * $EXAMPLES$ - * ? ATREPL( "ABC", "ABCDABCDABC", "xx" ) // --> "xxDxxDxx" - * ? ATREPL( "ABC", "ABCDABC", "ZYXW" ) // --> "ZYXWDZYXW" - * ? ATREPL( "ABC", "ABCDABCDABC", "xx", 2 ) // --> "xxDxxDABC" - * ? ATREPL( "ABC", "ABCDABCDABC", "xx", 2, .T. ) // --> "ABCDxxDABC" - * $TESTS$ - * ATREPL( "ABC", "ABCDABCDABC", "xx" ) == "xxDxxDxx" - * ATREPL( "ABC", "ABCDABC", "ZYXW" ) == "ZYXWDZYXW" - * ATREPL( "ABC", "ABCDABCDABC", "xx", 2 ) == "xxDxxDABC" - * ATREPL( "ABC", "ABCDABCDABC", "xx", 2, .T. ) == "ABCDxxDABC" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * ATREPL() is compatible with CT3's ATREPL(). - * Note the new, 6th parameter ! - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CSETATMUPA() SETATLIKE() - * $END$ +/* $DOC$ + $FUNCNAME$ + ATREPL() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Search and replace sequences in a string + $SYNTAX$ + ATREPL( , , , [], + [], [] ) --> cString + $ARGUMENTS$ + is the substring searched for in + is the processed string + is the replacement for sequences found + [] specifies the number of replacements + Default: last occurence + [] if set to .T., only the th sequence + of will be replaced, else + all sequences will be replaced. + Default: .F. + []) specifies how many characters in from + the beginning should be ignored by the function + Default: 0 + $RETURNS$ + + $DESCRIPTION$ + The ATREPL() function searches and replaces sequences in a string. + First, the function ignores the first characters of . + Then, if is set to .T., it searches for the th + occurence of in . If successful, the + sequence will be replaced with . + If is set to .F., the same search is performed, but EVERY + occurence of till the th (inclusive) will + be replaced with . Note that, in this case, + the replacements are performed even if the th occurence + does not exist. + By using the CSETATMUPA() switch you can decide whether the + function restarts searching after a found sequence of after + the first character of that sequence. + The function allows the use of wildcards in + and looks for the settings of SETATLIKE(). + $EXAMPLES$ + ? ATREPL( "ABC", "ABCDABCDABC", "xx" ) // --> "xxDxxDxx" + ? ATREPL( "ABC", "ABCDABC", "ZYXW" ) // --> "ZYXWDZYXW" + ? ATREPL( "ABC", "ABCDABCDABC", "xx", 2 ) // --> "xxDxxDABC" + ? ATREPL( "ABC", "ABCDABCDABC", "xx", 2, .T. ) // --> "ABCDxxDABC" + $TESTS$ + ATREPL( "ABC", "ABCDABCDABC", "xx" ) == "xxDxxDxx" + ATREPL( "ABC", "ABCDABC", "ZYXW" ) == "ZYXWDZYXW" + ATREPL( "ABC", "ABCDABCDABC", "xx", 2 ) == "xxDxxDABC" + ATREPL( "ABC", "ABCDABCDABC", "xx", 2, .T. ) == "ABCDxxDABC" + $STATUS$ + Ready + $COMPLIANCE$ + ATREPL() is compatible with CT3's ATREPL(). + Note the new, 6th parameter ! + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CSETATMUPA() SETATLIKE() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/charevod.txt b/harbour/contrib/hbct/doc/en/charevod.txt index a79acb0fc6..1e6758d179 100644 --- a/harbour/contrib/hbct/doc/en/charevod.txt +++ b/harbour/contrib/hbct/doc/en/charevod.txt @@ -2,73 +2,73 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * CHAREVEN() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Returns the characters on the even positions in a string - * $SYNTAX$ - * CHAREVEN( ) --> cEvenString - * $ARGUMENTS$ - * processed string - * $RETURNS$ - * a string containing all character from even positions - * in - * $DESCRIPTION$ - * The CHAREVEN() function looks for the characters on the even positions - * in a given string, collects them and returns them as a string. - * $EXAMPLES$ - * ? CHAREVEN( " H E L L O !" ) // -> "HELLO!" - * $TESTS$ - * CHAREVEN( " 1 2 3 4 5" ) == "12345" - * CHAREVEN( " 1 2 3 4 " ) == "1234" - * CHAREVEN( " " ) == "" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHAREVEN() is compatible with CT3's CHAREVEN(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARODD() CHARMIX() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHAREVEN() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Returns the characters on the even positions in a string + $SYNTAX$ + CHAREVEN( ) --> cEvenString + $ARGUMENTS$ + processed string + $RETURNS$ + a string containing all character from even positions + in + $DESCRIPTION$ + The CHAREVEN() function looks for the characters on the even positions + in a given string, collects them and returns them as a string. + $EXAMPLES$ + ? CHAREVEN( " H E L L O !" ) // -> "HELLO!" + $TESTS$ + CHAREVEN( " 1 2 3 4 5" ) == "12345" + CHAREVEN( " 1 2 3 4 " ) == "1234" + CHAREVEN( " " ) == "" + $STATUS$ + Ready + $COMPLIANCE$ + CHAREVEN() is compatible with CT3's CHAREVEN(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARODD() CHARMIX() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARODD() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Returns the characters on the odd positions in a string - * $SYNTAX$ - * CHARODD( ) --> cOddString - * $ARGUMENTS$ - * processed string - * $RETURNS$ - * a string containing all character from odd positions - * in - * $DESCRIPTION$ - * The CHARODD() function looks for the characters on the odd positions - * in a given string, collects them and returns them as a string. - * $EXAMPLES$ - * ? CHARODD( "H E L L O ! " ) // -> "HELLO!" - * $TESTS$ - * CHARODD( "1A2B3C4D5E" ) == "12345" - * CHARODD( "1A2B3C4D5" ) == "12345" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARODD() is compatible with CT3's CHARODD(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHAREVEN() CHARMIX() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARODD() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Returns the characters on the odd positions in a string + $SYNTAX$ + CHARODD( ) --> cOddString + $ARGUMENTS$ + processed string + $RETURNS$ + a string containing all character from odd positions + in + $DESCRIPTION$ + The CHARODD() function looks for the characters on the odd positions + in a given string, collects them and returns them as a string. + $EXAMPLES$ + ? CHARODD( "H E L L O ! " ) // -> "HELLO!" + $TESTS$ + CHARODD( "1A2B3C4D5E" ) == "12345" + CHARODD( "1A2B3C4D5" ) == "12345" + $STATUS$ + Ready + $COMPLIANCE$ + CHARODD() is compatible with CT3's CHARODD(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHAREVEN() CHARMIX() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/charlihb.txt b/harbour/contrib/hbct/doc/en/charlihb.txt index 0a51a8c4f1..6077874d51 100644 --- a/harbour/contrib/hbct/doc/en/charlihb.txt +++ b/harbour/contrib/hbct/doc/en/charlihb.txt @@ -2,80 +2,80 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARSLIST() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Generates a sorted list of all characters in a string - * $SYNTAX$ - * CHARSLIST( [] ) -> cSortedCharacterList - * $ARGUMENTS$ - * [] is the string for whom the function generates a - * sorted list of all characters - * Default: "" (empty string) - * $RETURNS$ - * a sorted list of the characters in - * $DESCRIPTION$ - * The CHARLIST() function generates a sorted list of those characters that - * are contained in . This list can contain each character - * only once, so that its maximum length is 256. The function - * gives the same result as CHARSORT(CHARLIST()) - * $EXAMPLES$ - * ? charslist( "Hello World !" ) // --> " !HWdelor" - * $TESTS$ - * charslist( "Hello World !" ) == " !HWdelor" - * charslist( "Hello World !" ) == charsort( charlist( "Hello World !" ) ) - * charslist( NIL ) == "" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARSLIST() is only available in Harbour's CT3 library. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARNOLIST(),CHARLIST(),CHARHIST() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARSLIST() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Generates a sorted list of all characters in a string + $SYNTAX$ + CHARSLIST( [] ) -> cSortedCharacterList + $ARGUMENTS$ + [] is the string for whom the function generates a + sorted list of all characters + Default: "" (empty string) + $RETURNS$ + a sorted list of the characters in + $DESCRIPTION$ + The CHARLIST() function generates a sorted list of those characters that + are contained in . This list can contain each character + only once, so that its maximum length is 256. The function + gives the same result as CHARSORT(CHARLIST()) + $EXAMPLES$ + ? charslist( "Hello World !" ) // --> " !HWdelor" + $TESTS$ + charslist( "Hello World !" ) == " !HWdelor" + charslist( "Hello World !" ) == charsort( charlist( "Hello World !" ) ) + charslist( NIL ) == "" + $STATUS$ + Ready + $COMPLIANCE$ + CHARSLIST() is only available in Harbour's CT3 library. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARNOLIST(),CHARLIST(),CHARHIST() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARHIST() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Generates a character histogram of a string - * $SYNTAX$ - * CHARHIST( [] ) -> aCharacterCount - * $ARGUMENTS$ - * [] is the string for whom the function generates a - * character histogram - * Default: "" (empty string) - * $RETURNS$ - * an array with 256 elements where the nth element - * contains the count of character #(n-1) in cString - * $DESCRIPTION$ - * The CHARHIST() function generates a character histogram of those - * characters that are contained in . This histogram is stored - * in an 256-element array where the nth element contains the count - * of ASCII character #(n-1) in . - * $EXAMPLES$ - * ? charhist( "Hello World !" )[ 109 ] // --> 3 // Chr( 108 ) == "l" - * $TESTS$ - * charhist( "Hello World !" )[ 109 ] == 3 - * eval( {|| AEval( charhist( "Hello World !" ), {| x | nTotal += x } ), nTotal == Len( "Hello World !" ) } - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARHIST() is only available in Harbour's CT3 library. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARLIST(),CHARNOLIST(),CHARSLIST() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARHIST() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Generates a character histogram of a string + $SYNTAX$ + CHARHIST( [] ) -> aCharacterCount + $ARGUMENTS$ + [] is the string for whom the function generates a + character histogram + Default: "" (empty string) + $RETURNS$ + an array with 256 elements where the nth element + contains the count of character #(n-1) in cString + $DESCRIPTION$ + The CHARHIST() function generates a character histogram of those + characters that are contained in . This histogram is stored + in an 256-element array where the nth element contains the count + of ASCII character #(n-1) in . + $EXAMPLES$ + ? charhist( "Hello World !" )[ 109 ] // --> 3 // Chr( 108 ) == "l" + $TESTS$ + charhist( "Hello World !" )[ 109 ] == 3 + eval( {|| AEval( charhist( "Hello World !" ), {| x | nTotal += x } ), nTotal == Len( "Hello World !" ) } + $STATUS$ + Ready + $COMPLIANCE$ + CHARHIST() is only available in Harbour's CT3 library. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARLIST(),CHARNOLIST(),CHARSLIST() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/charlist.txt b/harbour/contrib/hbct/doc/en/charlist.txt index 2ac7196442..def4f29f55 100644 --- a/harbour/contrib/hbct/doc/en/charlist.txt +++ b/harbour/contrib/hbct/doc/en/charlist.txt @@ -2,78 +2,78 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARLIST() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Generates a list of all characters in a string - * $SYNTAX$ - * CHARLIST( [] ) -> cCharacterList - * $ARGUMENTS$ - * [] is the string for whom the function generates a list - * of all characters - * Default: "" (empty string) - * $RETURNS$ - * a list of the characters in - * $DESCRIPTION$ - * The CHARLIST() function generates a list of those characters that - * are contained in . This list can contain each character - * only once, so that its maximum length is 256. The list lists those - * characters first that are occuring in first. - * $EXAMPLES$ - * ? charlist( "Hello World !" ) // --> "Helo Wrd!" - * $TESTS$ - * charlist( "Hello World !" ) == "Helo Wrd!" - * charlist( NIL ) == "" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARLIST() is compatible with CT3's CHARLIST(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARNOLIST(),CHARSLIST(),CHARHIST() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARLIST() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Generates a list of all characters in a string + $SYNTAX$ + CHARLIST( [] ) -> cCharacterList + $ARGUMENTS$ + [] is the string for whom the function generates a list + of all characters + Default: "" (empty string) + $RETURNS$ + a list of the characters in + $DESCRIPTION$ + The CHARLIST() function generates a list of those characters that + are contained in . This list can contain each character + only once, so that its maximum length is 256. The list lists those + characters first that are occuring in first. + $EXAMPLES$ + ? charlist( "Hello World !" ) // --> "Helo Wrd!" + $TESTS$ + charlist( "Hello World !" ) == "Helo Wrd!" + charlist( NIL ) == "" + $STATUS$ + Ready + $COMPLIANCE$ + CHARLIST() is compatible with CT3's CHARLIST(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARNOLIST(),CHARSLIST(),CHARHIST() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARNOLIST() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Generates a list of all characters not contained in a string - * $SYNTAX$ - * CHARNOLIST( [] ) -> cCharacterList - * $ARGUMENTS$ - * [] is the string for whom the function generates a list - * of all characters not contained in that string - * Default: "" (empty string) - * $RETURNS$ - * a list of the characters that are not contained in - * $DESCRIPTION$ - * The CHARNOLIST() function generates a list of those characters that - * are not contained in . This list can contain each character - * only once, so that its maximum length is 256. The list is alphabetically - * sorted. - * $EXAMPLES$ - * ? charnolist( charnolist( "Hello World !" ) ) // --> " !HWdelor" - * $TESTS$ - * charnolist( charnolist( "Hello World !" ) ) == charslist( "Hello World !" ) - * charnolist( charnolist( NIL ) ) == "" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARNOLIST() is compatible with CT3's CHARNOLIST(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARLIST(),CHARSLIST(),CHARHIST() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARNOLIST() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Generates a list of all characters not contained in a string + $SYNTAX$ + CHARNOLIST( [] ) -> cCharacterList + $ARGUMENTS$ + [] is the string for whom the function generates a list + of all characters not contained in that string + Default: "" (empty string) + $RETURNS$ + a list of the characters that are not contained in + $DESCRIPTION$ + The CHARNOLIST() function generates a list of those characters that + are not contained in . This list can contain each character + only once, so that its maximum length is 256. The list is alphabetically + sorted. + $EXAMPLES$ + ? charnolist( charnolist( "Hello World !" ) ) // --> " !HWdelor" + $TESTS$ + charnolist( charnolist( "Hello World !" ) ) == charslist( "Hello World !" ) + charnolist( charnolist( NIL ) ) == "" + $STATUS$ + Ready + $COMPLIANCE$ + CHARNOLIST() is compatible with CT3's CHARNOLIST(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARLIST(),CHARSLIST(),CHARHIST() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/charmirr.txt b/harbour/contrib/hbct/doc/en/charmirr.txt index 8b65422b5e..fc0f622ba4 100644 --- a/harbour/contrib/hbct/doc/en/charmirr.txt +++ b/harbour/contrib/hbct/doc/en/charmirr.txt @@ -2,47 +2,47 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARMIRR() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Mirror a string - * $SYNTAX$ - * CHARMIRR( <[@]cString>, [] ) -> cMirroredString - * $ARGUMENTS$ - * <[@]cString> is the string that should be mirrored - * [] if set to .T., spaces at the end of - * will not be mirrored but kept at the end - * Default: .F., mirror the whole string - * $RETURNS$ - * the mirrored string - * $DESCRIPTION$ - * The CHARMIRR() function mirrors a string, i.e. the first character - * will be put at the end, the second at the last but one position etc.. - * One can use this function for index searches, but then, the spaces - * at the end of the string should not be mirrored. - * One can omit the return value of the function by setting the CSETREF() - * switch to .T., but must then be passed by reference to get - * a result. - * $EXAMPLES$ - * ? charmirr( "racecar" ) // "racecar" - * ? charmirr( "racecar ", .T. ) // "racecar " - * ? charmirr( "racecar ", .F. ) // " racecar" - * $TESTS$ - * charmirr( "racecar" ) == "racecar" - * charmirr( "racecar ", .T. ) == "racecar " - * charmirr( "racecar ", .F. ) == " racecar" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARMIRR() is compatible with CT3's CHARMIRR(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARMIRR() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Mirror a string + $SYNTAX$ + CHARMIRR( <[@]cString>, [] ) -> cMirroredString + $ARGUMENTS$ + <[@]cString> is the string that should be mirrored + [] if set to .T., spaces at the end of + will not be mirrored but kept at the end + Default: .F., mirror the whole string + $RETURNS$ + the mirrored string + $DESCRIPTION$ + The CHARMIRR() function mirrors a string, i.e. the first character + will be put at the end, the second at the last but one position etc.. + One can use this function for index searches, but then, the spaces + at the end of the string should not be mirrored. + One can omit the return value of the function by setting the CSETREF() + switch to .T., but must then be passed by reference to get + a result. + $EXAMPLES$ + ? charmirr( "racecar" ) // "racecar" + ? charmirr( "racecar ", .T. ) // "racecar " + ? charmirr( "racecar ", .F. ) // " racecar" + $TESTS$ + charmirr( "racecar" ) == "racecar" + charmirr( "racecar ", .T. ) == "racecar " + charmirr( "racecar ", .F. ) == " racecar" + $STATUS$ + Ready + $COMPLIANCE$ + CHARMIRR() is compatible with CT3's CHARMIRR(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CSETREF() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/charmix.txt b/harbour/contrib/hbct/doc/en/charmix.txt index e75744d280..2f9021fb0f 100644 --- a/harbour/contrib/hbct/doc/en/charmix.txt +++ b/harbour/contrib/hbct/doc/en/charmix.txt @@ -2,53 +2,53 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARMIX() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Mix two strings - * $SYNTAX$ - * CHARMIX( [, ] ) --> cMixedString - * $ARGUMENTS$ - * String that will be mixed with the characters from - * [] String whose characters will be mixed with the one from - * . - * Default: " " (string with one space char) - * $RETURNS$ - * Mixed string - * $DESCRIPTION$ - * The CHARMIX() function mixes the strings and . To - * do this it takes one character after the other alternatively from - * and and puts them in the output string. - * This procedure is stopped when the end of is reached. If - * is shorter than , the function will start at - * the begin of again. If on the other hand is - * longer than , the surplus characters will be omitted. - * $EXAMPLES$ - * ? CHARMIX( "ABC", "123" ) // "A1B2C3" - * ? CHARMIX( "ABCDE", "12" ) // "A1B2C1D2E1" - * ? CHARMIX( "AB", "12345" ) // "A1B2" - * ? CHARMIX( "HELLO", " " ) // "H E L L O " - * ? CHARMIX( "HELLO", "" ) // "HELLO" - * $TESTS$ - * CHARMIX( "ABC", "123" ) == "A1B2C3" - * CHARMIX( "ABCDE", "12" ) == "A1B2C1D2E1" - * CHARMIX( "AB", "12345") == "A1B2" - * CHARMIX( "HELLO", " " ) == "H E L L O " - * CHARMIX( "HELLO", "" ) == "HELLO" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARMIX() is compatible with CT3's CHARMIX(). - * NOTE: CA-Tools version of CHARMIX() will hang - * if the second parameter is an empty string, this version will not. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHAREVEN() CHARODD() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARMIX() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Mix two strings + $SYNTAX$ + CHARMIX( [, ] ) --> cMixedString + $ARGUMENTS$ + String that will be mixed with the characters from + [] String whose characters will be mixed with the one from + . + Default: " " (string with one space char) + $RETURNS$ + Mixed string + $DESCRIPTION$ + The CHARMIX() function mixes the strings and . To + do this it takes one character after the other alternatively from + and and puts them in the output string. + This procedure is stopped when the end of is reached. If + is shorter than , the function will start at + the begin of again. If on the other hand is + longer than , the surplus characters will be omitted. + $EXAMPLES$ + ? CHARMIX( "ABC", "123" ) // "A1B2C3" + ? CHARMIX( "ABCDE", "12" ) // "A1B2C1D2E1" + ? CHARMIX( "AB", "12345" ) // "A1B2" + ? CHARMIX( "HELLO", " " ) // "H E L L O " + ? CHARMIX( "HELLO", "" ) // "HELLO" + $TESTS$ + CHARMIX( "ABC", "123" ) == "A1B2C3" + CHARMIX( "ABCDE", "12" ) == "A1B2C1D2E1" + CHARMIX( "AB", "12345") == "A1B2" + CHARMIX( "HELLO", " " ) == "H E L L O " + CHARMIX( "HELLO", "" ) == "HELLO" + $STATUS$ + Ready + $COMPLIANCE$ + CHARMIX() is compatible with CT3's CHARMIX(). + NOTE: CA-Tools version of CHARMIX() will hang + if the second parameter is an empty string, this version will not. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHAREVEN() CHARODD() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/charone.txt b/harbour/contrib/hbct/doc/en/charone.txt index 127be8aafc..9946eab89c 100644 --- a/harbour/contrib/hbct/doc/en/charone.txt +++ b/harbour/contrib/hbct/doc/en/charone.txt @@ -2,87 +2,87 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARONE() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Reduce multiple occurences of a character to one - * $SYNTAX$ - * CHARONE( [,] ) -> cReducedString - * $ARGUMENTS$ - * [] specifies the characters the multiple - * occurences of which should be reduced to one - * Default: All characters. - * specifies the processed string - * $RETURNS$ - * the string with the reduced occurences - * $DESCRIPTION$ - * The CHARONE() function reduces multiple occurences of characters in - * to a single one. It is important to note that the multiple - * occurences must occur directly one behind the other. This behaviour is - * is in contrast to the CHARLIST() function. - * $EXAMPLES$ - * ? CHARONE( "122333a123" ) // "123a123" - * ? CHARONE( "A B CCCD" ) // "A B CD" - * ? CHARONE( " ", "A B A B" ) // "A B A B" - * ? CHARONE( "o", "122oooB12o" ) // "122oB12o" - * $TESTS$ - * CHARONE( "122333a123" ) == "123a123" - * CHARONE( "A B CCCD" ) == "A B CD" - * CHARONE( " ", "A B A B" ) == "A B A B" - * CHARONE( "o", "122oooB12o" ) == "122oB12o" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARONE() is compatible with CT3's CHARONE(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARREM() WORDONE() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARONE() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Reduce multiple occurences of a character to one + $SYNTAX$ + CHARONE( [,] ) -> cReducedString + $ARGUMENTS$ + [] specifies the characters the multiple + occurences of which should be reduced to one + Default: All characters. + specifies the processed string + $RETURNS$ + the string with the reduced occurences + $DESCRIPTION$ + The CHARONE() function reduces multiple occurences of characters in + to a single one. It is important to note that the multiple + occurences must occur directly one behind the other. This behaviour is + is in contrast to the CHARLIST() function. + $EXAMPLES$ + ? CHARONE( "122333a123" ) // "123a123" + ? CHARONE( "A B CCCD" ) // "A B CD" + ? CHARONE( " ", "A B A B" ) // "A B A B" + ? CHARONE( "o", "122oooB12o" ) // "122oB12o" + $TESTS$ + CHARONE( "122333a123" ) == "123a123" + CHARONE( "A B CCCD" ) == "A B CD" + CHARONE( " ", "A B A B" ) == "A B A B" + CHARONE( "o", "122oooB12o" ) == "122oB12o" + $STATUS$ + Ready + $COMPLIANCE$ + CHARONE() is compatible with CT3's CHARONE(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARREM() WORDONE() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * WORDONE() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Reduce multiple occurences of a double character to one - * $SYNTAX$ - * WORDONE( [,] ) -> cReducedString - * $ARGUMENTS$ - * [] specifies the double characters the multiple - * occurences of which should be reduced to one - * Default: All characters. - * specifies the processed string - * $RETURNS$ - * the string with the reduced occurences - * $DESCRIPTION$ - * The WORDONE() function reduces multiple occurences of double characters in - * to a single one. It is important to note that the multiple - * occurences must occur directly one behind the other. - * $EXAMPLES$ - * ? WORDONE( "12ABAB12" ) // "12AB12" - * ? WORDONE( "1AAAA2" ) // "1AAAA2" - * ? WORDONE( "12", "1212ABAB" ) // "12ABAB" - * $TESTS$ - * WORDONE( "12ABAB12" ) == "12AB12" - * WORDONE( "1AAAA2" ) == "1AAAA2" - * WORDONE( "12", "1212ABAB" ) == "12ABAB" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * WORDONE() is compatible with CT3's WORDONE(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARONE() CHARREM() - * $END$ +/* $DOC$ + $FUNCNAME$ + WORDONE() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Reduce multiple occurences of a double character to one + $SYNTAX$ + WORDONE( [,] ) -> cReducedString + $ARGUMENTS$ + [] specifies the double characters the multiple + occurences of which should be reduced to one + Default: All characters. + specifies the processed string + $RETURNS$ + the string with the reduced occurences + $DESCRIPTION$ + The WORDONE() function reduces multiple occurences of double characters in + to a single one. It is important to note that the multiple + occurences must occur directly one behind the other. + $EXAMPLES$ + ? WORDONE( "12ABAB12" ) // "12AB12" + ? WORDONE( "1AAAA2" ) // "1AAAA2" + ? WORDONE( "12", "1212ABAB" ) // "12ABAB" + $TESTS$ + WORDONE( "12ABAB12" ) == "12AB12" + WORDONE( "1AAAA2" ) == "1AAAA2" + WORDONE( "12", "1212ABAB" ) == "12ABAB" + $STATUS$ + Ready + $COMPLIANCE$ + WORDONE() is compatible with CT3's WORDONE(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARONE() CHARREM() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/charonly.txt b/harbour/contrib/hbct/doc/en/charonly.txt index e0659a26c0..cecfb318da 100644 --- a/harbour/contrib/hbct/doc/en/charonly.txt +++ b/harbour/contrib/hbct/doc/en/charonly.txt @@ -2,157 +2,157 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARONLY() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Intersectional set of two strings based on characters - * $SYNTAX$ - * CHARONLY( , ) -> cReducedString - * $ARGUMENTS$ - * specifies the characters that must not be - * deleted in . - * is the string that should be processed - * $RETURNS$ - * A string with all characters deleted but those - * specified in . - * $DESCRIPTION$ - * The CHARONLY() function calculates the intersectional set of two - * strings. To do this, it deletes all characters from that - * do not appear in . - * $EXAMPLES$ - * ? CHARONLY( "0123456789", "0211 - 38 99 77" ) // "0211389977" - * ? CHARONLY( "0123456789", "0211/ 389 977" ) // "0211389977" - * $TESTS$ - * CHARONLY( "0123456789", "0211 - 38 99 77" ) == "0211389977" - * CHARONLY( "0123456789", "0211/ 389 977" ) == "0211389977" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARONLY() is compatible with CT3's CHARONLY(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARREM() WORDONLY() WORDREM() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARONLY() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Intersectional set of two strings based on characters + $SYNTAX$ + CHARONLY( , ) -> cReducedString + $ARGUMENTS$ + specifies the characters that must not be + deleted in . + is the string that should be processed + $RETURNS$ + A string with all characters deleted but those + specified in . + $DESCRIPTION$ + The CHARONLY() function calculates the intersectional set of two + strings. To do this, it deletes all characters from that + do not appear in . + $EXAMPLES$ + ? CHARONLY( "0123456789", "0211 - 38 99 77" ) // "0211389977" + ? CHARONLY( "0123456789", "0211/ 389 977" ) // "0211389977" + $TESTS$ + CHARONLY( "0123456789", "0211 - 38 99 77" ) == "0211389977" + CHARONLY( "0123456789", "0211/ 389 977" ) == "0211389977" + $STATUS$ + Ready + $COMPLIANCE$ + CHARONLY() is compatible with CT3's CHARONLY(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARREM() WORDONLY() WORDREM() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * WORDONLY() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Intersectional set of two strings based on double characters - * $SYNTAX$ - * WORDONLY( , ) -> cReducedString - * $ARGUMENTS$ - * specifies the double characters that must - * not be deleted in . - * is the string that should be processed - * $RETURNS$ - * A string with all double characters deleted - * but those specified in . - * $DESCRIPTION$ - * The WORDONLY() function calculates the intersectional set of two - * strings based on double characters. To do this, it deletes all double - * characters from that do not appear in . - * $EXAMPLES$ - * ? WORDONLY( "AABBCCDD", "XXAAYYBBZZ" ) // "AABB" - * ? WORDONLY( "AABBCCDD", "XAAYYYBBZZ" ) // "BB" - * $TESTS$ - * WORDONLY( "AABBCCDD", "XXAAYYBBZZ" ) == "AABB" - * WORDONLY( "AABBCCDD", "XAAYYYBBZZ" ) == "BB" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * WORDONLY() is compatible with CT3's WORDONLY(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARONLY() CHARREM() WORDREM() - * $END$ +/* $DOC$ + $FUNCNAME$ + WORDONLY() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Intersectional set of two strings based on double characters + $SYNTAX$ + WORDONLY( , ) -> cReducedString + $ARGUMENTS$ + specifies the double characters that must + not be deleted in . + is the string that should be processed + $RETURNS$ + A string with all double characters deleted + but those specified in . + $DESCRIPTION$ + The WORDONLY() function calculates the intersectional set of two + strings based on double characters. To do this, it deletes all double + characters from that do not appear in . + $EXAMPLES$ + ? WORDONLY( "AABBCCDD", "XXAAYYBBZZ" ) // "AABB" + ? WORDONLY( "AABBCCDD", "XAAYYYBBZZ" ) // "BB" + $TESTS$ + WORDONLY( "AABBCCDD", "XXAAYYBBZZ" ) == "AABB" + WORDONLY( "AABBCCDD", "XAAYYYBBZZ" ) == "BB" + $STATUS$ + Ready + $COMPLIANCE$ + WORDONLY() is compatible with CT3's WORDONLY(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARONLY() CHARREM() WORDREM() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARREM() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Removes characters from a string - * $SYNTAX$ - * CHARREM( , ) -> cReducedString - * $ARGUMENTS$ - * specifies the characters that should - * be deleted in - * ) is the string that should be processed - * $RETURNS$ - * is a string where the characters specified - * in are deleted - * $DESCRIPTION$ - * The CHARREM() function deletes the characters specified in - * from . - * $EXAMPLES$ - * ? CHARREM( " ", " 1 2 " ) // "12" - * ? CHARREM( "3y", "xyz123" ) // "xz12" - * $TESTS$ - * CHARREM( " ", " 1 2 " ) == "12" - * CHARREM( "3y", "xyz123" ) == "xz12" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARREM() is compatible with CT3's CHARREM(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARONLY() WORDONLY() WORDREM() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARREM() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Removes characters from a string + $SYNTAX$ + CHARREM( , ) -> cReducedString + $ARGUMENTS$ + specifies the characters that should + be deleted in + ) is the string that should be processed + $RETURNS$ + is a string where the characters specified + in are deleted + $DESCRIPTION$ + The CHARREM() function deletes the characters specified in + from . + $EXAMPLES$ + ? CHARREM( " ", " 1 2 " ) // "12" + ? CHARREM( "3y", "xyz123" ) // "xz12" + $TESTS$ + CHARREM( " ", " 1 2 " ) == "12" + CHARREM( "3y", "xyz123" ) == "xz12" + $STATUS$ + Ready + $COMPLIANCE$ + CHARREM() is compatible with CT3's CHARREM(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARONLY() WORDONLY() WORDREM() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * WORDREM() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Removes characters from a string - * $SYNTAX$ - * WORDREM( , ) -> cReducedString - * $ARGUMENTS$ - * specifies the double characters that - * should be deleted in - * ) is the string that should be processed - * $RETURNS$ - * is a string where the double characters - * specified in - * are deleted - * $DESCRIPTION$ - * The WORDREM() function deletes the double characters specified in - * from . - * $EXAMPLES$ - * ? WORDREM( "abcd", "0ab1cd" ) // "0ab1" - * ? WORDREM( "abcd", "ab0cd1" ) // "0cd1" - * $TESTS$ - * WORDREM( "abcd", "0ab1cd" ) == "0ab1" - * WORDREM( "abcd", "ab0cd1" ) == "0cd1" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * WORDREM() is a new function available only in Harbour's CT3. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARONLY CHARREM() WORDREM() - * $END$ +/* $DOC$ + $FUNCNAME$ + WORDREM() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Removes characters from a string + $SYNTAX$ + WORDREM( , ) -> cReducedString + $ARGUMENTS$ + specifies the double characters that + should be deleted in + ) is the string that should be processed + $RETURNS$ + is a string where the double characters + specified in + are deleted + $DESCRIPTION$ + The WORDREM() function deletes the double characters specified in + from . + $EXAMPLES$ + ? WORDREM( "abcd", "0ab1cd" ) // "0ab1" + ? WORDREM( "abcd", "ab0cd1" ) // "0cd1" + $TESTS$ + WORDREM( "abcd", "0ab1cd" ) == "0ab1" + WORDREM( "abcd", "ab0cd1" ) == "0cd1" + $STATUS$ + Ready + $COMPLIANCE$ + WORDREM() is a new function available only in Harbour's CT3. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARONLY CHARREM() WORDREM() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/charop.txt b/harbour/contrib/hbct/doc/en/charop.txt index 3fc20ad7d1..f6a50716b9 100644 --- a/harbour/contrib/hbct/doc/en/charop.txt +++ b/harbour/contrib/hbct/doc/en/charop.txt @@ -2,242 +2,242 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARADD() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Adds corresponding ASCII value of two strings - * $SYNTAX$ - * CHARADD( <[@]cString1>, ) --> cAddString - * $ARGUMENTS$ - * <[@]cString1> first string - * second string - * $RETURNS$ - * string with added ASCII values - * $DESCRIPTION$ - * The CHARADD() function constructs a new string from the two strings - * passed as parameters. To do this, it adds the ASCII values of the - * corresponding characters of both strings and places a character in - * the resulting string whose ASCII value equals to that sum (modulo 256). - * If the first string is passed by reference, the resulting string is - * stored in , too. By setting the CSETREF()-switch to .T., - * the return value can be omitted. - * If is shorter than and the last character of - * has been processed, the function restarts with the first - * character of . - * $EXAMPLES$ - * ? charadd( "012345678", Chr( 1 ) ) // --> "123456789" - * ? charadd( "123456789", Chr( 255 ) ) // --> "012345678" - * ? charadd( "0000", Chr( 0 ) + Chr( 1 ) + Chr( 2 ) + Chr( 3 ) ) // --> "0123" - * $TESTS$ - * charadd( "012345678", Chr( 1 ) ) == "123456789" - * charadd( "012345678", Chr( 1 ) + Chr( 2 ) ) == "133557799" - * charadd( "123456789", Chr( 255 ) ) == "012345678" - * charadd( "123456789", Chr( 255 ) + Chr( 254 ) ) == "002244668" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARADD() is compatible with CT3's CHARADD(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARSUB() CHARAND() CHARNOT() - * CHAROR() CHARXOR() CHARSHL() - * CHARSHR() CHARRLL() CHARRLR() - * CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARADD() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Adds corresponding ASCII value of two strings + $SYNTAX$ + CHARADD( <[@]cString1>, ) --> cAddString + $ARGUMENTS$ + <[@]cString1> first string + second string + $RETURNS$ + string with added ASCII values + $DESCRIPTION$ + The CHARADD() function constructs a new string from the two strings + passed as parameters. To do this, it adds the ASCII values of the + corresponding characters of both strings and places a character in + the resulting string whose ASCII value equals to that sum (modulo 256). + If the first string is passed by reference, the resulting string is + stored in , too. By setting the CSETREF()-switch to .T., + the return value can be omitted. + If is shorter than and the last character of + has been processed, the function restarts with the first + character of . + $EXAMPLES$ + ? charadd( "012345678", Chr( 1 ) ) // --> "123456789" + ? charadd( "123456789", Chr( 255 ) ) // --> "012345678" + ? charadd( "0000", Chr( 0 ) + Chr( 1 ) + Chr( 2 ) + Chr( 3 ) ) // --> "0123" + $TESTS$ + charadd( "012345678", Chr( 1 ) ) == "123456789" + charadd( "012345678", Chr( 1 ) + Chr( 2 ) ) == "133557799" + charadd( "123456789", Chr( 255 ) ) == "012345678" + charadd( "123456789", Chr( 255 ) + Chr( 254 ) ) == "002244668" + $STATUS$ + Ready + $COMPLIANCE$ + CHARADD() is compatible with CT3's CHARADD(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARSUB() CHARAND() CHARNOT() + CHAROR() CHARXOR() CHARSHL() + CHARSHR() CHARRLL() CHARRLR() + CSETREF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARAND() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Combine corresponding ASCII value of two strings with bitwise AND - * $SYNTAX$ - * CHARAND( <[@]cString1>, ) --> cAndString - * $ARGUMENTS$ - * <[@]cString1> first string - * second string - * $RETURNS$ - * string with bitwise AND combined ASCII values - * $DESCRIPTION$ - * The CHARAND() function constructs a new string from the two strings - * passed as parameters. To do this, it combines the ASCII values of the - * corresponding characters of both strings with a bitwise AND-operation - * and places a character in the resulting string whose ASCII value - * equals to the result of that operation. - * If the first string is passed by reference, the resulting string is - * stored in , too. By setting the CSETREF()-switch to .T., - * the return value can be omitted. - * If is shorter than and the last character of - * has been processed, the function restarts with the first - * character of . - * $EXAMPLES$ - * // clear the LSB - * ? charand( "012345678", Chr( 254 ) ) // --> "002244668" - * ? charand( "012345678", Chr( 254 ) + Chr( 252 ) ) // --> "002044648" - * $TESTS$ - * charand( "012345678", Chr( 254 ) ) == "002244668" - * charand( "012345678", Chr( 254 ) + Chr( 252 ) ) == "002044648" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARAND() is compatible with CT3's CHARAND(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARADD() CHARSUB() CHARNOT() - * CHAROR() CHARXOR() CHARSHL() - * CHARSHR() CHARRLL() CHARRLR() - * CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARAND() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Combine corresponding ASCII value of two strings with bitwise AND + $SYNTAX$ + CHARAND( <[@]cString1>, ) --> cAndString + $ARGUMENTS$ + <[@]cString1> first string + second string + $RETURNS$ + string with bitwise AND combined ASCII values + $DESCRIPTION$ + The CHARAND() function constructs a new string from the two strings + passed as parameters. To do this, it combines the ASCII values of the + corresponding characters of both strings with a bitwise AND-operation + and places a character in the resulting string whose ASCII value + equals to the result of that operation. + If the first string is passed by reference, the resulting string is + stored in , too. By setting the CSETREF()-switch to .T., + the return value can be omitted. + If is shorter than and the last character of + has been processed, the function restarts with the first + character of . + $EXAMPLES$ + // clear the LSB + ? charand( "012345678", Chr( 254 ) ) // --> "002244668" + ? charand( "012345678", Chr( 254 ) + Chr( 252 ) ) // --> "002044648" + $TESTS$ + charand( "012345678", Chr( 254 ) ) == "002244668" + charand( "012345678", Chr( 254 ) + Chr( 252 ) ) == "002044648" + $STATUS$ + Ready + $COMPLIANCE$ + CHARAND() is compatible with CT3's CHARAND(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARADD() CHARSUB() CHARNOT() + CHAROR() CHARXOR() CHARSHL() + CHARSHR() CHARRLL() CHARRLR() + CSETREF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARNOT() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Process each character in a string with bitwise NOT operation - * $SYNTAX$ - * CHARNOT( <[@]cString> ) --> cNotString - * $ARGUMENTS$ - * <[@]cString> string to be processed - * $RETURNS$ - * string with bitwise negated characters - * $DESCRIPTION$ - * The CHARNOT() function constructs a new string from the string - * passed as parameter. To do this, it performs a bitwise NOT operation - * to the characters of the string and places a character in - * the resulting string whose ASCII value equals to the result of that - * operation. It can be easily seen that the resulting ASCII-value equals - * 255 minus input ASCII value. - * If the string is passed by reference, the resulting string is - * stored in , too. By setting the CSETREF()-switch to .T., - * the return value can be omitted. - * $EXAMPLES$ - * ? charnot( Chr( 85 ) + Chr( 128 ) + Chr( 170 ) + Chr( 1 ) ) // --> Chr( 170 ) + Chr( 127 ) + Chr( 85 ) + Chr( 254 ) - * ? charnot( charnot( "This is a test!" ) ) --> "This is a test!" - * $TESTS$ - * charnot( Chr( 85 ) + Chr( 128 ) + Chr( 170 ) + Chr( 1 ) ) == Chr( 170 ) + Chr( 127 ) + Chr( 85 ) + Chr( 254 ) - * charnot( charnot( "This is a test!" ) ) == "This is a test!" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARNOT() is compatible with CT3's CHARNOT(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARADD() CHARSUB() CHARAND() - * CHAROR() CHARXOR() CHARSHL() - * CHARSHR() CHARRLL() CHARRLR() - * CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARNOT() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Process each character in a string with bitwise NOT operation + $SYNTAX$ + CHARNOT( <[@]cString> ) --> cNotString + $ARGUMENTS$ + <[@]cString> string to be processed + $RETURNS$ + string with bitwise negated characters + $DESCRIPTION$ + The CHARNOT() function constructs a new string from the string + passed as parameter. To do this, it performs a bitwise NOT operation + to the characters of the string and places a character in + the resulting string whose ASCII value equals to the result of that + operation. It can be easily seen that the resulting ASCII-value equals + 255 minus input ASCII value. + If the string is passed by reference, the resulting string is + stored in , too. By setting the CSETREF()-switch to .T., + the return value can be omitted. + $EXAMPLES$ + ? charnot( Chr( 85 ) + Chr( 128 ) + Chr( 170 ) + Chr( 1 ) ) // --> Chr( 170 ) + Chr( 127 ) + Chr( 85 ) + Chr( 254 ) + ? charnot( charnot( "This is a test!" ) ) --> "This is a test!" + $TESTS$ + charnot( Chr( 85 ) + Chr( 128 ) + Chr( 170 ) + Chr( 1 ) ) == Chr( 170 ) + Chr( 127 ) + Chr( 85 ) + Chr( 254 ) + charnot( charnot( "This is a test!" ) ) == "This is a test!" + $STATUS$ + Ready + $COMPLIANCE$ + CHARNOT() is compatible with CT3's CHARNOT(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARADD() CHARSUB() CHARAND() + CHAROR() CHARXOR() CHARSHL() + CHARSHR() CHARRLL() CHARRLR() + CSETREF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CHAROR() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Combine corresponding ASCII value of two strings with bitwise OR - * $SYNTAX$ - * CHAROR( <[@]cString1>, ) --> cOrString - * $ARGUMENTS$ - * <[@]cString1> first string - * second string - * $RETURNS$ - * string with bitwise OR combined ASCII values - * $DESCRIPTION$ - * The CHAROR() function constructs a new string from the two strings - * passed as parameters. To do this, it combines the ASCII values of the - * corresponding characters of both strings with a bitwise OR-operation - * and places a character in the resulting string whose ASCII value - * equals to the result of that operation. - * If the first string is passed by reference, the resulting string is - * stored in , too. By setting the CSETREF()-switch to .T., - * the return value can be omitted. - * If is shorter than and the last character of - * has been processed, the function restarts with the first - * character of . - * $EXAMPLES$ - * // set the LSB - * ? charor( "012345678", Chr( 1 ) ) // --> "113355779" - * ? charor( "012345678", Chr( 1 ) + Chr( 3 ) ) // --> "133357779" - * $TESTS$ - * charor( "012345678", Chr( 1 ) ) == "113355779" - * charor( "012345678", Chr( 1 ) + Chr( 3 ) ) == "133357779" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHAROR() is compatible with CT3's CHAROR(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARADD() CHARSUB() CHARNOT() - * CHARAND() CHARXOR() CHARSHL() - * CHARSHR() CHARRLL() CHARRLR() - * CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHAROR() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Combine corresponding ASCII value of two strings with bitwise OR + $SYNTAX$ + CHAROR( <[@]cString1>, ) --> cOrString + $ARGUMENTS$ + <[@]cString1> first string + second string + $RETURNS$ + string with bitwise OR combined ASCII values + $DESCRIPTION$ + The CHAROR() function constructs a new string from the two strings + passed as parameters. To do this, it combines the ASCII values of the + corresponding characters of both strings with a bitwise OR-operation + and places a character in the resulting string whose ASCII value + equals to the result of that operation. + If the first string is passed by reference, the resulting string is + stored in , too. By setting the CSETREF()-switch to .T., + the return value can be omitted. + If is shorter than and the last character of + has been processed, the function restarts with the first + character of . + $EXAMPLES$ + // set the LSB + ? charor( "012345678", Chr( 1 ) ) // --> "113355779" + ? charor( "012345678", Chr( 1 ) + Chr( 3 ) ) // --> "133357779" + $TESTS$ + charor( "012345678", Chr( 1 ) ) == "113355779" + charor( "012345678", Chr( 1 ) + Chr( 3 ) ) == "133357779" + $STATUS$ + Ready + $COMPLIANCE$ + CHAROR() is compatible with CT3's CHAROR(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARADD() CHARSUB() CHARNOT() + CHARAND() CHARXOR() CHARSHL() + CHARSHR() CHARRLL() CHARRLR() + CSETREF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARXOR() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Combine corresponding ASCII value of two strings with bitwise XOR - * $SYNTAX$ - * CHARXOR( <[@]cString1>, ) --> cXOrString - * $ARGUMENTS$ - * <[@]cString1> first string - * second string - * $RETURNS$ - * string with bitwise XOR combined ASCII values - * $DESCRIPTION$ - * The CHARXOR() function constructs a new string from the two strings - * passed as parameters. To do this, it combines the ASCII values of the - * corresponding characters of both strings with a bitwise XOR-operation - * and places a character in the resulting string whose ASCII value - * equals to the result of that operation. - * If the first string is passed by reference, the resulting string is - * stored in , too. By setting the CSETREF()-switch to .T., - * the return value can be omitted. - * If is shorter than and the last character of - * has been processed, the function restarts with the first - * character of . - * $EXAMPLES$ - * // easy encryption - * ? charxor( "This is top secret !", "My Password" ) // --> - * $TESTS$ - * charxor( charxor( "This is top secret !", "My Password" ), "My Password" ) == "This is top secret !" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARXOR() is compatible with CT3's CHARXOR(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARADD() CHARSUB() CHARNOT() - * CHARAND() CHAROR() CHARSHL() - * CHARSHR() CHARRLL() CHARRLR() - * CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARXOR() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Combine corresponding ASCII value of two strings with bitwise XOR + $SYNTAX$ + CHARXOR( <[@]cString1>, ) --> cXOrString + $ARGUMENTS$ + <[@]cString1> first string + second string + $RETURNS$ + string with bitwise XOR combined ASCII values + $DESCRIPTION$ + The CHARXOR() function constructs a new string from the two strings + passed as parameters. To do this, it combines the ASCII values of the + corresponding characters of both strings with a bitwise XOR-operation + and places a character in the resulting string whose ASCII value + equals to the result of that operation. + If the first string is passed by reference, the resulting string is + stored in , too. By setting the CSETREF()-switch to .T., + the return value can be omitted. + If is shorter than and the last character of + has been processed, the function restarts with the first + character of . + $EXAMPLES$ + // easy encryption + ? charxor( "This is top secret !", "My Password" ) // --> + $TESTS$ + charxor( charxor( "This is top secret !", "My Password" ), "My Password" ) == "This is top secret !" + $STATUS$ + Ready + $COMPLIANCE$ + CHARXOR() is compatible with CT3's CHARXOR(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARADD() CHARSUB() CHARNOT() + CHARAND() CHAROR() CHARSHL() + CHARSHR() CHARRLL() CHARRLR() + CSETREF() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/charophb.txt b/harbour/contrib/hbct/doc/en/charophb.txt index 3fa4b1241b..13a9cca7a9 100644 --- a/harbour/contrib/hbct/doc/en/charophb.txt +++ b/harbour/contrib/hbct/doc/en/charophb.txt @@ -2,236 +2,236 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARSUB() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Subtracts corresponding ASCII value of two strings - * $SYNTAX$ - * CHARSUB( <[@]cString1>, ) --> cSubString - * $ARGUMENTS$ - * <[@]cString1> first string - * second string - * $RETURNS$ - * string with subtracted ASCII values - * $DESCRIPTION$ - * The CHARSUB() function constructs a new string from the two strings - * passed as parameters. To do this, it subtracts the ASCII values of the - * corresponding characters of both strings and places a character in - * the resulting string whose ASCII value equals to that difference (modulo 256). - * If the first string is passed by reference, the resulting string is - * stored in , too. By setting the CSETREF()-switch to .T., - * the return value can be omitted. - * If is shorter than and the last character of - * has been processed, the function restarts with the first - * character of . - * $EXAMPLES$ - * ? charsub( "012345678", Chr( 1 ) ) // --> "/01234567" - * ? charsub( "123456789", Chr( 255 ) ) // --> "23456789:" - * ? charsub( "9999", Chr( 0 ) + Chr( 1 ) + Chr( 2 ) + Chr( 3 ) ) // --> "9876" - * $TESTS$ - * charsub( "123456789", Chr( 1 ) ) == "012345678" - * charsub( "123456789", Chr( 1 ) + Chr( 2 ) ) == "002244668" - * charsub( "012345678", Chr( 255 ) ) == "123456789" - * charsub( "012345678", Chr( 255 ) + Chr( 254 ) ) == "133557799" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARSUB() is a new function that is only available in Harbour's CT3 lib. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARADD() CHARAND() CHARNOT() - * CHAROR() CHARXOR() CHARSHL() - * CHARSHR() CHARRLL() CHARRLR() - * CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARSUB() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Subtracts corresponding ASCII value of two strings + $SYNTAX$ + CHARSUB( <[@]cString1>, ) --> cSubString + $ARGUMENTS$ + <[@]cString1> first string + second string + $RETURNS$ + string with subtracted ASCII values + $DESCRIPTION$ + The CHARSUB() function constructs a new string from the two strings + passed as parameters. To do this, it subtracts the ASCII values of the + corresponding characters of both strings and places a character in + the resulting string whose ASCII value equals to that difference (modulo 256). + If the first string is passed by reference, the resulting string is + stored in , too. By setting the CSETREF()-switch to .T., + the return value can be omitted. + If is shorter than and the last character of + has been processed, the function restarts with the first + character of . + $EXAMPLES$ + ? charsub( "012345678", Chr( 1 ) ) // --> "/01234567" + ? charsub( "123456789", Chr( 255 ) ) // --> "23456789:" + ? charsub( "9999", Chr( 0 ) + Chr( 1 ) + Chr( 2 ) + Chr( 3 ) ) // --> "9876" + $TESTS$ + charsub( "123456789", Chr( 1 ) ) == "012345678" + charsub( "123456789", Chr( 1 ) + Chr( 2 ) ) == "002244668" + charsub( "012345678", Chr( 255 ) ) == "123456789" + charsub( "012345678", Chr( 255 ) + Chr( 254 ) ) == "133557799" + $STATUS$ + Ready + $COMPLIANCE$ + CHARSUB() is a new function that is only available in Harbour's CT3 lib. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARADD() CHARAND() CHARNOT() + CHAROR() CHARXOR() CHARSHL() + CHARSHR() CHARRLL() CHARRLR() + CSETREF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARSHL() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Process each character in a string with bitwise SHIFT LEFT operation - * $SYNTAX$ - * CHARSHL( <[@]cString>, ) --> cSHLString - * $ARGUMENTS$ - * <[@]cString> string to be processed - * number of bit positions to be shifted to the left - * $RETURNS$ - * string with bitwise shifted left characters - * $DESCRIPTION$ - * The CHARSHL() function constructs a new string from the string - * passed as parameter. To do this, it performs a bitwise SHIFT LEFT - * (SHL) operation to the characters of the string and places a character in - * the resulting string whose ASCII value equals to the result of that - * operation. - * Be aware that bits shifted out of the byte are lost. If you need - * a bit rotation, use the CHARRLL() function instead. - * If the string is passed by reference, the resulting string is - * stored in , too. By setting the CSETREF()-switch to .T., - * the return value can be omitted. - * $EXAMPLES$ - * ? charshl( Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128), 3 ) - * // --> Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128)+Chr(0)+Chr(0)+Chr(0) - * $TESTS$ - * charshl( Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128), 3 ) == Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128)+Chr(0)+Chr(0)+Chr(0) - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARSHL() is a new function that is only available in Harbour's CT3 lib. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARADD() CHARSUB() CHARAND() - * CHAROR() CHARXOR() CHARNOT() - * CHARSHR() CHARRLL() CHARRLR() - * CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARSHL() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Process each character in a string with bitwise SHIFT LEFT operation + $SYNTAX$ + CHARSHL( <[@]cString>, ) --> cSHLString + $ARGUMENTS$ + <[@]cString> string to be processed + number of bit positions to be shifted to the left + $RETURNS$ + string with bitwise shifted left characters + $DESCRIPTION$ + The CHARSHL() function constructs a new string from the string + passed as parameter. To do this, it performs a bitwise SHIFT LEFT + (SHL) operation to the characters of the string and places a character in + the resulting string whose ASCII value equals to the result of that + operation. + Be aware that bits shifted out of the byte are lost. If you need + a bit rotation, use the CHARRLL() function instead. + If the string is passed by reference, the resulting string is + stored in , too. By setting the CSETREF()-switch to .T., + the return value can be omitted. + $EXAMPLES$ + ? charshl( Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128), 3 ) + // --> Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128)+Chr(0)+Chr(0)+Chr(0) + $TESTS$ + charshl( Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128), 3 ) == Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128)+Chr(0)+Chr(0)+Chr(0) + $STATUS$ + Ready + $COMPLIANCE$ + CHARSHL() is a new function that is only available in Harbour's CT3 lib. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARADD() CHARSUB() CHARAND() + CHAROR() CHARXOR() CHARNOT() + CHARSHR() CHARRLL() CHARRLR() + CSETREF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARSHR() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Process each character in a string with bitwise SHIFT RIGHT operation - * $SYNTAX$ - * CHARSHR( <[@]cString>, ) --> cSHRString - * $ARGUMENTS$ - * <[@]cString> string to be processed - * number of bit positions to be shifted to the right - * $RETURNS$ - * string with bitwise shifted right characters - * $DESCRIPTION$ - * The CHARSHR() function constructs a new string from the string - * passed as parameter. To do this, it performs a bitwise SHIFT RIGHT - * (SHR) operation to the characters of the string and places a character in - * the resulting string whose ASCII value equals to the result of that - * operation. - * Be aware that bits shifted out of the byte are lost. If you need - * a bit rotation, use the CHARRLR() function instead. - * If the string is passed by reference, the resulting string is - * stored in , too. By setting the CSETREF()-switch to .T., - * the return value can be omitted. - * $EXAMPLES$ - * ? charshr( Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128), 3 ) - * // --> Chr(0)+Chr(0)+Chr(0)+Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16) - * $TESTS$ - * charshr( Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128), 3 ) == Chr(0)+Chr(0)+Chr(0)+Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16) - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARSHR() is a new function that is only available in Harbour's CT3 lib. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARADD() CHARSUB() CHARAND() - * CHAROR() CHARXOR() CHARNOT() - * CHARSHL() CHARRLL() CHARRLR() - * CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARSHR() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Process each character in a string with bitwise SHIFT RIGHT operation + $SYNTAX$ + CHARSHR( <[@]cString>, ) --> cSHRString + $ARGUMENTS$ + <[@]cString> string to be processed + number of bit positions to be shifted to the right + $RETURNS$ + string with bitwise shifted right characters + $DESCRIPTION$ + The CHARSHR() function constructs a new string from the string + passed as parameter. To do this, it performs a bitwise SHIFT RIGHT + (SHR) operation to the characters of the string and places a character in + the resulting string whose ASCII value equals to the result of that + operation. + Be aware that bits shifted out of the byte are lost. If you need + a bit rotation, use the CHARRLR() function instead. + If the string is passed by reference, the resulting string is + stored in , too. By setting the CSETREF()-switch to .T., + the return value can be omitted. + $EXAMPLES$ + ? charshr( Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128), 3 ) + // --> Chr(0)+Chr(0)+Chr(0)+Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16) + $TESTS$ + charshr( Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128), 3 ) == Chr(0)+Chr(0)+Chr(0)+Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16) + $STATUS$ + Ready + $COMPLIANCE$ + CHARSHR() is a new function that is only available in Harbour's CT3 lib. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARADD() CHARSUB() CHARAND() + CHAROR() CHARXOR() CHARNOT() + CHARSHL() CHARRLL() CHARRLR() + CSETREF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARRLL() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Process each character in a string with bitwise ROLL LEFT operation - * $SYNTAX$ - * CHARRLL( <[@]cString>, ) --> cRLLString - * $ARGUMENTS$ - * <[@]cString> string to be processed - * number of bit positions to be rolled to the left - * $RETURNS$ - * string with bitwise rolled left characters - * $DESCRIPTION$ - * The CHARRLL() function constructs a new string from the string - * passed as parameter. To do this, it performs a bitwise ROLL LEFT - * (RLL) operation to the characters of the string and places a character in - * the resulting string whose ASCII value equals to the result of that - * operation. - * Be aware that, in contrast to CHARSHL(), bits rolled out on - * the left are put in again on the right. - * If the string is passed by reference, the resulting string is - * stored in , too. By setting the CSETREF()-switch to .T., - * the return value can be omitted. - * $EXAMPLES$ - * ? charrll( Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128), 3 ) - * // --> Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128)+Chr(1)+Chr(2)+Chr(4) - * $TESTS$ - * charrll( Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128), 3 ) == Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128)+Chr(1)+Chr(2)+Chr(4) - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARRLL() is a new function that is only available in Harbour's CT3 lib. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARADD() CHARSUB() CHARAND() - * CHAROR() CHARXOR() CHARNOT() - * CHARSHL() CHARSHR() CHARRLR() - * CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARRLL() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Process each character in a string with bitwise ROLL LEFT operation + $SYNTAX$ + CHARRLL( <[@]cString>, ) --> cRLLString + $ARGUMENTS$ + <[@]cString> string to be processed + number of bit positions to be rolled to the left + $RETURNS$ + string with bitwise rolled left characters + $DESCRIPTION$ + The CHARRLL() function constructs a new string from the string + passed as parameter. To do this, it performs a bitwise ROLL LEFT + (RLL) operation to the characters of the string and places a character in + the resulting string whose ASCII value equals to the result of that + operation. + Be aware that, in contrast to CHARSHL(), bits rolled out on + the left are put in again on the right. + If the string is passed by reference, the resulting string is + stored in , too. By setting the CSETREF()-switch to .T., + the return value can be omitted. + $EXAMPLES$ + ? charrll( Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128), 3 ) + // --> Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128)+Chr(1)+Chr(2)+Chr(4) + $TESTS$ + charrll( Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128), 3 ) == Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128)+Chr(1)+Chr(2)+Chr(4) + $STATUS$ + Ready + $COMPLIANCE$ + CHARRLL() is a new function that is only available in Harbour's CT3 lib. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARADD() CHARSUB() CHARAND() + CHAROR() CHARXOR() CHARNOT() + CHARSHL() CHARSHR() CHARRLR() + CSETREF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARRLR() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Process each character in a string with bitwise ROLL RIGHT operation - * $SYNTAX$ - * CHARRLR( <[@]cString>, ) --> cRLRString - * $ARGUMENTS$ - * <[@]cString> string to be processed - * number of bit positions to be rolled to the right - * $RETURNS$ - * string with bitwise rolled right characters - * $DESCRIPTION$ - * The CHARRLR() function constructs a new string from the string - * passed as parameter. To do this, it performs a bitwise ROLL RIGHT - * (RLR) operation to the characters of the string and places a character in - * the resulting string whose ASCII value equals to the result of that - * operation. - * Be aware that, in contrast to CHARSHR(), bits rolled out on - * the right are put in again on the left. - * If the string is passed by reference, the resulting string is - * stored in , too. By setting the CSETREF()-switch to .T., - * the return value can be omitted. - * $EXAMPLES$ - * ? charrlr( Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128), 3 ) - * // --> Chr(32)+Chr(64)+Chr(128)+Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16) - * $TESTS$ - * charrlr( Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128), 3 ) == Chr(32)+Chr(64)+Chr(128)+Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16) - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARRLR() is a new function that is only available in Harbour's CT3 lib. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARADD() CHARSUB() CHARAND() - * CHAROR() CHARXOR() CHARNOT() - * CHARSHL() CHARSHR() CHARRLL() - * CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARRLR() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Process each character in a string with bitwise ROLL RIGHT operation + $SYNTAX$ + CHARRLR( <[@]cString>, ) --> cRLRString + $ARGUMENTS$ + <[@]cString> string to be processed + number of bit positions to be rolled to the right + $RETURNS$ + string with bitwise rolled right characters + $DESCRIPTION$ + The CHARRLR() function constructs a new string from the string + passed as parameter. To do this, it performs a bitwise ROLL RIGHT + (RLR) operation to the characters of the string and places a character in + the resulting string whose ASCII value equals to the result of that + operation. + Be aware that, in contrast to CHARSHR(), bits rolled out on + the right are put in again on the left. + If the string is passed by reference, the resulting string is + stored in , too. By setting the CSETREF()-switch to .T., + the return value can be omitted. + $EXAMPLES$ + ? charrlr( Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128), 3 ) + // --> Chr(32)+Chr(64)+Chr(128)+Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16) + $TESTS$ + charrlr( Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16)+Chr(32)+Chr(64)+Chr(128), 3 ) == Chr(32)+Chr(64)+Chr(128)+Chr(1)+Chr(2)+Chr(4)+Chr(8)+Chr(16) + $STATUS$ + Ready + $COMPLIANCE$ + CHARRLR() is a new function that is only available in Harbour's CT3 lib. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARADD() CHARSUB() CHARAND() + CHAROR() CHARXOR() CHARNOT() + CHARSHL() CHARSHR() CHARRLL() + CSETREF() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/charrepl.txt b/harbour/contrib/hbct/doc/en/charrepl.txt index 39933e15da..58e8cf7d36 100644 --- a/harbour/contrib/hbct/doc/en/charrepl.txt +++ b/harbour/contrib/hbct/doc/en/charrepl.txt @@ -2,66 +2,66 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARREPL() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Replacement of characters - * $SYNTAX$ - * CHARREPL( , <[@]cString>, - * , [] ) -> cString - * $ARGUMENTS$ - * is a string of characters that should be replaced - * <[@]cString> is the processed string - * is a string of characters that replace the one - * of - * [] sets the replacement method (see description) - * Default: .F. - * $RETURNS$ - * the processed string - * $DESCRIPTION$ - * The CHARREPL() function replaces certain characters in - * with others depending on the setting of . - * If is set to .F., the function takes the characters of - * one after the other, searches for them in - * and, if successful, replaces them with the corresponding character - * of . Be aware that if the same characters occur - * in both and , the character on a - * certain position in can be replaced multiple times. - * if is set to .T., the function takes the characters in - * one after the other, searches for them in and, if - * successful, replaces them with the corresponding character of - * . Note that no multiple replacements are possible - * in this mode. - * If is shorter than , the last - * character of is used as corresponding character - * for the the "rest" of . - * One can omit the return value by setting the CSETREF() switch to .T., - * but then one must pass by reference to get the result. - * $EXAMPLES$ - * ? charrepl( "1234", "1x2y3z", "abcd" ) // "axbycz" - * ? charrepl( "abcdefghij", "jhfdb", "1234567890" ) // "08642" - * ? charrepl( "abcdefghij", "jhfdb", "12345" ) // "55542" - * ? charrepl( "1234", "1234", "234A" ) // "AAAA" - * ? charrepl( "1234", "1234", "234A", .T. ) // "234A" - * $TESTS$ - * charrepl( "1234", "1x2y3z", "abcd" ) == "axbycz" - * charrepl( "abcdefghij", "jhfdb", "1234567890" ) == "08642" - * charrepl( "abcdefghij", "jhfdb", "12345" ) == "55542" - * charrepl( "1234", "1234", "234A" ) == "AAAA" - * charrepl( "1234", "1234", "234A", .T. ) == "234A" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARREPL() is compatible with CT3's CHARREPL(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * WORDREPL() POSREPL() RANGEREPL() - * CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARREPL() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Replacement of characters + $SYNTAX$ + CHARREPL( , <[@]cString>, + , [] ) -> cString + $ARGUMENTS$ + is a string of characters that should be replaced + <[@]cString> is the processed string + is a string of characters that replace the one + of + [] sets the replacement method (see description) + Default: .F. + $RETURNS$ + the processed string + $DESCRIPTION$ + The CHARREPL() function replaces certain characters in + with others depending on the setting of . + If is set to .F., the function takes the characters of + one after the other, searches for them in + and, if successful, replaces them with the corresponding character + of . Be aware that if the same characters occur + in both and , the character on a + certain position in can be replaced multiple times. + if is set to .T., the function takes the characters in + one after the other, searches for them in and, if + successful, replaces them with the corresponding character of + . Note that no multiple replacements are possible + in this mode. + If is shorter than , the last + character of is used as corresponding character + for the the "rest" of . + One can omit the return value by setting the CSETREF() switch to .T., + but then one must pass by reference to get the result. + $EXAMPLES$ + ? charrepl( "1234", "1x2y3z", "abcd" ) // "axbycz" + ? charrepl( "abcdefghij", "jhfdb", "1234567890" ) // "08642" + ? charrepl( "abcdefghij", "jhfdb", "12345" ) // "55542" + ? charrepl( "1234", "1234", "234A" ) // "AAAA" + ? charrepl( "1234", "1234", "234A", .T. ) // "234A" + $TESTS$ + charrepl( "1234", "1x2y3z", "abcd" ) == "axbycz" + charrepl( "abcdefghij", "jhfdb", "1234567890" ) == "08642" + charrepl( "abcdefghij", "jhfdb", "12345" ) == "55542" + charrepl( "1234", "1234", "234A" ) == "AAAA" + charrepl( "1234", "1234", "234A", .T. ) == "234A" + $STATUS$ + Ready + $COMPLIANCE$ + CHARREPL() is compatible with CT3's CHARREPL(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + WORDREPL() POSREPL() RANGEREPL() + CSETREF() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/charsort.txt b/harbour/contrib/hbct/doc/en/charsort.txt index fbd593ca61..032eda29f2 100644 --- a/harbour/contrib/hbct/doc/en/charsort.txt +++ b/harbour/contrib/hbct/doc/en/charsort.txt @@ -2,83 +2,83 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARSORT() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Sort sequences within a string. - * $SYNTAX$ - * CHARSORT( <[@]cString>, [], [], - * [], [], [], - * [] ) -> cSortedString - * $ARGUMENTS$ - * <[@]cString> is the string that should be processed - * [] specifies the length of the elements that - * should be sorted - * Default: 1 - * [] specifies how many characters within one - * element should be used for comparison - * Default: - * [] specifies the number of characters at the - * beginning of that should be ignored - * in the sort process - * Default: 0 - * [] specifies the offset of the comparison string - * within a element - * Default: 0 - * [] specifies how many characters in , - * starting from the position, - * should be sorted - * Default: len(cString)-nIgnoreCharacters - * []) specifies whether the process should - * sort descending or not - * $RETURNS$ - * the string resulting from the sort process - * $DESCRIPTION$ - * The CHARSORT function sorts the characters within a string . - * With the parameters and , you can - * determine that only the substring from position +1 - * to position + within should - * be sorted. - * The sorting algorithm is determined with the other parameters. - * specifies the length of one element, i.e. there are - * / elements that are sorted. Note that - * surplus characters are not sorted but stay at their position. - * To do the sorting, the function uses the Quicksort algorithm implemented - * in the C-lib qsort() function. This algorithm needs to know how to compare - * and order two elements. This is done by comparing the ASCII values of - * a substring within each element. This substring is determined by the - * parameters and and the order - * by . - * By setting the CSETREF() switch to .T., one can omit the return value - * of the function, but one must then pass by reference. - * $EXAMPLES$ - * ? CHARSORT( "qwert" ) // "eqrtw" - * ? CHARSORT( "qwert", 2 ) // "erqwt" - * ? CHARSORT( "b1a4a3a2a1", 2, 1 ) // "a2a1a3a4b1" - * ? CHARSORT( "XXXqwert", 1, 1, 3 ) // "XXXeqrtw" - * ? CHARSORT( "b1a4a3a2a1", 2, 1, 0, 1 ) // "a1b1a2a3a4" - * ? CHARSORT( "384172852", 1, 1, 0, 0, 4 ) // "134872852" - * ? CHARSORT( "qwert", .T. ) // "wtrqe" - * $TESTS$ - * CHARSORT( "qwert" ) == "eqrtw" - * CHARSORT( "qwert", 2 ) == "erqwt" - * CHARSORT( "b1a4a3a2a1", 2, 1 ) == "a2a1a3a4b1" - * CHARSORT( "XXXqwert", 1, 1, 3 ) == "XXXeqrtw" - * CHARSORT( "b1a4a3a2a1", 2, 1, 0, 1 ) == "a1b1a2a3a4" - * CHARSORT( "384172852", 1, 1, 0, 0, 4 ) == "134872852" - * CHARSORT( "qwert", .T. ) == "wtrqe" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARSORT() is compatible with CT3's CHARSORT(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARSORT() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Sort sequences within a string. + $SYNTAX$ + CHARSORT( <[@]cString>, [], [], + [], [], [], + [] ) -> cSortedString + $ARGUMENTS$ + <[@]cString> is the string that should be processed + [] specifies the length of the elements that + should be sorted + Default: 1 + [] specifies how many characters within one + element should be used for comparison + Default: + [] specifies the number of characters at the + beginning of that should be ignored + in the sort process + Default: 0 + [] specifies the offset of the comparison string + within a element + Default: 0 + [] specifies how many characters in , + starting from the position, + should be sorted + Default: len(cString)-nIgnoreCharacters + []) specifies whether the process should + sort descending or not + $RETURNS$ + the string resulting from the sort process + $DESCRIPTION$ + The CHARSORT function sorts the characters within a string . + With the parameters and , you can + determine that only the substring from position +1 + to position + within should + be sorted. + The sorting algorithm is determined with the other parameters. + specifies the length of one element, i.e. there are + / elements that are sorted. Note that + surplus characters are not sorted but stay at their position. + To do the sorting, the function uses the Quicksort algorithm implemented + in the C-lib qsort() function. This algorithm needs to know how to compare + and order two elements. This is done by comparing the ASCII values of + a substring within each element. This substring is determined by the + parameters and and the order + by . + By setting the CSETREF() switch to .T., one can omit the return value + of the function, but one must then pass by reference. + $EXAMPLES$ + ? CHARSORT( "qwert" ) // "eqrtw" + ? CHARSORT( "qwert", 2 ) // "erqwt" + ? CHARSORT( "b1a4a3a2a1", 2, 1 ) // "a2a1a3a4b1" + ? CHARSORT( "XXXqwert", 1, 1, 3 ) // "XXXeqrtw" + ? CHARSORT( "b1a4a3a2a1", 2, 1, 0, 1 ) // "a1b1a2a3a4" + ? CHARSORT( "384172852", 1, 1, 0, 0, 4 ) // "134872852" + ? CHARSORT( "qwert", .T. ) // "wtrqe" + $TESTS$ + CHARSORT( "qwert" ) == "eqrtw" + CHARSORT( "qwert", 2 ) == "erqwt" + CHARSORT( "b1a4a3a2a1", 2, 1 ) == "a2a1a3a4b1" + CHARSORT( "XXXqwert", 1, 1, 3 ) == "XXXeqrtw" + CHARSORT( "b1a4a3a2a1", 2, 1, 0, 1 ) == "a1b1a2a3a4" + CHARSORT( "384172852", 1, 1, 0, 0, 4 ) == "134872852" + CHARSORT( "qwert", .T. ) == "wtrqe" + $STATUS$ + Ready + $COMPLIANCE$ + CHARSORT() is compatible with CT3's CHARSORT(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CSETREF() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/charswap.txt b/harbour/contrib/hbct/doc/en/charswap.txt index 164d027d46..2381238b71 100644 --- a/harbour/contrib/hbct/doc/en/charswap.txt +++ b/harbour/contrib/hbct/doc/en/charswap.txt @@ -2,84 +2,84 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARSWAP() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Swap neighbouring characters in a string - * $SYNTAX$ - * CHARSWAP( <[@]cString> ) -> cSwappedString - * $ARGUMENTS$ - * <[@]cString> is the string that should be processed - * $RETURNS$ - * a string where neighbour characters are swapped - * $DESCRIPTION$ - * The CHARSWAP() function loops through in steps of two - * characters and exchanges the characters from the odd and the even - * positions. - * By setting the CSETREF() switch to .T., one can omit the return value - * of this functin, but one must then pass by reference. - * $EXAMPLES$ - * ? CHARSWAP( "0123456789" ) // "1032547698" - * ? CHARSWAP( "ABCDEFGHIJK" ) // "BADCFEHGJIK" - * $TESTS$ - * CHARSWAP( "0123456789" ) == "1032547698" - * CHARSWAP( "ABCDEFGHIJK" ) == "BADCFEHGJIK" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CHARSWAP() is compatible with CT3's CHARSWAP(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * WORDSWAP(),CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARSWAP() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Swap neighbouring characters in a string + $SYNTAX$ + CHARSWAP( <[@]cString> ) -> cSwappedString + $ARGUMENTS$ + <[@]cString> is the string that should be processed + $RETURNS$ + a string where neighbour characters are swapped + $DESCRIPTION$ + The CHARSWAP() function loops through in steps of two + characters and exchanges the characters from the odd and the even + positions. + By setting the CSETREF() switch to .T., one can omit the return value + of this functin, but one must then pass by reference. + $EXAMPLES$ + ? CHARSWAP( "0123456789" ) // "1032547698" + ? CHARSWAP( "ABCDEFGHIJK" ) // "BADCFEHGJIK" + $TESTS$ + CHARSWAP( "0123456789" ) == "1032547698" + CHARSWAP( "ABCDEFGHIJK" ) == "BADCFEHGJIK" + $STATUS$ + Ready + $COMPLIANCE$ + CHARSWAP() is compatible with CT3's CHARSWAP(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + WORDSWAP(),CSETREF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * WORDSWAP() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Swap neighbouring double characters in a string - * $SYNTAX$ - * WORDSWAP( <[@]cString> [, ] ) -> cSwappedString - * $ARGUMENTS$ - * <[@]cString> is the string that should be processed - * [] specifies whether an additional swap should be - * done within the double characters - * Default: .F., no additional swap - * $RETURNS$ - * a string where neighbouring double characters are - * swapped - * $DESCRIPTION$ - * The WORDSWAP() function loops through in steps of four - * characters and exchanges the double characters from the first and - * second position with the one from the third and forth position. - * Additionally the function can perform a swap of the both char of - * each double character. - * By setting the CSETREF() switch to .T., one can omit the return value - * of this functin, but one must then pass by reference. - * $EXAMPLES$ - * ? WORDSWAP( "1234567890" ) // "3412785690" - * ? WORDSWAP( "1234567890", .T. ) // "4321876590" - * $TESTS$ - * WORDSWAP( "1234567890" ) == "3412785690" - * WORDSWAP( "1234567890", .T. ) == "4321876590" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * WORDSWAP() is compatible with CT3's WORDSWAP(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARSWAP(),CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + WORDSWAP() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Swap neighbouring double characters in a string + $SYNTAX$ + WORDSWAP( <[@]cString> [, ] ) -> cSwappedString + $ARGUMENTS$ + <[@]cString> is the string that should be processed + [] specifies whether an additional swap should be + done within the double characters + Default: .F., no additional swap + $RETURNS$ + a string where neighbouring double characters are + swapped + $DESCRIPTION$ + The WORDSWAP() function loops through in steps of four + characters and exchanges the double characters from the first and + second position with the one from the third and forth position. + Additionally the function can perform a swap of the both char of + each double character. + By setting the CSETREF() switch to .T., one can omit the return value + of this functin, but one must then pass by reference. + $EXAMPLES$ + ? WORDSWAP( "1234567890" ) // "3412785690" + ? WORDSWAP( "1234567890", .T. ) // "4321876590" + $TESTS$ + WORDSWAP( "1234567890" ) == "3412785690" + WORDSWAP( "1234567890", .T. ) == "4321876590" + $STATUS$ + Ready + $COMPLIANCE$ + WORDSWAP() is compatible with CT3's WORDSWAP(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARSWAP(),CSETREF() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/color.txt b/harbour/contrib/hbct/doc/en/color.txt index a7bf6f37cf..ee33f89248 100644 --- a/harbour/contrib/hbct/doc/en/color.txt +++ b/harbour/contrib/hbct/doc/en/color.txt @@ -2,218 +2,218 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * INVERTATTR() - * $CATEGORY$ - * CT3 video functions - * $ONELINER$ - * - * $SYNTAX$ - * - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * INVERTATTR() is compatible with CT3's INVERTATTR(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + INVERTATTR() + $CATEGORY$ + CT3 video functions + $ONELINER$ + + $SYNTAX$ + + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + INVERTATTR() is compatible with CT3's INVERTATTR(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * COLORTON() - * $CATEGORY$ - * CT3 video functions - * $ONELINER$ - * - * $SYNTAX$ - * COLORTON( ) -> - * $ARGUMENTS$ - * Designates the alphanumeric color attribute that is - * converted in NN/NN or CC/CC form. - * - * $RETURNS$ - * COLORTON() returns a number that corresponds to the combined numeric - * color attribute. - * - * $DESCRIPTION$ - * COLOR TO (N)umeric - * The function changes an alphanumeric color attribute from NN/NN or - * CC/CC into a combined numeric attribute. These combined attribute - * values are useful with the CA-Cl*pper Tools functions STRSCREEN(), - * SCREENMIX(), SCREENATTR(), and the CA-Cl*pper commands - * SAVE/RESTORE SCREEN. - * - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + COLORTON() + $CATEGORY$ + CT3 video functions + $ONELINER$ + + $SYNTAX$ + COLORTON( ) -> + $ARGUMENTS$ + Designates the alphanumeric color attribute that is + converted in NN/NN or CC/CC form. + + $RETURNS$ + COLORTON() returns a number that corresponds to the combined numeric + color attribute. + + $DESCRIPTION$ + COLOR TO (N)umeric + The function changes an alphanumeric color attribute from NN/NN or + CC/CC into a combined numeric attribute. These combined attribute + values are useful with the CA-Cl*pper Tools functions STRSCREEN(), + SCREENMIX(), SCREENATTR(), and the CA-Cl*pper commands + SAVE/RESTORE SCREEN. + + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * NTOCOLOR() - * $CATEGORY$ - * HBCT video functions - * $ONELINER$ - * - * $SYNTAX$ - * NTOCOLOR( , [] ) -> - * $ARGUMENTS$ - * Designates the value for the combined numeric color - * attributes. - * - * If designated as .F. or if the parameter is omitted, - * NTOCOLOR() returns a string with a numeric color code. - * When designated as .T., NTOCOLOR() returns a string with - * the CA-Cl*pper alpha color coding. - * - * $RETURNS$ - * NTOCOLOR() returns the designated color attribute in the NN/NN - * or CC/CC form. - * - * $DESCRIPTION$ - * NTOCOLOR() converts a color attribute returned from another function - * in numeric form, into the alphanumeric data format. Use this - * attribute in conjunction with the CA-Cl*pper SET COLOR TO command. - * - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + NTOCOLOR() + $CATEGORY$ + HBCT video functions + $ONELINER$ + + $SYNTAX$ + NTOCOLOR( , [] ) -> + $ARGUMENTS$ + Designates the value for the combined numeric color + attributes. + + If designated as .F. or if the parameter is omitted, + NTOCOLOR() returns a string with a numeric color code. + When designated as .T., NTOCOLOR() returns a string with + the CA-Cl*pper alpha color coding. + + $RETURNS$ + NTOCOLOR() returns the designated color attribute in the NN/NN + or CC/CC form. + + $DESCRIPTION$ + NTOCOLOR() converts a color attribute returned from another function + in numeric form, into the alphanumeric data format. Use this + attribute in conjunction with the CA-Cl*pper SET COLOR TO command. + + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ENHANCED() - * $CATEGORY$ - * CT3 video functions - * $ONELINER$ - * Select the "ENHANCED" color value for output - * $SYNTAX$ - * ENHANCED() -> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * ENHANCED() is compatible with CT3's ENHANCED() - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * STANDARD(),UNSELECTED() - * $END$ +/* $DOC$ + $FUNCNAME$ + ENHANCED() + $CATEGORY$ + CT3 video functions + $ONELINER$ + Select the "ENHANCED" color value for output + $SYNTAX$ + ENHANCED() -> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + ENHANCED() is compatible with CT3's ENHANCED() + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + STANDARD(),UNSELECTED() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * STANDARD() - * $CATEGORY$ - * CT3 video functions - * $ONELINER$ - * Select the "STANDARD" color value for output - * $SYNTAX$ - * STANDARD() -> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * STANDARD() is compatible with CT3's STANDARD() - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * ENHANCED(),UNSELECTED() - * $END$ +/* $DOC$ + $FUNCNAME$ + STANDARD() + $CATEGORY$ + CT3 video functions + $ONELINER$ + Select the "STANDARD" color value for output + $SYNTAX$ + STANDARD() -> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + STANDARD() is compatible with CT3's STANDARD() + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + ENHANCED(),UNSELECTED() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * UNSELECTED() - * $CATEGORY$ - * CT3 video functions - * $ONELINER$ - * Select the "UNSELECTED" color value for output - * $SYNTAX$ - * UNSELECTED() -> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * UNSELECTED() is compatible with CT3's UNSELECTED() - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * ENHANCED(),STANDARD() - * $END$ +/* $DOC$ + $FUNCNAME$ + UNSELECTED() + $CATEGORY$ + CT3 video functions + $ONELINER$ + Select the "UNSELECTED" color value for output + $SYNTAX$ + UNSELECTED() -> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + UNSELECTED() is compatible with CT3's UNSELECTED() + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + ENHANCED(),STANDARD() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/count.txt b/harbour/contrib/hbct/doc/en/count.txt index c1f834f009..4c5dcf10ca 100644 --- a/harbour/contrib/hbct/doc/en/count.txt +++ b/harbour/contrib/hbct/doc/en/count.txt @@ -2,66 +2,66 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * COUNTLEFT() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Count a certain character at the beginning of a string - * $SYNTAX$ - * COUNTLEFT( , [] ) -> nCount - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * COUNTLEFT() is compatible with CT3's COUNTLEFT(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * COUNTRIGHT() - * $END$ +/* $DOC$ + $FUNCNAME$ + COUNTLEFT() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Count a certain character at the beginning of a string + $SYNTAX$ + COUNTLEFT( , [] ) -> nCount + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + COUNTLEFT() is compatible with CT3's COUNTLEFT(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + COUNTRIGHT() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * COUNTRIGHT() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Count a certain character at the end of a string - * $SYNTAX$ - * COUNTRIGHT( , [] ) -> nCount - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * COUNTRIGHT() is compatible with CT3's COUNTRIGHT(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * COUNTLEFT() - * $END$ +/* $DOC$ + $FUNCNAME$ + COUNTRIGHT() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Count a certain character at the end of a string + $SYNTAX$ + COUNTRIGHT( , [] ) -> nCount + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + COUNTRIGHT() is compatible with CT3's COUNTRIGHT(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + COUNTLEFT() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/ct.txt b/harbour/contrib/hbct/doc/en/ct.txt index dc84a51164..c9192e268a 100644 --- a/harbour/contrib/hbct/doc/en/ct.txt +++ b/harbour/contrib/hbct/doc/en/ct.txt @@ -2,74 +2,74 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * CTINIT() - * $CATEGORY$ - * CT3 general functions - * $ONELINER$ - * Initializes the CT3 library - * $SYNTAX$ - * CTINIT() -> lInitialized - * $ARGUMENTS$ - * None - * $RETURNS$ - * lInitialized .T. if the function has been correctly initialized - * $DESCRIPTION$ - * The CTINIT() function initializes the CT3 library. - * Identical code is declared as INIT FUNCTION, thus should be executed - * automatically at the beginning of the application, but it is a good - * idea to call it once again explicitly somewhere at the beginning of - * your program to check the initialization. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CTINIT() is a new function in Harbour's CT3 library. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + CTINIT() + $CATEGORY$ + CT3 general functions + $ONELINER$ + Initializes the CT3 library + $SYNTAX$ + CTINIT() -> lInitialized + $ARGUMENTS$ + None + $RETURNS$ + lInitialized .T. if the function has been correctly initialized + $DESCRIPTION$ + The CTINIT() function initializes the CT3 library. + Identical code is declared as INIT FUNCTION, thus should be executed + automatically at the beginning of the application, but it is a good + idea to call it once again explicitly somewhere at the beginning of + your program to check the initialization. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + CTINIT() is a new function in Harbour's CT3 library. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CTEXIT() - * $CATEGORY$ - * CT3 general functions - * $ONELINER$ - * Uninitializes the CT3 library - * $SYNTAX$ - * CTEXIT() -> nil - * $ARGUMENTS$ - * none - * $RETURNS$ - * nil - * $DESCRIPTION$ - * The CTEXIT() function uninitializes the CT3 library. - * Identical code is declared as EXIT FUNCTION, thus should be executed - * automatically at the end of the application, but it is a good idea - * to call it explicitly somewhere at the end of your program to make - * sure that the deinitialization takes place. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CTEXIT() is a new function in Harbour's CT3 library. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + CTEXIT() + $CATEGORY$ + CT3 general functions + $ONELINER$ + Uninitializes the CT3 library + $SYNTAX$ + CTEXIT() -> nil + $ARGUMENTS$ + none + $RETURNS$ + nil + $DESCRIPTION$ + The CTEXIT() function uninitializes the CT3 library. + Identical code is declared as EXIT FUNCTION, thus should be executed + automatically at the end of the application, but it is a good idea + to call it explicitly somewhere at the end of your program to make + sure that the deinitialization takes place. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + CTEXIT() is a new function in Harbour's CT3 library. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/ctc.txt b/harbour/contrib/hbct/doc/en/ctc.txt index d928261d34..789159a370 100644 --- a/harbour/contrib/hbct/doc/en/ctc.txt +++ b/harbour/contrib/hbct/doc/en/ctc.txt @@ -2,111 +2,111 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * CSETARGERR() - * $CATEGORY$ - * CT3 general functions - * $ONELINER$ - * Sets argument error behaviour - * $SYNTAX$ - * CSETARGERR( [] ) -> - * $ARGUMENTS$ - * [] New argument error throwing mode - * $RETURNS$ - * The current or old argument error throwing mode. - * $DESCRIPTION$ - * All CT3 functions are very compliant in their reaction to wrong - * parameters. By using the CSETARGERR() function, you can make the - * library throw an error with the severity . It is then - * up to the error handler to substitute the return value. - * can be one of the severity modes defined in ct.ch: - * CT_ARGERR_WHOCARES corresponds to ES_WHOCARES - * CT_ARGERR_WARNING corresponds to ES_WARNING - * CT_ARGERR_ERROR corresponds to ES_ERROR - * CT_ARGERR_CATASTROPHIC corresponds to ES_CATASTROPHIC - * CT_ARGERR_IGNORE - * The last is the default behaviour and switches any argument error - * throwing off. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CSETARGERR() is a new function in Harbour's CT3 library. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + CSETARGERR() + $CATEGORY$ + CT3 general functions + $ONELINER$ + Sets argument error behaviour + $SYNTAX$ + CSETARGERR( [] ) -> + $ARGUMENTS$ + [] New argument error throwing mode + $RETURNS$ + The current or old argument error throwing mode. + $DESCRIPTION$ + All CT3 functions are very compliant in their reaction to wrong + parameters. By using the CSETARGERR() function, you can make the + library throw an error with the severity . It is then + up to the error handler to substitute the return value. + can be one of the severity modes defined in ct.ch: + CT_ARGERR_WHOCARES corresponds to ES_WHOCARES + CT_ARGERR_WARNING corresponds to ES_WARNING + CT_ARGERR_ERROR corresponds to ES_ERROR + CT_ARGERR_CATASTROPHIC corresponds to ES_CATASTROPHIC + CT_ARGERR_IGNORE + The last is the default behaviour and switches any argument error + throwing off. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + CSETARGERR() is a new function in Harbour's CT3 library. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CTCINIT() - * $CATEGORY$ - * CT3 general functions - * $ONELINER$ - * Initializes the CT3 library, C part - * $SYNTAX$ - * CTCINIT() -> lInitialized - * $ARGUMENTS$ - * None - * $RETURNS$ - * lInitialized .T. if the function has been correctly initialized - * $DESCRIPTION$ - * The CTCINIT() function initializes the C source part of the CT3 - * library. Do not call this function directly. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CTCINIT() is a new function in Harbour's CT3 library. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CTINIT(),CTEXIT() - * $END$ +/* $DOC$ + $FUNCNAME$ + CTCINIT() + $CATEGORY$ + CT3 general functions + $ONELINER$ + Initializes the CT3 library, C part + $SYNTAX$ + CTCINIT() -> lInitialized + $ARGUMENTS$ + None + $RETURNS$ + lInitialized .T. if the function has been correctly initialized + $DESCRIPTION$ + The CTCINIT() function initializes the C source part of the CT3 + library. Do not call this function directly. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + CTCINIT() is a new function in Harbour's CT3 library. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CTINIT(),CTEXIT() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CTCEXIT() - * $CATEGORY$ - * CT3 general functions - * $ONELINER$ - * Uninitializes the CT3 library, C part - * $SYNTAX$ - * CTCEXIT() -> NIL - * $ARGUMENTS$ - * none - * $RETURNS$ - * nil - * $DESCRIPTION$ - * The CTCEXIT() function uninitializes the C part of the CT3 library. - * Do not call this function directly. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CTCEXIT() is a new function in Harbour's CT3 library. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CTINIT(),CTEXIT() - * $END$ +/* $DOC$ + $FUNCNAME$ + CTCEXIT() + $CATEGORY$ + CT3 general functions + $ONELINER$ + Uninitializes the CT3 library, C part + $SYNTAX$ + CTCEXIT() -> NIL + $ARGUMENTS$ + none + $RETURNS$ + nil + $DESCRIPTION$ + The CTCEXIT() function uninitializes the C part of the CT3 library. + Do not call this function directly. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + CTCEXIT() is a new function in Harbour's CT3 library. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CTINIT(),CTEXIT() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/ctmath.txt b/harbour/contrib/hbct/doc/en/ctmath.txt index 71e9dcbf57..1aba52068c 100644 --- a/harbour/contrib/hbct/doc/en/ctmath.txt +++ b/harbour/contrib/hbct/doc/en/ctmath.txt @@ -2,68 +2,68 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * SETPREC() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Set precision of math functions - * $SYNTAX$ - * SETPREC( ) -> cEmptyString - * $ARGUMENTS$ - * digit count between 1 and 16, defaults to 16 - * $RETURNS$ - * cEmptyString this function always returns an empty string - * $DESCRIPTION$ - * Be aware that calls to this functions do _NOT_ affect the - * calculation precision of the math functions at the moment. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * SETPREC() is compatible with CT3's SETPREC. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + SETPREC() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Set precision of math functions + $SYNTAX$ + SETPREC( ) -> cEmptyString + $ARGUMENTS$ + digit count between 1 and 16, defaults to 16 + $RETURNS$ + cEmptyString this function always returns an empty string + $DESCRIPTION$ + Be aware that calls to this functions do _NOT_ affect the + calculation precision of the math functions at the moment. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + SETPREC() is compatible with CT3's SETPREC. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * GETPREC() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Get precision of math functions - * $SYNTAX$ - * GETPREC() -> nDigits - * $ARGUMENTS$ - * - * $RETURNS$ - * nDigits digit count between 1 and 16 - * $DESCRIPTION$ - * Be aware that calls to this functions do _NOT_ affect the - * calculation precision of the math functions at the moment. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * GETPREC() is compatible with CT3's GETPREC. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + GETPREC() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Get precision of math functions + $SYNTAX$ + GETPREC() -> nDigits + $ARGUMENTS$ + + $RETURNS$ + nDigits digit count between 1 and 16 + $DESCRIPTION$ + Be aware that calls to this functions do _NOT_ affect the + calculation precision of the math functions at the moment. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + GETPREC() is compatible with CT3's GETPREC. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/ctmath2.txt b/harbour/contrib/hbct/doc/en/ctmath2.txt index d19a9f275d..27f36de9f9 100644 --- a/harbour/contrib/hbct/doc/en/ctmath2.txt +++ b/harbour/contrib/hbct/doc/en/ctmath2.txt @@ -2,185 +2,185 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FLOOR() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Rounds down a number to the next integer - * $SYNTAX$ - * FLOOR( ) -> nDownRoundedNumber - * $ARGUMENTS$ - * number to round down - * $RETURNS$ - * the rounded number - * $DESCRIPTION$ - * The function FLOOR() determines the biggest integer that is smaller - * than . - * $EXAMPLES$ - * ? floor( 1.1 ) // --> 1.0 - * ? floor( -1.1 ) // --> -2.0 - * $TESTS$ - * floor( 1.1 ) == 1.0 - * floor( -1.1 ) == -2.0 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * FLOOR() is compatible with CT3's FLOOR(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CEILING - * $END$ +/* $DOC$ + $FUNCNAME$ + FLOOR() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Rounds down a number to the next integer + $SYNTAX$ + FLOOR( ) -> nDownRoundedNumber + $ARGUMENTS$ + number to round down + $RETURNS$ + the rounded number + $DESCRIPTION$ + The function FLOOR() determines the biggest integer that is smaller + than . + $EXAMPLES$ + ? floor( 1.1 ) // --> 1.0 + ? floor( -1.1 ) // --> -2.0 + $TESTS$ + floor( 1.1 ) == 1.0 + floor( -1.1 ) == -2.0 + $STATUS$ + Ready + $COMPLIANCE$ + FLOOR() is compatible with CT3's FLOOR(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CEILING + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CEILING() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Rounds up a number to the next integer - * $SYNTAX$ - * CEILING( ) -> nUpRoundedNumber - * $ARGUMENTS$ - * number to round up - * $RETURNS$ - * the rounded number - * $DESCRIPTION$ - * The function CEILING() determines the smallest integer that is bigger - * than . - * $EXAMPLES$ - * ? ceiling( 1.1 ) // --> 2.0 - * ? ceiling( -1.1 ) // --> -1.0 - * $TESTS$ - * ceiling( 1.1 ) == 2.0 - * ceiling( -1.1 ) == -1.0 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CEILING() is compatible with CT3's CEILING(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * FLOOR - * $END$ +/* $DOC$ + $FUNCNAME$ + CEILING() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Rounds up a number to the next integer + $SYNTAX$ + CEILING( ) -> nUpRoundedNumber + $ARGUMENTS$ + number to round up + $RETURNS$ + the rounded number + $DESCRIPTION$ + The function CEILING() determines the smallest integer that is bigger + than . + $EXAMPLES$ + ? ceiling( 1.1 ) // --> 2.0 + ? ceiling( -1.1 ) // --> -1.0 + $TESTS$ + ceiling( 1.1 ) == 2.0 + ceiling( -1.1 ) == -1.0 + $STATUS$ + Ready + $COMPLIANCE$ + CEILING() is compatible with CT3's CEILING(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + FLOOR + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * SIGN() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Sign of a number - * $SYNTAX$ - * SIGN( ) -> nSign - * $ARGUMENTS$ - * a number - * $RETURNS$ - * sign of - * $DESCRIPTION$ - * The function SIGN() determines the sign of . - * If is > 0, then SIGN() returns 1 - * If is < 0, then SIGN() returns -1 - * If is == 0, then SIGN() returns 0 - * $EXAMPLES$ - * ? sign( 1.1 ) // --> 1 - * ? sign( -1.1 ) // --> -1 - * ? sign( 0.0 ) // --> 0 - * $TESTS$ - * sign( 1.1 ) == 1 - * sign( -1.1 ) == -1 - * sign( 0.0 ) == 0 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * SIGN() is compatible with CT3's SIGN(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + SIGN() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Sign of a number + $SYNTAX$ + SIGN( ) -> nSign + $ARGUMENTS$ + a number + $RETURNS$ + sign of + $DESCRIPTION$ + The function SIGN() determines the sign of . + If is > 0, then SIGN() returns 1 + If is < 0, then SIGN() returns -1 + If is == 0, then SIGN() returns 0 + $EXAMPLES$ + ? sign( 1.1 ) // --> 1 + ? sign( -1.1 ) // --> -1 + ? sign( 0.0 ) // --> 0 + $TESTS$ + sign( 1.1 ) == 1 + sign( -1.1 ) == -1 + sign( 0.0 ) == 0 + $STATUS$ + Ready + $COMPLIANCE$ + SIGN() is compatible with CT3's SIGN(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * LOG10() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Decadic logarithm of a number - * $SYNTAX$ - * LOG10( ) -> nLogarithm - * $ARGUMENTS$ - * number to logarithm - * $RETURNS$ - * decadic logarithm of - * $DESCRIPTION$ - * The function LOG10() calculates the decadic logarithm of , - * i.e. 10^ == . - * $EXAMPLES$ - * ? log10( 10.0 ) // --> 1.0 - * ? log10( sqrt( 10.0 ) ) // --> 0.5 - * $TESTS$ - * log10( 10.0 ) == 1.0 - * log10( sqrt( 10.0 ) ) == 0.5 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * LOG10() is compatible with CT3's LOG10(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + LOG10() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Decadic logarithm of a number + $SYNTAX$ + LOG10( ) -> nLogarithm + $ARGUMENTS$ + number to logarithm + $RETURNS$ + decadic logarithm of + $DESCRIPTION$ + The function LOG10() calculates the decadic logarithm of , + i.e. 10^ == . + $EXAMPLES$ + ? log10( 10.0 ) // --> 1.0 + ? log10( sqrt( 10.0 ) ) // --> 0.5 + $TESTS$ + log10( 10.0 ) == 1.0 + log10( sqrt( 10.0 ) ) == 0.5 + $STATUS$ + Ready + $COMPLIANCE$ + LOG10() is compatible with CT3's LOG10(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FACT() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Calculates faculty - * $SYNTAX$ - * FACT( ) -> nFaculty - * $ARGUMENTS$ - * number between 0 and 21 - * $RETURNS$ - * the faculty of - * $DESCRIPTION$ - * The function FACT() calculates the faculty to the integer given in - * . The faculty is defined as n! = 1*2*...*n and is often - * used in statistics. Note, that faculties above 21 are too big - * so that the function must return a -1. - * $EXAMPLES$ - * ? fact( 0 ) // --> 1 - * ? fact( 1 ) // --> 1 - * ? fact( 4 ) // --> 24 - * $TESTS$ - * fact( 0 ) == 1 - * fact( 1 ) == 1 - * fact( 4 ) == 24 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * FACT() is compatible with CT3's FACT(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + FACT() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Calculates faculty + $SYNTAX$ + FACT( ) -> nFaculty + $ARGUMENTS$ + number between 0 and 21 + $RETURNS$ + the faculty of + $DESCRIPTION$ + The function FACT() calculates the faculty to the integer given in + . The faculty is defined as n! = 1*2*...*n and is often + used in statistics. Note, that faculties above 21 are too big + so that the function must return a -1. + $EXAMPLES$ + ? fact( 0 ) // --> 1 + ? fact( 1 ) // --> 1 + ? fact( 4 ) // --> 24 + $TESTS$ + fact( 0 ) == 1 + fact( 1 ) == 1 + fact( 4 ) == 24 + $STATUS$ + Ready + $COMPLIANCE$ + FACT() is compatible with CT3's FACT(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/ctpad.txt b/harbour/contrib/hbct/doc/en/ctpad.txt index b9a41e8e33..95846a5510 100644 --- a/harbour/contrib/hbct/doc/en/ctpad.txt +++ b/harbour/contrib/hbct/doc/en/ctpad.txt @@ -2,66 +2,66 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * PADLEFT() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Fills string to a certain length on the left - * $SYNTAX$ - * PADLEFT( , , [] ) -> cString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * PADLEFT() is compatible with CT3's PADLEFT(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * PADRIGHT() - * $END$ +/* $DOC$ + $FUNCNAME$ + PADLEFT() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Fills string to a certain length on the left + $SYNTAX$ + PADLEFT( , , [] ) -> cString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + PADLEFT() is compatible with CT3's PADLEFT(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + PADRIGHT() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * PADRIGHT() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Fills string to a certain length on the right - * $SYNTAX$ - * PADRIGHT( , , [] ) -> cString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * PADRIGHT() is compatible with CT3's PADRIGHT(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * PADLEFT() - * $END$ +/* $DOC$ + $FUNCNAME$ + PADRIGHT() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Fills string to a certain length on the right + $SYNTAX$ + PADRIGHT( , , [] ) -> cString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + PADRIGHT() is compatible with CT3's PADRIGHT(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + PADLEFT() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/ctstr.txt b/harbour/contrib/hbct/doc/en/ctstr.txt index 3b6e9625c5..3503242f09 100644 --- a/harbour/contrib/hbct/doc/en/ctstr.txt +++ b/harbour/contrib/hbct/doc/en/ctstr.txt @@ -2,170 +2,170 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * CSETREF() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Determine return value of reference sensitive CT3 string functions - * $SYNTAX$ - * CSETREF( [] ) -> lOldSwitch - * $ARGUMENTS$ - * [] .T. -> suppress return value - * .F. -> do not suppress return value - * $RETURNS$ - * lOldSwitch old (if lNewSwitch is a logical value) or - * current state of the switch - * $DESCRIPTION$ - * Within the CT3 functions, the following functions do not - * change the length of a string passed as parameter while - * transforming this string: - * - * ADDASCII() BLANK() CHARADD() - * CHARAND() CHARMIRR() CHARNOT() - * CHAROR() CHARRELREP() CHARREPL() - * CHARSORT() CHARSWAP() CHARXOR() - * CRYPT() JUSTLEFT() JUSTRIGHT() - * POSCHAR() POSREPL() RANGEREPL() - * REPLALL() REPLLEFT() REPLRIGHT() - * TOKENLOWER() TOKENUPPER() WORDREPL() - * WORDSWAP() - * - * Thus, these functions allow to pass the string by reference [@] to - * the function so that it may not be necessary to return the transformed - * string. By calling CSETREF (.T.), the above mentioned functions return - * the value .F. instead of the transformed string if the string is - * passed by reference to the function. - * The switch is turned off (.F.) by default. - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * This function is fully CT3 compatible. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * ADDASCII() BLANK() CHARADD() - * CHARAND() CHARMIRR() CHARNOT() - * CHAROR() CHARRELREP() CHARREPL() - * CHARSORT() CHARSWAP() CHARXOR() - * CRYPT() JUSTLEFT() JUSTRIGHT() - * POSCHAR() POSREPL() RANGEREPL() - * REPLALL() REPLLEFT() REPLRIGHT() - * TOKENLOWER() TOKENUPPER() WORDREPL() - * WORDSWAP() - * $END$ +/* $DOC$ + $FUNCNAME$ + CSETREF() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Determine return value of reference sensitive CT3 string functions + $SYNTAX$ + CSETREF( [] ) -> lOldSwitch + $ARGUMENTS$ + [] .T. -> suppress return value + .F. -> do not suppress return value + $RETURNS$ + lOldSwitch old (if lNewSwitch is a logical value) or + current state of the switch + $DESCRIPTION$ + Within the CT3 functions, the following functions do not + change the length of a string passed as parameter while + transforming this string: + + ADDASCII() BLANK() CHARADD() + CHARAND() CHARMIRR() CHARNOT() + CHAROR() CHARRELREP() CHARREPL() + CHARSORT() CHARSWAP() CHARXOR() + CRYPT() JUSTLEFT() JUSTRIGHT() + POSCHAR() POSREPL() RANGEREPL() + REPLALL() REPLLEFT() REPLRIGHT() + TOKENLOWER() TOKENUPPER() WORDREPL() + WORDSWAP() + + Thus, these functions allow to pass the string by reference [@] to + the function so that it may not be necessary to return the transformed + string. By calling CSETREF (.T.), the above mentioned functions return + the value .F. instead of the transformed string if the string is + passed by reference to the function. + The switch is turned off (.F.) by default. + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + This function is fully CT3 compatible. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + ADDASCII() BLANK() CHARADD() + CHARAND() CHARMIRR() CHARNOT() + CHAROR() CHARRELREP() CHARREPL() + CHARSORT() CHARSWAP() CHARXOR() + CRYPT() JUSTLEFT() JUSTRIGHT() + POSCHAR() POSREPL() RANGEREPL() + REPLALL() REPLLEFT() REPLRIGHT() + TOKENLOWER() TOKENUPPER() WORDREPL() + WORDSWAP() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CSETATMUPA() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Determine "multi-pass" behaviour in some string functions - * $SYNTAX$ - * CSETATMUPA( [] ) -> lOldSwitch - * $ARGUMENTS$ - * [] .T. -> turn "multi-pass" on - * .F. -> turn "multi-pass" off - * $RETURNS$ - * lOldSwitch old (if lNewSwitch is a logical value) or - * current state of the switch - * $DESCRIPTION$ - * CSETATMUPA determines how the following CT3 string functions - * - * ATNUM() AFTERATNUM() BEFORATNUM() - * ATREPL() NUMAT() ATADJUST() - * WORDTOCHAR() WORDREPL() - * - * perform their work. See the respective function documentation for a - * further description how the switch influences these functions. - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * This function is fully CT3 compatible. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * ATNUM() AFTERATNUM() BEFORATNUM() - * ATREPL() NUMAT() ATADJUST() - * WORDTOCHAR() WORDREPL() - * $END$ +/* $DOC$ + $FUNCNAME$ + CSETATMUPA() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Determine "multi-pass" behaviour in some string functions + $SYNTAX$ + CSETATMUPA( [] ) -> lOldSwitch + $ARGUMENTS$ + [] .T. -> turn "multi-pass" on + .F. -> turn "multi-pass" off + $RETURNS$ + lOldSwitch old (if lNewSwitch is a logical value) or + current state of the switch + $DESCRIPTION$ + CSETATMUPA determines how the following CT3 string functions + + ATNUM() AFTERATNUM() BEFORATNUM() + ATREPL() NUMAT() ATADJUST() + WORDTOCHAR() WORDREPL() + + perform their work. See the respective function documentation for a + further description how the switch influences these functions. + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + This function is fully CT3 compatible. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + ATNUM() AFTERATNUM() BEFORATNUM() + ATREPL() NUMAT() ATADJUST() + WORDTOCHAR() WORDREPL() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * SETATLIKE() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Determine scan behaviour in some string functions - * $SYNTAX$ - * SETATLIKE ([] [, <[@]cWildcard>]) --> nOldMode - * $ARGUMENTS$ - * [] CT_SETATLIKE_EXACT -> characters are compared exactly - * CT_SETATLIKE_WILDCARD -> characters are compared using - * a wildcard character - * The default value is CT_SETATLIKE_EXACT. - * [<[@]cWildcard>] determines the character that is subsequently used - * as a wildcard character for substring scanning. - * The default value is "?". - * NEW: If this parameter is passed by reference [@], - * the current wildcard character is stored in - * . - * $RETURNS$ - * nOldMode old (if nMode is a numeric value) or - * current state of the switch - * $DESCRIPTION$ - * In the following CT3 functions, strings are compared on a character - * base: - * - * ATADJUST() ATNUM() AFTERATNUM() - * BEFOREATNUM() ATREPL() NUMAT() - * STRDIFF() - * - * With the SETATLIKE function, one can determine when characters are - * considered to match within these functions. If CT_SETATLIKE_WILDCARD - * is set (e.g. "?"), then "?" matches every other character. - * - * can be one of the following values that are defined - * in ct.ch - * - * Definition | Value - * ----------------------|------ - * CT_SETATLIKE_EXACT | 0 - * CT_SETATLIKE_WILDCARD | 1 - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * This function is fully CT3 compatible, but allows to pass the - * second parameter by reference so that the current wildcard character - * can be determined. - * $PLATFORMS$ - * All - * $FILES$ - * Header is ct.ch, library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + SETATLIKE() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Determine scan behaviour in some string functions + $SYNTAX$ + SETATLIKE ([] [, <[@]cWildcard>]) --> nOldMode + $ARGUMENTS$ + [] CT_SETATLIKE_EXACT -> characters are compared exactly + CT_SETATLIKE_WILDCARD -> characters are compared using + a wildcard character + The default value is CT_SETATLIKE_EXACT. + [<[@]cWildcard>] determines the character that is subsequently used + as a wildcard character for substring scanning. + The default value is "?". + NEW: If this parameter is passed by reference [@], + the current wildcard character is stored in + . + $RETURNS$ + nOldMode old (if nMode is a numeric value) or + current state of the switch + $DESCRIPTION$ + In the following CT3 functions, strings are compared on a character + base: + + ATADJUST() ATNUM() AFTERATNUM() + BEFOREATNUM() ATREPL() NUMAT() + STRDIFF() + + With the SETATLIKE function, one can determine when characters are + considered to match within these functions. If CT_SETATLIKE_WILDCARD + is set (e.g. "?"), then "?" matches every other character. + + can be one of the following values that are defined + in ct.ch + + Definition | Value + ----------------------|------ + CT_SETATLIKE_EXACT | 0 + CT_SETATLIKE_WILDCARD | 1 + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + This function is fully CT3 compatible, but allows to pass the + second parameter by reference so that the current wildcard character + can be determined. + $PLATFORMS$ + All + $FILES$ + Header is ct.ch, library is libct. + $SEEALSO$ + + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/datetime.txt b/harbour/contrib/hbct/doc/en/datetime.txt index e5a4b2910b..1e2ca79e87 100644 --- a/harbour/contrib/hbct/doc/en/datetime.txt +++ b/harbour/contrib/hbct/doc/en/datetime.txt @@ -2,194 +2,194 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * BOM() - * $CATEGORY$ - * CT3 date and time functions - * $ONELINER$ - * _B_egin _O_f _M_onth - * $SYNTAX$ - * BOM( [] ) -> dDateBeginOfMonth - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * BOM() is compatible with CT3's BOM(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * EOM(),BOQ(),EOQ(),BOY(),EOY() - * $END$ +/* $DOC$ + $FUNCNAME$ + BOM() + $CATEGORY$ + CT3 date and time functions + $ONELINER$ + _B_egin _O_f _M_onth + $SYNTAX$ + BOM( [] ) -> dDateBeginOfMonth + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + BOM() is compatible with CT3's BOM(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + EOM(),BOQ(),EOQ(),BOY(),EOY() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * EOM() - * $CATEGORY$ - * CT3 date and time functions - * $ONELINER$ - * _E_nd _O_f _M_onth - * $SYNTAX$ - * EOM( [] ) -> dDateEndOfMonth - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * EOM() is compatible with CT3's EOM(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * BOM(),BOQ(),EOQ(),BOY(),EOY() - * $END$ +/* $DOC$ + $FUNCNAME$ + EOM() + $CATEGORY$ + CT3 date and time functions + $ONELINER$ + _E_nd _O_f _M_onth + $SYNTAX$ + EOM( [] ) -> dDateEndOfMonth + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + EOM() is compatible with CT3's EOM(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + BOM(),BOQ(),EOQ(),BOY(),EOY() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * BOQ() - * $CATEGORY$ - * CT3 date and time functions - * $ONELINER$ - * _B_egin _O_f _Q_uarter - * $SYNTAX$ - * BOQ( [] ) -> dDateBeginOfQuarter - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * BOQ() is compatible with CT3's BOQ(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * BOM(),EOM(),EOQ(),BOY(),EOY() - * $END$ +/* $DOC$ + $FUNCNAME$ + BOQ() + $CATEGORY$ + CT3 date and time functions + $ONELINER$ + _B_egin _O_f _Q_uarter + $SYNTAX$ + BOQ( [] ) -> dDateBeginOfQuarter + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + BOQ() is compatible with CT3's BOQ(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + BOM(),EOM(),EOQ(),BOY(),EOY() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * EOQ() - * $CATEGORY$ - * CT3 date and time functions - * $ONELINER$ - * _E_nd _O_f _Q_uarter - * $SYNTAX$ - * EOQ( [] ) -> dDateEndOfQuarter - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * EOQ() is compatible with CT3's EOQ(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * BOM(),EOM(),BOQ(),BOY(),EOY() - * $END$ +/* $DOC$ + $FUNCNAME$ + EOQ() + $CATEGORY$ + CT3 date and time functions + $ONELINER$ + _E_nd _O_f _Q_uarter + $SYNTAX$ + EOQ( [] ) -> dDateEndOfQuarter + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + EOQ() is compatible with CT3's EOQ(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + BOM(),EOM(),BOQ(),BOY(),EOY() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * BOY() - * $CATEGORY$ - * CT3 date and time functions - * $ONELINER$ - * _B_egin _O_f _Y_ear - * $SYNTAX$ - * BOY( [] ) -> dDateBeginOfYear - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * BOY() is compatible with CT3's BOY(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * BOM(),EOM(),BOQ(),EOQ(),EOY() - * $END$ +/* $DOC$ + $FUNCNAME$ + BOY() + $CATEGORY$ + CT3 date and time functions + $ONELINER$ + _B_egin _O_f _Y_ear + $SYNTAX$ + BOY( [] ) -> dDateBeginOfYear + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + BOY() is compatible with CT3's BOY(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + BOM(),EOM(),BOQ(),EOQ(),EOY() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * EOY() - * $CATEGORY$ - * CT3 date and time functions - * $ONELINER$ - * _E_nd _O_f _Y_ear - * $SYNTAX$ - * EOY( [] ) -> dDateEndOfYear - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * EOY() is compatible with CT3's EOY(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * BOM(),EOM(),BOQ(),EOQ(),BOY() - * $END$ +/* $DOC$ + $FUNCNAME$ + EOY() + $CATEGORY$ + CT3 date and time functions + $ONELINER$ + _E_nd _O_f _Y_ear + $SYNTAX$ + EOY( [] ) -> dDateEndOfYear + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + EOY() is compatible with CT3's EOY(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + BOM(),EOM(),BOQ(),EOQ(),BOY() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/dattime2.txt b/harbour/contrib/hbct/doc/en/dattime2.txt index 7bebd0196e..7d53010fa5 100644 --- a/harbour/contrib/hbct/doc/en/dattime2.txt +++ b/harbour/contrib/hbct/doc/en/dattime2.txt @@ -2,473 +2,473 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * CTODOW() - * $CATEGORY$ - * CT3 date and time functions - * $ONELINER$ - * convert name of day of the week to its ordinal number - * $SYNTAX$ - * CTODOW( ) -> nOrdinal - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * CTODOW() is compatible with CT3's CTODOW(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * NTOCDOW() - * $END$ +/* $DOC$ + $FUNCNAME$ + CTODOW() + $CATEGORY$ + CT3 date and time functions + $ONELINER$ + convert name of day of the week to its ordinal number + $SYNTAX$ + CTODOW( ) -> nOrdinal + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + CTODOW() is compatible with CT3's CTODOW(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + NTOCDOW() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CTOMONTH() - * $CATEGORY$ - * CT3 date and time functions - * $ONELINER$ - * convert name of month to its ordinal number - * $SYNTAX$ - * CTOMONTH( ) -> nOrdinal - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * CTOMONTH() is compatible with CT3's CTOMONTH(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * NTOCMONTH() - * $END$ +/* $DOC$ + $FUNCNAME$ + CTOMONTH() + $CATEGORY$ + CT3 date and time functions + $ONELINER$ + convert name of month to its ordinal number + $SYNTAX$ + CTOMONTH( ) -> nOrdinal + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + CTOMONTH() is compatible with CT3's CTOMONTH(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + NTOCMONTH() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * DMY() - * $CATEGORY$ - * CT3 date and time functions - * $ONELINER$ - * Returns the date as a string in DD Month YY format - * $SYNTAX$ - * DMY( [][, ] ) -> cDateString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * Returns the date as a string in DD Month YY format. If lmode - * is TRUE, a "." is inserted after the DD - * TODO: add further documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * DMY() is compatible with CT3's DMY(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * MDY() - * $END$ +/* $DOC$ + $FUNCNAME$ + DMY() + $CATEGORY$ + CT3 date and time functions + $ONELINER$ + Returns the date as a string in DD Month YY format + $SYNTAX$ + DMY( [][, ] ) -> cDateString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + Returns the date as a string in DD Month YY format. If lmode + is TRUE, a "." is inserted after the DD + TODO: add further documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + DMY() is compatible with CT3's DMY(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + MDY() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * MDY() - * $CATEGORY$ - * CT3 date and time functions - * $ONELINER$ - * Returns the date as a string in Month DD, YY or Month DD, YYYY - * $SYNTAX$ - * MDY( [] ) -> cDateString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * Returns the date as a string in Month DD, YY or Month DD, YYYY - * If dDate is NULL, the system date is used - * TODO: add further documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * MDY() is compatible with CT3's MDY(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * DMY() - * $END$ +/* $DOC$ + $FUNCNAME$ + MDY() + $CATEGORY$ + CT3 date and time functions + $ONELINER$ + Returns the date as a string in Month DD, YY or Month DD, YYYY + $SYNTAX$ + MDY( [] ) -> cDateString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + Returns the date as a string in Month DD, YY or Month DD, YYYY + If dDate is NULL, the system date is used + TODO: add further documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + MDY() is compatible with CT3's MDY(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + DMY() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADDMONTH() - * $CATEGORY$ - * CT3 date and time functions - * $ONELINER$ - * add months to a date - * $SYNTAX$ - * ADDMONTH( [,] ) -> dShiftedDate - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * ADDMONTH() is compatible with CT3's ADDMOTH(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + ADDMONTH() + $CATEGORY$ + CT3 date and time functions + $ONELINER$ + add months to a date + $SYNTAX$ + ADDMONTH( [,] ) -> dShiftedDate + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + ADDMONTH() is compatible with CT3's ADDMOTH(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * DOY() - * $CATEGORY$ - * CT3 date and time functions - * $ONELINER$ - * Determines the day of the year for a specific date - * $SYNTAX$ - * DMY( [] ) -> nDayOfYear - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * Determines the day of the year for a specific date - * if dDate is invalid, returns 0 - * TODO: add further documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * DOY() is compatible with CT3's DOY(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + DOY() + $CATEGORY$ + CT3 date and time functions + $ONELINER$ + Determines the day of the year for a specific date + $SYNTAX$ + DMY( [] ) -> nDayOfYear + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + Determines the day of the year for a specific date + if dDate is invalid, returns 0 + TODO: add further documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + DOY() is compatible with CT3's DOY(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ISLEAP() - * $CATEGORY$ - * CT3 date and time functions - * $ONELINER$ - * determines of year of date is a leap year - * $SYNTAX$ - * ISLEAP( [] ) -> lIsLeap - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add further documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * ISLEAP() is compatible with CT3's ISLEAP(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + ISLEAP() + $CATEGORY$ + CT3 date and time functions + $ONELINER$ + determines of year of date is a leap year + $SYNTAX$ + ISLEAP( [] ) -> lIsLeap + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add further documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + ISLEAP() is compatible with CT3's ISLEAP(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * DAYSTOMONTH() - * $CATEGORY$ - * CT3 date and time functions - * $ONELINER$ - * Total number of days from first of Jan to beginning of nMonth. - * $SYNTAX$ - * DAYSTOMONTH( , ) -> nDaysToMonth - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * lLeap is FALSE for a non-leap year but TRUE if it is. If so and nMonth - * is greater than 2, ndays is incremented - * TODO: add further documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * DAYSTOMONTH() is a new function in Harbour's CT3 library. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * DAYSINMONTH() - * $END$ +/* $DOC$ + $FUNCNAME$ + DAYSTOMONTH() + $CATEGORY$ + CT3 date and time functions + $ONELINER$ + Total number of days from first of Jan to beginning of nMonth. + $SYNTAX$ + DAYSTOMONTH( , ) -> nDaysToMonth + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + lLeap is FALSE for a non-leap year but TRUE if it is. If so and nMonth + is greater than 2, ndays is incremented + TODO: add further documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + DAYSTOMONTH() is a new function in Harbour's CT3 library. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + DAYSINMONTH() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * DAYSINMONTH() - * $CATEGORY$ - * CT3 date and time functions - * $ONELINER$ - * Returns the number of days in month - * $SYNTAX$ - * DAYSINMONTH (, ) -> nDaysInMonth - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * DAYSINMONTH() is a new function in Harbour's CT3 library. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * DAYSTOMONTH() - * $END$ +/* $DOC$ + $FUNCNAME$ + DAYSINMONTH() + $CATEGORY$ + CT3 date and time functions + $ONELINER$ + Returns the number of days in month + $SYNTAX$ + DAYSINMONTH (, ) -> nDaysInMonth + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + DAYSINMONTH() is a new function in Harbour's CT3 library. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + DAYSTOMONTH() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * QUARTER() - * $CATEGORY$ - * CT3 date and time functions - * $ONELINER$ - * Returns a number equal to the quarter in which a date falls - * $SYNTAX$ - * QUARTER( [] ) -> nQuarter - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * Returns a number equal to the quarter in which ddate - * falls. If ddate is empty, the system date is employed. - * TODO: add further documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * QUARTER() is compatible with CT3's QUARTER(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + QUARTER() + $CATEGORY$ + CT3 date and time functions + $ONELINER$ + Returns a number equal to the quarter in which a date falls + $SYNTAX$ + QUARTER( [] ) -> nQuarter + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + Returns a number equal to the quarter in which ddate + falls. If ddate is empty, the system date is employed. + TODO: add further documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + QUARTER() is compatible with CT3's QUARTER(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * LASTDAYOM() - * $CATEGORY$ - * CT3 date and time functions - * $ONELINER$ - * Returns the the number of days in the month. - * $SYNTAX$ - * LASTDAYOM( [] ) -> nDaysInMonth - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * can be a date or a month number. If empty uses the - * system date. If nMonth is a 2, lastdayom() will not know if it - * is a leap year or not. If dDate is invalid, returns 0 - * TODO: add further documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * LASTDAYOM() is compatible with CT3's LASTDAYOM(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * EOM() - * $END$ +/* $DOC$ + $FUNCNAME$ + LASTDAYOM() + $CATEGORY$ + CT3 date and time functions + $ONELINER$ + Returns the the number of days in the month. + $SYNTAX$ + LASTDAYOM( [] ) -> nDaysInMonth + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + can be a date or a month number. If empty uses the + system date. If nMonth is a 2, lastdayom() will not know if it + is a leap year or not. If dDate is invalid, returns 0 + TODO: add further documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + LASTDAYOM() is compatible with CT3's LASTDAYOM(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + EOM() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * NTOCDOW() - * $CATEGORY$ - * CT3 date and time functions - * $ONELINER$ - * (num of day) -> day name - * $SYNTAX$ - * NTOCDOW( ) -> cDay - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * NTOCDOW() is compatible with CT3's NTOCDOW(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CTODOW() - * $END$ +/* $DOC$ + $FUNCNAME$ + NTOCDOW() + $CATEGORY$ + CT3 date and time functions + $ONELINER$ + (num of day) -> day name + $SYNTAX$ + NTOCDOW( ) -> cDay + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + NTOCDOW() is compatible with CT3's NTOCDOW(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CTODOW() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * NTOCMONTH() - * $CATEGORY$ - * CT3 date and time functions - * $ONELINER$ - * (num of month ) -> Month Name - * $SYNTAX$ - * NTOCMONTH( ) -> cMonth - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * NTOCMONTH() is compatible with CT3's NTOCMONTH(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CTOMONTH() - * $END$ +/* $DOC$ + $FUNCNAME$ + NTOCMONTH() + $CATEGORY$ + CT3 date and time functions + $ONELINER$ + (num of month ) -> Month Name + $SYNTAX$ + NTOCMONTH( ) -> cMonth + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + NTOCMONTH() is compatible with CT3's NTOCMONTH(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CTOMONTH() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * WEEK() - * $CATEGORY$ - * CT3 date and time functions - * $ONELINER$ - * Returns the calendar week a number - * $SYNTAX$ - * WEEK( [][, ] ) -> nWeek - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * Returns the calendar week a number. If no date is specified, - * the system date is used. An empty date via hb_SToD("") - * returns 0. - * If is .T., week() will calculate the "simple week number", defined by - * - week #1 starts on January, 1st - * - week #(n+1) starts seven days after start of week #n - * If is .F. (default), the ISO8601 week number, defined by - * - weeks start on mondays - * - week #1 is the one that includes January, 4 - * will be calculated - * TODO: add further documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * WEEK() is compatible with CT3's WEEK(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + WEEK() + $CATEGORY$ + CT3 date and time functions + $ONELINER$ + Returns the calendar week a number + $SYNTAX$ + WEEK( [][, ] ) -> nWeek + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + Returns the calendar week a number. If no date is specified, + the system date is used. An empty date via hb_SToD("") + returns 0. + If is .T., week() will calculate the "simple week number", defined by + - week #1 starts on January, 1st + - week #(n+1) starts seven days after start of week #n + If is .F. (default), the ISO8601 week number, defined by + - weeks start on mondays + - week #1 is the one that includes January, 4 + will be calculated + TODO: add further documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + WEEK() is compatible with CT3's WEEK(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/dattime3.txt b/harbour/contrib/hbct/doc/en/dattime3.txt index f2f208a348..5f6075b097 100644 --- a/harbour/contrib/hbct/doc/en/dattime3.txt +++ b/harbour/contrib/hbct/doc/en/dattime3.txt @@ -2,219 +2,219 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * WAITPERIOD() - * $CATEGORY$ - * HBCT date and time functions - * $ONELINER$ - * Pauses a specified time in increments of 1/100 seconds - * $SYNTAX$ - * WAITPERIOD( [] ) --> lNotElapsed - * $ARGUMENTS$ - * Designates the waiting period at initialization in - * 1/100ths of seconds. Values from 1 to 8, 640, 000 (one day) are - * possible. - * $RETURNS$ - * WAITPERIOD() returns .T., if the time span designated at initialization - * has not elapsed. - * $DESCRIPTION$ - * This function sets a time span for a xHarbour DO WHILE loop to run. - * The function must initialize prior to the loop, since you must specify - * the parameter in 1/100th seconds. Subsequently, the function - * can be implemented without a parameter for additional loop conditions. - * It returns .T., as long as the designated time span has not yet run out. - * - * Note - * - * The function notes the status of the internal timer at - * initialization. From that point on, the initialization should always - * precede the respective DO WHILE; otherwise, the time delay is - * incorrect. The passing of midnight (the time resets to the 0 value) - * is taken into account. - * $EXAMPLES$ - * Run a loop for 5 seconds: - * - * WAITPERIOD( 500 ) // Initialization, 5 seconds - * DO WHILE .AND. .AND. WAITPERIOD() - * *... - * ENDDO - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * WAITPERIOD() is Clipper Tools compatible. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + WAITPERIOD() + $CATEGORY$ + HBCT date and time functions + $ONELINER$ + Pauses a specified time in increments of 1/100 seconds + $SYNTAX$ + WAITPERIOD( [] ) --> lNotElapsed + $ARGUMENTS$ + Designates the waiting period at initialization in + 1/100ths of seconds. Values from 1 to 8, 640, 000 (one day) are + possible. + $RETURNS$ + WAITPERIOD() returns .T., if the time span designated at initialization + has not elapsed. + $DESCRIPTION$ + This function sets a time span for a xHarbour DO WHILE loop to run. + The function must initialize prior to the loop, since you must specify + the parameter in 1/100th seconds. Subsequently, the function + can be implemented without a parameter for additional loop conditions. + It returns .T., as long as the designated time span has not yet run out. + + Note + + The function notes the status of the internal timer at + initialization. From that point on, the initialization should always + precede the respective DO WHILE; otherwise, the time delay is + incorrect. The passing of midnight (the time resets to the 0 value) + is taken into account. + $EXAMPLES$ + Run a loop for 5 seconds: + + WAITPERIOD( 500 ) // Initialization, 5 seconds + DO WHILE .AND. .AND. WAITPERIOD() + *... + ENDDO + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + WAITPERIOD() is Clipper Tools compatible. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * TIMEVALID() - * $CATEGORY$ - * HBCT Date and Time Functions - * $ONELINER$ - * Determines whether a specIFied time is valid - * $SYNTAX$ - * TIMEVALID( ) --> lValid - * $ARGUMENTS$ - * Designates a character string that contains the time to - * test. - * $RETURNS$ - * TIMEVALID() RETURNs .T. when is a valid time; or .F. when - * is an invalid time. - * $DESCRIPTION$ - * With input that requires time manipulation, writing your own UDF to - * check time inputs was unavoidable up to now. TIMEVALID() permits - * Complete checking of a time designation. You can use this FUNCTION - * effectively with a VALID clause within a READ mask. - * - * Note - * - * Note the format for time designations. There must always be - * two digits for hours, minutes, seconds, and hundredths; otherwise, - * the time it is regarded as invalid. Valid examples are "12", - * "12:59", "12:59:59", and "12:59:59:99". By contrast, invalid - * examples are "24", "12:60", or "12:1", and/or "12:". IF you work - * with time strings that are not completely filled and that you need to - * check with TIMEVALID(), then they must be TRIMmed prior to the use of - * TIMEVALID() (see following Examples). - * $EXAMPLES$ - * Using the VALID clause with TRIM, all valid times are - * accepted, even IF no seconds or minutes are specIFied: - * - * cBegin := SPACE( 11 ) - * @ 5, 10 SAY "Please input time for beginning work:"; - * GET cBegin VALID TIMEVALID( RTRIM( cBegin ) ) - * READ - * - * Using a VALID clause without TRIM, hours and minutes must be - * specified, so that TIMEVALID() can confirm a valid time: - * - * cBegin := SPACE( 5 ) - * @ 5, 10 SAY "Please input time for beginning work:"; - * GET cBegin VALID TIMEVALID( cBegin ) - * READ - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * This function is CA-Cl*pper Tools compatible. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * SETTIME() - * $END$ +/* $DOC$ + $FUNCNAME$ + TIMEVALID() + $CATEGORY$ + HBCT Date and Time Functions + $ONELINER$ + Determines whether a specIFied time is valid + $SYNTAX$ + TIMEVALID( ) --> lValid + $ARGUMENTS$ + Designates a character string that contains the time to + test. + $RETURNS$ + TIMEVALID() RETURNs .T. when is a valid time; or .F. when + is an invalid time. + $DESCRIPTION$ + With input that requires time manipulation, writing your own UDF to + check time inputs was unavoidable up to now. TIMEVALID() permits + Complete checking of a time designation. You can use this FUNCTION + effectively with a VALID clause within a READ mask. + + Note + + Note the format for time designations. There must always be + two digits for hours, minutes, seconds, and hundredths; otherwise, + the time it is regarded as invalid. Valid examples are "12", + "12:59", "12:59:59", and "12:59:59:99". By contrast, invalid + examples are "24", "12:60", or "12:1", and/or "12:". IF you work + with time strings that are not completely filled and that you need to + check with TIMEVALID(), then they must be TRIMmed prior to the use of + TIMEVALID() (see following Examples). + $EXAMPLES$ + Using the VALID clause with TRIM, all valid times are + accepted, even IF no seconds or minutes are specIFied: + + cBegin := SPACE( 11 ) + @ 5, 10 SAY "Please input time for beginning work:"; + GET cBegin VALID TIMEVALID( RTRIM( cBegin ) ) + READ + + Using a VALID clause without TRIM, hours and minutes must be + specified, so that TIMEVALID() can confirm a valid time: + + cBegin := SPACE( 5 ) + @ 5, 10 SAY "Please input time for beginning work:"; + GET cBegin VALID TIMEVALID( cBegin ) + READ + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + This function is CA-Cl*pper Tools compatible. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + SETTIME() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * SETTIME() - * $CATEGORY$ - * HBCT Date and Time Functions - * $ONELINER$ - * Sets the system clock - * $SYNTAX$ - * SETTIME( , [] ) --> lSet - * $ARGUMENTS$ - * Designates a character string that contains the time that - * is to become the system time. - * - * Designates whether the time should also be set in the - * CMOS-RAM of an AT. The default is do not write to CMOS-RAM. Note that in - * Windows platform this adjust is automatic, therefore this parameter is - * without efect. - * $RETURNS$ - * The FUNCTION RETURNs .T. when the time is set successfully. - * $DESCRIPTION$ - * When you use this FUNCTION to convert the time into the system time from - * within your xHarbour application, all files acquire this time with - * each write procedure. - * $EXAMPLES$ - * Set the system time in each case; but the hardware clock only - * on an AT: - * - * cNewTime := "10:20:00" - * IF ISAT() - * SETTIME( cNewTime, .T. ) - * ELSE - * SETTIME( cNewTime ) - * ENDIF - * - * Or, more compactly: - * - * SETTIME( cNewTime, ISAT() ) - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * This function is CA-Cl*pper Tools compatible. - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * Library is libct. - * $SEEALSO$ - * SETDATE(),TIMEVALID() - * $END$ +/* $DOC$ + $FUNCNAME$ + SETTIME() + $CATEGORY$ + HBCT Date and Time Functions + $ONELINER$ + Sets the system clock + $SYNTAX$ + SETTIME( , [] ) --> lSet + $ARGUMENTS$ + Designates a character string that contains the time that + is to become the system time. + + Designates whether the time should also be set in the + CMOS-RAM of an AT. The default is do not write to CMOS-RAM. Note that in + Windows platform this adjust is automatic, therefore this parameter is + without efect. + $RETURNS$ + The FUNCTION RETURNs .T. when the time is set successfully. + $DESCRIPTION$ + When you use this FUNCTION to convert the time into the system time from + within your xHarbour application, all files acquire this time with + each write procedure. + $EXAMPLES$ + Set the system time in each case; but the hardware clock only + on an AT: + + cNewTime := "10:20:00" + IF ISAT() + SETTIME( cNewTime, .T. ) + ELSE + SETTIME( cNewTime ) + ENDIF + + Or, more compactly: + + SETTIME( cNewTime, ISAT() ) + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + This function is CA-Cl*pper Tools compatible. + $PLATFORMS$ + Windows, Linux + $FILES$ + Library is libct. + $SEEALSO$ + SETDATE(),TIMEVALID() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * SETDATE() - * $CATEGORY$ - * HBCT Date and Time Functions - * $ONELINER$ - * Sets the system date - * $SYNTAX$ - * SETDATE( , [] ) --> lSet - * $ARGUMENTS$ - * Designates which date to use to set the system date. - * - * Designates whether the date should also be set in the CMOS- - * RAM of an AT. The default is do not write (.F.). Note that in Windows - * plataform this adjust is automatic, therefore this parameter is without - * efect. - * $RETURNS$ - * SETDATE() RETURNs .T. when the date is successfully set. - * $DESCRIPTION$ - * When you use this FUNCTION to set the system date from within your - * xHarbour application, all files acquire this date with each write - * procedure. - * $EXAMPLES$ - * Set the system date in each case; but the hardware clock only - * on an AT: - * - * dNewDate := SToD( "19910730" ) - * IF ISAT() - * SETDATE( dNewDate, .T. ) - * ELSE - * SETDATE( dNewDate ) - * ENDIF - * - * Or, more compactly: - * - * SETDATE( dNewDate, ISAT() ) - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * This function is CA-Cl*pper Tools compatible. - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * Library is libct. - * $SEEALSO$ - * SETTIME() - * $END$ +/* $DOC$ + $FUNCNAME$ + SETDATE() + $CATEGORY$ + HBCT Date and Time Functions + $ONELINER$ + Sets the system date + $SYNTAX$ + SETDATE( , [] ) --> lSet + $ARGUMENTS$ + Designates which date to use to set the system date. + + Designates whether the date should also be set in the CMOS- + RAM of an AT. The default is do not write (.F.). Note that in Windows + plataform this adjust is automatic, therefore this parameter is without + efect. + $RETURNS$ + SETDATE() RETURNs .T. when the date is successfully set. + $DESCRIPTION$ + When you use this FUNCTION to set the system date from within your + xHarbour application, all files acquire this date with each write + procedure. + $EXAMPLES$ + Set the system date in each case; but the hardware clock only + on an AT: + + dNewDate := SToD( "19910730" ) + IF ISAT() + SETDATE( dNewDate, .T. ) + ELSE + SETDATE( dNewDate ) + ENDIF + + Or, more compactly: + + SETDATE( dNewDate, ISAT() ) + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + This function is CA-Cl*pper Tools compatible. + $PLATFORMS$ + Windows, Linux + $FILES$ + Library is libct. + $SEEALSO$ + SETTIME() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/exponent.txt b/harbour/contrib/hbct/doc/en/exponent.txt index cbd379bd83..d306368e22 100644 --- a/harbour/contrib/hbct/doc/en/exponent.txt +++ b/harbour/contrib/hbct/doc/en/exponent.txt @@ -2,91 +2,91 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * MANTISSA() - * $CATEGORY$ - * CT3 number and bit manipulation functions - * $ONELINER$ - * Evaluate the mantissa of a floating point number - * $SYNTAX$ - * MANTISSA( ) --> nMantissa - * $ARGUMENTS$ - * Designate any Harbour number. - * $RETURNS$ - * MANTISSA() returns the mantissa of the number. - * $DESCRIPTION$ - * This function supplements EXPONENT() to return the mantissa of the - * number. - * - * Note: The mantissa value can be 0 or in the range of 1 to 2. - * - * The following calculation reproduces the original value: - * - * MANTISSA( ) * 2 ^ EXPONENT( ) = - * - * - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * MANTISSA() is compatible with CT3's MANTISSA(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * EXPONENT() - * $END$ +/* $DOC$ + $FUNCNAME$ + MANTISSA() + $CATEGORY$ + CT3 number and bit manipulation functions + $ONELINER$ + Evaluate the mantissa of a floating point number + $SYNTAX$ + MANTISSA( ) --> nMantissa + $ARGUMENTS$ + Designate any Harbour number. + $RETURNS$ + MANTISSA() returns the mantissa of the number. + $DESCRIPTION$ + This function supplements EXPONENT() to return the mantissa of the + number. + + Note: The mantissa value can be 0 or in the range of 1 to 2. + + The following calculation reproduces the original value: + + MANTISSA( ) * 2 ^ EXPONENT( ) = + + + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + MANTISSA() is compatible with CT3's MANTISSA(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + EXPONENT() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * EXPONENT() - * $CATEGORY$ - * CT3 number and bit manipulation functions - * $ONELINER$ - * Evaluate the exponent of a floating point number - * $SYNTAX$ - * EXPONENT( ) --> nExponent - * $ARGUMENTS$ - * Designate any Harbour number. - * $RETURNS$ - * EXPONENT() returns the exponent of the number - * in base 2. - * $DESCRIPTION$ - * This function supplements MANTISSA() to return the exponent of the - * number. - * - * Values > 1 or values < -1 return a positive number 0 to 1023. - * - * Values < 1 or values > -1 return a negative number -1 to -1023. - * - * The EXPONENT( 0 ), return 0. - * - * The following calculation reproduces the original value: - * - * 2^EXPONENT() * MANTISSA() = - * - * - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * EXPONENT() is compatible with CT3's EXPONENT() - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * MANTISSA() - * $END$ +/* $DOC$ + $FUNCNAME$ + EXPONENT() + $CATEGORY$ + CT3 number and bit manipulation functions + $ONELINER$ + Evaluate the exponent of a floating point number + $SYNTAX$ + EXPONENT( ) --> nExponent + $ARGUMENTS$ + Designate any Harbour number. + $RETURNS$ + EXPONENT() returns the exponent of the number + in base 2. + $DESCRIPTION$ + This function supplements MANTISSA() to return the exponent of the + number. + + Values > 1 or values < -1 return a positive number 0 to 1023. + + Values < 1 or values > -1 return a negative number -1 to -1023. + + The EXPONENT( 0 ), return 0. + + The following calculation reproduces the original value: + + 2^EXPONENT() * MANTISSA() = + + + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + EXPONENT() is compatible with CT3's EXPONENT() + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + MANTISSA() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/finan.txt b/harbour/contrib/hbct/doc/en/finan.txt index 93076ed7ee..053a3848e4 100644 --- a/harbour/contrib/hbct/doc/en/finan.txt +++ b/harbour/contrib/hbct/doc/en/finan.txt @@ -2,255 +2,255 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FV() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Future value of a capital - * $SYNTAX$ - * FV( nDeposit, nInterest, nPeriods ) --> nFutureValue - * $ARGUMENTS$ - * amount of money invested per period - * rate of interest per period, 1 == 100% - * period count - * $RETURNS$ - * Total value of the capital after of - * paying and interest being - * paid every period and added to the capital (resulting - * in compound interest) - * $DESCRIPTION$ - * FV() calculates the value of a capital after periods. - * Starting with a value of 0, every period, - * (Dollars, Euros, Yens, ...) and an interest of for the - * current capital are added for the capital (=Percent/100). - * Thus, one gets the non-linear effects of compound interests: - * value in period 0 = 0 - * value in period 1 = ((value in period 0)*(1+/100)) + - * value in period 2 = ((value in period 1)*(1+/100)) + - * etc.... - * value in period = ((value in period -1)*(1+/100))< + - * = * sum from i=0 to -1 over (1+/100)^i - * = * ((1+/100)^n-1) / (/100) - * $EXAMPLES$ - * // Payment of 1000 per year for 10 years at a interest rate - * // of 5 per cent per year - * - * ? fv( 1000, 0.05, 10 ) // --> 12577.893 - * $TESTS$ - * fv( 1000, 0.00, 10 ) == 10000.0 - * fv( 1000, 0.05, 10 ) == 12577.893 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * FV() is compatible with CT3's FV(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * PV(),PAYMENT(),PERIODS(),RATE() - * $END$ +/* $DOC$ + $FUNCNAME$ + FV() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Future value of a capital + $SYNTAX$ + FV( nDeposit, nInterest, nPeriods ) --> nFutureValue + $ARGUMENTS$ + amount of money invested per period + rate of interest per period, 1 == 100% + period count + $RETURNS$ + Total value of the capital after of + paying and interest being + paid every period and added to the capital (resulting + in compound interest) + $DESCRIPTION$ + FV() calculates the value of a capital after periods. + Starting with a value of 0, every period, + (Dollars, Euros, Yens, ...) and an interest of for the + current capital are added for the capital (=Percent/100). + Thus, one gets the non-linear effects of compound interests: + value in period 0 = 0 + value in period 1 = ((value in period 0)*(1+/100)) + + value in period 2 = ((value in period 1)*(1+/100)) + + etc.... + value in period = ((value in period -1)*(1+/100))< + + = * sum from i=0 to -1 over (1+/100)^i + = * ((1+/100)^n-1) / (/100) + $EXAMPLES$ + // Payment of 1000 per year for 10 years at a interest rate + // of 5 per cent per year + + ? fv( 1000, 0.05, 10 ) // --> 12577.893 + $TESTS$ + fv( 1000, 0.00, 10 ) == 10000.0 + fv( 1000, 0.05, 10 ) == 12577.893 + $STATUS$ + Ready + $COMPLIANCE$ + FV() is compatible with CT3's FV(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + PV(),PAYMENT(),PERIODS(),RATE() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * PV() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Present value of a loan - * $SYNTAX$ - * PV( nPayment, nInterest, nPeriods ) --> nPresentValue - * $ARGUMENTS$ - * amount of money paid back per period - * rate of interest per period, 1 == 100% - * period count - * $RETURNS$ - * Present value of a loan when one is paying back - * per period at a rate of interest of - * per period - * $DESCRIPTION$ - * PV() calculates the present value of a loan that is paid back - * in payments of (Dollars, Euros, Yens,...) - * while the rate of interest is per period: - * debt in period 0 = - * debt in period 1 = ((debt in period 0)-)*(1+/100) - * debt in period 2 = ((debt in period 1)-)*(1+/100) - * etc... - * debt in period = ((debt in period -1)-)*(1+/100) - * -> has to be 0, so - * = *(1-(1+/100)^(-n))/(/100) - * $EXAMPLES$ - * // You can afford to pay back 100 Dollars per month for 5 years - * // at a interest rate of 0.5% per month (6% per year), so instead - * // of 6000 Dollars (the amount you will pay back) the bank will pay - * // you - * - * ? pv( 100, 0.005, 60 ) // --> 5172.56 - * $TESTS$ - * pv( 100, 0.0, 60 ) == 6000.0 - * pv( 100, 0.005, 60 ) == 5172.56 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * PV() is compatible with CT3's PV(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * FV(),PAYMENT(),PERIODS(),RATE() - * $END$ +/* $DOC$ + $FUNCNAME$ + PV() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Present value of a loan + $SYNTAX$ + PV( nPayment, nInterest, nPeriods ) --> nPresentValue + $ARGUMENTS$ + amount of money paid back per period + rate of interest per period, 1 == 100% + period count + $RETURNS$ + Present value of a loan when one is paying back + per period at a rate of interest of + per period + $DESCRIPTION$ + PV() calculates the present value of a loan that is paid back + in payments of (Dollars, Euros, Yens,...) + while the rate of interest is per period: + debt in period 0 = + debt in period 1 = ((debt in period 0)-)*(1+/100) + debt in period 2 = ((debt in period 1)-)*(1+/100) + etc... + debt in period = ((debt in period -1)-)*(1+/100) + -> has to be 0, so + = *(1-(1+/100)^(-n))/(/100) + $EXAMPLES$ + // You can afford to pay back 100 Dollars per month for 5 years + // at a interest rate of 0.5% per month (6% per year), so instead + // of 6000 Dollars (the amount you will pay back) the bank will pay + // you + + ? pv( 100, 0.005, 60 ) // --> 5172.56 + $TESTS$ + pv( 100, 0.0, 60 ) == 6000.0 + pv( 100, 0.005, 60 ) == 5172.56 + $STATUS$ + Ready + $COMPLIANCE$ + PV() is compatible with CT3's PV(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + FV(),PAYMENT(),PERIODS(),RATE() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * PAYMENT() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Payments for a loan - * $SYNTAX$ - * PAYMENT( nLoan, nInterest, nPeriods ) --> nPayment - * $ARGUMENTS$ - * amount of money you get from the bank - * rate of interest per period, 1 == 100% - * period count - * $RETURNS$ - * Periodical payment one has to make to pay the - * loan back - * $DESCRIPTION$ - * PAYMENT() calculates the payment one has to make periodically - * to pay back a loan within periods and for a - * rate of interest per period. - * debt in period 0 = - * debt in period 1 = ((debt in period 0)-)*(1+/100) - * debt in period 2 = ((debt in period 1)-)*(1+/100) - * etc... - * debt in period = ((debt in period -1)-)*(1+/100) - * -> has to be 0, so - * = *(/100)/(1-(1+/100)^(-n)) - * $EXAMPLES$ - * // You get a loan of 5172.56 at a interest rate of 0.5% per - * // month (6% per year). - * // For 5 years, you have to pay back every month - * - * ? payment( 5172.56, 0.005, 60 ) // --> 100.00 - * $TESTS$ - * payment( 5172.56, 0.0, 60 ) == 86.21 - * payment( 5172.56, 0.005, 60 ) == 100.00 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * PAYMENT() is compatible with CT3's PAYMENT(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * PV(),FV(),PERIODS(),RATE() - * $END$ +/* $DOC$ + $FUNCNAME$ + PAYMENT() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Payments for a loan + $SYNTAX$ + PAYMENT( nLoan, nInterest, nPeriods ) --> nPayment + $ARGUMENTS$ + amount of money you get from the bank + rate of interest per period, 1 == 100% + period count + $RETURNS$ + Periodical payment one has to make to pay the + loan back + $DESCRIPTION$ + PAYMENT() calculates the payment one has to make periodically + to pay back a loan within periods and for a + rate of interest per period. + debt in period 0 = + debt in period 1 = ((debt in period 0)-)*(1+/100) + debt in period 2 = ((debt in period 1)-)*(1+/100) + etc... + debt in period = ((debt in period -1)-)*(1+/100) + -> has to be 0, so + = *(/100)/(1-(1+/100)^(-n)) + $EXAMPLES$ + // You get a loan of 5172.56 at a interest rate of 0.5% per + // month (6% per year). + // For 5 years, you have to pay back every month + + ? payment( 5172.56, 0.005, 60 ) // --> 100.00 + $TESTS$ + payment( 5172.56, 0.0, 60 ) == 86.21 + payment( 5172.56, 0.005, 60 ) == 100.00 + $STATUS$ + Ready + $COMPLIANCE$ + PAYMENT() is compatible with CT3's PAYMENT(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + PV(),FV(),PERIODS(),RATE() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * PERIODS() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Number of periods for a loan - * $SYNTAX$ - * PERIODS( nLoan, nPayment, nInterest ) --> nPeriods - * $ARGUMENTS$ - * amount of money you get from the bank - * amount of money you pay back per period - * rate of interest per period, 1 == 100% - * $RETURNS$ - * number of periods you need to pay the loan back - * $DESCRIPTION$ - * PERIODS() calculates the number of periods one needs to pay back - * a loan of with periodical payments of and for a - * rate of interest per period. - * debt in period 0 = - * debt in period 1 = ((debt in period 0)-)*(1+/100) - * debt in period 2 = ((debt in period 1)-)*(1+/100) - * etc... - * debt in period = ((debt in period -1)-)*(1+/100) - * -> has to be 0, so - * = -log(1-*(/100)/)/log(1+/100)) - * - * Note, however that in the case of nPayment <= *(/100), - * one would need infinite time to pay the loan back. The functions does - * then return -1. - * $EXAMPLES$ - * // You get a loan of 5172.56 at a interest rate of 0.5% per - * // month (6% per year). - * // You can afford to pay 100 back every month, so you need - * - * ? periods( 5172.56, 100, 0.005 ) // --> 60.0 - * - * // months to cancel the loan. - * $TESTS$ - * periods( 5172.56, 100, 0.005 ) == 60.0 - * periods( 5172.56, 100, 0.0 ) == 51.7256 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * PERIODS() is compatible with CT3's PERIODS(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * PV(),FV(),PAYMENT(),RATE() - * $END$ +/* $DOC$ + $FUNCNAME$ + PERIODS() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Number of periods for a loan + $SYNTAX$ + PERIODS( nLoan, nPayment, nInterest ) --> nPeriods + $ARGUMENTS$ + amount of money you get from the bank + amount of money you pay back per period + rate of interest per period, 1 == 100% + $RETURNS$ + number of periods you need to pay the loan back + $DESCRIPTION$ + PERIODS() calculates the number of periods one needs to pay back + a loan of with periodical payments of and for a + rate of interest per period. + debt in period 0 = + debt in period 1 = ((debt in period 0)-)*(1+/100) + debt in period 2 = ((debt in period 1)-)*(1+/100) + etc... + debt in period = ((debt in period -1)-)*(1+/100) + -> has to be 0, so + = -log(1-*(/100)/)/log(1+/100)) + + Note, however that in the case of nPayment <= *(/100), + one would need infinite time to pay the loan back. The functions does + then return -1. + $EXAMPLES$ + // You get a loan of 5172.56 at a interest rate of 0.5% per + // month (6% per year). + // You can afford to pay 100 back every month, so you need + + ? periods( 5172.56, 100, 0.005 ) // --> 60.0 + + // months to cancel the loan. + $TESTS$ + periods( 5172.56, 100, 0.005 ) == 60.0 + periods( 5172.56, 100, 0.0 ) == 51.7256 + $STATUS$ + Ready + $COMPLIANCE$ + PERIODS() is compatible with CT3's PERIODS(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + PV(),FV(),PAYMENT(),RATE() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * RATE() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Estimate rate of interest for a loan - * $SYNTAX$ - * RATE( nLoan, nPayment, nPeriods ) --> nRate - * $ARGUMENTS$ - * amount of money you get from the bank - * amount of money you pay back per period - * number of periods you pay the loan back - * $RETURNS$ - * estimated rate of interest per period, 1 == 100% - * $DESCRIPTION$ - * RATE() calculates the rate of interest per period for the given - * loan, payment per periods and number of periods. This is done with - * the same equation used in the PAYMENT() or PERIODS() function: - * - * = *(/100)/(1-(1+/100)^(-)) - * - * However, this equation can not be solved for in a "closed" - * manner, i.e. = ..., so that the result can only be estimated. - * $EXAMPLES$ - * // You get a loan of 5172.56, pay 100 back every month for - * // 5 years (60 months). The effective interest rate per - * // period (=month) is - * - * ? rate( 5172.56, 100, 60 ) // --> 0.005 - * - * $TESTS$ - * rate( 5172.56, 100, 60.0 ) == 0.005 - * rate( 6000.0, 100, 60.0 ) == 0.0 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * RATE() is compatible with CT3's RATE(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * PV(),FV(),PAYMENT(),PERIODS() - * $END$ +/* $DOC$ + $FUNCNAME$ + RATE() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Estimate rate of interest for a loan + $SYNTAX$ + RATE( nLoan, nPayment, nPeriods ) --> nRate + $ARGUMENTS$ + amount of money you get from the bank + amount of money you pay back per period + number of periods you pay the loan back + $RETURNS$ + estimated rate of interest per period, 1 == 100% + $DESCRIPTION$ + RATE() calculates the rate of interest per period for the given + loan, payment per periods and number of periods. This is done with + the same equation used in the PAYMENT() or PERIODS() function: + + = *(/100)/(1-(1+/100)^(-)) + + However, this equation can not be solved for in a "closed" + manner, i.e. = ..., so that the result can only be estimated. + $EXAMPLES$ + // You get a loan of 5172.56, pay 100 back every month for + // 5 years (60 months). The effective interest rate per + // period (=month) is + + ? rate( 5172.56, 100, 60 ) // --> 0.005 + + $TESTS$ + rate( 5172.56, 100, 60.0 ) == 0.005 + rate( 6000.0, 100, 60.0 ) == 0.0 + $STATUS$ + Ready + $COMPLIANCE$ + RATE() is compatible with CT3's RATE(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + PV(),FV(),PAYMENT(),PERIODS() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/ftoc.txt b/harbour/contrib/hbct/doc/en/ftoc.txt index 2c4b21fbd6..d397b7b8f7 100644 --- a/harbour/contrib/hbct/doc/en/ftoc.txt +++ b/harbour/contrib/hbct/doc/en/ftoc.txt @@ -2,85 +2,85 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FTOC() - * $CATEGORY$ - * CT3 number and bit manipulation functions - * $ONELINER$ - * - * $SYNTAX$ - * FTOC( ) --> cFloatingPointNumber - * - * $ARGUMENTS$ - * Designate any Harbour number. - * - * $RETURNS$ - * FTOC() return a string with the size of DOUBLE. - * ATTENTION: different implementations or platforms of Harbour, they - * could produce different format in the string returned by FTOC(). - * - * $DESCRIPTION$ - * Harbour internal numbers in Floating Point are stored in data type - * DOUBLE. FTOC() returns these bits as an string. In this way, - * numbers con be saved more compactly. - * - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CTOF(), XTOC() - * $END$ +/* $DOC$ + $FUNCNAME$ + FTOC() + $CATEGORY$ + CT3 number and bit manipulation functions + $ONELINER$ + + $SYNTAX$ + FTOC( ) --> cFloatingPointNumber + + $ARGUMENTS$ + Designate any Harbour number. + + $RETURNS$ + FTOC() return a string with the size of DOUBLE. + ATTENTION: different implementations or platforms of Harbour, they + could produce different format in the string returned by FTOC(). + + $DESCRIPTION$ + Harbour internal numbers in Floating Point are stored in data type + DOUBLE. FTOC() returns these bits as an string. In this way, + numbers con be saved more compactly. + + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CTOF(), XTOC() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CTOF() - * $CATEGORY$ - * CT3 number and bit manipulation functions - * $ONELINER$ - * - * $SYNTAX$ - * CTOF( ) --> nFloatingPointNumber - * - * $ARGUMENTS$ - * Designate a string that contains a Harbour - * number in flotaing point format. - * ATTENTION: different implementations or platforms of Harbour, they - * could produce different format in the string returned by FTOC(). - * - * $RETURNS$ - * CTOF() return the floating point number that corresponds to the - * string passed. - * - * $DESCRIPTION$ - * Character strings created with FTOC() or XTOC() are convert into - * Harbour floating point number - * - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * FTOC(), XTOC() - * $END$ +/* $DOC$ + $FUNCNAME$ + CTOF() + $CATEGORY$ + CT3 number and bit manipulation functions + $ONELINER$ + + $SYNTAX$ + CTOF( ) --> nFloatingPointNumber + + $ARGUMENTS$ + Designate a string that contains a Harbour + number in flotaing point format. + ATTENTION: different implementations or platforms of Harbour, they + could produce different format in the string returned by FTOC(). + + $RETURNS$ + CTOF() return the floating point number that corresponds to the + string passed. + + $DESCRIPTION$ + Character strings created with FTOC() or XTOC() are convert into + Harbour floating point number + + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + FTOC(), XTOC() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/justify.txt b/harbour/contrib/hbct/doc/en/justify.txt index fb1c65b39c..a0f15a6dec 100644 --- a/harbour/contrib/hbct/doc/en/justify.txt +++ b/harbour/contrib/hbct/doc/en/justify.txt @@ -2,66 +2,66 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * JUSTLEFT() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Move characters from the beginning to the end of a string - * $SYNTAX$ - * JUSTLEFT( <[@]cString>, [|] ) -> cJustifiedString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * JUSTLEFT() is compatible with CT3's JUSTLEFT(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * JUSTRIGHT() - * $END$ +/* $DOC$ + $FUNCNAME$ + JUSTLEFT() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Move characters from the beginning to the end of a string + $SYNTAX$ + JUSTLEFT( <[@]cString>, [|] ) -> cJustifiedString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + JUSTLEFT() is compatible with CT3's JUSTLEFT(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + JUSTRIGHT() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * JUSTRIGHT() - * $CATEGORY$ - * Harbour Tools string functions - * $ONELINER$ - * Move characters from the end to the beginning of a string - * $SYNTAX$ - * JUSTRIGHT( <[@]cString>, [|] ) -> cJustifiedString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * JUSTRIGHT() is compatible with CT3's JUSTRIGHT(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * JUSTLEFT() - * $END$ +/* $DOC$ + $FUNCNAME$ + JUSTRIGHT() + $CATEGORY$ + Harbour Tools string functions + $ONELINER$ + Move characters from the end to the beginning of a string + $SYNTAX$ + JUSTRIGHT( <[@]cString>, [|] ) -> cJustifiedString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + JUSTRIGHT() is compatible with CT3's JUSTRIGHT(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + JUSTLEFT() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/keyset.txt b/harbour/contrib/hbct/doc/en/keyset.txt index 11cf0f72e6..d916e3cae1 100644 --- a/harbour/contrib/hbct/doc/en/keyset.txt +++ b/harbour/contrib/hbct/doc/en/keyset.txt @@ -2,130 +2,130 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * KSETINS() - * $CATEGORY$ - * CT3 switch and state functions - * $ONELINER$ - * - * $SYNTAX$ - * KSETINS( [] ) -> lOldSwitch - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * DOS - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + KSETINS() + $CATEGORY$ + CT3 switch and state functions + $ONELINER$ + + $SYNTAX$ + KSETINS( [] ) -> lOldSwitch + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + DOS + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * KSETCAPS() - * $CATEGORY$ - * CT3 switch and state functions - * $ONELINER$ - * - * $SYNTAX$ - * KSETCAPS( [] ) -> lOldSwitch - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * DOS - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + KSETCAPS() + $CATEGORY$ + CT3 switch and state functions + $ONELINER$ + + $SYNTAX$ + KSETCAPS( [] ) -> lOldSwitch + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + DOS + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * KSETNUM() - * $CATEGORY$ - * CT3 switch and state functions - * $ONELINER$ - * - * $SYNTAX$ - * KSETNUM( [] ) -> lOldSwitch - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * DOS - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + KSETNUM() + $CATEGORY$ + CT3 switch and state functions + $ONELINER$ + + $SYNTAX$ + KSETNUM( [] ) -> lOldSwitch + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + DOS + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * KSETSCROLL() - * $CATEGORY$ - * CT3 switch and state functions - * $ONELINER$ - * - * $SYNTAX$ - * KSETSCROLL( [] ) -> lOldSwitch - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * DOS - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + KSETSCROLL() + $CATEGORY$ + CT3 switch and state functions + $ONELINER$ + + $SYNTAX$ + KSETSCROLL( [] ) -> lOldSwitch + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + DOS + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/misc1.txt b/harbour/contrib/hbct/doc/en/misc1.txt index ccce3d6e46..919bc66e31 100644 --- a/harbour/contrib/hbct/doc/en/misc1.txt +++ b/harbour/contrib/hbct/doc/en/misc1.txt @@ -2,50 +2,50 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * XTOC() - * $CATEGORY$ - * CT3 miscellaneous functions - * $ONELINER$ - * - * $SYNTAX$ - * XTOC( ) --> cValue - * - * $ARGUMENTS$ - * Designate an expression of some of the following data - * type: NUMBER, CHARACTER, DATE, LOGICAL. - * - * $RETURNS$ - * XTOC() return a string with the representation of data type of - * expValue. - * - * $DESCRIPTION$ - * Each data type always returns a string with a particular fixed length: - * - * ----------------------------------------------------------- - * Data Type Result Length Similar function - * ----------------------------------------------------------- - * Numeric sizeof( DOUBLE ) FTOC() - * Logical 1 - * Date 8 DTOS() - * String Unchanged - * ----------------------------------------------------------- - * - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CTOF(), FTOC() - * $END$ +/* $DOC$ + $FUNCNAME$ + XTOC() + $CATEGORY$ + CT3 miscellaneous functions + $ONELINER$ + + $SYNTAX$ + XTOC( ) --> cValue + + $ARGUMENTS$ + Designate an expression of some of the following data + type: NUMBER, CHARACTER, DATE, LOGICAL. + + $RETURNS$ + XTOC() return a string with the representation of data type of + expValue. + + $DESCRIPTION$ + Each data type always returns a string with a particular fixed length: + + ----------------------------------------------------------- + Data Type Result Length Similar function + ----------------------------------------------------------- + Numeric sizeof( DOUBLE ) FTOC() + Logical 1 + Date 8 DTOS() + String Unchanged + ----------------------------------------------------------- + + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CTOF(), FTOC() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/num1.txt b/harbour/contrib/hbct/doc/en/num1.txt index 8ebdda0732..adf9559d68 100644 --- a/harbour/contrib/hbct/doc/en/num1.txt +++ b/harbour/contrib/hbct/doc/en/num1.txt @@ -2,114 +2,114 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * CELSIUS() - * $CATEGORY$ - * CT3 numeric functions - * $ONELINER$ - * Temperature conversion Fahrenheit to Celsius - * $SYNTAX$ - * CELSIUS( nDegreeFahrenheit ) --> nDegreeCelsius - * $ARGUMENTS$ - * temperature in degree Fahrenheit - * $RETURNS$ - * temperate in degree Celsius - * $DESCRIPTION$ - * CELSIUS() converts temperature values measured in the Fahrenheit scale - * to the Celsius scale. - * $EXAMPLES$ - * // melting point of water in standard conditions - * ? celsius( 32.0 ) // --> 0.0 - * // boiling point of water in standard conditions - * ? celsius( 212.0 ) // --> 100.0 - * $TESTS$ - * celsius( 32.0 ) == 0.0 - * celsius( 212.0 ) == 100.0 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * CELSIUS() is compatible with CT3's CELSIUS(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * FAHRENHEIT() - * $END$ +/* $DOC$ + $FUNCNAME$ + CELSIUS() + $CATEGORY$ + CT3 numeric functions + $ONELINER$ + Temperature conversion Fahrenheit to Celsius + $SYNTAX$ + CELSIUS( nDegreeFahrenheit ) --> nDegreeCelsius + $ARGUMENTS$ + temperature in degree Fahrenheit + $RETURNS$ + temperate in degree Celsius + $DESCRIPTION$ + CELSIUS() converts temperature values measured in the Fahrenheit scale + to the Celsius scale. + $EXAMPLES$ + // melting point of water in standard conditions + ? celsius( 32.0 ) // --> 0.0 + // boiling point of water in standard conditions + ? celsius( 212.0 ) // --> 100.0 + $TESTS$ + celsius( 32.0 ) == 0.0 + celsius( 212.0 ) == 100.0 + $STATUS$ + Ready + $COMPLIANCE$ + CELSIUS() is compatible with CT3's CELSIUS(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + FAHRENHEIT() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FAHRENHEIT() - * $CATEGORY$ - * CT3 numeric functions - * $ONELINER$ - * Temperature conversion Celsius to Fahrenheit - * $SYNTAX$ - * FAHRENHEIT( nDegreeCelsius ) --> nDegreeFahrenheit - * $ARGUMENTS$ - * temperate in degree Celsius - * $RETURNS$ - * temperature in degree Fahrenheit - * $DESCRIPTION$ - * FAHRENHEIT() converts temperature values measured in the Celsius scale - * to the Fahrenheit scale. - * $EXAMPLES$ - * // melting point of water in standard conditions - * ? fahrenheit( 0.0 ) // --> 32.0 - * // boiling point of water in standard conditions - * ? fahrenheit( 100.0 ) // --> 212.0 - * $TESTS$ - * fahrenheit( 0.0 ) == 32.0 - * celsius( 100.0 ) == 212.0 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * FAHRENHEIT() is compatible with CT3's FAHRENHEIT(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CELSIUS() - * $END$ +/* $DOC$ + $FUNCNAME$ + FAHRENHEIT() + $CATEGORY$ + CT3 numeric functions + $ONELINER$ + Temperature conversion Celsius to Fahrenheit + $SYNTAX$ + FAHRENHEIT( nDegreeCelsius ) --> nDegreeFahrenheit + $ARGUMENTS$ + temperate in degree Celsius + $RETURNS$ + temperature in degree Fahrenheit + $DESCRIPTION$ + FAHRENHEIT() converts temperature values measured in the Celsius scale + to the Fahrenheit scale. + $EXAMPLES$ + // melting point of water in standard conditions + ? fahrenheit( 0.0 ) // --> 32.0 + // boiling point of water in standard conditions + ? fahrenheit( 100.0 ) // --> 212.0 + $TESTS$ + fahrenheit( 0.0 ) == 32.0 + celsius( 100.0 ) == 212.0 + $STATUS$ + Ready + $COMPLIANCE$ + FAHRENHEIT() is compatible with CT3's FAHRENHEIT(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CELSIUS() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * INFINITY() - * $CATEGORY$ - * CT3 numeric functions - * $ONELINER$ - * Returns the largest floating point number available in the system - * $SYNTAX$ - * INFINITY( [] ) --> nLargestNumber - * $ARGUMENTS$ - * [] .T., if the function should return - * the maximum floating point value - * available (DBL_MAX) - * .F., function should try to return - * the same value as the original CT3 lib did - * Default: .F. - * $RETURNS$ - * the largest floating point number available in the system - * $DESCRIPTION$ - * INFINITY() returns the largest floating point number available - * in the system. For platform independance, this is set to DBL_MAX. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * INFINITY() must not necessarily return the same number as CT3's INFINITY(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + INFINITY() + $CATEGORY$ + CT3 numeric functions + $ONELINER$ + Returns the largest floating point number available in the system + $SYNTAX$ + INFINITY( [] ) --> nLargestNumber + $ARGUMENTS$ + [] .T., if the function should return + the maximum floating point value + available (DBL_MAX) + .F., function should try to return + the same value as the original CT3 lib did + Default: .F. + $RETURNS$ + the largest floating point number available in the system + $DESCRIPTION$ + INFINITY() returns the largest floating point number available + in the system. For platform independance, this is set to DBL_MAX. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + INFINITY() must not necessarily return the same number as CT3's INFINITY(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/numat.txt b/harbour/contrib/hbct/doc/en/numat.txt index 095e8330b6..765aa1e449 100644 --- a/harbour/contrib/hbct/doc/en/numat.txt +++ b/harbour/contrib/hbct/doc/en/numat.txt @@ -2,34 +2,34 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * NUMAT() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Number of occurrences of a sequence in a string - * $SYNTAX$ - * NUMAT( , , [] ) --> nCount - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * NUMAT() is compatible with CT3's NUMAT(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CSETATMUPA(),SETATLIKE() - * $END$ +/* $DOC$ + $FUNCNAME$ + NUMAT() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Number of occurrences of a sequence in a string + $SYNTAX$ + NUMAT( , , [] ) --> nCount + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + NUMAT() is compatible with CT3's NUMAT(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CSETATMUPA(),SETATLIKE() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/numconv.txt b/harbour/contrib/hbct/doc/en/numconv.txt index 1dce433472..979646b356 100644 --- a/harbour/contrib/hbct/doc/en/numconv.txt +++ b/harbour/contrib/hbct/doc/en/numconv.txt @@ -2,130 +2,130 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * NTOC() - * $CATEGORY$ - * CT3 number and bit manipulation functions - * $ONELINER$ - * - * $SYNTAX$ - * NTOC( [, ][,][,] ) -> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CTON() - * $END$ +/* $DOC$ + $FUNCNAME$ + NTOC() + $CATEGORY$ + CT3 number and bit manipulation functions + $ONELINER$ + + $SYNTAX$ + NTOC( [, ][,][,] ) -> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CTON() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CTON() - * $CATEGORY$ - * CT3 number and bit manipulation functions - * $ONELINER$ - * - * $SYNTAX$ - * CTON( [, ][,] ) -> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * NTOC() - * $END$ +/* $DOC$ + $FUNCNAME$ + CTON() + $CATEGORY$ + CT3 number and bit manipulation functions + $ONELINER$ + + $SYNTAX$ + CTON( [, ][,] ) -> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + NTOC() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * BITTOC() - * $CATEGORY$ - * CT3 number and bit manipulation functions - * $ONELINER$ - * - * $SYNTAX$ - * BITTOC( , [,] ) -> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CTOBIT() - * $END$ +/* $DOC$ + $FUNCNAME$ + BITTOC() + $CATEGORY$ + CT3 number and bit manipulation functions + $ONELINER$ + + $SYNTAX$ + BITTOC( , [,] ) -> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CTOBIT() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CTOBIT() - * $CATEGORY$ - * CT3 number and bit manipulation functions - * $ONELINER$ - * - * $SYNTAX$ - * CTOBIT( , ) -> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * BITTOC() - * $END$ +/* $DOC$ + $FUNCNAME$ + CTOBIT() + $CATEGORY$ + CT3 number and bit manipulation functions + $ONELINER$ + + $SYNTAX$ + CTOBIT( , ) -> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + BITTOC() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/pos1.txt b/harbour/contrib/hbct/doc/en/pos1.txt index d9733b2fbe..ba8ceb7734 100644 --- a/harbour/contrib/hbct/doc/en/pos1.txt +++ b/harbour/contrib/hbct/doc/en/pos1.txt @@ -2,131 +2,131 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * POSALPHA() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Left-most position of a letter in a string - * $SYNTAX$ - * POSALPHA( , [], [] ) -> nPosition - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * POSALPHA() is compatible with CT3's POSALPHA(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * POSLOWER(),POSUPPER(),POSRANGE() - * $END$ +/* $DOC$ + $FUNCNAME$ + POSALPHA() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Left-most position of a letter in a string + $SYNTAX$ + POSALPHA( , [], [] ) -> nPosition + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + POSALPHA() is compatible with CT3's POSALPHA(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + POSLOWER(),POSUPPER(),POSRANGE() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * POSLOWER() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Left-most position of a lowercase letter in a string - * $SYNTAX$ - * POSLOWER( , [], [] ) -> nPosition - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * POSLOWER() is compatible with CT3's POSLOWER(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * POSALPHA(),POSUPPER(),POSRANGE() - * $END$ +/* $DOC$ + $FUNCNAME$ + POSLOWER() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Left-most position of a lowercase letter in a string + $SYNTAX$ + POSLOWER( , [], [] ) -> nPosition + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + POSLOWER() is compatible with CT3's POSLOWER(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + POSALPHA(),POSUPPER(),POSRANGE() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * POSRANGE() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Left-most position of a character from a set in a string - * $SYNTAX$ - * POSRANGE( , , , [], - * [] ) -> nPosition - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * POSRANGE() is compatible with CT3's POSRANGE(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * POSALPHA(),POSLOWER(),POSUPPER() - * $END$ +/* $DOC$ + $FUNCNAME$ + POSRANGE() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Left-most position of a character from a set in a string + $SYNTAX$ + POSRANGE( , , , [], + [] ) -> nPosition + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + POSRANGE() is compatible with CT3's POSRANGE(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + POSALPHA(),POSLOWER(),POSUPPER() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * POSUPPER() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Left-most position of an uppercase letter in a string - * $SYNTAX$ - * POSUPPER( , [], [] ) -> nPosition - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * POSUPPER() is compatible with CT3's POSUPPER(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * POSALPHA(),POSLOWER(),POSRANGE() - * $END$ +/* $DOC$ + $FUNCNAME$ + POSUPPER() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Left-most position of an uppercase letter in a string + $SYNTAX$ + POSUPPER( , [], [] ) -> nPosition + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + POSUPPER() is compatible with CT3's POSUPPER(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + POSALPHA(),POSLOWER(),POSRANGE() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/pos2.txt b/harbour/contrib/hbct/doc/en/pos2.txt index 03074c0b95..8a9e2a56b5 100644 --- a/harbour/contrib/hbct/doc/en/pos2.txt +++ b/harbour/contrib/hbct/doc/en/pos2.txt @@ -2,130 +2,130 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * POSCHAR() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Replace character at a certain position within a string - * $SYNTAX$ - * POSCHAR( <[@]cString>, , [] ) -> cString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * POSCHAR() is compatible with CT3's POSCHAR(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * POSDEL(),POSINS(),POSREPL(),CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + POSCHAR() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Replace character at a certain position within a string + $SYNTAX$ + POSCHAR( <[@]cString>, , [] ) -> cString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + POSCHAR() is compatible with CT3's POSCHAR(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + POSDEL(),POSINS(),POSREPL(),CSETREF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * POSDEL() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Delete characters at a certain position within a string - * $SYNTAX$ - * POSDEL( , [], ) -> cString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * POSDEL() is compatible with CT3's POSDEL(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * POSCHAR(),POSINS(),POSREPL() - * $END$ +/* $DOC$ + $FUNCNAME$ + POSDEL() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Delete characters at a certain position within a string + $SYNTAX$ + POSDEL( , [], ) -> cString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + POSDEL() is compatible with CT3's POSDEL(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + POSCHAR(),POSINS(),POSREPL() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * POSINS() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Insert characters at a certain position within a string - * $SYNTAX$ - * POSINS( , , [] ) -> cString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * POSINS() is compatible with CT3's POSINS(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * POSCHAR,POSDEL(),POSREPL() - * $END$ +/* $DOC$ + $FUNCNAME$ + POSINS() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Insert characters at a certain position within a string + $SYNTAX$ + POSINS( , , [] ) -> cString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + POSINS() is compatible with CT3's POSINS(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + POSCHAR,POSDEL(),POSREPL() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * POSREPL() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Replace characters at a certain position within a string - * $SYNTAX$ - * POSREPL( <[@]cString>, , [] ) -> cString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * POSREPL() is compatible with CT3's POSREPL(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * POSCHAR(),POSDEL(),POSINS(),CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + POSREPL() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Replace characters at a certain position within a string + $SYNTAX$ + POSREPL( <[@]cString>, , [] ) -> cString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + POSREPL() is compatible with CT3's POSREPL(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + POSCHAR(),POSDEL(),POSINS(),CSETREF() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/posdiff.txt b/harbour/contrib/hbct/doc/en/posdiff.txt index 8e5a2480a3..c0800a3d99 100644 --- a/harbour/contrib/hbct/doc/en/posdiff.txt +++ b/harbour/contrib/hbct/doc/en/posdiff.txt @@ -2,66 +2,66 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * POSDIFF() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * The left-most position there two string differ - * $SYNTAX$ - * POSDIFF( , , [] ) -> nPosition - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * POSDIFF() is compatible with CT3's POSDIFF(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * POSEQUAL() - * $END$ +/* $DOC$ + $FUNCNAME$ + POSDIFF() + $CATEGORY$ + CT3 string functions + $ONELINER$ + The left-most position there two string differ + $SYNTAX$ + POSDIFF( , , [] ) -> nPosition + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + POSDIFF() is compatible with CT3's POSDIFF(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + POSEQUAL() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * POSEQUAL() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * The left-most position there two string begin to be equal - * $SYNTAX$ - * POSEQUAL( , , [], [] ) -> nPosition - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * POSEQUAL() is compatible with CT3's POSEQUAL(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * POSDIFF() - * $END$ +/* $DOC$ + $FUNCNAME$ + POSEQUAL() + $CATEGORY$ + CT3 string functions + $ONELINER$ + The left-most position there two string begin to be equal + $SYNTAX$ + POSEQUAL( , , [], [] ) -> nPosition + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + POSEQUAL() is compatible with CT3's POSEQUAL(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + POSDIFF() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/print.txt b/harbour/contrib/hbct/doc/en/print.txt index ac62ed5392..724e249626 100644 --- a/harbour/contrib/hbct/doc/en/print.txt +++ b/harbour/contrib/hbct/doc/en/print.txt @@ -2,66 +2,66 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * PRINTSTAT() - * $CATEGORY$ - * CT3 printer functions - * $ONELINER$ - * - * $SYNTAX$ - * PRINTSTAT( [] ) -> nState - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * DOS - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + PRINTSTAT() + $CATEGORY$ + CT3 printer functions + $ONELINER$ + + $SYNTAX$ + PRINTSTAT( [] ) -> nState + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + DOS + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * PRINTREADY() - * $CATEGORY$ - * CT3 printer functions - * $ONELINER$ - * - * $SYNTAX$ - * PRINTREADY( [] ) -> lPrinterReady - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * DOS - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + PRINTREADY() + $CATEGORY$ + CT3 printer functions + $ONELINER$ + + $SYNTAX$ + PRINTREADY( [] ) -> lPrinterReady + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + DOS + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/range.txt b/harbour/contrib/hbct/doc/en/range.txt index 95e743803e..e675857542 100644 --- a/harbour/contrib/hbct/doc/en/range.txt +++ b/harbour/contrib/hbct/doc/en/range.txt @@ -2,77 +2,77 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * RANGEREM() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Remove characters within a certain ASCII range from a string - * $SYNTAX$ - * RANGEREM( , , ) -> cString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * ? rangerem( "0", "9", "year2002.dbf" ) // "year.dbf", remove all digits - * ? rangerem( "9", "0", "year2002.dbf" ) // "22", testing removal from "9" to Chr(255) - * // and from Chr(0) to "0" - * ? rangerem( "0", "9", "yearcurr.dbf" ) // "yearcurr.dbf", test leaving string untouched - * $TESTS$ - * rangerem( "0", "9", "year2002.dbf" ) == "year.dbf" - * rangerem( "9", "0", "year2002.dbf" ) == "22" - * rangerem( "0", "9", "yearcurr.dbf" ) == "yearcurr.dbf" - * $STATUS$ - * Started - * $COMPLIANCE$ - * RANGEREM() is compatible with CT3's RANGEREM(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * RANGEREPL() - * $END$ +/* $DOC$ + $FUNCNAME$ + RANGEREM() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Remove characters within a certain ASCII range from a string + $SYNTAX$ + RANGEREM( , , ) -> cString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + ? rangerem( "0", "9", "year2002.dbf" ) // "year.dbf", remove all digits + ? rangerem( "9", "0", "year2002.dbf" ) // "22", testing removal from "9" to Chr(255) + // and from Chr(0) to "0" + ? rangerem( "0", "9", "yearcurr.dbf" ) // "yearcurr.dbf", test leaving string untouched + $TESTS$ + rangerem( "0", "9", "year2002.dbf" ) == "year.dbf" + rangerem( "9", "0", "year2002.dbf" ) == "22" + rangerem( "0", "9", "yearcurr.dbf" ) == "yearcurr.dbf" + $STATUS$ + Started + $COMPLIANCE$ + RANGEREM() is compatible with CT3's RANGEREM(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + RANGEREPL() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * RANGEREPL - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Replace characters within a certain ASCII range from a string - * $SYNTAX$ - * RANGEREPL( , , - * <[@]cString>, ) -> cString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * ? rangerepl( "0", "9", "year2002.dbf", "?" ) // "year????.dbf", replace all digits - * ? rangerepl( "9", "0", "year2002.dbf", "?" ) // "????2??2????", testing replacement from "9" to Chr(255) - * // and from Chr(0) to "0" - * ? rangerepl( "0", "9", "yearcurr.dbf", "?" ) // "yearcurr.dbf", test leaving string untouched - * $TESTS$ - * rangerepl( "0", "9", "year2002.dbf", "?" ) == "year????.dbf" - * rangerepl( "9", "0", "year2002.dbf", "?" ) == "????2??2????" - * rangerepl( "0", "9", "yearcurr.dbf", "?" ) == "yearcurr.dbf" - * $STATUS$ - * Started - * $COMPLIANCE$ - * RANGEREPL() is compatible with CT3's RANGEREPL(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * RANGEREM() - * $END$ +/* $DOC$ + $FUNCNAME$ + RANGEREPL + $CATEGORY$ + CT3 string functions + $ONELINER$ + Replace characters within a certain ASCII range from a string + $SYNTAX$ + RANGEREPL( , , + <[@]cString>, ) -> cString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + ? rangerepl( "0", "9", "year2002.dbf", "?" ) // "year????.dbf", replace all digits + ? rangerepl( "9", "0", "year2002.dbf", "?" ) // "????2??2????", testing replacement from "9" to Chr(255) + // and from Chr(0) to "0" + ? rangerepl( "0", "9", "yearcurr.dbf", "?" ) // "yearcurr.dbf", test leaving string untouched + $TESTS$ + rangerepl( "0", "9", "year2002.dbf", "?" ) == "year????.dbf" + rangerepl( "9", "0", "year2002.dbf", "?" ) == "????2??2????" + rangerepl( "0", "9", "yearcurr.dbf", "?" ) == "yearcurr.dbf" + $STATUS$ + Started + $COMPLIANCE$ + RANGEREPL() is compatible with CT3's RANGEREPL(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + RANGEREM() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/relation.txt b/harbour/contrib/hbct/doc/en/relation.txt index df623ae0ef..0974d904dc 100644 --- a/harbour/contrib/hbct/doc/en/relation.txt +++ b/harbour/contrib/hbct/doc/en/relation.txt @@ -2,69 +2,69 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARRELA() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Character relation of two strings - * $SYNTAX$ - * CHARRELA( , , - * , ) -> nPosition - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * CHARRELA() is compatible with CT3's CHARRELA(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARRELREP() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARRELA() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Character relation of two strings + $SYNTAX$ + CHARRELA( , , + , ) -> nPosition + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + CHARRELA() is compatible with CT3's CHARRELA(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARRELREP() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARRELREP() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Relation dependant character replacement - * $SYNTAX$ - * CHARRELREP( , , - * , <[@]cString2>, - * ) -> cString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * CHARRELREP() is compatible with CT3's CHARRELREP(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARRELA(),CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARRELREP() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Relation dependant character replacement + $SYNTAX$ + CHARRELREP( , , + , <[@]cString2>, + ) -> cString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + CHARRELREP() is compatible with CT3's CHARRELREP(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARRELA(),CSETREF() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/remove.txt b/harbour/contrib/hbct/doc/en/remove.txt index 4316b74377..0e497f85b7 100644 --- a/harbour/contrib/hbct/doc/en/remove.txt +++ b/harbour/contrib/hbct/doc/en/remove.txt @@ -2,98 +2,98 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * REMALL() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Remove certain characters at the left and right of a string - * $SYNTAX$ - * REMALL( , [] ) -> cString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * REMALL() is compatible with CT3's REMALL(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * REMLEFT(),REMRIGHT() - * $END$ +/* $DOC$ + $FUNCNAME$ + REMALL() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Remove certain characters at the left and right of a string + $SYNTAX$ + REMALL( , [] ) -> cString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + REMALL() is compatible with CT3's REMALL(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + REMLEFT(),REMRIGHT() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * REMLEFT() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Remove certain characters at the left of a string - * $SYNTAX$ - * REMLEFT( , [] ) -> cString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * REMLEFT() is compatible with CT3's REMLEFT(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * REMALL(),REMRIGHT() - * $END$ +/* $DOC$ + $FUNCNAME$ + REMLEFT() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Remove certain characters at the left of a string + $SYNTAX$ + REMLEFT( , [] ) -> cString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + REMLEFT() is compatible with CT3's REMLEFT(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + REMALL(),REMRIGHT() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * REMRIGHT() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Remove certain characters at the right of a string - * $SYNTAX$ - * REMRIGHT( , [] ) -> cString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * REMRIGHT() is compatible with CT3's REMRIGHT(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * REMALL(),REMLEFT() - * $END$ +/* $DOC$ + $FUNCNAME$ + REMRIGHT() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Remove certain characters at the right of a string + $SYNTAX$ + REMRIGHT( , [] ) -> cString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + REMRIGHT() is compatible with CT3's REMRIGHT(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + REMALL(),REMLEFT() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/replace.txt b/harbour/contrib/hbct/doc/en/replace.txt index f0002039ab..9d89700124 100644 --- a/harbour/contrib/hbct/doc/en/replace.txt +++ b/harbour/contrib/hbct/doc/en/replace.txt @@ -2,98 +2,98 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * REPLALL() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Replace certain characters at the left and right of a string - * $SYNTAX$ - * REPLALL( , , [] ) -> cString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * REPLALL() is compatible with CT3's REPLALL(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * REPLLEFT(),REPLRIGHT() - * $END$ +/* $DOC$ + $FUNCNAME$ + REPLALL() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Replace certain characters at the left and right of a string + $SYNTAX$ + REPLALL( , , [] ) -> cString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + REPLALL() is compatible with CT3's REPLALL(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + REPLLEFT(),REPLRIGHT() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * REPLLEFT() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Replace certain characters at the left of a string - * $SYNTAX$ - * REPLLEFT( , , [] ) -> cString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * REPLLEFT() is compatible with CT3's REPLLEFT(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * REPLALL(),REPLRIGHT() - * $END$ +/* $DOC$ + $FUNCNAME$ + REPLLEFT() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Replace certain characters at the left of a string + $SYNTAX$ + REPLLEFT( , , [] ) -> cString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + REPLLEFT() is compatible with CT3's REPLLEFT(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + REPLALL(),REPLRIGHT() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * REPLRIGHT() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Replace certain characters at the right of a string - * $SYNTAX$ - * REPLRIGHT( , , [] ) -> cString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * REPLRIGHT() is compatible with CT3's REPLRIGHT(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * REPLALL(),REPLLEFT() - * $END$ +/* $DOC$ + $FUNCNAME$ + REPLRIGHT() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Replace certain characters at the right of a string + $SYNTAX$ + REPLRIGHT( , , [] ) -> cString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + REPLRIGHT() is compatible with CT3's REPLRIGHT(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + REPLALL(),REPLLEFT() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/screen1.txt b/harbour/contrib/hbct/doc/en/screen1.txt index bbdb55b146..5d27dfe93b 100644 --- a/harbour/contrib/hbct/doc/en/screen1.txt +++ b/harbour/contrib/hbct/doc/en/screen1.txt @@ -2,356 +2,356 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * SCREENATTR() - * $CATEGORY$ - * CT3 video functions - * $ONELINER$ - * - * $SYNTAX$ - * SCREENATTR( [],[] ) -> - * $ARGUMENTS$ - * Designates the line from which to determine the attribute. - * The default is the cursor line. - * - * Designates the column from which to determine the - * attribute. The default is the cursor column. - * - * $RETURNS$ - * SCREENATTR() returns the attribute at the designated position. - * - * $DESCRIPTION$ - * SCREENATTR() returns the current screen attribute at and - * . You can query targeted attributes this way and save them - * to use later, or process them later with INVERTATTR(). - * - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + SCREENATTR() + $CATEGORY$ + CT3 video functions + $ONELINER$ + + $SYNTAX$ + SCREENATTR( [],[] ) -> + $ARGUMENTS$ + Designates the line from which to determine the attribute. + The default is the cursor line. + + Designates the column from which to determine the + attribute. The default is the cursor column. + + $RETURNS$ + SCREENATTR() returns the attribute at the designated position. + + $DESCRIPTION$ + SCREENATTR() returns the current screen attribute at and + . You can query targeted attributes this way and save them + to use later, or process them later with INVERTATTR(). + + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * SCREENMIX() - * $CATEGORY$ - * CT3 video functions - * $ONELINER$ - * - * $SYNTAX$ - * SCREENMIX( , , [], [] ) -> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + SCREENMIX() + $CATEGORY$ + CT3 video functions + $ONELINER$ + + $SYNTAX$ + SCREENMIX( , , [], [] ) -> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * SAYSCREEN() - * $CATEGORY$ - * CT3 video functions - * $ONELINER$ - * - * $SYNTAX$ - * SAYSCREEN( , [], [] ) -> - * $ARGUMENTS$ - * - the string to output. Although undocumented, can be NIL. - * - row number, defaults to cursor row. - * - column number, defaults to cursor column. - * $RETURNS$ - * Returns an empty string. - * $DESCRIPTION$ - * Outputs a string at specified coordinates without changing character - * attributes. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * SCREENMIX() - * $END$ +/* $DOC$ + $FUNCNAME$ + SAYSCREEN() + $CATEGORY$ + CT3 video functions + $ONELINER$ + + $SYNTAX$ + SAYSCREEN( , [], [] ) -> + $ARGUMENTS$ + - the string to output. Although undocumented, can be NIL. + - row number, defaults to cursor row. + - column number, defaults to cursor column. + $RETURNS$ + Returns an empty string. + $DESCRIPTION$ + Outputs a string at specified coordinates without changing character + attributes. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + SCREENMIX() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * INVERTWIN() - * $CATEGORY$ - * CT3 video functions - * $ONELINER$ - * - * $SYNTAX$ - * - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * INVERTWIN() is compatible with CT3's INVERTWIN(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + INVERTWIN() + $CATEGORY$ + CT3 video functions + $ONELINER$ + + $SYNTAX$ + + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + INVERTWIN() is compatible with CT3's INVERTWIN(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * UNTEXTWIN() - * $CATEGORY$ - * CT3 video functions - * $ONELINER$ - * - * $SYNTAX$ - * UNTEXTWIN( , , , , - * , - * [], - * [] ) --> cNull - * $ARGUMENTS$ - * Designates the line for the upper-left corner of the - * area. - * Designates the column for the upper-left corner of - * the area. - * Designates the line for the bottom-right corner of - * the area. - * Designates the line for the bottom-right column of - * the area. - * Replaces each - * character within the window, with the exception of those within the - * range of and - * . - * Designates the beginning of - * the bracketed area. The character can be number in the range of 0 to - * 255, or the character string type. The default value is 176. - * Designates the end of the bracketed - * area. The character can be number in the range of 0 to 255 or the - * character string type. The default value is 223. - * $RETURNS$ - * Returns a null string. - * $DESCRIPTION$ - * Replaces an area of characters from a region of the screen - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + UNTEXTWIN() + $CATEGORY$ + CT3 video functions + $ONELINER$ + + $SYNTAX$ + UNTEXTWIN( , , , , + , + [], + [] ) --> cNull + $ARGUMENTS$ + Designates the line for the upper-left corner of the + area. + Designates the column for the upper-left corner of + the area. + Designates the line for the bottom-right corner of + the area. + Designates the line for the bottom-right column of + the area. + Replaces each + character within the window, with the exception of those within the + range of and + . + Designates the beginning of + the bracketed area. The character can be number in the range of 0 to + 255, or the character string type. The default value is 176. + Designates the end of the bracketed + area. The character can be number in the range of 0 to 255 or the + character string type. The default value is 223. + $RETURNS$ + Returns a null string. + $DESCRIPTION$ + Replaces an area of characters from a region of the screen + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARWIN() - * $CATEGORY$ - * CT3 video functions - * $ONELINER$ - * - * $SYNTAX$ - * CHARWIN( , , , , [], - * [] ) --> - * $ARGUMENTS$ - * - top row number, default 0 - * - left column number, default 0 - * - top row number, default MaxRow() - * - right column number, default MaxCol() - * - new character for the screen area, - * as a numeric value in the range of 0 to - * 255 or as a character string, default value is the CLEARB. - * - character to exchange. Specify the parameter - * as a numeric in the range of 0 to 255 - * or as a character string. The default is to exchange all characters. - * $RETURNS$ - * Returns an empty string. - * $DESCRIPTION$ - * Exchanges particular characters in a screen area. - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARWIN() + $CATEGORY$ + CT3 video functions + $ONELINER$ + + $SYNTAX$ + CHARWIN( , , , , [], + [] ) --> + $ARGUMENTS$ + - top row number, default 0 + - left column number, default 0 + - top row number, default MaxRow() + - right column number, default MaxCol() + - new character for the screen area, + as a numeric value in the range of 0 to + 255 or as a character string, default value is the CLEARB. + - character to exchange. Specify the parameter + as a numeric in the range of 0 to 255 + or as a character string. The default is to exchange all characters. + $RETURNS$ + Returns an empty string. + $DESCRIPTION$ + Exchanges particular characters in a screen area. + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * COLORWIN() - * $CATEGORY$ - * CT3 video functions - * $ONELINER$ - * - * $SYNTAX$ - * COLORWIN( [], [], [], [], - * [], [] ) --> cNull - * $ARGUMENTS$ - * Designates the topmost line to begin processing. The - * default is the cursor line. - * Designates the leftmost column to begin processing. The - * default is the cursor column. - * Designates the bottommost line that is processed. - * The default is the last screen line or window line. - * Designates the rightmost column to clear. The default - * is the right screen border or window border. - * Designates the new attribute to replace the old - * one. The default is the standard attribute CLEARA. - * Designates the old character to exchange. The - * default is "exchange all attributes". - * $RETURNS$ - * Returns an empty string. - * $DESCRIPTION$ - * Exchanges particular attributes in a screen area - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + COLORWIN() + $CATEGORY$ + CT3 video functions + $ONELINER$ + + $SYNTAX$ + COLORWIN( [], [], [], [], + [], [] ) --> cNull + $ARGUMENTS$ + Designates the topmost line to begin processing. The + default is the cursor line. + Designates the leftmost column to begin processing. The + default is the cursor column. + Designates the bottommost line that is processed. + The default is the last screen line or window line. + Designates the rightmost column to clear. The default + is the right screen border or window border. + Designates the new attribute to replace the old + one. The default is the standard attribute CLEARA. + Designates the old character to exchange. The + default is "exchange all attributes". + $RETURNS$ + Returns an empty string. + $DESCRIPTION$ + Exchanges particular attributes in a screen area + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * SCREENTEXT() - * $CATEGORY$ - * CT video functions (Harbour extension) - * $ONELINER$ - * - * $SYNTAX$ - * SCREENTEXT( , , , ) - * $ARGUMENTS$ - * - top row number, default 0 - * - left column number, default 0 - * - top row number, default MaxRow() - * - right column number, default MaxCol() - * $RETURNS$ - * Returns string with characters taken from given screen region. - * $DESCRIPTION$ - * Returns string with characters taken from given screen region. - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + SCREENTEXT() + $CATEGORY$ + CT video functions (Harbour extension) + $ONELINER$ + + $SYNTAX$ + SCREENTEXT( , , , ) + $ARGUMENTS$ + - top row number, default 0 + - left column number, default 0 + - top row number, default MaxRow() + - right column number, default MaxCol() + $RETURNS$ + Returns string with characters taken from given screen region. + $DESCRIPTION$ + Returns string with characters taken from given screen region. + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * COLORREPL() - * $CATEGORY$ - * CT3 video functions - * $ONELINER$ - * - * $SYNTAX$ - * COLORREPL( [], [] ) --> cNull - * $ARGUMENTS$ - * Designates the new attribute. The default is - * CLEARA. - * Designates the old attribute to exchange. The - * default is all existing attributes. - * $RETURNS$ - * Returns an empty string. - * $DESCRIPTION$ - * Exchanges particular screen attributes - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + COLORREPL() + $CATEGORY$ + CT3 video functions + $ONELINER$ + + $SYNTAX$ + COLORREPL( [], [] ) --> cNull + $ARGUMENTS$ + Designates the new attribute. The default is + CLEARA. + Designates the old attribute to exchange. The + default is all existing attributes. + $RETURNS$ + Returns an empty string. + $DESCRIPTION$ + Exchanges particular screen attributes + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/strdiff.txt b/harbour/contrib/hbct/doc/en/strdiff.txt index 014253907f..6853c681fa 100644 --- a/harbour/contrib/hbct/doc/en/strdiff.txt +++ b/harbour/contrib/hbct/doc/en/strdiff.txt @@ -2,70 +2,70 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * STRDIFF() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Evaluate the "Edit (Levensthein) Distance" of two strings - * $SYNTAX$ - * STRDIFF( , , [], [], - * [] ) -> - * $ARGUMENTS$ - * string at the "starting point" of the transformation process, default is "" - * string at the "end point" of the transformation process, default is "" - * penalty points for a replacement of one character, default is 3 - * penalty points for a deletion of one character, default is 6 - * penalty points for an insertion of one character, default is 1 - * $RETURNS$ - * penalty point sum of all operations needed to transform to - * $DESCRIPTION$ - * The STRDIFF() functions calculates the so called "Edit" or "Levensthein" distance of two strings. - * This distance is a measure for the number of single character replace/insert/delete operations (so called - * "point mutations") required to transform into and its value will be the smallest sum of - * the penalty points of the required operations. - * - * Be aware that this function is both quite time - O(len(cString1)*len(cString2)) - and memory consuming - - * O((len(cString1)+1)*(len(cString2)+1)*sizeof(int)) - so keep the strings as short as possible. - * E.g., on common 32 bit systems (sizeof(int) == 4), calling strdiff() with two strings of 1024 bytes - * in length will consume 4 MB of memory. To not impose unneeded restrictions, the function will only check if - * (len(cString1)+1)*(len(cString2)+1)*sizeof(int) <= UINT_MAX, although allocing UINT_MAX bytes will not - * work on most systems. If this simple check fails, -1 is returned. - * - * Also, be aware that there can be an overflow when the penalty points are summed up: Assuming that the - * number of transformation operations is in the order of max(len(cString1),len(cString2)), the penalty point - * sum, that is internally stored in an "int" variable, is in the order of - * (max(len(cString1),len(cString2))*max(nReplacementPenalty,nDeletionPenalty,nInsertionPentaly). - * The STRDIFF() does not do an overflow check due to time performance reasons. Future versions of STRDIFF() - * could use a type different to "int" to store the penalty point sum to save memory or to avoid overflows. - * - * The function is aware of the settings done by SETATLIKE(), that means that the wildchar character - * is considered equal to ALL characters. - * - * $EXAMPLES$ - * ? strdiff( "ABC", "ADC" ) // 3, one character replaced - * ? strdiff( "ABC", "AEC" ) // 3, dito - * ? strdiff( "CBA", "ABC" ) // 6, two characters replaced - * ? strdiff( "ABC", "AXBC" ) // 1, one character inserted - * ? strdiff( "AXBC", "ABC" ) // 6, one character removed - * ? strdiff( "AXBC", "ADC" ) // 9, one character removed and one replaced - * $TESTS$ - * strdiff( "ABC", "ADC" ) == 3 - * strdiff( "ABC", "AEC" ) == 3 - * strdiff( "CBA", "ABC" ) == 6 - * strdiff( "ABC", "AXBC" ) == 1 - * strdiff( "AXBC", "ABC" ) == 6 - * strdiff( "AXBC", "ADC" ) == 9 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * STRDIFF() is compatible with CT3's STRDIFF(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * SETATLIKE() - * $END$ +/* $DOC$ + $FUNCNAME$ + STRDIFF() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Evaluate the "Edit (Levensthein) Distance" of two strings + $SYNTAX$ + STRDIFF( , , [], [], + [] ) -> + $ARGUMENTS$ + string at the "starting point" of the transformation process, default is "" + string at the "end point" of the transformation process, default is "" + penalty points for a replacement of one character, default is 3 + penalty points for a deletion of one character, default is 6 + penalty points for an insertion of one character, default is 1 + $RETURNS$ + penalty point sum of all operations needed to transform to + $DESCRIPTION$ + The STRDIFF() functions calculates the so called "Edit" or "Levensthein" distance of two strings. + This distance is a measure for the number of single character replace/insert/delete operations (so called + "point mutations") required to transform into and its value will be the smallest sum of + the penalty points of the required operations. + + Be aware that this function is both quite time - O(len(cString1)*len(cString2)) - and memory consuming - + O((len(cString1)+1)*(len(cString2)+1)*sizeof(int)) - so keep the strings as short as possible. + E.g., on common 32 bit systems (sizeof(int) == 4), calling strdiff() with two strings of 1024 bytes + in length will consume 4 MB of memory. To not impose unneeded restrictions, the function will only check if + (len(cString1)+1)*(len(cString2)+1)*sizeof(int) <= UINT_MAX, although allocing UINT_MAX bytes will not + work on most systems. If this simple check fails, -1 is returned. + + Also, be aware that there can be an overflow when the penalty points are summed up: Assuming that the + number of transformation operations is in the order of max(len(cString1),len(cString2)), the penalty point + sum, that is internally stored in an "int" variable, is in the order of + (max(len(cString1),len(cString2))*max(nReplacementPenalty,nDeletionPenalty,nInsertionPentaly). + The STRDIFF() does not do an overflow check due to time performance reasons. Future versions of STRDIFF() + could use a type different to "int" to store the penalty point sum to save memory or to avoid overflows. + + The function is aware of the settings done by SETATLIKE(), that means that the wildchar character + is considered equal to ALL characters. + + $EXAMPLES$ + ? strdiff( "ABC", "ADC" ) // 3, one character replaced + ? strdiff( "ABC", "AEC" ) // 3, dito + ? strdiff( "CBA", "ABC" ) // 6, two characters replaced + ? strdiff( "ABC", "AXBC" ) // 1, one character inserted + ? strdiff( "AXBC", "ABC" ) // 6, one character removed + ? strdiff( "AXBC", "ADC" ) // 9, one character removed and one replaced + $TESTS$ + strdiff( "ABC", "ADC" ) == 3 + strdiff( "ABC", "AEC" ) == 3 + strdiff( "CBA", "ABC" ) == 6 + strdiff( "ABC", "AXBC" ) == 1 + strdiff( "AXBC", "ABC" ) == 6 + strdiff( "AXBC", "ADC" ) == 9 + $STATUS$ + Ready + $COMPLIANCE$ + STRDIFF() is compatible with CT3's STRDIFF(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + SETATLIKE() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/strswap.txt b/harbour/contrib/hbct/doc/en/strswap.txt index f630efe7e1..b3521ea036 100644 --- a/harbour/contrib/hbct/doc/en/strswap.txt +++ b/harbour/contrib/hbct/doc/en/strswap.txt @@ -2,34 +2,34 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * STRSWAP() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Swap the contents of two strings - * $SYNTAX$ - * STRSWAP( <[@]cString1>, <[@]cString2> ) -> cString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * STRSWAP() is compatible with CT3's STRSWAP(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + STRSWAP() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Swap the contents of two strings + $SYNTAX$ + STRSWAP( <[@]cString1>, <[@]cString2> ) -> cString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + STRSWAP() is compatible with CT3's STRSWAP(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/tab.txt b/harbour/contrib/hbct/doc/en/tab.txt index 95afa14096..db96df691b 100644 --- a/harbour/contrib/hbct/doc/en/tab.txt +++ b/harbour/contrib/hbct/doc/en/tab.txt @@ -2,100 +2,100 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * TABEXPAND() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Replace tabulator control characters with fill characters - * $SYNTAX$ - * TABEXPAND (, [], [], - * [], [], - * []) -> cExpandedString - * $ARGUMENTS$ - * - * - * - * string indicating new line, - * default is the string returned by - * hb_eol() - * character indicating a tab stop, - * default is Chr(9) - * .T., if the soft-CR used by MEMOEDIT() - * should be ignored as a newline indicator, - * default is .F. (functions uses Chr(141)) - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * tabexpand("-"+Chr(9)+"!") == "- !" - * tabexpand("----"+Chr(9) +"!") == "---- !" - * tabexpand("-"+Chr(9)+"!",, "+") == "-+++++++!" - * tabexpand("-"+Chr(9)+ "!", 4) == "- !" - * tabexpand("----"+Chr(9)+ "!", 8) == "---- !" - * tabexpand("----"+Chr(9)+ "!", 8, "+") == "----++++!" - * tabexpand("-"+Chr(9)+"!"+hb_eol()+"----"+Chr(9)+ "!",, "+") == "-+++++++!"+hb_eol()+"----++++!" - * $STATUS$ - * Started - * $COMPLIANCE$ - * TABEXPAND() is compatible with CT3's TABEXPAND(), but there are - * three new parameters for a better fine control of the function's - * behaviour. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * TABPACK() - * $END$ +/* $DOC$ + $FUNCNAME$ + TABEXPAND() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Replace tabulator control characters with fill characters + $SYNTAX$ + TABEXPAND (, [], [], + [], [], + []) -> cExpandedString + $ARGUMENTS$ + + + + string indicating new line, + default is the string returned by + hb_eol() + character indicating a tab stop, + default is Chr(9) + .T., if the soft-CR used by MEMOEDIT() + should be ignored as a newline indicator, + default is .F. (functions uses Chr(141)) + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + tabexpand("-"+Chr(9)+"!") == "- !" + tabexpand("----"+Chr(9) +"!") == "---- !" + tabexpand("-"+Chr(9)+"!",, "+") == "-+++++++!" + tabexpand("-"+Chr(9)+ "!", 4) == "- !" + tabexpand("----"+Chr(9)+ "!", 8) == "---- !" + tabexpand("----"+Chr(9)+ "!", 8, "+") == "----++++!" + tabexpand("-"+Chr(9)+"!"+hb_eol()+"----"+Chr(9)+ "!",, "+") == "-+++++++!"+hb_eol()+"----++++!" + $STATUS$ + Started + $COMPLIANCE$ + TABEXPAND() is compatible with CT3's TABEXPAND(), but there are + three new parameters for a better fine control of the function's + behaviour. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + TABPACK() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * TABPACK() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Pack fill characters to appropriate tab characters - * $SYNTAX$ - * TABPACK( , [], [], - * [], [], - * [] ) -> cPackedString - * $ARGUMENTS$ - * - * - * - * string indicating new line, - * default is the string returned by - * hb_eol() - * character indicating a tab stop, - * default is Chr(9) - * .T., if the soft-CR used by MEMOEDIT() - * should be ignored as a newline indicator, - * default is .F. (functions uses Chr(141)) - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * TABPACK() is compatible with CT3's TABPACK(), but there are - * three new parameters for a better fine control of the function's - * behaviour. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * TABEXPAND() - * $END$ +/* $DOC$ + $FUNCNAME$ + TABPACK() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Pack fill characters to appropriate tab characters + $SYNTAX$ + TABPACK( , [], [], + [], [], + [] ) -> cPackedString + $ARGUMENTS$ + + + + string indicating new line, + default is the string returned by + hb_eol() + character indicating a tab stop, + default is Chr(9) + .T., if the soft-CR used by MEMOEDIT() + should be ignored as a newline indicator, + default is .F. (functions uses Chr(141)) + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + TABPACK() is compatible with CT3's TABPACK(), but there are + three new parameters for a better fine control of the function's + behaviour. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + TABEXPAND() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/token1.txt b/harbour/contrib/hbct/doc/en/token1.txt index b7269a4989..5452d15035 100644 --- a/harbour/contrib/hbct/doc/en/token1.txt +++ b/harbour/contrib/hbct/doc/en/token1.txt @@ -2,333 +2,333 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * ATTOKEN() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Position of a token in a string - * $SYNTAX$ - * ATTOKEN( , [], - * [], [] ) -> nPosition - * $ARGUMENTS$ - * is the processed string - * [] is a list of characters separating the tokens - * in - * Default: Chr( 0 ) + Chr( 9 ) + Chr( 10 ) + - * Chr( 13 ) + Chr( 26 ) + Chr( 32 ) + - * Chr( 32 ) + Chr( 138 ) + Chr( 141 ) + - * ",.;:!\?/\\<>()#&%+-*" - * [] specifies the count of the token whose - * position should be calculated - * Default: last token - * [] specifies the maximum number of successive - * tokenizing characters that are combined as - * ONE token stop, e.g. specifying 1 can - * yield to empty tokens - * Default: 0, any number of successive tokenizing - * characters are combined as ONE token stop - * $RETURNS$ - * The start position of the specified token or - * 0 if such a token does not exist in . - * $DESCRIPTION$ - * The ATTOKEN() function calculates the start position of tne - * th token in . By setting the new - * parameter to a value different than 0, you can specify how many tokenizing - * characters are combined at most to one token stop. Be aware that - * this can result to empty tokens there the start position is not - * defined clearly. Then, ATTOKEN() returns the position there the - * token WOULD start if its length is larger than 0. To check for - * empty tokens, simply look if the character at the returned position - * is within the tokenizer list. - * $EXAMPLES$ - * attoken( "Hello, World!" ) // --> 8 // empty strings after tokenizer - * // are not a token ! - * $TESTS$ - * attoken( "Hello, World!" ) == 8 - * attoken( "Hello, World!",, 2 ) == 8 - * attoken( "Hello, World!",, 2, 1 ) == 7 - * attoken( "Hello, World!", " ", 2, 1 ) == 8 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * ATTOKEN() is compatible with CT3's ATTOKEN, but has an additional - * 4th parameter to let you specify a skip width equal to that in the - * TOKEN() function. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * TOKEN(),NUMTOKEN(),TOKENLOWER(),TOKENUPPER(),TOKENSEP() - * $END$ +/* $DOC$ + $FUNCNAME$ + ATTOKEN() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Position of a token in a string + $SYNTAX$ + ATTOKEN( , [], + [], [] ) -> nPosition + $ARGUMENTS$ + is the processed string + [] is a list of characters separating the tokens + in + Default: Chr( 0 ) + Chr( 9 ) + Chr( 10 ) + + Chr( 13 ) + Chr( 26 ) + Chr( 32 ) + + Chr( 32 ) + Chr( 138 ) + Chr( 141 ) + + ",.;:!\?/\\<>()#&%+-*" + [] specifies the count of the token whose + position should be calculated + Default: last token + [] specifies the maximum number of successive + tokenizing characters that are combined as + ONE token stop, e.g. specifying 1 can + yield to empty tokens + Default: 0, any number of successive tokenizing + characters are combined as ONE token stop + $RETURNS$ + The start position of the specified token or + 0 if such a token does not exist in . + $DESCRIPTION$ + The ATTOKEN() function calculates the start position of tne + th token in . By setting the new + parameter to a value different than 0, you can specify how many tokenizing + characters are combined at most to one token stop. Be aware that + this can result to empty tokens there the start position is not + defined clearly. Then, ATTOKEN() returns the position there the + token WOULD start if its length is larger than 0. To check for + empty tokens, simply look if the character at the returned position + is within the tokenizer list. + $EXAMPLES$ + attoken( "Hello, World!" ) // --> 8 // empty strings after tokenizer + // are not a token ! + $TESTS$ + attoken( "Hello, World!" ) == 8 + attoken( "Hello, World!",, 2 ) == 8 + attoken( "Hello, World!",, 2, 1 ) == 7 + attoken( "Hello, World!", " ", 2, 1 ) == 8 + $STATUS$ + Ready + $COMPLIANCE$ + ATTOKEN() is compatible with CT3's ATTOKEN, but has an additional + 4th parameter to let you specify a skip width equal to that in the + TOKEN() function. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + TOKEN(),NUMTOKEN(),TOKENLOWER(),TOKENUPPER(),TOKENSEP() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * TOKEN() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Tokens of a string - * $SYNTAX$ - * TOKEN( , [], - * [], - * [<@cPreTokenSep>], [<@cPostTokenSep>] ) -> cToken - * $ARGUMENTS$ - * is the processed string - * [] is a list of characters separating the tokens - * in - * Default: Chr( 0 ) + Chr( 9 ) + Chr( 10 ) + - * Chr( 13 ) + Chr( 26 ) + Chr( 32 ) + - * Chr( 32 ) + Chr( 138 ) + Chr( 141 ) + - * ",.;:!\?/\\<>()#&%+-*" - * [] specifies the count of the token that - * should be extracted - * Default: last token - * [] specifies the maximum number of successive - * tokenizing characters that are combined as - * ONE token stop, e.g. specifying 1 can - * yield to empty token - * Default: 0, any number of successive tokenizing - * characters are combined as ONE token stop - * [<@cPreTokenSep>] If given by reference, the tokenizer before - * the actual token will be stored - * [<@cPostTokenSep>] If given by reference, the tokenizer after - * the actual token will be stored - * $RETURNS$ - * the token specified by the parameters given above - * $DESCRIPTION$ - * The TOKEN() function extracts the th token from the - * string . In the course of this, the tokens in the - * string are separated by the character(s) specified in . - * The function may also extract empty tokens, if you specify a skip - * width other than zero. - * Be aware of the new 5th and 6th parameter there the TOKEN() function - * stores the tokenizing character before and after the extracted token. - * Therefore, additional calls to the TOKENSEP() function are not - * necessary. - * $EXAMPLES$ - * ? token( "Hello, World!" ) --> "World" - * ? token( "Hello, World!",, 2, 1 ) --> "" - * ? token( "Hello, World!", ",", 2, 1 ) --> " World!" - * ? token( "Hello, World!", " ", 2, 1 ) --> "World!" - * $TESTS$ - * token( "Hello, World!" ) == "World" - * token( "Hello, World!",, 2, 1 ) == "" - * token( "Hello, World!", ",", 2, 1 ) == " World!" - * token( "Hello, World!", " ", 2, 1 ) == "World!" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * TOKEN() is compatible with CT3's TOKEN, but two additional - * parameters have been added there the TOKEN() function can store - * the tokenizers before and after the current token. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * NUMTOKEN(),ATTOKEN(),TOKENLOWER(),TOKENUPPER(),TOKENSEP() - * $END$ +/* $DOC$ + $FUNCNAME$ + TOKEN() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Tokens of a string + $SYNTAX$ + TOKEN( , [], + [], + [<@cPreTokenSep>], [<@cPostTokenSep>] ) -> cToken + $ARGUMENTS$ + is the processed string + [] is a list of characters separating the tokens + in + Default: Chr( 0 ) + Chr( 9 ) + Chr( 10 ) + + Chr( 13 ) + Chr( 26 ) + Chr( 32 ) + + Chr( 32 ) + Chr( 138 ) + Chr( 141 ) + + ",.;:!\?/\\<>()#&%+-*" + [] specifies the count of the token that + should be extracted + Default: last token + [] specifies the maximum number of successive + tokenizing characters that are combined as + ONE token stop, e.g. specifying 1 can + yield to empty token + Default: 0, any number of successive tokenizing + characters are combined as ONE token stop + [<@cPreTokenSep>] If given by reference, the tokenizer before + the actual token will be stored + [<@cPostTokenSep>] If given by reference, the tokenizer after + the actual token will be stored + $RETURNS$ + the token specified by the parameters given above + $DESCRIPTION$ + The TOKEN() function extracts the th token from the + string . In the course of this, the tokens in the + string are separated by the character(s) specified in . + The function may also extract empty tokens, if you specify a skip + width other than zero. + Be aware of the new 5th and 6th parameter there the TOKEN() function + stores the tokenizing character before and after the extracted token. + Therefore, additional calls to the TOKENSEP() function are not + necessary. + $EXAMPLES$ + ? token( "Hello, World!" ) --> "World" + ? token( "Hello, World!",, 2, 1 ) --> "" + ? token( "Hello, World!", ",", 2, 1 ) --> " World!" + ? token( "Hello, World!", " ", 2, 1 ) --> "World!" + $TESTS$ + token( "Hello, World!" ) == "World" + token( "Hello, World!",, 2, 1 ) == "" + token( "Hello, World!", ",", 2, 1 ) == " World!" + token( "Hello, World!", " ", 2, 1 ) == "World!" + $STATUS$ + Ready + $COMPLIANCE$ + TOKEN() is compatible with CT3's TOKEN, but two additional + parameters have been added there the TOKEN() function can store + the tokenizers before and after the current token. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + NUMTOKEN(),ATTOKEN(),TOKENLOWER(),TOKENUPPER(),TOKENSEP() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * NUMTOKEN() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Retrieves the number of tokens in a string - * $SYNTAX$ - * NUMTOKEN( , [], [] ) -> nTokenCount - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * numtoken( "Hello, World!" ) == 2 - * numtoken( "This is good. See you! How do you do?", ".!?" ) == 3 - * numtoken( "one,,three,four,,six", ",", 1 ) == 6 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * NUMTOKEN() is compatible with CT3's NUMTOKEN(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * TOKEN(),ATTOKEN(),TOKENLOWER(),TOKENUPPER(),TOKENSEP() - * $END$ +/* $DOC$ + $FUNCNAME$ + NUMTOKEN() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Retrieves the number of tokens in a string + $SYNTAX$ + NUMTOKEN( , [], [] ) -> nTokenCount + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + numtoken( "Hello, World!" ) == 2 + numtoken( "This is good. See you! How do you do?", ".!?" ) == 3 + numtoken( "one,,three,four,,six", ",", 1 ) == 6 + $STATUS$ + Ready + $COMPLIANCE$ + NUMTOKEN() is compatible with CT3's NUMTOKEN(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + TOKEN(),ATTOKEN(),TOKENLOWER(),TOKENUPPER(),TOKENSEP() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * TOKENLOWER() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Change the first letter of tokens to lower case - * $SYNTAX$ - * TOKENLOWER( <[@]cString>, [], [], - * [] ) -> cString - * $ARGUMENTS$ - * <[@]cString> is the processed string - * [] is a list of characters separating the tokens - * in - * Default: Chr( 0 ) + Chr( 9 ) + Chr( 10 ) + - * Chr( 13 ) + Chr( 26 ) + Chr( 32 ) + - * Chr( 32 ) + Chr( 138 ) + Chr( 141 ) + - * ",.;:!\?/\\<>()#&%+-*" - * [] specifies the number of tokens that - * should be processed - * Default: all tokens - * [] specifies the maximum number of successive - * tokenizing characters that are combined as - * ONE token stop, e.g. specifying 1 can - * yield to empty token - * Default: 0, any number of successive tokenizing - * characters are combined as ONE token stop - * $RETURNS$ - * the string with the lowercased tokens - * $DESCRIPTION$ - * The TOKENLOWER() function changes the first letter of tokens in - * to lower case. To do this, it uses the same tokenizing mechanism - * as the token() function. If TOKENLOWER() extracts a token that starts - * with a letter, this letter will be changed to lower case. - * You can omit the return value of this function by setting the CSETREF() - * switch to .T., but you must then pass by reference to get - * the result. - * $EXAMPLES$ - * ? tokenlower( "Hello, World, here I am!" ) // "hello, world, here i am!" - * ? tokenlower( "Hello, World, here I am!",, 3 ) // "hello, world, here I am!" - * ? tokenlower( "Hello, World, here I am!", ",", 3 ) // "hello, World, here I am!" - * ? tokenlower( "Hello, World, here I am!", " W" ) // "hello, World, here i am!" - * $TESTS$ - * tokenlower( "Hello, World, here I am!" ) == "hello, world, here i am!" - * tokenlower( "Hello, World, here I am!",, 3 ) == "hello, world, here I am!" - * tokenlower( "Hello, World, here I am!", ",", 3 ) == "hello, World, here I am!" - * tokenlower( "Hello, World, here I am!", " W" ) == "hello, World, here i am!" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * TOKENLOWER() is compatible with CT3's TOKENLOWER(), - * but a new 4th parameter, has been added for - * synchronization with the the other token functions. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * TOKEN(),NUMTOKEN(),ATTOKEN(),TOKENUPPER(),TOKENSEP(),CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + TOKENLOWER() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Change the first letter of tokens to lower case + $SYNTAX$ + TOKENLOWER( <[@]cString>, [], [], + [] ) -> cString + $ARGUMENTS$ + <[@]cString> is the processed string + [] is a list of characters separating the tokens + in + Default: Chr( 0 ) + Chr( 9 ) + Chr( 10 ) + + Chr( 13 ) + Chr( 26 ) + Chr( 32 ) + + Chr( 32 ) + Chr( 138 ) + Chr( 141 ) + + ",.;:!\?/\\<>()#&%+-*" + [] specifies the number of tokens that + should be processed + Default: all tokens + [] specifies the maximum number of successive + tokenizing characters that are combined as + ONE token stop, e.g. specifying 1 can + yield to empty token + Default: 0, any number of successive tokenizing + characters are combined as ONE token stop + $RETURNS$ + the string with the lowercased tokens + $DESCRIPTION$ + The TOKENLOWER() function changes the first letter of tokens in + to lower case. To do this, it uses the same tokenizing mechanism + as the token() function. If TOKENLOWER() extracts a token that starts + with a letter, this letter will be changed to lower case. + You can omit the return value of this function by setting the CSETREF() + switch to .T., but you must then pass by reference to get + the result. + $EXAMPLES$ + ? tokenlower( "Hello, World, here I am!" ) // "hello, world, here i am!" + ? tokenlower( "Hello, World, here I am!",, 3 ) // "hello, world, here I am!" + ? tokenlower( "Hello, World, here I am!", ",", 3 ) // "hello, World, here I am!" + ? tokenlower( "Hello, World, here I am!", " W" ) // "hello, World, here i am!" + $TESTS$ + tokenlower( "Hello, World, here I am!" ) == "hello, world, here i am!" + tokenlower( "Hello, World, here I am!",, 3 ) == "hello, world, here I am!" + tokenlower( "Hello, World, here I am!", ",", 3 ) == "hello, World, here I am!" + tokenlower( "Hello, World, here I am!", " W" ) == "hello, World, here i am!" + $STATUS$ + Ready + $COMPLIANCE$ + TOKENLOWER() is compatible with CT3's TOKENLOWER(), + but a new 4th parameter, has been added for + synchronization with the the other token functions. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + TOKEN(),NUMTOKEN(),ATTOKEN(),TOKENUPPER(),TOKENSEP(),CSETREF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * TOKENUPPER() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Change the first letter of tokens to upper case - * $SYNTAX$ - * TOKENUPPER( <[@]cString>, [], [], - * [] ) -> cString - * $ARGUMENTS$ - * <[@]cString> is the processed string - * [] is a list of characters separating the tokens - * in - * Default: Chr( 0 ) + Chr( 9 ) + Chr( 10 ) + - * Chr( 13 ) + Chr( 26 ) + Chr( 32 ) + - * Chr( 32 ) + Chr( 138 ) + Chr( 141 ) + - * ",.;:!\?/\\<>()#&%+-*" - * [] specifies the number of tokens that - * should be processed - * Default: all tokens - * [] specifies the maximum number of successive - * tokenizing characters that are combined as - * ONE token stop, e.g. specifying 1 can - * yield to empty token - * Default: 0, any number of successive tokenizing - * characters are combined as ONE token stop - * $RETURNS$ - * the string with the uppercased tokens - * $DESCRIPTION$ - * The TOKENUPPER() function changes the first letter of tokens in - * to upper case. To do this, it uses the same tokenizing mechanism - * as the token() function. If TOKENUPPER() extracts a token that starts - * with a letter, this letter will be changed to upper case. - * You can omit the return value of this function by setting the CSETREF() - * switch to .T., but you must then pass by reference to get - * the result. - * $EXAMPLES$ - * ? tokenupper( "Hello, world, here I am!" ) // "Hello, World, Here I Am!" - * ? tokenupper( "Hello, world, here I am!",, 3 ) // "Hello, World, Here I am!" - * ? tokenupper( "Hello, world, here I am!", ",", 3 ) // "Hello, world, here I am!" - * ? tokenupper( "Hello, world, here I am!", " w" ) // "Hello, wOrld, Here I Am!" - * $TESTS$ - * tokenupper( "Hello, world, here I am!" ) == "Hello, World, Here I Am!" - * tokenupper( "Hello, world, here I am!",, 3 ) == "Hello, World, Here I am!" - * tokenupper( "Hello, world, here I am!", ",", 3 ) == "Hello, world, here I am!" - * tokenupper( "Hello, world, here I am!", " w" ) == "Hello, wOrld, Here I Am!" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * TOKENUPPER() is compatible with CT3's TOKENUPPER(), - * but a new 4th parameter, has been added for - * synchronization with the the other token functions. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * TOKEN(),NUMTOKEN(),ATTOKEN(),TOKENLOWER(),TOKENSEP(),CSETREF() - * $END$ +/* $DOC$ + $FUNCNAME$ + TOKENUPPER() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Change the first letter of tokens to upper case + $SYNTAX$ + TOKENUPPER( <[@]cString>, [], [], + [] ) -> cString + $ARGUMENTS$ + <[@]cString> is the processed string + [] is a list of characters separating the tokens + in + Default: Chr( 0 ) + Chr( 9 ) + Chr( 10 ) + + Chr( 13 ) + Chr( 26 ) + Chr( 32 ) + + Chr( 32 ) + Chr( 138 ) + Chr( 141 ) + + ",.;:!\?/\\<>()#&%+-*" + [] specifies the number of tokens that + should be processed + Default: all tokens + [] specifies the maximum number of successive + tokenizing characters that are combined as + ONE token stop, e.g. specifying 1 can + yield to empty token + Default: 0, any number of successive tokenizing + characters are combined as ONE token stop + $RETURNS$ + the string with the uppercased tokens + $DESCRIPTION$ + The TOKENUPPER() function changes the first letter of tokens in + to upper case. To do this, it uses the same tokenizing mechanism + as the token() function. If TOKENUPPER() extracts a token that starts + with a letter, this letter will be changed to upper case. + You can omit the return value of this function by setting the CSETREF() + switch to .T., but you must then pass by reference to get + the result. + $EXAMPLES$ + ? tokenupper( "Hello, world, here I am!" ) // "Hello, World, Here I Am!" + ? tokenupper( "Hello, world, here I am!",, 3 ) // "Hello, World, Here I am!" + ? tokenupper( "Hello, world, here I am!", ",", 3 ) // "Hello, world, here I am!" + ? tokenupper( "Hello, world, here I am!", " w" ) // "Hello, wOrld, Here I Am!" + $TESTS$ + tokenupper( "Hello, world, here I am!" ) == "Hello, World, Here I Am!" + tokenupper( "Hello, world, here I am!",, 3 ) == "Hello, World, Here I am!" + tokenupper( "Hello, world, here I am!", ",", 3 ) == "Hello, world, here I am!" + tokenupper( "Hello, world, here I am!", " w" ) == "Hello, wOrld, Here I Am!" + $STATUS$ + Ready + $COMPLIANCE$ + TOKENUPPER() is compatible with CT3's TOKENUPPER(), + but a new 4th parameter, has been added for + synchronization with the the other token functions. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + TOKEN(),NUMTOKEN(),ATTOKEN(),TOKENLOWER(),TOKENSEP(),CSETREF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * TOKENSEP() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Retrieves the token separators of the last token() call - * $SYNTAX$ - * TOKENSEP( [] ) -> cSeparator - * $ARGUMENTS$ - * [] if set to .T., the token separator BEHIND the token - * retrieved from the token() call will be returned. - * Default: .F., returns the separator BEFORE the token - * $RETURNS$ - * Depending on the setting of , the separating character of the - * the token retrieved from the last token() call will be returned. - * These separating characters can now also be retrieved with the token() - * function. - * $DESCRIPTION$ - * When one does extract tokens from a string with the token() function, - * one might be interested in the separator characters that have been - * used to extract a specific token. To get this information you can - * either use the TOKENSEP() function after each token() call, or - * use the new 5th and 6th parameter of the token() function. - * $EXAMPLES$ - * see TOKEN() function - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * TOKENSEP() is compatible with CT3's TOKENSEP(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * TOKEN(),NUMTOKEN(),ATTOKEN(),TOKENLOWER(),TOKENUPPER() - * $END$ +/* $DOC$ + $FUNCNAME$ + TOKENSEP() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Retrieves the token separators of the last token() call + $SYNTAX$ + TOKENSEP( [] ) -> cSeparator + $ARGUMENTS$ + [] if set to .T., the token separator BEHIND the token + retrieved from the token() call will be returned. + Default: .F., returns the separator BEFORE the token + $RETURNS$ + Depending on the setting of , the separating character of the + the token retrieved from the last token() call will be returned. + These separating characters can now also be retrieved with the token() + function. + $DESCRIPTION$ + When one does extract tokens from a string with the token() function, + one might be interested in the separator characters that have been + used to extract a specific token. To get this information you can + either use the TOKENSEP() function after each token() call, or + use the new 5th and 6th parameter of the token() function. + $EXAMPLES$ + see TOKEN() function + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + TOKENSEP() is compatible with CT3's TOKENSEP(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + TOKEN(),NUMTOKEN(),ATTOKEN(),TOKENLOWER(),TOKENUPPER() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/token2.txt b/harbour/contrib/hbct/doc/en/token2.txt index 1780270516..a93d696160 100644 --- a/harbour/contrib/hbct/doc/en/token2.txt +++ b/harbour/contrib/hbct/doc/en/token2.txt @@ -2,393 +2,393 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * TOKENINIT() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Initializes a token environment - * $SYNTAX$ - * TOKENINIT( <[@]cString>], [], [], - * [<@cTokenEnvironment>] ) -> lState - * $ARGUMENTS$ - * <[@]cString> is the processed string - * is a list of characters separating the tokens - * in - * Default: Chr(0)+Chr(9)+Chr(10)+Chr(13)+Chr(26)+ - * Chr(32)+Chr(32)+Chr(138)+Chr(141)+ - * ",.;:!\?/\\<>()#&%+-*" - * specifies the maximum number of successive - * tokenizing characters that are combined as - * ONE token stop, e.g. specifying 1 can - * yield to empty token - * Default: 0, any number of successive tokenizing - * characters are combined as ONE token stop - * <@cTokenEnvironment> is a token environment stored in a binary - * encoded string - * $RETURNS$ - * success of the initialization - * $DESCRIPTION$ - * The TOKENINIT() function initializes a token environment. A token - * environment is the information about how a string is to be tokenized. - * This information is created in the process of tokenization of the - * string - equal to the one used in the TOKEN() function - * with the help of the and parameters. - * - * This token environment can be very useful when large strings have - * to be tokenized since the tokenization has to take place only once - * whereas the TOKEN() function must always start the tokenizing process - * from scratch. - * - * Unlike CTIII, this function provides two mechanisms of storing the - * resulting token environment. If a variable is passed by reference - * as 4th parameter, the token environment is stored in this variable, - * otherwise the global token environment is used. Do not modify the - * token environment string directly ! - * - * Additionally, a counter is stored in the token environment, so that - * the tokens can successivly be obtained. This counter is first set to 1. - * When the TOKENINIT() function is called without a string a tokenize, - * the counter of either the global environment or the environment given - * by reference in the 4th parameter is rewind to 1. - * - * Additionally, unlike CTIII, tokeninit() does not need the string - * to be passed by reference, since one must provide the - * string in calls to TOKENNEXT() again. - * $EXAMPLES$ - * tokeninit( cString ) // tokenize the string with default - * // rules and store the token environment globally - * // and eventually delete an old global TE - * tokeninit( @cString ) // no difference in result, but eventually faster, - * // since the string must not be copied - * tokeninit() // rewind counter of global TE to 1 - * tokeninit( "1,2,3", "," , 1 ) // tokenize constant string, store in global TE - * tokeninit( cString, , 1, @cTE1) // tokenize cString and store TE in - * // cTE1 only without overriding global TE - * tokeninit( cString, , 1, cTE1 ) // tokenize cString and store TE in - * // GLOBAL TE since 4th parameter is - * // not given by reference !!! - * tokeninit( ,,, @cTE1 ) // set counter in TE stored in cTE1 to 1 - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * TOKENINIT() is compatible with CTIII's TOKENINIT(), - * but there is an additional parameter featuring local token environments. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * TOKEN(),TOKENEXIT(),TOKENNEXT(),TOKENNUM(),TOKENAT(),SAVETOKEN(),RESTTOKEN(),TOKENEND() - * $END$ +/* $DOC$ + $FUNCNAME$ + TOKENINIT() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Initializes a token environment + $SYNTAX$ + TOKENINIT( <[@]cString>], [], [], + [<@cTokenEnvironment>] ) -> lState + $ARGUMENTS$ + <[@]cString> is the processed string + is a list of characters separating the tokens + in + Default: Chr(0)+Chr(9)+Chr(10)+Chr(13)+Chr(26)+ + Chr(32)+Chr(32)+Chr(138)+Chr(141)+ + ",.;:!\?/\\<>()#&%+-*" + specifies the maximum number of successive + tokenizing characters that are combined as + ONE token stop, e.g. specifying 1 can + yield to empty token + Default: 0, any number of successive tokenizing + characters are combined as ONE token stop + <@cTokenEnvironment> is a token environment stored in a binary + encoded string + $RETURNS$ + success of the initialization + $DESCRIPTION$ + The TOKENINIT() function initializes a token environment. A token + environment is the information about how a string is to be tokenized. + This information is created in the process of tokenization of the + string - equal to the one used in the TOKEN() function + with the help of the and parameters. + + This token environment can be very useful when large strings have + to be tokenized since the tokenization has to take place only once + whereas the TOKEN() function must always start the tokenizing process + from scratch. + + Unlike CTIII, this function provides two mechanisms of storing the + resulting token environment. If a variable is passed by reference + as 4th parameter, the token environment is stored in this variable, + otherwise the global token environment is used. Do not modify the + token environment string directly ! + + Additionally, a counter is stored in the token environment, so that + the tokens can successivly be obtained. This counter is first set to 1. + When the TOKENINIT() function is called without a string a tokenize, + the counter of either the global environment or the environment given + by reference in the 4th parameter is rewind to 1. + + Additionally, unlike CTIII, tokeninit() does not need the string + to be passed by reference, since one must provide the + string in calls to TOKENNEXT() again. + $EXAMPLES$ + tokeninit( cString ) // tokenize the string with default + // rules and store the token environment globally + // and eventually delete an old global TE + tokeninit( @cString ) // no difference in result, but eventually faster, + // since the string must not be copied + tokeninit() // rewind counter of global TE to 1 + tokeninit( "1,2,3", "," , 1 ) // tokenize constant string, store in global TE + tokeninit( cString, , 1, @cTE1) // tokenize cString and store TE in + // cTE1 only without overriding global TE + tokeninit( cString, , 1, cTE1 ) // tokenize cString and store TE in + // GLOBAL TE since 4th parameter is + // not given by reference !!! + tokeninit( ,,, @cTE1 ) // set counter in TE stored in cTE1 to 1 + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + TOKENINIT() is compatible with CTIII's TOKENINIT(), + but there is an additional parameter featuring local token environments. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + TOKEN(),TOKENEXIT(),TOKENNEXT(),TOKENNUM(),TOKENAT(),SAVETOKEN(),RESTTOKEN(),TOKENEND() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * TOKENNEXT() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Successivly obtains tokens from a string - * $SYNTAX$ - * TOKENNEXT( <[@]cString>, [], - * [<@cTokenEnvironment>] ) -> cToken - * $ARGUMENTS$ - * <[@]cString> the processed string - * a token number - * <@cTokenEnvironment> a token environment - * $RETURNS$ - * a token from - * $DESCRIPTION$ - * With TOKENNEXT(), the tokens determined with the TOKENINIT() functions - * can be retrieved. To do this, TOKENNEXT() uses the information stored - * in either the global token environment or the local one supplied by - * . Note that, is supplied, this 3rd parameter has - * always to be passed by reference. - * - * If the 2nd parameter, is given, TOKENNEXT() simply returns - * the th token without manipulating the TE counter. Otherwise - * the token pointed to by the TE counter is returned and the counter - * is incremented by one. Like this, a simple loop with TOKENEND() can - * be used to retrieve all tokens of a string successivly. - * - * Note that does not have to be the same used in TOKENINIT(), - * so that one can do a "correlational tokenization", i.e. tokenize a string - * as if it was another! E.G. using TOKENINIT() with the string - * "AA,BBB" but calling TOKENNEXT() with "CCCEE" would - * give first "CC" and then "EE" (because "CCCEE" is not long enough). - * $EXAMPLES$ - * // default behavhiour - * tokeninit( cString ) // initialize a TE - * DO WHILE ! tokenend() - * ? tokennext( cString ) // get all tokens successivly - * ENDDO - * ? tokennext( cString, 3 ) // get the 3rd token, counter will remain the same - * tokenexit() // free the memory used for the global TE - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * TOKENNEXT() is compatible with CTIII's TOKENNEXT(), - * but there are two additional parameters featuring local token - * environments and optional access to tokens. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * TOKENINIT(),TOKENEXIT(),TOKENNUM(),TOKENAT(),SAVETOKEN(),RESTTOKEN(),TOKENEND() - * $END$ +/* $DOC$ + $FUNCNAME$ + TOKENNEXT() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Successivly obtains tokens from a string + $SYNTAX$ + TOKENNEXT( <[@]cString>, [], + [<@cTokenEnvironment>] ) -> cToken + $ARGUMENTS$ + <[@]cString> the processed string + a token number + <@cTokenEnvironment> a token environment + $RETURNS$ + a token from + $DESCRIPTION$ + With TOKENNEXT(), the tokens determined with the TOKENINIT() functions + can be retrieved. To do this, TOKENNEXT() uses the information stored + in either the global token environment or the local one supplied by + . Note that, is supplied, this 3rd parameter has + always to be passed by reference. + + If the 2nd parameter, is given, TOKENNEXT() simply returns + the th token without manipulating the TE counter. Otherwise + the token pointed to by the TE counter is returned and the counter + is incremented by one. Like this, a simple loop with TOKENEND() can + be used to retrieve all tokens of a string successivly. + + Note that does not have to be the same used in TOKENINIT(), + so that one can do a "correlational tokenization", i.e. tokenize a string + as if it was another! E.G. using TOKENINIT() with the string + "AA,BBB" but calling TOKENNEXT() with "CCCEE" would + give first "CC" and then "EE" (because "CCCEE" is not long enough). + $EXAMPLES$ + // default behavhiour + tokeninit( cString ) // initialize a TE + DO WHILE ! tokenend() + ? tokennext( cString ) // get all tokens successivly + ENDDO + ? tokennext( cString, 3 ) // get the 3rd token, counter will remain the same + tokenexit() // free the memory used for the global TE + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + TOKENNEXT() is compatible with CTIII's TOKENNEXT(), + but there are two additional parameters featuring local token + environments and optional access to tokens. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + TOKENINIT(),TOKENEXIT(),TOKENNUM(),TOKENAT(),SAVETOKEN(),RESTTOKEN(),TOKENEND() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * TOKENNUM() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Get the total number of tokens in a token environment - * $SYNTAX$ - * TOKENNUM( [<@cTokenEnvironment>] ) -> nNumberofTokens - * $ARGUMENTS$ - * <@cTokenEnvironment> a token environment - * $RETURNS$ - * number of tokens in the token environment - * $DESCRIPTION$ - * The TOKENNUM() function can be used to retrieve the total number - * of tokens in a token environment. - * If the parameter <@cTokenEnvironment> is supplied (must be by - * reference), the information from this token environment is used, - * otherwise the global TE is used. - * $EXAMPLES$ - * tokeninit( "a.b.c.d", ".", 1 ) // initialize global TE - * ? tokennum() // --> 4 - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * TOKENNUM() is a new function in Harbour's CTIII library. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * TOKENINIT(),TOKENEXIT(),TOKENNEXT(),TOKENAT(),SAVETOKEN(),RESTTOKEN(),TOKENEND() - * $END$ +/* $DOC$ + $FUNCNAME$ + TOKENNUM() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Get the total number of tokens in a token environment + $SYNTAX$ + TOKENNUM( [<@cTokenEnvironment>] ) -> nNumberofTokens + $ARGUMENTS$ + <@cTokenEnvironment> a token environment + $RETURNS$ + number of tokens in the token environment + $DESCRIPTION$ + The TOKENNUM() function can be used to retrieve the total number + of tokens in a token environment. + If the parameter <@cTokenEnvironment> is supplied (must be by + reference), the information from this token environment is used, + otherwise the global TE is used. + $EXAMPLES$ + tokeninit( "a.b.c.d", ".", 1 ) // initialize global TE + ? tokennum() // --> 4 + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + TOKENNUM() is a new function in Harbour's CTIII library. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + TOKENINIT(),TOKENEXIT(),TOKENNEXT(),TOKENAT(),SAVETOKEN(),RESTTOKEN(),TOKENEND() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * TOKENEND() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Check whether additional tokens are available with TOKENNEXT() - * $SYNTAX$ - * TOKENEND( [<@cTokenEnvironment>] ) -> lTokenEnd - * $ARGUMENTS$ - * <@cTokenEnvironment> a token environment - * $RETURNS$ - * .T., if additional tokens are available - * $DESCRIPTION$ - * The TOKENEND() function can be used to check whether the next - * call to TOKENNEXT() would return a new token. This can not be - * decided with TOKENNEXT() alone, since an empty token cannot be - * distinguished from a "no more" tokens. - * If the parameter <@cTokenEnvironment> is supplied (must be by - * reference), the information from this token environment is used, - * otherwise the global TE is used. - * With a combination of TOKENEND() and TOKENNEXT(), all tokens from a - * string can be retrieved successivly (see example). - * $EXAMPLES$ - * tokeninit( "a.b.c.d", ".", 1 ) // initialize global TE - * DO WHILE ! tokenend() - * ? tokennext( "a.b.c.d" ) // get all tokens successivly - * ENDDO - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * TOKENEND() is compatible with CTIII's TOKENEND(), - * but there are is an additional parameter featuring local token environments. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * TOKENINIT(),TOKENEXIT(),TOKENNEXT(),TOKENNUM(),TOKENAT(),SAVETOKEN(),RESTTOKEN() - * $END$ +/* $DOC$ + $FUNCNAME$ + TOKENEND() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Check whether additional tokens are available with TOKENNEXT() + $SYNTAX$ + TOKENEND( [<@cTokenEnvironment>] ) -> lTokenEnd + $ARGUMENTS$ + <@cTokenEnvironment> a token environment + $RETURNS$ + .T., if additional tokens are available + $DESCRIPTION$ + The TOKENEND() function can be used to check whether the next + call to TOKENNEXT() would return a new token. This can not be + decided with TOKENNEXT() alone, since an empty token cannot be + distinguished from a "no more" tokens. + If the parameter <@cTokenEnvironment> is supplied (must be by + reference), the information from this token environment is used, + otherwise the global TE is used. + With a combination of TOKENEND() and TOKENNEXT(), all tokens from a + string can be retrieved successivly (see example). + $EXAMPLES$ + tokeninit( "a.b.c.d", ".", 1 ) // initialize global TE + DO WHILE ! tokenend() + ? tokennext( "a.b.c.d" ) // get all tokens successivly + ENDDO + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + TOKENEND() is compatible with CTIII's TOKENEND(), + but there are is an additional parameter featuring local token environments. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + TOKENINIT(),TOKENEXIT(),TOKENNEXT(),TOKENNUM(),TOKENAT(),SAVETOKEN(),RESTTOKEN() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * TOKENEXIT() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Release global token environment - * $SYNTAX$ - * TOKENEXIT() -> lStaticEnvironmentReleased - * $ARGUMENTS$ - * - * $RETURNS$ - * .T., if global token environment is successfully released - * $DESCRIPTION$ - * The TOKENEXIT() function releases the memory associated with the - * global token environment. One should use it for every tokeninit() - * using the global TE. Additionally, TOKENEXIT() is implicitly called - * from CTEXIT() to free the memory at library shutdown. - * $EXAMPLES$ - * tokeninit( cString ) // initialize a TE - * DO WHILE ! tokenend() - * ? tokennext( cString ) // get all tokens successivly - * ENDDO - * ? tokennext( cString, 3 ) // get the 3rd token, counter will remain the same - * tokenexit() // free the memory used for the global TE - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * TOKENEXIT() is a new function in Harbour's CTIII library. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * TOKENINIT(),TOKENNEXT(),TOKENNUM(),TOKENAT(),SAVETOKEN(),RESTTOKEN(),TOKENEND() - * $END$ +/* $DOC$ + $FUNCNAME$ + TOKENEXIT() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Release global token environment + $SYNTAX$ + TOKENEXIT() -> lStaticEnvironmentReleased + $ARGUMENTS$ + + $RETURNS$ + .T., if global token environment is successfully released + $DESCRIPTION$ + The TOKENEXIT() function releases the memory associated with the + global token environment. One should use it for every tokeninit() + using the global TE. Additionally, TOKENEXIT() is implicitly called + from CTEXIT() to free the memory at library shutdown. + $EXAMPLES$ + tokeninit( cString ) // initialize a TE + DO WHILE ! tokenend() + ? tokennext( cString ) // get all tokens successivly + ENDDO + ? tokennext( cString, 3 ) // get the 3rd token, counter will remain the same + tokenexit() // free the memory used for the global TE + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + TOKENEXIT() is a new function in Harbour's CTIII library. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + TOKENINIT(),TOKENNEXT(),TOKENNUM(),TOKENAT(),SAVETOKEN(),RESTTOKEN(),TOKENEND() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * TOKENAT() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Get start and end positions of tokens in a token environment - * $SYNTAX$ - * TOKENAT( [], [], - * [<@cTokenEnvironment>] ) -> nPosition - * $ARGUMENTS$ - * .T., if TOKENAT() should return - * the position of the separator character - * BEHIND the token. - * Default: .F., return start position of a token. - * a token number - * <@cTokenEnvironment> a token environment - * $RETURNS$ - * - * $DESCRIPTION$ - * The TOKENAT() function is used to retrieve the start and end position - * of the tokens in a token environment. Note however that the position of - * last character of a token is given by tokenat (.T.)-1 !! - * - * If the 2nd parameter, is given, TOKENAT() returns the - * positions of the th token. Otherwise - * the token pointed to by the TE counter, i.e. the token that will - * be retrieved by TOKENNEXT() _NEXT_ is used. - * - * If the parameter <@cTokenEnvironment> is supplied (must be by - * reference), the information from this token environment is used, - * otherwise the global TE is used. - * $EXAMPLES$ - * - * $TESTS$ - * tokeninit( cString ) // initialize a TE - * DO WHILE ! tokenend() - * ? "From", tokenat(), "to", tokenat( .T. ) - 1 - * ? tokennext( cString ) // get all tokens successivly - * ENDDO - * ? tokennext( cString, 3 ) // get the 3rd token, counter will remain the same - * tokenexit() // free the memory used for the global TE - * $STATUS$ - * Ready - * $COMPLIANCE$ - * TOKENAT() is compatible with CTIII's TOKENAT(), - * but there are two additional parameters featuring local token - * environments and optional access to tokens. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * TOKENINIT(),TOKENEXIT(),TOKENNEXT(),TOKENNUM(),SAVETOKEN(),RESTTOKEN(),TOKENEND() - * $END$ +/* $DOC$ + $FUNCNAME$ + TOKENAT() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Get start and end positions of tokens in a token environment + $SYNTAX$ + TOKENAT( [], [], + [<@cTokenEnvironment>] ) -> nPosition + $ARGUMENTS$ + .T., if TOKENAT() should return + the position of the separator character + BEHIND the token. + Default: .F., return start position of a token. + a token number + <@cTokenEnvironment> a token environment + $RETURNS$ + + $DESCRIPTION$ + The TOKENAT() function is used to retrieve the start and end position + of the tokens in a token environment. Note however that the position of + last character of a token is given by tokenat (.T.)-1 !! + + If the 2nd parameter, is given, TOKENAT() returns the + positions of the th token. Otherwise + the token pointed to by the TE counter, i.e. the token that will + be retrieved by TOKENNEXT() _NEXT_ is used. + + If the parameter <@cTokenEnvironment> is supplied (must be by + reference), the information from this token environment is used, + otherwise the global TE is used. + $EXAMPLES$ + + $TESTS$ + tokeninit( cString ) // initialize a TE + DO WHILE ! tokenend() + ? "From", tokenat(), "to", tokenat( .T. ) - 1 + ? tokennext( cString ) // get all tokens successivly + ENDDO + ? tokennext( cString, 3 ) // get the 3rd token, counter will remain the same + tokenexit() // free the memory used for the global TE + $STATUS$ + Ready + $COMPLIANCE$ + TOKENAT() is compatible with CTIII's TOKENAT(), + but there are two additional parameters featuring local token + environments and optional access to tokens. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + TOKENINIT(),TOKENEXIT(),TOKENNEXT(),TOKENNUM(),SAVETOKEN(),RESTTOKEN(),TOKENEND() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * SAVETOKEN() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Save the global token environment - * $SYNTAX$ - * SAVETOKEN() -> cStaticTokenEnvironment - * $ARGUMENTS$ - * - * $RETURNS$ - * a binary string encoding the global TE - * $DESCRIPTION$ - * The SAVETOKEN() function can be used to store the global TE for future - * use or when two or more incremental tokenizers must the nested. - * Note however that the latter can now be solved with locally stored - * token environments. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * SAVETOKEN() is compatible with CTIII's SAVETOKEN(), - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * TOKENINIT(),TOKENEXIT(),TOKENNEXT(),TOKENNUM(),TOKENAT(),RESTTOKEN(),TOKENEND() - * $END$ +/* $DOC$ + $FUNCNAME$ + SAVETOKEN() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Save the global token environment + $SYNTAX$ + SAVETOKEN() -> cStaticTokenEnvironment + $ARGUMENTS$ + + $RETURNS$ + a binary string encoding the global TE + $DESCRIPTION$ + The SAVETOKEN() function can be used to store the global TE for future + use or when two or more incremental tokenizers must the nested. + Note however that the latter can now be solved with locally stored + token environments. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + SAVETOKEN() is compatible with CTIII's SAVETOKEN(), + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + TOKENINIT(),TOKENEXIT(),TOKENNEXT(),TOKENNUM(),TOKENAT(),RESTTOKEN(),TOKENEND() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * RESTTOKEN() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Restore global token environment - * $SYNTAX$ - * RESTTOKEN( ) -> cOldStaticEnvironment - * $ARGUMENTS$ - * a binary string encoding a TE - * $RETURNS$ - * a string encoding the old global TE - * $DESCRIPTION$ - * The RESTTOKEN() function restores the global TE to the one encoded - * in . This can either be the return value - * of SAVETOKEN() or the value stored in the 4th parameter in a - * TOKENINIT() call. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * RESTTOKEN() is compatible with CTIII's RESTTOKEN(), - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * TOKENINIT(),TOKENEXIT(),TOKENNEXT(),TOKENNUM(),TOKENAT(),SAVETOKEN(),TOKENEND() - * $END$ +/* $DOC$ + $FUNCNAME$ + RESTTOKEN() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Restore global token environment + $SYNTAX$ + RESTTOKEN( ) -> cOldStaticEnvironment + $ARGUMENTS$ + a binary string encoding a TE + $RETURNS$ + a string encoding the old global TE + $DESCRIPTION$ + The RESTTOKEN() function restores the global TE to the one encoded + in . This can either be the return value + of SAVETOKEN() or the value stored in the 4th parameter in a + TOKENINIT() call. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + RESTTOKEN() is compatible with CTIII's RESTTOKEN(), + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + TOKENINIT(),TOKENEXIT(),TOKENNEXT(),TOKENNUM(),TOKENAT(),SAVETOKEN(),TOKENEND() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/trig.txt b/harbour/contrib/hbct/doc/en/trig.txt index 7f9465b563..43580787d6 100644 --- a/harbour/contrib/hbct/doc/en/trig.txt +++ b/harbour/contrib/hbct/doc/en/trig.txt @@ -2,547 +2,547 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * PI() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Returns Pi, the perimeter-to-diameter-ratio of a circle - * $SYNTAX$ - * PI() -> nPi - * $ARGUMENTS$ - * - * $RETURNS$ - * the math constant Pi with maximum precision available - * $DESCRIPTION$ - * The function PI() can be used if the constant Pi is needed - * with maximum precision. One of the most known interpretations of this - * number is the constant perimeter-to-diameter-ratio of circles. - * $EXAMPLES$ - * // the diameter of a circle-like swimming pool is 3.4 meters, how - * // long is the perimeter ? - * - * ? Str( PI() * 3.4, 5, 3 ) + " meters" // --> 10.681 meters - * $TESTS$ - * - * $STATUS$ - * Ready - * $COMPLIANCE$ - * PI() is compatible with CT3's PI(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * SIN(),COS(),TAN(),COT(),ASIN(),ACOS(),ATAN(),ATN2(),SINH(),COSH(),TANH(),RTOD(),DTOR() - * $END$ +/* $DOC$ + $FUNCNAME$ + PI() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Returns Pi, the perimeter-to-diameter-ratio of a circle + $SYNTAX$ + PI() -> nPi + $ARGUMENTS$ + + $RETURNS$ + the math constant Pi with maximum precision available + $DESCRIPTION$ + The function PI() can be used if the constant Pi is needed + with maximum precision. One of the most known interpretations of this + number is the constant perimeter-to-diameter-ratio of circles. + $EXAMPLES$ + // the diameter of a circle-like swimming pool is 3.4 meters, how + // long is the perimeter ? + + ? Str( PI() * 3.4, 5, 3 ) + " meters" // --> 10.681 meters + $TESTS$ + + $STATUS$ + Ready + $COMPLIANCE$ + PI() is compatible with CT3's PI(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + SIN(),COS(),TAN(),COT(),ASIN(),ACOS(),ATAN(),ATN2(),SINH(),COSH(),TANH(),RTOD(),DTOR() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * SIN() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Sine of the argument - * $SYNTAX$ - * SIN (nRadiant) -> nSine - * $ARGUMENTS$ - * an angle size given in radiants - * $RETURNS$ - * the sine of - * $DESCRIPTION$ - * The function SIN() calculates the sine of an angle whose size is - * given in radiants (full angle equals 2*Pi - see DTOR() for angle size - * given in degress). - * A common geometric interpretation of the SIN() function is the - * counterkathede-hypotenuse-ratio of a right-angled triangle. - * $EXAMPLES$ - * ? sin( 0.0 ) // --> 0.0 - * ? sin( 1.0 ) // --> 0.8414... - * $TESTS$ - * sin( 0.0 ) == 0.0 - * sin( PI() / 4 ) == sqrt( 1 / 2 ) - * sin( PI() / 2 ) == 1.0 - * sin( PI() ) == 0.0 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * SIN() is compatible with CT3's SIN(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * COS(),TAN(),COT(),ASIN(),ACOS(),ATAN(),ATN2(),SINH(),COSH(),TANH(),RTOD(),DTOR(),PI() - * $END$ +/* $DOC$ + $FUNCNAME$ + SIN() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Sine of the argument + $SYNTAX$ + SIN (nRadiant) -> nSine + $ARGUMENTS$ + an angle size given in radiants + $RETURNS$ + the sine of + $DESCRIPTION$ + The function SIN() calculates the sine of an angle whose size is + given in radiants (full angle equals 2*Pi - see DTOR() for angle size + given in degress). + A common geometric interpretation of the SIN() function is the + counterkathede-hypotenuse-ratio of a right-angled triangle. + $EXAMPLES$ + ? sin( 0.0 ) // --> 0.0 + ? sin( 1.0 ) // --> 0.8414... + $TESTS$ + sin( 0.0 ) == 0.0 + sin( PI() / 4 ) == sqrt( 1 / 2 ) + sin( PI() / 2 ) == 1.0 + sin( PI() ) == 0.0 + $STATUS$ + Ready + $COMPLIANCE$ + SIN() is compatible with CT3's SIN(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + COS(),TAN(),COT(),ASIN(),ACOS(),ATAN(),ATN2(),SINH(),COSH(),TANH(),RTOD(),DTOR(),PI() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * COS() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Cosine of the argument - * $SYNTAX$ - * COS( nRadiant ) -> nCosine - * $ARGUMENTS$ - * an angle size given in radiants - * $RETURNS$ - * the cosine of - * $DESCRIPTION$ - * The function COS() calculates the cosine of an angle whose size is - * given in radiants (full angle equals 2*Pi - see DTOR() for angle size - * given in degress). - * A common geometric interpretation of the COS() function is the - * ankathede-hypotenuse-ratio of a right-angled triangle. - * $EXAMPLES$ - * ? cos( 0.0 ) // --> 1.0 - * ? cos( 1.0 ) // --> 0.5403... - * $TESTS$ - * cos( 0.0) == 1.0 - * cos( PI() / 4 ) == sqrt( 1 / 2 ) - * cos( PI() / 2 ) == 0.0 - * cos( PI() ) == -1.0 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * COS() is compatible with CT3's COS(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * SIN(),TAN(),COT(),ASIN(),ACOS(),ATAN(),ATN2(),SINH(),COSH(),TANH(),RTOD(),DTOR(),PI() - * $END$ +/* $DOC$ + $FUNCNAME$ + COS() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Cosine of the argument + $SYNTAX$ + COS( nRadiant ) -> nCosine + $ARGUMENTS$ + an angle size given in radiants + $RETURNS$ + the cosine of + $DESCRIPTION$ + The function COS() calculates the cosine of an angle whose size is + given in radiants (full angle equals 2*Pi - see DTOR() for angle size + given in degress). + A common geometric interpretation of the COS() function is the + ankathede-hypotenuse-ratio of a right-angled triangle. + $EXAMPLES$ + ? cos( 0.0 ) // --> 1.0 + ? cos( 1.0 ) // --> 0.5403... + $TESTS$ + cos( 0.0) == 1.0 + cos( PI() / 4 ) == sqrt( 1 / 2 ) + cos( PI() / 2 ) == 0.0 + cos( PI() ) == -1.0 + $STATUS$ + Ready + $COMPLIANCE$ + COS() is compatible with CT3's COS(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + SIN(),TAN(),COT(),ASIN(),ACOS(),ATAN(),ATN2(),SINH(),COSH(),TANH(),RTOD(),DTOR(),PI() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * TAN() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Tangent of the argument - * $SYNTAX$ - * TAN( nRadiant ) -> nTangent - * $ARGUMENTS$ - * an angle size given in radiants - * $RETURNS$ - * the tangent of - * $DESCRIPTION$ - * The function TAN() calculates the tangent of an angle whose size is - * given in radiants (full angle equals 2*Pi - see DTOR() for angle size - * given in degress). - * A common geometric interpretation of the TAN() function is the - * counterkathede-ankathede-ratio of a right-angled triangle, or, - * tan(x) = sin(x)/cos(x). - * $EXAMPLES$ - * ? tan( 0.0 ) // --> 0.0 - * ? tan( 1.0 ) // --> 1.5574... - * $TESTS$ - * tan( 0.0 ) == 0.0 - * tan( PI() / 4 ) == 1 - * tan( PI() ) == 0.0 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * TAN() is compatible with CT3's TAN(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * SIN(),COS(),COT(),ASIN(),ACOS(),ATAN(),ATN2(),SINH(),COSH(),TANH(),RTOD(),DTOR(),PI() - * $END$ +/* $DOC$ + $FUNCNAME$ + TAN() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Tangent of the argument + $SYNTAX$ + TAN( nRadiant ) -> nTangent + $ARGUMENTS$ + an angle size given in radiants + $RETURNS$ + the tangent of + $DESCRIPTION$ + The function TAN() calculates the tangent of an angle whose size is + given in radiants (full angle equals 2*Pi - see DTOR() for angle size + given in degress). + A common geometric interpretation of the TAN() function is the + counterkathede-ankathede-ratio of a right-angled triangle, or, + tan(x) = sin(x)/cos(x). + $EXAMPLES$ + ? tan( 0.0 ) // --> 0.0 + ? tan( 1.0 ) // --> 1.5574... + $TESTS$ + tan( 0.0 ) == 0.0 + tan( PI() / 4 ) == 1 + tan( PI() ) == 0.0 + $STATUS$ + Ready + $COMPLIANCE$ + TAN() is compatible with CT3's TAN(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + SIN(),COS(),COT(),ASIN(),ACOS(),ATAN(),ATN2(),SINH(),COSH(),TANH(),RTOD(),DTOR(),PI() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * COT() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Cotangent of the argument - * $SYNTAX$ - * COT( nRadiant ) -> nCotangent - * $ARGUMENTS$ - * an angle size given in radiants - * $RETURNS$ - * the cotangent of - * $DESCRIPTION$ - * The function COT() calculates the cotangent of an angle whose size is - * given in radiants (full angle equals 2*Pi - see DTOR() for angle size - * given in degress). - * A common geometric interpretation of the COT() function is the - * ankathede-counterkathede-ratio of a right-angled triangle, or, - * cot(x) = cos(x)/sin(x)=1/tan(x). - * $EXAMPLES$ - * ? cot( 1.0 ) // --> 0.6420... - * $TESTS$ - * cot( PI() / 4 ) == 1 - * cot( PI() / 2 ) == 0 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * COT() is compatible with CT3's COT(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * SIN(),COS(),TAN(),ASIN(),ACOS(),ATAN(),ATN2(),SINH(),COSH(),TANH(),RTOD(),DTOR(),PI() - * $END$ +/* $DOC$ + $FUNCNAME$ + COT() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Cotangent of the argument + $SYNTAX$ + COT( nRadiant ) -> nCotangent + $ARGUMENTS$ + an angle size given in radiants + $RETURNS$ + the cotangent of + $DESCRIPTION$ + The function COT() calculates the cotangent of an angle whose size is + given in radiants (full angle equals 2*Pi - see DTOR() for angle size + given in degress). + A common geometric interpretation of the COT() function is the + ankathede-counterkathede-ratio of a right-angled triangle, or, + cot(x) = cos(x)/sin(x)=1/tan(x). + $EXAMPLES$ + ? cot( 1.0 ) // --> 0.6420... + $TESTS$ + cot( PI() / 4 ) == 1 + cot( PI() / 2 ) == 0 + $STATUS$ + Ready + $COMPLIANCE$ + COT() is compatible with CT3's COT(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + SIN(),COS(),TAN(),ASIN(),ACOS(),ATAN(),ATN2(),SINH(),COSH(),TANH(),RTOD(),DTOR(),PI() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ASIN() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Arcus sine of the argument - * $SYNTAX$ - * ASIN( nSine ) -> nRadiant - * $ARGUMENTS$ - * the sine of an angle - * $RETURNS$ - * the angle whose sine is - * $DESCRIPTION$ - * The function ASIN() is the inverse function of SIN(). It takes a - * sine value and returns the smallest(!) angle whose sine equals to the argument. - * The return value is given in radiants (full angle equals 2*Pi - - * see DTOR() if you need to convert it into degress). - * Note, that must be between -1 and 1 and that - * is always between -PI()/2 and PI()/2. - * $EXAMPLES$ - * ? asin( 0.0 ) // --> 0.0 - * ? asin( 0.5 ) // --> 0.5235... - * $TESTS$ - * asin( 0.0 ) == 0.0 - * asin( sqrt( 1 / 2 ) ) == PI() / 4 - * asin( 1.0 ) == PI() / 2 - * asin( 0.0 ) == 0.0 // and not PI(), since the smallest angle is returned ! - * $STATUS$ - * Ready - * $COMPLIANCE$ - * ASIN() is compatible with CT3's ASIN(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * SIN(),COS(),TAN(),COT(),ACOS(),ATAN(),ATN2(),SINH(),COSH(),TANH(),RTOD(),DTOR(),PI() - * $END$ +/* $DOC$ + $FUNCNAME$ + ASIN() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Arcus sine of the argument + $SYNTAX$ + ASIN( nSine ) -> nRadiant + $ARGUMENTS$ + the sine of an angle + $RETURNS$ + the angle whose sine is + $DESCRIPTION$ + The function ASIN() is the inverse function of SIN(). It takes a + sine value and returns the smallest(!) angle whose sine equals to the argument. + The return value is given in radiants (full angle equals 2*Pi - + see DTOR() if you need to convert it into degress). + Note, that must be between -1 and 1 and that + is always between -PI()/2 and PI()/2. + $EXAMPLES$ + ? asin( 0.0 ) // --> 0.0 + ? asin( 0.5 ) // --> 0.5235... + $TESTS$ + asin( 0.0 ) == 0.0 + asin( sqrt( 1 / 2 ) ) == PI() / 4 + asin( 1.0 ) == PI() / 2 + asin( 0.0 ) == 0.0 // and not PI(), since the smallest angle is returned ! + $STATUS$ + Ready + $COMPLIANCE$ + ASIN() is compatible with CT3's ASIN(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + SIN(),COS(),TAN(),COT(),ACOS(),ATAN(),ATN2(),SINH(),COSH(),TANH(),RTOD(),DTOR(),PI() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ACOS() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Arcus cosine of the argument - * $SYNTAX$ - * ACOS( nCosine ) -> nRadiant - * $ARGUMENTS$ - * the cosine of an angle - * $RETURNS$ - * the angle whose cosine is - * $DESCRIPTION$ - * The function ACOS() is the inverse function of COS(). It takes a - * cosine value and returns the smallest(!) angle whose cosine equals to the argument. - * The return value is given in radiants (full angle equals 2*Pi - - * see DTOR() if you need to convert it into degress). - * Note, that must be between -1 and 1 and that - * is always between 0 and PI(). - * $EXAMPLES$ - * ? acos( 0.0 ) // --> PI() / 2 - * ? acos( 0.5 ) // --> 1.04719... - * $TESTS$ - * acos( 0.0 ) == PI() / 2 - * acos( sqrt( 1 / 2 ) ) == PI() / 4 - * acos( 1.0 ) == 0.0 - * acos( -1.0 ) == PI() - * acos( 0.0 ) == PI() / 2 // and not -PI()/2, although cos (-PI()/2) == 0.0 ! - * $STATUS$ - * Ready - * $COMPLIANCE$ - * ACOS() is compatible with CT3's ACOS(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * SIN(),COS(),TAN(),COT(),ASIN(),ATAN(),ATN2(),SINH(),COSH(),TANH(),RTOD(),DTOR(),PI() - * $END$ +/* $DOC$ + $FUNCNAME$ + ACOS() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Arcus cosine of the argument + $SYNTAX$ + ACOS( nCosine ) -> nRadiant + $ARGUMENTS$ + the cosine of an angle + $RETURNS$ + the angle whose cosine is + $DESCRIPTION$ + The function ACOS() is the inverse function of COS(). It takes a + cosine value and returns the smallest(!) angle whose cosine equals to the argument. + The return value is given in radiants (full angle equals 2*Pi - + see DTOR() if you need to convert it into degress). + Note, that must be between -1 and 1 and that + is always between 0 and PI(). + $EXAMPLES$ + ? acos( 0.0 ) // --> PI() / 2 + ? acos( 0.5 ) // --> 1.04719... + $TESTS$ + acos( 0.0 ) == PI() / 2 + acos( sqrt( 1 / 2 ) ) == PI() / 4 + acos( 1.0 ) == 0.0 + acos( -1.0 ) == PI() + acos( 0.0 ) == PI() / 2 // and not -PI()/2, although cos (-PI()/2) == 0.0 ! + $STATUS$ + Ready + $COMPLIANCE$ + ACOS() is compatible with CT3's ACOS(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + SIN(),COS(),TAN(),COT(),ASIN(),ATAN(),ATN2(),SINH(),COSH(),TANH(),RTOD(),DTOR(),PI() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ATAN() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Arcus tangent of the argument - * $SYNTAX$ - * ACOS( nTangent ) -> nRadiant - * $ARGUMENTS$ - * the tangent of an angle - * $RETURNS$ - * the angle whose tangent is - * $DESCRIPTION$ - * The function ATAN() is the inverse function of TAN(). It takes a - * tangent value and returns the smallest(!) angle whose tangent equals to the argument. - * The return value is given in radiants between -PI()/2 and PI()/2 - * (full angle equals 2*Pi - see DTOR() if you need to convert it into degress). - * $EXAMPLES$ - * ? atan( 0.0 ) // --> 0.0 - * ? atan( 0.5 ) // --> 0.4636... - * $TESTS$ - * atan( 0.0 ) == 0.0 - * atan( 1.0 ) == PI() / 4 - * atan( 0.0 ) == 0.0 // and not PI(), although tan( PI() ) == 0.0 ! - * $STATUS$ - * Ready - * $COMPLIANCE$ - * ATAN() is compatible with CT3's ATAN(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * SIN(),COS(),TAN(),COT(),ASIN(),ACOS(),ATAN(),SINH(),COSH(),TANH(),RTOD(),DTOR(),PI() - * $END$ +/* $DOC$ + $FUNCNAME$ + ATAN() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Arcus tangent of the argument + $SYNTAX$ + ACOS( nTangent ) -> nRadiant + $ARGUMENTS$ + the tangent of an angle + $RETURNS$ + the angle whose tangent is + $DESCRIPTION$ + The function ATAN() is the inverse function of TAN(). It takes a + tangent value and returns the smallest(!) angle whose tangent equals to the argument. + The return value is given in radiants between -PI()/2 and PI()/2 + (full angle equals 2*Pi - see DTOR() if you need to convert it into degress). + $EXAMPLES$ + ? atan( 0.0 ) // --> 0.0 + ? atan( 0.5 ) // --> 0.4636... + $TESTS$ + atan( 0.0 ) == 0.0 + atan( 1.0 ) == PI() / 4 + atan( 0.0 ) == 0.0 // and not PI(), although tan( PI() ) == 0.0 ! + $STATUS$ + Ready + $COMPLIANCE$ + ATAN() is compatible with CT3's ATAN(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + SIN(),COS(),TAN(),COT(),ASIN(),ACOS(),ATAN(),SINH(),COSH(),TANH(),RTOD(),DTOR(),PI() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ATN2() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Arcus tangent a sine and a cosine argument - * $SYNTAX$ - * ATN2( nSine, nCosine ) -> nRadiant - * $ARGUMENTS$ - * the sine of an angle - * the cosine of an angle - * $RETURNS$ - * the angle whose tangent is / - * $DESCRIPTION$ - * The function ATN2() is an alternate function for calculating - * the arcus tangent, atn2(x,y) = atan(x/y). - * It takes two arguments, the sine and the cosine - * of the angle that should be calculated. Thus, in contrast to the ATAN() - * function, ATN2() can distinguish whether the sine or the cosine has - * a negative sign (or both being positive or negative), so that - * the return value can be between -PI() and PI() and covers the full - * angle. - * The return value is given in radiants (full angle equals 2*Pi - - * see DTOR() if you need to convert it into degress). - * $EXAMPLES$ - * ? atn2( 0.0, 1.0 ) // --> 0.0 - * ? atn2( sqrt( 1 / 2 ), sqrt( 1 / 2 ) ) // --> PI() / 4 - * $TESTS$ - * atn2( 0.0, 1.0 ) == 0.0 - * atn2( sqrt( 1 / 2 ), sqrt( 1 / 2 ) ) == PI() / 4 - * atn2( -sqrt( 1 / 2 ), -sqrt( 1 / 2 ) ) == -3 / 4 * PI() // atan() would return PI() / 4 ! - * $STATUS$ - * Ready - * $COMPLIANCE$ - * ATN2() is compatible with CT3's ATN2(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * SIN(),COS(),TAN(),COT(),ASIN(),ACOS(),ATAN(),SINH(),COSH(),TANH(),RTOD(),DTOR(),PI() - * $END$ +/* $DOC$ + $FUNCNAME$ + ATN2() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Arcus tangent a sine and a cosine argument + $SYNTAX$ + ATN2( nSine, nCosine ) -> nRadiant + $ARGUMENTS$ + the sine of an angle + the cosine of an angle + $RETURNS$ + the angle whose tangent is / + $DESCRIPTION$ + The function ATN2() is an alternate function for calculating + the arcus tangent, atn2(x,y) = atan(x/y). + It takes two arguments, the sine and the cosine + of the angle that should be calculated. Thus, in contrast to the ATAN() + function, ATN2() can distinguish whether the sine or the cosine has + a negative sign (or both being positive or negative), so that + the return value can be between -PI() and PI() and covers the full + angle. + The return value is given in radiants (full angle equals 2*Pi - + see DTOR() if you need to convert it into degress). + $EXAMPLES$ + ? atn2( 0.0, 1.0 ) // --> 0.0 + ? atn2( sqrt( 1 / 2 ), sqrt( 1 / 2 ) ) // --> PI() / 4 + $TESTS$ + atn2( 0.0, 1.0 ) == 0.0 + atn2( sqrt( 1 / 2 ), sqrt( 1 / 2 ) ) == PI() / 4 + atn2( -sqrt( 1 / 2 ), -sqrt( 1 / 2 ) ) == -3 / 4 * PI() // atan() would return PI() / 4 ! + $STATUS$ + Ready + $COMPLIANCE$ + ATN2() is compatible with CT3's ATN2(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + SIN(),COS(),TAN(),COT(),ASIN(),ACOS(),ATAN(),SINH(),COSH(),TANH(),RTOD(),DTOR(),PI() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * SINH() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Hyperbolic Sine of the argument - * $SYNTAX$ - * SINH( nArea ) -> nHyperbolicSine - * $ARGUMENTS$ - * the size of the area (see below) - * $RETURNS$ - * the hyperbolic sine of - * $DESCRIPTION$ - * The function SINH() calculates the hyperbolic sine of the argument. - * In analytical mathematics it is defined as 1/2*(exp(nArea)-exp(-nArea)). - * A common geometric interpretation of the SINH() function is the - * maximum y value of the points in the area with the given size , - * that is bound by the x axis, a straight line through the point of - * origin (this one is fixed by the area) and the hyperbola x^2-y^2=1. - * $EXAMPLES$ - * ? sinh( 0.0 ) // --> 0.0 - * ? sinh( 1.0 ) // --> 1.1752... - * $TESTS$ - * sinh( 0.0 ) == 0.0 - * sinh( -0.5 ) == -sinh( 0.5 ) - * $STATUS$ - * Ready - * $COMPLIANCE$ - * SINH() is new in Harbours CT3's library. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * SIN(),COS(),TAN(),COT(),ASIN(),ACOS(),ATAN(),ATN2(),COSH(),TANH(),RTOD(),DTOR(),PI() - * $END$ +/* $DOC$ + $FUNCNAME$ + SINH() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Hyperbolic Sine of the argument + $SYNTAX$ + SINH( nArea ) -> nHyperbolicSine + $ARGUMENTS$ + the size of the area (see below) + $RETURNS$ + the hyperbolic sine of + $DESCRIPTION$ + The function SINH() calculates the hyperbolic sine of the argument. + In analytical mathematics it is defined as 1/2*(exp(nArea)-exp(-nArea)). + A common geometric interpretation of the SINH() function is the + maximum y value of the points in the area with the given size , + that is bound by the x axis, a straight line through the point of + origin (this one is fixed by the area) and the hyperbola x^2-y^2=1. + $EXAMPLES$ + ? sinh( 0.0 ) // --> 0.0 + ? sinh( 1.0 ) // --> 1.1752... + $TESTS$ + sinh( 0.0 ) == 0.0 + sinh( -0.5 ) == -sinh( 0.5 ) + $STATUS$ + Ready + $COMPLIANCE$ + SINH() is new in Harbours CT3's library. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + SIN(),COS(),TAN(),COT(),ASIN(),ACOS(),ATAN(),ATN2(),COSH(),TANH(),RTOD(),DTOR(),PI() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * COSH() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Hyperbolic Cosine of the argument - * $SYNTAX$ - * COSH( nArea ) -> nHyperbolicCosine - * $ARGUMENTS$ - * the size of the area (see below) - * $RETURNS$ - * the hyperbolic cosine of - * $DESCRIPTION$ - * The function COSH() calculates the hyperbolic cosine of the argument. - * In analytical mathematics it is defined as 1/2*(exp(nArea)+exp(-nArea)). - * A common geometric interpretation of the COSH() function is the - * maximum x value of the points in the area with the given size , - * that is bound by the x axis, a straight line through the point of - * origin (this one is fixed by the area) and the hyperbola x^2-y^2=1. - * $EXAMPLES$ - * ? cosh( 0.0 ) // --> 1.0 - * ? cosh( 1.0 ) // --> 1.5430... - * $TESTS$ - * cosh( 0.0 ) == 1.0 - * cosh( -0.5 ) == cosh( 0.5 ) - * $STATUS$ - * Ready - * $COMPLIANCE$ - * COSH() is new in Harbours CT3's library. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * SIN(),COS(),TAN(),COT(),ASIN(),ACOS(),ATAN(),ATN2(),SINH(),TANH(),RTOD(),DTOR(),PI() - * $END$ +/* $DOC$ + $FUNCNAME$ + COSH() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Hyperbolic Cosine of the argument + $SYNTAX$ + COSH( nArea ) -> nHyperbolicCosine + $ARGUMENTS$ + the size of the area (see below) + $RETURNS$ + the hyperbolic cosine of + $DESCRIPTION$ + The function COSH() calculates the hyperbolic cosine of the argument. + In analytical mathematics it is defined as 1/2*(exp(nArea)+exp(-nArea)). + A common geometric interpretation of the COSH() function is the + maximum x value of the points in the area with the given size , + that is bound by the x axis, a straight line through the point of + origin (this one is fixed by the area) and the hyperbola x^2-y^2=1. + $EXAMPLES$ + ? cosh( 0.0 ) // --> 1.0 + ? cosh( 1.0 ) // --> 1.5430... + $TESTS$ + cosh( 0.0 ) == 1.0 + cosh( -0.5 ) == cosh( 0.5 ) + $STATUS$ + Ready + $COMPLIANCE$ + COSH() is new in Harbours CT3's library. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + SIN(),COS(),TAN(),COT(),ASIN(),ACOS(),ATAN(),ATN2(),SINH(),TANH(),RTOD(),DTOR(),PI() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * TANH() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Hyperbolic Tangent of the argument - * $SYNTAX$ - * TANH( nArea ) -> nHyperbolicTangent - * $ARGUMENTS$ - * the size of the area (see below) - * $RETURNS$ - * the hyperbolic tangent of - * $DESCRIPTION$ - * The function TANH() calculates the hyperbolic tangent of the argument. - * In analytical mathematics it is defined as SINH(x)/COSH(x). - * $EXAMPLES$ - * ? tanh( 0.0 ) // --> 0.0 - * ? tanh( 1.0 ) // --> 0.7615... - * $TESTS$ - * tanh( 0.0 ) == 0.0 - * tanh( -0.5 ) == -tanh( 0.5 ) - * $STATUS$ - * Ready - * $COMPLIANCE$ - * TANH() is new in Harbours CT3's library. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * SIN(),COS(),TAN(),COT(),ASIN(),ACOS(),ATAN(),ATN2(),SINH(),COSH(),RTOD(),DTOR(),PI() - * $END$ +/* $DOC$ + $FUNCNAME$ + TANH() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Hyperbolic Tangent of the argument + $SYNTAX$ + TANH( nArea ) -> nHyperbolicTangent + $ARGUMENTS$ + the size of the area (see below) + $RETURNS$ + the hyperbolic tangent of + $DESCRIPTION$ + The function TANH() calculates the hyperbolic tangent of the argument. + In analytical mathematics it is defined as SINH(x)/COSH(x). + $EXAMPLES$ + ? tanh( 0.0 ) // --> 0.0 + ? tanh( 1.0 ) // --> 0.7615... + $TESTS$ + tanh( 0.0 ) == 0.0 + tanh( -0.5 ) == -tanh( 0.5 ) + $STATUS$ + Ready + $COMPLIANCE$ + TANH() is new in Harbours CT3's library. + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + SIN(),COS(),TAN(),COT(),ASIN(),ACOS(),ATAN(),ATN2(),SINH(),COSH(),RTOD(),DTOR(),PI() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * RTOD() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Convert radiant to degree - * $SYNTAX$ - * RTOD( nRadiant ) -> nDegree - * $ARGUMENTS$ - * the size of an angle in radiant - * $RETURNS$ - * the size of that angle in degree - * $DESCRIPTION$ - * The function RTOD() can be used to convert sizes of angles given - * in radiant (like those returned by the asin, acos or atan function) - * to degrees that are commonly used geometry and technics. - * $EXAMPLES$ - * ? rtod( PI() ) // --> 180 - * ? tanh( PI() / 3 ) // --> 60 - * $TESTS$ - * rtod( 0.0 ) == 0.0 - * rtod( PI() ) == 180.0 - * $STATUS$ - * Ready - * $COMPLIANCE$ - * RTOD() is compatible with CT3's RTOD(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * SIN(),COS(),TAN(),COT(),ASIN(),ACOS(),ATAN(),ATN2(),SINH(),COSH(),TANH(),DTOR(),PI() - * $END$ +/* $DOC$ + $FUNCNAME$ + RTOD() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Convert radiant to degree + $SYNTAX$ + RTOD( nRadiant ) -> nDegree + $ARGUMENTS$ + the size of an angle in radiant + $RETURNS$ + the size of that angle in degree + $DESCRIPTION$ + The function RTOD() can be used to convert sizes of angles given + in radiant (like those returned by the asin, acos or atan function) + to degrees that are commonly used geometry and technics. + $EXAMPLES$ + ? rtod( PI() ) // --> 180 + ? tanh( PI() / 3 ) // --> 60 + $TESTS$ + rtod( 0.0 ) == 0.0 + rtod( PI() ) == 180.0 + $STATUS$ + Ready + $COMPLIANCE$ + RTOD() is compatible with CT3's RTOD(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + SIN(),COS(),TAN(),COT(),ASIN(),ACOS(),ATAN(),ATN2(),SINH(),COSH(),TANH(),DTOR(),PI() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * DTOR() - * $CATEGORY$ - * CT3 math functions - * $ONELINER$ - * Convert degree to radiant - * $SYNTAX$ - * DTOR( nDegree ) -> nRadiant - * $ARGUMENTS$ - * the size of that angle in degree - * $RETURNS$ - * the size of an angle in radiant - * $DESCRIPTION$ - * The function DTOR() can be used to convert sizes of angles given - * in degrees to radiant (as expected by sin, cos or tan functions). - * $EXAMPLES$ - * ? dtor( 180 ) // --> PI() - * ? dtor( 60 ) // --> PI() / 3 - * $TESTS$ - * dtor( 0.0 ) == 0.0 - * dtor( 180.0 ) == PI() - * $STATUS$ - * Ready - * $COMPLIANCE$ - * DTOR() is compatible with CT3's DTOR(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * SIN(),COS(),TAN(),COT(),ASIN(),ACOS(),ATAN(),ATN2(),SINH(),COSH(),TANH(),RTOD(),PI() - * $END$ +/* $DOC$ + $FUNCNAME$ + DTOR() + $CATEGORY$ + CT3 math functions + $ONELINER$ + Convert degree to radiant + $SYNTAX$ + DTOR( nDegree ) -> nRadiant + $ARGUMENTS$ + the size of that angle in degree + $RETURNS$ + the size of an angle in radiant + $DESCRIPTION$ + The function DTOR() can be used to convert sizes of angles given + in degrees to radiant (as expected by sin, cos or tan functions). + $EXAMPLES$ + ? dtor( 180 ) // --> PI() + ? dtor( 60 ) // --> PI() / 3 + $TESTS$ + dtor( 0.0 ) == 0.0 + dtor( 180.0 ) == PI() + $STATUS$ + Ready + $COMPLIANCE$ + DTOR() is compatible with CT3's DTOR(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + SIN(),COS(),TAN(),COT(),ASIN(),ACOS(),ATAN(),ATN2(),SINH(),COSH(),TANH(),RTOD(),PI() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/video.txt b/harbour/contrib/hbct/doc/en/video.txt index a9dc9a0419..15d2a6ef0f 100644 --- a/harbour/contrib/hbct/doc/en/video.txt +++ b/harbour/contrib/hbct/doc/en/video.txt @@ -2,144 +2,144 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * CHARPIX() - * $CATEGORY$ - * HBCT video functions - * $ONELINER$ - * Gets the number of scan lines per character. - * $SYNTAX$ - * CHARPIX() --> nHeight - * $ARGUMENTS$ - * - * $RETURNS$ - * Returns the number of scan lines per character. - * $DESCRIPTION$ - * Returns the number of scan lines per character. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * This function is xHarbour libct contrib - * $PLATFORMS$ - * DJGPP - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + CHARPIX() + $CATEGORY$ + HBCT video functions + $ONELINER$ + Gets the number of scan lines per character. + $SYNTAX$ + CHARPIX() --> nHeight + $ARGUMENTS$ + + $RETURNS$ + Returns the number of scan lines per character. + $DESCRIPTION$ + Returns the number of scan lines per character. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + This function is xHarbour libct contrib + $PLATFORMS$ + DJGPP + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * VGAPALETTE() - * $CATEGORY$ - * HBCT video functions - * $ONELINER$ - * Changes VGA palette colors - * $SYNTAX$ - * VGAPALETTE( [, [, , - * lValid - * $ARGUMENTS$ - * - the color to change in CA-Cl*pper color notation or - * as a number from 0 to 15. - * , , and specify the palette - * settings for the respective portions in the range from 0 to 63. - * If no RGB value is specified, the palette register is reset to - * its default value (currently unsupported). - * If the function is called without parameters, the palette registers for - * all colors are reset to their default values (currently unsupported). - * $RETURNS$ - * Returns .T. on success. - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * This function is xHarbour libct contrib - * $PLATFORMS$ - * DJGPP - * $FILES$ - * Library is libct. - * $SEEALSO$ - * EGAPALETTE() FONTRESET() - * $END$ +/* $DOC$ + $FUNCNAME$ + VGAPALETTE() + $CATEGORY$ + HBCT video functions + $ONELINER$ + Changes VGA palette colors + $SYNTAX$ + VGAPALETTE( [, [, , + lValid + $ARGUMENTS$ + - the color to change in CA-Cl*pper color notation or + as a number from 0 to 15. + , , and specify the palette + settings for the respective portions in the range from 0 to 63. + If no RGB value is specified, the palette register is reset to + its default value (currently unsupported). + If the function is called without parameters, the palette registers for + all colors are reset to their default values (currently unsupported). + $RETURNS$ + Returns .T. on success. + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + This function is xHarbour libct contrib + $PLATFORMS$ + DJGPP + $FILES$ + Library is libct. + $SEEALSO$ + EGAPALETTE() FONTRESET() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * VIDEOTYPE() - * $CATEGORY$ - * HBCT video functions - * $ONELINER$ - * Detects supported video adapter modes - * $SYNTAX$ - * VIDEOTYPE() --> nMask - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: Finish documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * This function is xHarbour libct contrib - * $PLATFORMS$ - * DJGPP - * $FILES$ - * Library is libct. - * $SEEALSO$ - * ISCGA(), ISEGA(), ISHERCULES(), ISMCGA(), ISMONO(), ISPGA(), ISVGA() - * $END$ +/* $DOC$ + $FUNCNAME$ + VIDEOTYPE() + $CATEGORY$ + HBCT video functions + $ONELINER$ + Detects supported video adapter modes + $SYNTAX$ + VIDEOTYPE() --> nMask + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: Finish documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + This function is xHarbour libct contrib + $PLATFORMS$ + DJGPP + $FILES$ + Library is libct. + $SEEALSO$ + ISCGA(), ISEGA(), ISHERCULES(), ISMCGA(), ISMONO(), ISPGA(), ISVGA() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * SETFONT() - * $CATEGORY$ - * HBCT video functions - * $ONELINER$ - * Loads font from a string. - * $SYNTAX$ - * SETFONT( , [], [], [] ) --> nError - * or: - * SETFONT( , [], [] ) --> nError - * $ARGUMENTS$ - * Binary string containing a valid font definition. - * Number of a font area where the font must be loaded. - * First character code to be loaded. - * Number of characters to load. - * When .T., the function computes font height automatically. - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: Finish documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * This function is xHarbour libct contrib - * $PLATFORMS$ - * DJGPP - * $FILES$ - * Library is libct. - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + SETFONT() + $CATEGORY$ + HBCT video functions + $ONELINER$ + Loads font from a string. + $SYNTAX$ + SETFONT( , [], [], [] ) --> nError + or: + SETFONT( , [], [] ) --> nError + $ARGUMENTS$ + Binary string containing a valid font definition. + Number of a font area where the font must be loaded. + First character code to be loaded. + Number of characters to load. + When .T., the function computes font height automatically. + $RETURNS$ + + $DESCRIPTION$ + TODO: Finish documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + This function is xHarbour libct contrib + $PLATFORMS$ + DJGPP + $FILES$ + Library is libct. + $SEEALSO$ + + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/wordrepl.txt b/harbour/contrib/hbct/doc/en/wordrepl.txt index 526e0369c8..0ebcff2cb8 100644 --- a/harbour/contrib/hbct/doc/en/wordrepl.txt +++ b/harbour/contrib/hbct/doc/en/wordrepl.txt @@ -2,66 +2,66 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * WORDREPL() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Replacement of double characters - * $SYNTAX$ - * WORDREPL( , <[@]cString>, - * , [] ) -> cString - * $ARGUMENTS$ - * is a string of double characters - * that should be replaced - * <[@]cString> is the processed string - * is a string of double characters that - * replace the one of - * [] sets the replacement method (see description) - * Default: .F. - * $RETURNS$ - * cString the processed string - * $DESCRIPTION$ - * The WORDREPL() takes the double characters of - * one after the other and searches for them in . - * For set to .F., this search is successful, if the double - * character sequence in starts at an odd position or at any - * position, if is set to .T. - * If this happens, the double character sequence will be replaced with - * the corresponding double character sequence of . - * If is shorter than - * the last double sequence of is used for - * the "rest" of . Note that the last double - * character sequence in "AABBC" is "BB" in this context !! - * After the replacement the function restarts the search in - * BEHIND the replacement if the CSETATMUPA() switch is turned off, or - * BEHIND the first character of the replacement if the switch is turned on. - * (see examples for this !) - * One can omit the return value of this function by setting the CSETREF() - * to .T., but one must then pass by reference to get a result. - * $EXAMPLES$ - * ? wordrepl( "CC", "AABBCCDDEE", "XX" ) // "AABBXXDDEE" - * ? wordrepl( "aa", "1aaaa", "ba" ) // "1abaa" - * ? wordrepl( "aa", "1aaaa", "ba", .T. ) // "1baba" - * csetatmupa( .T. ) - * ? wordrepl( "aa", "1aaaa", "ba" ) // "1abaa" - * ? wordrepl( "aa", "1aaaa", "ba", .T. ) // "1bbba" - * $TESTS$ - * wordrepl( "CC", "AABBCCDDEE", "XX" ) == "AABBXXDDEE" - * wordrepl( "aa", "1aaaa", "ba" ) == "1abaa" - * wordrepl( "aa", "1aaaa", "ba", .T. ) == "1baba" - * Eval( {|| csetatmupa( .T. ), wordrepl( "aa", "1aaaa", "ba" ) } ) == "1abaa" - * Eval( {|| csetatmupa( .T. ), wordrepl( "aa", "1aaaa", "ba", .T. ) } ) == "1bbba" - * $STATUS$ - * Ready - * $COMPLIANCE$ - * WORDREPL() is compatible with CT3's WORDREPL(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CHARREPL(),RANGEREPL(),POSREPL(),CSETREF(),CSETATMUPA() - * $END$ +/* $DOC$ + $FUNCNAME$ + WORDREPL() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Replacement of double characters + $SYNTAX$ + WORDREPL( , <[@]cString>, + , [] ) -> cString + $ARGUMENTS$ + is a string of double characters + that should be replaced + <[@]cString> is the processed string + is a string of double characters that + replace the one of + [] sets the replacement method (see description) + Default: .F. + $RETURNS$ + cString the processed string + $DESCRIPTION$ + The WORDREPL() takes the double characters of + one after the other and searches for them in . + For set to .F., this search is successful, if the double + character sequence in starts at an odd position or at any + position, if is set to .T. + If this happens, the double character sequence will be replaced with + the corresponding double character sequence of . + If is shorter than + the last double sequence of is used for + the "rest" of . Note that the last double + character sequence in "AABBC" is "BB" in this context !! + After the replacement the function restarts the search in + BEHIND the replacement if the CSETATMUPA() switch is turned off, or + BEHIND the first character of the replacement if the switch is turned on. + (see examples for this !) + One can omit the return value of this function by setting the CSETREF() + to .T., but one must then pass by reference to get a result. + $EXAMPLES$ + ? wordrepl( "CC", "AABBCCDDEE", "XX" ) // "AABBXXDDEE" + ? wordrepl( "aa", "1aaaa", "ba" ) // "1abaa" + ? wordrepl( "aa", "1aaaa", "ba", .T. ) // "1baba" + csetatmupa( .T. ) + ? wordrepl( "aa", "1aaaa", "ba" ) // "1abaa" + ? wordrepl( "aa", "1aaaa", "ba", .T. ) // "1bbba" + $TESTS$ + wordrepl( "CC", "AABBCCDDEE", "XX" ) == "AABBXXDDEE" + wordrepl( "aa", "1aaaa", "ba" ) == "1abaa" + wordrepl( "aa", "1aaaa", "ba", .T. ) == "1baba" + Eval( {|| csetatmupa( .T. ), wordrepl( "aa", "1aaaa", "ba" ) } ) == "1abaa" + Eval( {|| csetatmupa( .T. ), wordrepl( "aa", "1aaaa", "ba", .T. ) } ) == "1bbba" + $STATUS$ + Ready + $COMPLIANCE$ + WORDREPL() is compatible with CT3's WORDREPL(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CHARREPL(),RANGEREPL(),POSREPL(),CSETREF(),CSETATMUPA() + $END$ */ diff --git a/harbour/contrib/hbct/doc/en/wordtoch.txt b/harbour/contrib/hbct/doc/en/wordtoch.txt index 4feaca2aba..9294d0a174 100644 --- a/harbour/contrib/hbct/doc/en/wordtoch.txt +++ b/harbour/contrib/hbct/doc/en/wordtoch.txt @@ -2,35 +2,35 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * WORDTOCHAR() - * $CATEGORY$ - * CT3 string functions - * $ONELINER$ - * Replace double with single characters - * $SYNTAX$ - * WORDTOCHAR( , , - * ) -> cString - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * TODO: add documentation - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * Started - * $COMPLIANCE$ - * WORDTOCHAR() is compatible with CT3's WORDTOCHAR(). - * $PLATFORMS$ - * All - * $FILES$ - * Library is libct. - * $SEEALSO$ - * CSETATMUPA(),CHARREPL(),WORDREPL() - * $END$ +/* $DOC$ + $FUNCNAME$ + WORDTOCHAR() + $CATEGORY$ + CT3 string functions + $ONELINER$ + Replace double with single characters + $SYNTAX$ + WORDTOCHAR( , , + ) -> cString + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + TODO: add documentation + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + Started + $COMPLIANCE$ + WORDTOCHAR() is compatible with CT3's WORDTOCHAR(). + $PLATFORMS$ + All + $FILES$ + Library is libct. + $SEEALSO$ + CSETATMUPA(),CHARREPL(),WORDREPL() + $END$ */ diff --git a/harbour/contrib/hbgd/doc/en/hbgd.txt b/harbour/contrib/hbgd/doc/en/hbgd.txt index f401bb15ad..bb915e28eb 100644 --- a/harbour/contrib/hbgd/doc/en/hbgd.txt +++ b/harbour/contrib/hbgd/doc/en/hbgd.txt @@ -2,2057 +2,2013 @@ * $Id$ */ -/* - * The following parts are Copyright of the individual authors. - * www - http://www.xharbour.org http://www.harbour-project.org - * - * Copyright 2004-2005 Francesco Saverio Giudice - * Documentation for GD Library wrapper functions and classes - * - * See COPYING for licensing terms. - * +/* $DOC$ + $FUNCNAME$ + The GD Library + $CATEGORY$ + Document + $ONELINER$ + Read me file for GD Library + $DESCRIPTION$ + HBGD is basically a wrapper of Thomas Boutell's GD Library version 2.0.33. + GD Library is a powerfull graphic library very usefull expecially under CGI environment. + + HBGD actually contains almost all GD functions, more a set of functions that extends original + library and a set of classes that make easier to work with this library. + + Thomas Boutell's GD library actually supports these graphic formats: + PNG, JPEG, GIF, Animated GIF, GD, GD2, WBMP, XBM, XPM + WBMP is Wireless Bitmap, not Windows Bitmap, and it is used for WAP. It is a B&W bitmap. + + HBGD actually supports PNG, JPEG, GIF, GD, WBMP + The other Animated GIF, GD2, XBM and XPM are not wrapped actually. + + Using this library you can, as a little example: + - create an image in memory, true color or with a 256 colors palette; + - load and save an image of above formats and convert it to another supported format; + - draw dots, lines, dashed lines, polygons, rectangles, arcs, circles and ellipses; + - fill with colors; + - draw with brushes; + - check a point or part or full image with a lot of query functions; + - draw characters and words with internal fonts or using truetype fonts; + - write strings on a base line or on a circle line and with any angle degree; + - copy, resize and rotate part or full image; + + and, over this, some functions to clone, crop, zoom, rotate outside and inside. + + The prefix for all functions is GD (i.e. gdImageCreate() ) + + You can use directly all API functions or TGD class. + + NOTE: Not all functions are wrapped. + + $SEEALSO$ + Alphabetical list of functions, Categorized list of functions, GDImage Class, GDChart Class. + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * The GD Library - * $CATEGORY$ - * Document - * $ONELINER$ - * Read me file for GD Library - * $DESCRIPTION$ - * HBGD is basically a wrapper of Thomas Boutell's GD Library version 2.0.33. - * GD Library is a powerfull graphic library very usefull expecially under CGI environment. - * - * HBGD actually contains almost all GD functions, more a set of functions that extends original - * library and a set of classes that make easier to work with this library. - * - * Thomas Boutell's GD library actually supports these graphic formats: - * PNG, JPEG, GIF, Animated GIF, GD, GD2, WBMP, XBM, XPM - * WBMP is Wireless Bitmap, not Windows Bitmap, and it is used for WAP. It is a B&W bitmap. - * - * HBGD actually supports PNG, JPEG, GIF, GD, WBMP - * The other Animated GIF, GD2, XBM and XPM are not wrapped actually. - * - * Using this library you can, as a little example: - * - create an image in memory, true color or with a 256 colors palette; - * - load and save an image of above formats and convert it to another supported format; - * - draw dots, lines, dashed lines, polygons, rectangles, arcs, circles and ellipses; - * - fill with colors; - * - draw with brushes; - * - check a point or part or full image with a lot of query functions; - * - draw characters and words with internal fonts or using truetype fonts; - * - write strings on a base line or on a circle line and with any angle degree; - * - copy, resize and rotate part or full image; - * - * and, over this, some functions to clone, crop, zoom, rotate outside and inside. - * - * The prefix for all functions is GD (i.e. gdImageCreate() ) - * - * You can use directly all API functions or TGD class. - * - * NOTE: Not all functions are wrapped. - * - * $SEEALSO$ - * Alphabetical list of functions, Categorized list of functions, GDImage Class, GDChart Class. - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageCreate() + $CATEGORY$ + HBGD + $ONELINER$ + Create a palette-based image in memory with no more that 256 colors. + $SYNTAX$ + gdImageCreate( , ) --> + $ARGUMENTS$ + - image width + - image height + $RETURNS$ + - Image pointer + $DESCRIPTION$ + gdImageCreate() creates an empty image in memory. + This image has no more than 256 colors. + + gdImageCreate() returns an image pointer or NIL if unable to create the image. + The image pointer must be destroyed using gdImageDestroy() + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + + pImage := gdImageCreate( 64, 64 ) + // Use here image + ......... + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreateTrueColor() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageCreate() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Create a palette-based image in memory with no more that 256 colors. - * $SYNTAX$ - * gdImageCreate( , ) --> - * $ARGUMENTS$ - * - image width - * - image height - * $RETURNS$ - * - Image pointer - * $DESCRIPTION$ - * gdImageCreate() creates an empty image in memory. - * This image has no more than 256 colors. - * - * gdImageCreate() returns an image pointer or NIL if unable to create the image. - * The image pointer must be destroyed using gdImageDestroy() - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * - * pImage := gdImageCreate( 64, 64 ) - * // Use here image - * ......... - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreateTrueColor() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageCreateTrueColor() + $CATEGORY$ + HBGD + $ONELINER$ + Create a true color image in memory. + $SYNTAX$ + gdImageCreateTrueColor( , ) --> + $ARGUMENTS$ + - image width + - image height + $RETURNS$ + - Image pointer + $DESCRIPTION$ + gdImageCreateTrueColor() creates an empty image in memory. + This image has true colors. + + gdImageCreateTrueColor() returns an image pointer or NIL if unable to create the image. + The image pointer must be destroyed using gdImageDestroy() + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + + pImage := gdImageCreateTrueColor( 64, 64 ) + // Use here image + ......... + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageCreateTrueColor() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Create a true color image in memory. - * $SYNTAX$ - * gdImageCreateTrueColor( , ) --> - * $ARGUMENTS$ - * - image width - * - image height - * $RETURNS$ - * - Image pointer - * $DESCRIPTION$ - * gdImageCreateTrueColor() creates an empty image in memory. - * This image has true colors. - * - * gdImageCreateTrueColor() returns an image pointer or NIL if unable to create the image. - * The image pointer must be destroyed using gdImageDestroy() - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * - * pImage := gdImageCreateTrueColor( 64, 64 ) - * // Use here image - * ......... - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageDestroy() + $CATEGORY$ + HBGD + $ONELINER$ + Free memory used from an image. + $SYNTAX$ + gdImageDestroy( ) --> NIL + $ARGUMENTS$ + - Image pointer + $RETURNS$ + NIL + $DESCRIPTION$ + gdImageDestroy() frees memory used from an image. + It's important to use this function before exiting from a program. + + HBGD uses it's own memory to manage an image, so it is important to use this function. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + + pImage := gdImageCreateTrueColor( 64, 64 ) + // Use here image + ......... + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageCreate(), gdImageCreateTrueColor() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageDestroy() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Free memory used from an image. - * $SYNTAX$ - * gdImageDestroy( ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * gdImageDestroy() frees memory used from an image. - * It's important to use this function before exiting from a program. - * - * HBGD uses it's own memory to manage an image, so it is important to use this function. - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * - * pImage := gdImageCreateTrueColor( 64, 64 ) - * // Use here image - * ......... - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageCreate(), gdImageCreateTrueColor() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageFromJpeg() + $CATEGORY$ + HBGD + $ONELINER$ + Load a JPEG image file. + $SYNTAX$ + gdImageFromJpeg( | | [, ] ) --> + $ARGUMENTS$ + - Image file name + - File handle + - Memory image pointer + - Image size + $RETURNS$ + - Image pointer + $DESCRIPTION$ + gdImageFromJpeg() creates a JPEG image from a file or a handle or another image in memory. + + You can use one of 3 syntax: + + pImage := gdImageFromJpeg( "myimage.jpg" ) + + or + + pImage := gdImageFromJpeg( nFileHandle, nSize ) + + or + + pImage := gdImageFromJpeg( pMemoryImagePtr, nSize ) + + the pImage pointer returned will be not NIL if successfull and will contains a memory pointer + to the jpeg image. + + Remember to free memory with gdImageDestroy() before exit from application. + HBGD uses it's own memory to manage an image, so it is important to use this function. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + + pImage := gdImageFromJpeg( "myimage.jpg" ) + // Use here image + ......... + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageCreate(), gdImageCreateTrueColor(), gdImageDestroy(), gdImageFromGif(), gdImageFromPng(), gdImageFromGD(), gdImageFromWBmp() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageFromJpeg() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Load a JPEG image file. - * $SYNTAX$ - * gdImageFromJpeg( | | [, ] ) --> - * $ARGUMENTS$ - * - Image file name - * - File handle - * - Memory image pointer - * - Image size - * $RETURNS$ - * - Image pointer - * $DESCRIPTION$ - * gdImageFromJpeg() creates a JPEG image from a file or a handle or another image in memory. - * - * You can use one of 3 syntax: - * - * pImage := gdImageFromJpeg( "myimage.jpg" ) - * - * or - * - * pImage := gdImageFromJpeg( nFileHandle, nSize ) - * - * or - * - * pImage := gdImageFromJpeg( pMemoryImagePtr, nSize ) - * - * the pImage pointer returned will be not NIL if successfull and will contains a memory pointer - * to the jpeg image. - * - * Remember to free memory with gdImageDestroy() before exit from application. - * HBGD uses it's own memory to manage an image, so it is important to use this function. - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * - * pImage := gdImageFromJpeg( "myimage.jpg" ) - * // Use here image - * ......... - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageCreate(), gdImageCreateTrueColor(), gdImageDestroy(), gdImageFromGif(), gdImageFromPng(), gdImageFromGD(), gdImageFromWBmp() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageFromGif() + $CATEGORY$ + HBGD + $ONELINER$ + Load a Gif image file. + $SYNTAX$ + gdImageFromGif( | | [, ] ) --> + $ARGUMENTS$ + - Image file name + - File handle + - Memory image pointer + - Image size + $RETURNS$ + - Image pointer + $DESCRIPTION$ + gdImageFromGif() creates a GIF image from a file or a handle or another image in memory. + + You can use one of 3 syntax: + + pImage := gdImageFromGif( "myimage.gif" ) + + or + + pImage := gdImageFromGif( nFileHandle, nSize ) + + or + + pImage := gdImageFromGif( pMemoryImagePtr, nSize ) + + the pImage pointer returned will be not NIL if successfull and will contains a memory pointer + to the gif image. + + Remember to free memory with gdImageDestroy() before exit from application. + HBGD uses it's own memory to manage an image, so it is important to use this function. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + + pImage := gdImageFromGif( "myimage.gif" ) + // Use here image + ......... + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageCreate(), gdImageCreateTrueColor(), gdImageDestroy(), gdImageFromJpeg(), gdImageFromPng(), gdImageFromGD(), gdImageFromWBmp() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageFromGif() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Load a Gif image file. - * $SYNTAX$ - * gdImageFromGif( | | [, ] ) --> - * $ARGUMENTS$ - * - Image file name - * - File handle - * - Memory image pointer - * - Image size - * $RETURNS$ - * - Image pointer - * $DESCRIPTION$ - * gdImageFromGif() creates a GIF image from a file or a handle or another image in memory. - * - * You can use one of 3 syntax: - * - * pImage := gdImageFromGif( "myimage.gif" ) - * - * or - * - * pImage := gdImageFromGif( nFileHandle, nSize ) - * - * or - * - * pImage := gdImageFromGif( pMemoryImagePtr, nSize ) - * - * the pImage pointer returned will be not NIL if successfull and will contains a memory pointer - * to the gif image. - * - * Remember to free memory with gdImageDestroy() before exit from application. - * HBGD uses it's own memory to manage an image, so it is important to use this function. - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * - * pImage := gdImageFromGif( "myimage.gif" ) - * // Use here image - * ......... - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageCreate(), gdImageCreateTrueColor(), gdImageDestroy(), gdImageFromJpeg(), gdImageFromPng(), gdImageFromGD(), gdImageFromWBmp() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageFromPng() + $CATEGORY$ + HBGD + $ONELINER$ + Load a PNG image file. + $SYNTAX$ + gdImageFromPng( | | [, ] ) --> + $ARGUMENTS$ + - Image file name + - File handle + - Memory image pointer + - Image size + $RETURNS$ + - Image pointer + $DESCRIPTION$ + gdImageFromPng() creates a PNG image from a file or a handle or another image in memory. + + You can use one of 3 syntax: + + pImage := gdImageFromPng( "myimage.png" ) + + or + + pImage := gdImageFromPng( nFileHandle, nSize ) + + or + + pImage := gdImageFromPng( pMemoryImagePtr, nSize ) + + the pImage pointer returned will be not NIL if successfull and will contains a memory pointer + to the png image. + + Remember to free memory with gdImageDestroy() before exit from application. + HBGD uses it's own memory to manage an image, so it is important to use this function. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + + pImage := gdImageFromPng( "myimage.png" ) + // Use here image + ......... + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageCreate(), gdImageCreateTrueColor(), gdImageDestroy(), gdImageFromJpeg(), gdImageFromGif(), gdImageFromGD(), gdImageFromWBmp() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageFromPng() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Load a PNG image file. - * $SYNTAX$ - * gdImageFromPng( | | [, ] ) --> - * $ARGUMENTS$ - * - Image file name - * - File handle - * - Memory image pointer - * - Image size - * $RETURNS$ - * - Image pointer - * $DESCRIPTION$ - * gdImageFromPng() creates a PNG image from a file or a handle or another image in memory. - * - * You can use one of 3 syntax: - * - * pImage := gdImageFromPng( "myimage.png" ) - * - * or - * - * pImage := gdImageFromPng( nFileHandle, nSize ) - * - * or - * - * pImage := gdImageFromPng( pMemoryImagePtr, nSize ) - * - * the pImage pointer returned will be not NIL if successfull and will contains a memory pointer - * to the png image. - * - * Remember to free memory with gdImageDestroy() before exit from application. - * HBGD uses it's own memory to manage an image, so it is important to use this function. - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * - * pImage := gdImageFromPng( "myimage.png" ) - * // Use here image - * ......... - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageCreate(), gdImageCreateTrueColor(), gdImageDestroy(), gdImageFromJpeg(), gdImageFromGif(), gdImageFromGD(), gdImageFromWBmp() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageFromGD() + $CATEGORY$ + HBGD + $ONELINER$ + Load a GD image file. + $SYNTAX$ + gdImageFromGD( | | [, ] ) --> + $ARGUMENTS$ + - Image file name + - File handle + - Memory image pointer + - Image size + $RETURNS$ + - Image pointer + $DESCRIPTION$ + gdImageFromGD() creates a GD image from a file or a handle or another image in memory. + + You can use one of 3 syntax: + + pImage := gdImageFromGD( "myimage.gd" ) + + or + + pImage := gdImageFromGD( nFileHandle, nSize ) + + or + + pImage := gdImageFromGD( pMemoryImagePtr, nSize ) + + the pImage pointer returned will be not NIL if successfull and will contains a memory pointer + to the GD image. + + Remember to free memory with gdImageDestroy() before exit from application. + HBGD uses it's own memory to manage an image, so it is important to use this function. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + + pImage := gdImageFromGD( "myimage.gd" ) + // Use here image + ......... + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageCreate(), gdImageCreateTrueColor(), gdImageDestroy(), gdImageFromJpeg(), gdImageFromGif(), gdImageFromPng(), gdImageFromWBmp() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageFromGD() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Load a GD image file. - * $SYNTAX$ - * gdImageFromGD( | | [, ] ) --> - * $ARGUMENTS$ - * - Image file name - * - File handle - * - Memory image pointer - * - Image size - * $RETURNS$ - * - Image pointer - * $DESCRIPTION$ - * gdImageFromGD() creates a GD image from a file or a handle or another image in memory. - * - * You can use one of 3 syntax: - * - * pImage := gdImageFromGD( "myimage.gd" ) - * - * or - * - * pImage := gdImageFromGD( nFileHandle, nSize ) - * - * or - * - * pImage := gdImageFromGD( pMemoryImagePtr, nSize ) - * - * the pImage pointer returned will be not NIL if successfull and will contains a memory pointer - * to the GD image. - * - * Remember to free memory with gdImageDestroy() before exit from application. - * HBGD uses it's own memory to manage an image, so it is important to use this function. - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * - * pImage := gdImageFromGD( "myimage.gd" ) - * // Use here image - * ......... - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageCreate(), gdImageCreateTrueColor(), gdImageDestroy(), gdImageFromJpeg(), gdImageFromGif(), gdImageFromPng(), gdImageFromWBmp() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageFromWBmp() + $CATEGORY$ + HBGD + $ONELINER$ + Load a WBmp image file. + $SYNTAX$ + gdImageFromWBmp( | | [, ] ) --> + $ARGUMENTS$ + - Image file name + - File handle + - Memory image pointer + - Image size + $RETURNS$ + - Image pointer + $DESCRIPTION$ + gdImageFromWBmp() creates a WBmp image from a file or a handle or another image in memory. + + You can use one of 3 syntax: + + pImage := gdImageFromWBmp( "myimage.wbmp" ) + + or + + pImage := gdImageFromWBmp( nFileHandle, nSize ) + + or + + pImage := gdImageFromWBmp( pMemoryImagePtr, nSize ) + + the pImage pointer returned will be not NIL if successfull and will contains a memory pointer + to the WBmp image. + + Remember to free memory with gdImageDestroy() before exit from application. + HBGD uses it's own memory to manage an image, so it is important to use this function. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + + pImage := gdImageFromWBmp( "myimage.wbmp" ) + // Use here image + ......... + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageCreate(), gdImageCreateTrueColor(), gdImageDestroy(), gdImageFromJpeg(), gdImageFromGif(), gdImageFromPng(), gdImageFromGD() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageFromWBmp() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Load a WBmp image file. - * $SYNTAX$ - * gdImageFromWBmp( | | [, ] ) --> - * $ARGUMENTS$ - * - Image file name - * - File handle - * - Memory image pointer - * - Image size - * $RETURNS$ - * - Image pointer - * $DESCRIPTION$ - * gdImageFromWBmp() creates a WBmp image from a file or a handle or another image in memory. - * - * You can use one of 3 syntax: - * - * pImage := gdImageFromWBmp( "myimage.wbmp" ) - * - * or - * - * pImage := gdImageFromWBmp( nFileHandle, nSize ) - * - * or - * - * pImage := gdImageFromWBmp( pMemoryImagePtr, nSize ) - * - * the pImage pointer returned will be not NIL if successfull and will contains a memory pointer - * to the WBmp image. - * - * Remember to free memory with gdImageDestroy() before exit from application. - * HBGD uses it's own memory to manage an image, so it is important to use this function. - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * - * pImage := gdImageFromWBmp( "myimage.wbmp" ) - * // Use here image - * ......... - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageCreate(), gdImageCreateTrueColor(), gdImageDestroy(), gdImageFromJpeg(), gdImageFromGif(), gdImageFromPng(), gdImageFromGD() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageJpeg() + $CATEGORY$ + HBGD + $ONELINER$ + Save a JPEG image. + $SYNTAX$ + gdImageJpeg( , | [, ] ) --> NIL + $ARGUMENTS$ + - Image pointer + - Image file name + - File handle + - a numeric value between 0=max compression and 95=min compression (best quality) + default is -1=auto + $RETURNS$ + NIL + $DESCRIPTION$ + gdImageJpeg() saves a JPEG image to a file or a handle. + + You can use one of 2 syntax: + + gdImageJpeg( pImage, "myimage.jpg" ) + + or + + gdImageJpeg( pImage, nFileHandle ) + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + + pImage := gdImageFromGif( "myimage.gif" ) + + // Image conversion + gdImageJpeg( pImage, "myimage.jpg" ) + + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageFromGif() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageJpeg() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Save a JPEG image. - * $SYNTAX$ - * gdImageJpeg( , | [, ] ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - Image file name - * - File handle - * - a numeric value between 0=max compression and 95=min compression (best quality) - * default is -1=auto - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * gdImageJpeg() saves a JPEG image to a file or a handle. - * - * You can use one of 2 syntax: - * - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * or - * - * gdImageJpeg( pImage, nFileHandle ) - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * - * pImage := gdImageFromGif( "myimage.gif" ) - * - * // Image conversion - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageFromGif() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageGif() + $CATEGORY$ + HBGD + $ONELINER$ + Save a GIF image. + $SYNTAX$ + gdImageGif( , | ) --> NIL + $ARGUMENTS$ + - Image pointer + - Image file name + - File handle + $RETURNS$ + NIL + $DESCRIPTION$ + gdImageGif() saves a GIF image to a file or a handle. + + You can use one of 2 syntax: + + gdImageGif( pImage, "myimage.gif" ) + + or + + gdImageGif( pImage, nFileHandle ) + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + + pImage := gdImageFromJpeg( "myimage.jpg" ) + + // Image conversion + gdImageGif( pImage, "myimage.gif" ) + + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageFromJpeg() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageGif() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Save a GIF image. - * $SYNTAX$ - * gdImageGif( , | ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - Image file name - * - File handle - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * gdImageGif() saves a GIF image to a file or a handle. - * - * You can use one of 2 syntax: - * - * gdImageGif( pImage, "myimage.gif" ) - * - * or - * - * gdImageGif( pImage, nFileHandle ) - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * - * pImage := gdImageFromJpeg( "myimage.jpg" ) - * - * // Image conversion - * gdImageGif( pImage, "myimage.gif" ) - * - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageFromJpeg() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImagePng() + $CATEGORY$ + HBGD + $ONELINER$ + Save a PNG image. + $SYNTAX$ + gdImagePng( , | [, ] ) --> NIL + $ARGUMENTS$ + - Image pointer + - Image file name + - File handle + - a numeric value between 0=no compression and 9=max compression + default is -1=auto + $RETURNS$ + NIL + $DESCRIPTION$ + gdImagePng() saves a PNG image to a file or a handle. + + You can use one of 2 syntax: + + gdImagePng( pImage, "myimage.png" ) + + or + + gdImagePng( pImage, nFileHandle ) + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + + pImage := gdImageFromGif( "myimage.gif" ) + + // Image conversion + gdImagePng( pImage, "myimage.png" ) + + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageFromGif() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImagePng() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Save a PNG image. - * $SYNTAX$ - * gdImagePng( , | [, ] ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - Image file name - * - File handle - * - a numeric value between 0=no compression and 9=max compression - * default is -1=auto - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * gdImagePng() saves a PNG image to a file or a handle. - * - * You can use one of 2 syntax: - * - * gdImagePng( pImage, "myimage.png" ) - * - * or - * - * gdImagePng( pImage, nFileHandle ) - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * - * pImage := gdImageFromGif( "myimage.gif" ) - * - * // Image conversion - * gdImagePng( pImage, "myimage.png" ) - * - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageFromGif() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageGD() + $CATEGORY$ + HBGD + $ONELINER$ + Save a GD image. + $SYNTAX$ + gdImageGd( , | ) --> NIL + $ARGUMENTS$ + - Image pointer + - Image file name + - File handle + $RETURNS$ + NIL + $DESCRIPTION$ + gdImageGd() saves a GD image to a file or a handle. + + You can use one of 2 syntax: + + gdImageGd( pImage, "myimage.gd" ) + + or + + gdImageGd( pImage, nFileHandle ) + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + + pImage := gdImageFromGif( "myimage.gif" ) + + // Image conversion + gdImageGd( pImage, "myimage.gd" ) + + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageFromGif() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageGD() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Save a GD image. - * $SYNTAX$ - * gdImageGd( , | ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - Image file name - * - File handle - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * gdImageGd() saves a GD image to a file or a handle. - * - * You can use one of 2 syntax: - * - * gdImageGd( pImage, "myimage.gd" ) - * - * or - * - * gdImageGd( pImage, nFileHandle ) - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * - * pImage := gdImageFromGif( "myimage.gif" ) - * - * // Image conversion - * gdImageGd( pImage, "myimage.gd" ) - * - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageFromGif() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageWBmp() + $CATEGORY$ + HBGD + $ONELINER$ + Save a WBMP image. + $SYNTAX$ + gdImageWBmp( , | [, ] ) --> NIL + $ARGUMENTS$ + - Image pointer + - Image file name + - File handle + - foreground color value to be used as foreground, the others are background + $RETURNS$ + NIL + $DESCRIPTION$ + gdImageWBmp() saves a WBMP image to a file or a handle. + + You can use one of 2 syntax: + + gdImageWBmp( pImage, "myimage.wbmp", nColor ) + + or + + gdImagePng( pImage, nFileHandle, nColor ) + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + LOCAL white, black + + // Create an image in memory + pImage := gdImageCreate( 100, 100 ) + + // Allocate background + white := gdImageColorAllocate(pImage, 255, 255, 255) + + // Allocate drawing color + black := gdImageColorAllocate(pImage, 0, 0, 0) + + // Draw a rectangle + gdImageRectangle(pImage, 0, 0, 99, 99, black) + + // Save the image with black as foreground color + gdImageWBmp( pImage, "myimage.wbmp", black ) + + // Destroy the image + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate(), gdImageRectangle(), gdColorAllocate() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageWBmp() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Save a WBMP image. - * $SYNTAX$ - * gdImageWBmp( , | [, ] ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - Image file name - * - File handle - * - foreground color value to be used as foreground, the others are background - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * gdImageWBmp() saves a WBMP image to a file or a handle. - * - * You can use one of 2 syntax: - * - * gdImageWBmp( pImage, "myimage.wbmp", nColor ) - * - * or - * - * gdImagePng( pImage, nFileHandle, nColor ) - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * LOCAL white, black - * - * // Create an image in memory - * pImage := gdImageCreate( 100, 100 ) - * - * // Allocate background - * white := gdImageColorAllocate(pImage, 255, 255, 255) - * - * // Allocate drawing color - * black := gdImageColorAllocate(pImage, 0, 0, 0) - * - * // Draw a rectangle - * gdImageRectangle(pImage, 0, 0, 99, 99, black) - * - * // Save the image with black as foreground color - * gdImageWBmp( pImage, "myimage.wbmp", black ) - * - * // Destroy the image - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate(), gdImageRectangle(), gdColorAllocate() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageSetPixel() + $CATEGORY$ + HBGD + $ONELINER$ + Set a pixel to a particular color index. + $SYNTAX$ + gdImageSetPixel( , , , ) --> NIL + $ARGUMENTS$ + - Image pointer + - Horizontal position + - Vertical position + - Color index + $RETURNS$ + NIL + $DESCRIPTION$ + gdImageSetPixel() sets a pixel to a particular color index. + + To set the color index you have to use gdImageColorAllocate() function. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + LOCAL white + + // Create an image in memory + pImage := gdImageCreate( 100, 100 ) + + // Allocate color + white := gdImageColorAllocate(pImage, 255, 255, 255) + + // Draw a pixel + gdImageSetPixel(pImage, 50, 50, white) + + // Save the image + gdImageJpeg( pImage, "myimage.jpg" ) + + // Destroy the image + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageSetPixel() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Set a pixel to a particular color index. - * $SYNTAX$ - * gdImageSetPixel( , , , ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - Horizontal position - * - Vertical position - * - Color index - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * gdImageSetPixel() sets a pixel to a particular color index. - * - * To set the color index you have to use gdImageColorAllocate() function. - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * LOCAL white - * - * // Create an image in memory - * pImage := gdImageCreate( 100, 100 ) - * - * // Allocate color - * white := gdImageColorAllocate(pImage, 255, 255, 255) - * - * // Draw a pixel - * gdImageSetPixel(pImage, 50, 50, white) - * - * // Save the image - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * // Destroy the image - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageLine() + $CATEGORY$ + HBGD + $ONELINER$ + Draws a line between two end points (x1, y1 and x2, y2) with a particular color index. + $SYNTAX$ + gdImageLine( , , , , , ) --> NIL + $ARGUMENTS$ + - Image pointer + - 1st point horizontal position + - 1st point vertical position + - 2nd point horizontal position + - 2nd point vertical position + - Color index + $RETURNS$ + NIL + $DESCRIPTION$ + gdImageLine() Draws a line between two end points (x1, y1 and x2, y2) + with a particular color index. + + To set the color index you have to use gdImageColorAllocate() function. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + LOCAL blue + + // Create an image in memory + pImage := gdImageCreate( 100, 100 ) + + // Allocate color + blue := gdImageColorAllocate(pImage, 0, 0, 255) + + // Draw a line + gdImageLine(pImage, 10, 10, 90, 90, blue) + + // Save the image + gdImageJpeg( pImage, "myimage.jpg" ) + + // Destroy the image + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageLine() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Draws a line between two end points (x1, y1 and x2, y2) with a particular color index. - * $SYNTAX$ - * gdImageLine( , , , , , ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - 1st point horizontal position - * - 1st point vertical position - * - 2nd point horizontal position - * - 2nd point vertical position - * - Color index - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * gdImageLine() Draws a line between two end points (x1, y1 and x2, y2) - * with a particular color index. - * - * To set the color index you have to use gdImageColorAllocate() function. - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * LOCAL blue - * - * // Create an image in memory - * pImage := gdImageCreate( 100, 100 ) - * - * // Allocate color - * blue := gdImageColorAllocate(pImage, 0, 0, 255) - * - * // Draw a line - * gdImageLine(pImage, 10, 10, 90, 90, blue) - * - * // Save the image - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * // Destroy the image - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageDashedLine() + $CATEGORY$ + HBGD + $ONELINER$ + Draws a dashed line between two end points (x1, y1 and x2, y2) with a particular color index. + $SYNTAX$ + gdImageDashedLine( , , , , , ) --> NIL + $ARGUMENTS$ + - Image pointer + - 1st point horizontal position + - 1st point vertical position + - 2nd point horizontal position + - 2nd point vertical position + - Color index + $RETURNS$ + NIL + $DESCRIPTION$ + gdImageDashedLine() Draws a dashed line between two end points (x1, y1 and x2, y2) + with a particular color index. + + To set the color index you have to use gdImageColorAllocate() function. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + LOCAL blue + + // Create an image in memory + pImage := gdImageCreate( 100, 100 ) + + // Allocate color + blue := gdImageColorAllocate(pImage, 0, 0, 255) + + // Draw a dashed line + gdImageDashedLine(pImage, 10, 10, 90, 90, blue) + + // Save the image + gdImageJpeg( pImage, "myimage.jpg" ) + + // Destroy the image + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageDashedLine() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Draws a dashed line between two end points (x1, y1 and x2, y2) with a particular color index. - * $SYNTAX$ - * gdImageDashedLine( , , , , , ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - 1st point horizontal position - * - 1st point vertical position - * - 2nd point horizontal position - * - 2nd point vertical position - * - Color index - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * gdImageDashedLine() Draws a dashed line between two end points (x1, y1 and x2, y2) - * with a particular color index. - * - * To set the color index you have to use gdImageColorAllocate() function. - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * LOCAL blue - * - * // Create an image in memory - * pImage := gdImageCreate( 100, 100 ) - * - * // Allocate color - * blue := gdImageColorAllocate(pImage, 0, 0, 255) - * - * // Draw a dashed line - * gdImageDashedLine(pImage, 10, 10, 90, 90, blue) - * - * // Save the image - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * // Destroy the image - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImagePolygon() + $CATEGORY$ + HBGD + $ONELINER$ + Draws a closed polygon with verticies (at least 3) with a particular color index. + $SYNTAX$ + gdImagePolygon( , , ) --> NIL + $ARGUMENTS$ + - Image pointer + - Array of point array { , } where + is horizontal position + is vertical position + - Color index + $RETURNS$ + NIL + $DESCRIPTION$ + gdImagePolygon() Draws a closed polygon with verticies (at least 3) with a + particular color index. + + To set the color index you have to use gdImageColorAllocate() function. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + LOCAL blue + LOCAL aVerticies := { ; + { 50, 0 } ,; + { 99, 99 } ,; + { 0, 99 } ; + } + + // Create an image in memory + pImage := gdImageCreate( 100, 100 ) + + // Allocate color + blue := gdImageColorAllocate(pImage, 0, 0, 255) + + // Draw a polygon + gdImagePolygon(pImage, aVerticies, blue) + + // Save the image + gdImageJpeg( pImage, "myimage.jpg" ) + + // Destroy the image + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImagePolygon() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Draws a closed polygon with verticies (at least 3) with a particular color index. - * $SYNTAX$ - * gdImagePolygon( , , ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - Array of point array { , } where - * is horizontal position - * is vertical position - * - Color index - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * gdImagePolygon() Draws a closed polygon with verticies (at least 3) with a - * particular color index. - * - * To set the color index you have to use gdImageColorAllocate() function. - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * LOCAL blue - * LOCAL aVerticies := { ; - * { 50, 0 } ,; - * { 99, 99 } ,; - * { 0, 99 } ; - * } - * - * // Create an image in memory - * pImage := gdImageCreate( 100, 100 ) - * - * // Allocate color - * blue := gdImageColorAllocate(pImage, 0, 0, 255) - * - * // Draw a polygon - * gdImagePolygon(pImage, aVerticies, blue) - * - * // Save the image - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * // Destroy the image - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageOpenPolygon() + $CATEGORY$ + HBGD + $ONELINER$ + Draws an open polygon with verticies (at least 3) with a particular color index. + $SYNTAX$ + gdImageOpenPolygon( , , ) --> NIL + $ARGUMENTS$ + - Image pointer + - Array of point array { , } where + is horizontal position + is vertical position + - Color index + $RETURNS$ + NIL + $DESCRIPTION$ + gdImageOpenPolygon() Draws an open polygon with verticies (at least 3) with a + particular color index. Unlike gdImagePolygon() the endpoints of the line sequence + are not connected to close the polygon. + + To set the color index you have to use gdImageColorAllocate() function. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + LOCAL blue + LOCAL aVerticies := { ; + { 50, 0 } ,; + { 99, 99 } ,; + { 0, 99 } ; + } + + // Create an image in memory + pImage := gdImageCreate( 100, 100 ) + + // Allocate color + blue := gdImageColorAllocate(pImage, 0, 0, 255) + + // Draws an open polygon + gdImageOpenPolygon(pImage, aVerticies, blue) + + // Save the image + gdImageJpeg( pImage, "myimage.jpg" ) + + // Destroy the image + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageOpenPolygon() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Draws an open polygon with verticies (at least 3) with a particular color index. - * $SYNTAX$ - * gdImageOpenPolygon( , , ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - Array of point array { , } where - * is horizontal position - * is vertical position - * - Color index - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * gdImageOpenPolygon() Draws an open polygon with verticies (at least 3) with a - * particular color index. Unlike gdImagePolygon() the endpoints of the line sequence - * are not connected to close the polygon. - * - * To set the color index you have to use gdImageColorAllocate() function. - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * LOCAL blue - * LOCAL aVerticies := { ; - * { 50, 0 } ,; - * { 99, 99 } ,; - * { 0, 99 } ; - * } - * - * // Create an image in memory - * pImage := gdImageCreate( 100, 100 ) - * - * // Allocate color - * blue := gdImageColorAllocate(pImage, 0, 0, 255) - * - * // Draws an open polygon - * gdImageOpenPolygon(pImage, aVerticies, blue) - * - * // Save the image - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * // Destroy the image - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageRectangle() + $CATEGORY$ + HBGD + $ONELINER$ + Draws a rectangle with a particular color index. + $SYNTAX$ + gdImageRectangle( , , , , , ) --> NIL + $ARGUMENTS$ + - Image pointer + - upper left point horizontal position + - upper left point vertical position + - lower right point horizontal position + - lower right point vertical position + - Color index + $RETURNS$ + NIL + $DESCRIPTION$ + gdImageRectangle() draws a rectangle between 2 points with a + particular color index. + + To set the color index you have to use gdImageColorAllocate() function. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + LOCAL blue + + // Create an image in memory + pImage := gdImageCreate( 100, 100 ) + + // Allocate color + blue := gdImageColorAllocate(pImage, 0, 0, 255) + + // Draw a rectangle + gdImageRectangle(pImage, 10, 10, 50, 50, blue) + + // Save the image + gdImageJpeg( pImage, "myimage.jpg" ) + + // Destroy the image + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageRectangle() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Draws a rectangle with a particular color index. - * $SYNTAX$ - * gdImageRectangle( , , , , , ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - upper left point horizontal position - * - upper left point vertical position - * - lower right point horizontal position - * - lower right point vertical position - * - Color index - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * gdImageRectangle() draws a rectangle between 2 points with a - * particular color index. - * - * To set the color index you have to use gdImageColorAllocate() function. - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * LOCAL blue - * - * // Create an image in memory - * pImage := gdImageCreate( 100, 100 ) - * - * // Allocate color - * blue := gdImageColorAllocate(pImage, 0, 0, 255) - * - * // Draw a rectangle - * gdImageRectangle(pImage, 10, 10, 50, 50, blue) - * - * // Save the image - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * // Destroy the image - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageFilledPolygon() + $CATEGORY$ + HBGD + $ONELINER$ + Draws a filled polygon with verticies (at least 3) with a particular color index. + $SYNTAX$ + gdImageFilledPolygon( , , ) --> NIL + $ARGUMENTS$ + - Image pointer + - Array of point array { , } where + is horizontal position + is vertical position + - Color index + $RETURNS$ + NIL + $DESCRIPTION$ + gdImageFilledPolygon() Draws a filled polygon with verticies (at least 3) with a + particular color index. + + To set the color index you have to use gdImageColorAllocate() function. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + LOCAL blue + LOCAL aVerticies := { ; + { 50, 0 } ,; + { 99, 99 } ,; + { 0, 99 } ; + } + + // Create an image in memory + pImage := gdImageCreate( 100, 100 ) + + // Allocate color + blue := gdImageColorAllocate(pImage, 0, 0, 255) + + // Draw a filled polygon + gdImageFilledPolygon(pImage, aVerticies, blue) + + // Save the image + gdImageJpeg( pImage, "myimage.jpg" ) + + // Destroy the image + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageFilledPolygon() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Draws a filled polygon with verticies (at least 3) with a particular color index. - * $SYNTAX$ - * gdImageFilledPolygon( , , ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - Array of point array { , } where - * is horizontal position - * is vertical position - * - Color index - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * gdImageFilledPolygon() Draws a filled polygon with verticies (at least 3) with a - * particular color index. - * - * To set the color index you have to use gdImageColorAllocate() function. - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * LOCAL blue - * LOCAL aVerticies := { ; - * { 50, 0 } ,; - * { 99, 99 } ,; - * { 0, 99 } ; - * } - * - * // Create an image in memory - * pImage := gdImageCreate( 100, 100 ) - * - * // Allocate color - * blue := gdImageColorAllocate(pImage, 0, 0, 255) - * - * // Draw a filled polygon - * gdImageFilledPolygon(pImage, aVerticies, blue) - * - * // Save the image - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * // Destroy the image - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageFilledRectangle() + $CATEGORY$ + HBGD + $ONELINER$ + Draws a filled rectangle with a particular color index. + $SYNTAX$ + gdImageFilledRectangle( , , , , , ) --> NIL + $ARGUMENTS$ + - Image pointer + - upper left point horizontal position + - upper left point vertical position + - lower right point horizontal position + - lower right point vertical position + - Color index + $RETURNS$ + NIL + $DESCRIPTION$ + gdImageFilledRectangle() draws a filled rectangle between 2 points with a + particular color index. + + To set the color index you have to use gdImageColorAllocate() function. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + LOCAL blue + + // Create an image in memory + pImage := gdImageCreate( 100, 100 ) + + // Allocate color + blue := gdImageColorAllocate(pImage, 0, 0, 255) + + // Draw a filled rectangle + gdImageFilledRectangle(pImage, 10, 10, 50, 50, blue) + + // Save the image + gdImageJpeg( pImage, "myimage.jpg" ) + + // Destroy the image + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageFilledRectangle() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Draws a filled rectangle with a particular color index. - * $SYNTAX$ - * gdImageFilledRectangle( , , , , , ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - upper left point horizontal position - * - upper left point vertical position - * - lower right point horizontal position - * - lower right point vertical position - * - Color index - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * gdImageFilledRectangle() draws a filled rectangle between 2 points with a - * particular color index. - * - * To set the color index you have to use gdImageColorAllocate() function. - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * LOCAL blue - * - * // Create an image in memory - * pImage := gdImageCreate( 100, 100 ) - * - * // Allocate color - * blue := gdImageColorAllocate(pImage, 0, 0, 255) - * - * // Draw a filled rectangle - * gdImageFilledRectangle(pImage, 10, 10, 50, 50, blue) - * - * // Save the image - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * // Destroy the image - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageArc() + $CATEGORY$ + HBGD + $ONELINER$ + Draws a partial ellipse centered at a given point. + $SYNTAX$ + gdImageArc( , , , , , , , ) --> NIL + $ARGUMENTS$ + - Image pointer + - center point horizontal position + - center point vertical position + - width + - height + - start degree + - end degree + - Color index + $RETURNS$ + NIL + $DESCRIPTION$ + gdImageArc() is used to draw a partial ellipse centered at the given point, + with the specified width and height in pixels. The arc begins at the position + in degrees specified by s and ends at the position specified by e. + The arc is drawn in the color specified by the last argument. A circle can be drawn + by beginning from 0 degrees and ending at 360 degrees, with width and height being equal. + must be greater than . Values greater than 360 are interpreted modulo 360. + + To set the color index you have to use gdImageColorAllocate() function. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + LOCAL blue + + // Create an image in memory + pImage := gdImageCreate( 100, 100 ) + + // Allocate color + blue := gdImageColorAllocate(pImage, 0, 0, 255) + + // Draw an ellipse + gdImageArc(pImage, 50, 25, 98, 48, 0, 360, blue) + + // Save the image + gdImageJpeg( pImage, "myimage.jpg" ) + + // Destroy the image + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageArc() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Draws a partial ellipse centered at a given point. - * $SYNTAX$ - * gdImageArc( , , , , , , , ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - center point horizontal position - * - center point vertical position - * - width - * - height - * - start degree - * - end degree - * - Color index - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * gdImageArc() is used to draw a partial ellipse centered at the given point, - * with the specified width and height in pixels. The arc begins at the position - * in degrees specified by s and ends at the position specified by e. - * The arc is drawn in the color specified by the last argument. A circle can be drawn - * by beginning from 0 degrees and ending at 360 degrees, with width and height being equal. - * must be greater than . Values greater than 360 are interpreted modulo 360. - * - * To set the color index you have to use gdImageColorAllocate() function. - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * LOCAL blue - * - * // Create an image in memory - * pImage := gdImageCreate( 100, 100 ) - * - * // Allocate color - * blue := gdImageColorAllocate(pImage, 0, 0, 255) - * - * // Draw an ellipse - * gdImageArc(pImage, 50, 25, 98, 48, 0, 360, blue) - * - * // Save the image - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * // Destroy the image - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageFilledArc() + $CATEGORY$ + HBGD + $ONELINER$ + Draws a partial filled ellipse centered at a given point. + $SYNTAX$ + gdImageArc( , , , , , , , , ) --> NIL + $ARGUMENTS$ + - Image pointer + - center point horizontal position + - center point vertical position + - width + - height + - start degree + - end degree + - Color index + - fill style + $RETURNS$ + NIL + $DESCRIPTION$ + gdImageFilledArc() is used to draw a partial ellipse centered at the given point, + with the specified width and height in pixels. The arc begins at the position + in degrees specified by s and ends at the position specified by e. + The arc is drawn in the color specified by the last argument. A circle can be drawn + by beginning from 0 degrees and ending at 360 degrees, with width and height being equal. + must be greater than . Values greater than 360 are interpreted modulo 360. + + To set the color index you have to use gdImageColorAllocate() function. + + Last parameter is a bitwise OR of the following possibilities: + gdArc + gdChord + gdPie (synonym for gdArc) + gdNoFill + gdEdged + + gdArc and gdChord are mutually exclusive; + gdChord just connects the starting and ending angles with a straight line, + while gdArc produces a rounded edge. gdPie is a synonym for gdArc. + gdNoFill indicates that the arc or chord should be outlined, not filled. + gdEdged, used together with gdNoFill, indicates that the beginning and ending + angles should be connected to the center; this is a good way to outline + (rather than fill) a 'pie slice' + + these constants are defined in gd.ch + + $EXAMPLES$ + #include "gd.ch" + + PROCEDURE Main() + LOCAL pImage + LOCAL blue + + // Create an image in memory + pImage := gdImageCreate( 100, 100 ) + + // Allocate color + blue := gdImageColorAllocate(pImage, 0, 0, 255) + + // Draw an ellipse + gdImageFilledArc(pImage, 50, 25, 98, 48, 0, 360, blue, gdArc) + + // Save the image + gdImageJpeg( pImage, "myimage.jpg" ) + + // Destroy the image + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageFilledArc() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Draws a partial filled ellipse centered at a given point. - * $SYNTAX$ - * gdImageArc( , , , , , , , , ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - center point horizontal position - * - center point vertical position - * - width - * - height - * - start degree - * - end degree - * - Color index - * - fill style - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * gdImageFilledArc() is used to draw a partial ellipse centered at the given point, - * with the specified width and height in pixels. The arc begins at the position - * in degrees specified by s and ends at the position specified by e. - * The arc is drawn in the color specified by the last argument. A circle can be drawn - * by beginning from 0 degrees and ending at 360 degrees, with width and height being equal. - * must be greater than . Values greater than 360 are interpreted modulo 360. - * - * To set the color index you have to use gdImageColorAllocate() function. - * - * Last parameter is a bitwise OR of the following possibilities: - * gdArc - * gdChord - * gdPie (synonym for gdArc) - * gdNoFill - * gdEdged - * - * gdArc and gdChord are mutually exclusive; - * gdChord just connects the starting and ending angles with a straight line, - * while gdArc produces a rounded edge. gdPie is a synonym for gdArc. - * gdNoFill indicates that the arc or chord should be outlined, not filled. - * gdEdged, used together with gdNoFill, indicates that the beginning and ending - * angles should be connected to the center; this is a good way to outline - * (rather than fill) a 'pie slice' - * - * these constants are defined in gd.ch - * - * $EXAMPLES$ - * - * #include "gd.ch" - * - * PROCEDURE Main() - * LOCAL pImage - * LOCAL blue - * - * // Create an image in memory - * pImage := gdImageCreate( 100, 100 ) - * - * // Allocate color - * blue := gdImageColorAllocate(pImage, 0, 0, 255) - * - * // Draw an ellipse - * gdImageFilledArc(pImage, 50, 25, 98, 48, 0, 360, blue, gdArc) - * - * // Save the image - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * // Destroy the image - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageFilledEllipse() + $CATEGORY$ + HBGD + $ONELINER$ + Draws a filled ellipse centered at a given point. + $SYNTAX$ + gdImageFilledEllipse( , , , , , ) --> NIL + $ARGUMENTS$ + - Image pointer + - center point horizontal position + - center point vertical position + - width + - height + - Color index + $RETURNS$ + NIL + $DESCRIPTION$ + gdImageFilledEllipse() is used to draw a filled ellipse centered at the given point, + with the specified width and height in pixels. + + To set the color index you have to use gdImageColorAllocate() function. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + LOCAL blue + + // Create an image in memory + pImage := gdImageCreate( 100, 100 ) + + // Allocate color + blue := gdImageColorAllocate(pImage, 0, 0, 255) + + // Draw an ellipse + gdImageFilledEllipse(pImage, 50, 25, 98, 48, blue) + + // Save the image + gdImageJpeg( pImage, "myimage.jpg" ) + + // Destroy the image + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageFilledEllipse() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * Draws a filled ellipse centered at a given point. - * $SYNTAX$ - * gdImageFilledEllipse( , , , , , ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - center point horizontal position - * - center point vertical position - * - width - * - height - * - Color index - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * gdImageFilledEllipse() is used to draw a filled ellipse centered at the given point, - * with the specified width and height in pixels. - * - * To set the color index you have to use gdImageColorAllocate() function. - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * LOCAL blue - * - * // Create an image in memory - * pImage := gdImageCreate( 100, 100 ) - * - * // Allocate color - * blue := gdImageColorAllocate(pImage, 0, 0, 255) - * - * // Draw an ellipse - * gdImageFilledEllipse(pImage, 50, 25, 98, 48, blue) - * - * // Save the image - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * // Destroy the image - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageFillToBorder() + $CATEGORY$ + HBGD + $ONELINER$ + floods a portion of the image with the specified color. + $SYNTAX$ + gdImageFillToBorder( , , , , ) --> NIL + $ARGUMENTS$ + - Image pointer + - start point horizontal position + - start point vertical position + - Color index where fill stops + - Color index of filling color + $RETURNS$ + NIL + $DESCRIPTION$ + gdImageFillToBorder() floods a portion of the image with the specified color, + beginning at the specified point and stopping at the specified border color. For a way of + flooding an area defined by the color of the starting point, see gdImageFill(). + + To set the color index you have to use gdImageColorAllocate() function. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + LOCAL blue, red + + // Create an image in memory + pImage := gdImageCreate( 100, 100 ) + + // Allocate color + blue := gdImageColorAllocate(pImage, 0, 0, 255) + red := gdImageColorAllocate(pImage, 255, 0, 0) + + // Draw an ellipse + gdImageArc(pImage, 50, 25, 98, 48, 0, 360, blue) + + // Fill the ellipse + gdImageFillToBorder(pImage, 50, 50, blue, red) + + // Save the image + gdImageJpeg( pImage, "myimage.jpg" ) + + // Destroy the image + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg(), gdImageArc() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageFillToBorder() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * floods a portion of the image with the specified color. - * $SYNTAX$ - * gdImageFillToBorder( , , , , ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - start point horizontal position - * - start point vertical position - * - Color index where fill stops - * - Color index of filling color - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * gdImageFillToBorder() floods a portion of the image with the specified color, - * beginning at the specified point and stopping at the specified border color. For a way of - * flooding an area defined by the color of the starting point, see gdImageFill(). - * - * To set the color index you have to use gdImageColorAllocate() function. - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * LOCAL blue, red - * - * // Create an image in memory - * pImage := gdImageCreate( 100, 100 ) - * - * // Allocate color - * blue := gdImageColorAllocate(pImage, 0, 0, 255) - * red := gdImageColorAllocate(pImage, 255, 0, 0) - * - * // Draw an ellipse - * gdImageArc(pImage, 50, 25, 98, 48, 0, 360, blue) - * - * // Fill the ellipse - * gdImageFillToBorder(pImage, 50, 50, blue, red) - * - * // Save the image - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * // Destroy the image - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg(), gdImageArc() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageFill() + $CATEGORY$ + HBGD + $ONELINER$ + floods a portion of the image with the specified color. + $SYNTAX$ + gdImageFill( , , , ) --> NIL + $ARGUMENTS$ + - Image pointer + - start point horizontal position + - start point vertical position + - Color index of filling color + $RETURNS$ + NIL + $DESCRIPTION$ + gdImageFill() floods a portion of the image with the specified color, beginning at the + specified point and flooding the surrounding region of the same color as the starting point. + For a way of flooding a region defined by a specific border color rather than by its interior + color, see gdImageFillToBorder(). + The fill color can be gdTiled, resulting in a tile fill using another image as the tile. + However, the tile image cannot be transparent. If the image you wish to fill with has a + transparent color index, call gdImageTransparent on the tile image and set the transparent + color index to -1 to turn off its transparency. + + To set the color index you have to use gdImageColorAllocate() function. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage + LOCAL blue, red + + // Create an image in memory + pImage := gdImageCreate( 100, 100 ) + + // Allocate color + blue := gdImageColorAllocate(pImage, 0, 0, 255) + red := gdImageColorAllocate(pImage, 255, 0, 0) + + // Draw an ellipse + gdImageArc(pImage, 50, 25, 98, 48, 0, 360, blue) + + // Fill the ellipse + gdImageFill(pImage, 50, 50, red) + + // Save the image + gdImageJpeg( pImage, "myimage.jpg" ) + + // Destroy the image + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg(), gdImageArc() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageFill() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * floods a portion of the image with the specified color. - * $SYNTAX$ - * gdImageFill( , , , ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - start point horizontal position - * - start point vertical position - * - Color index of filling color - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * gdImageFill() floods a portion of the image with the specified color, beginning at the - * specified point and flooding the surrounding region of the same color as the starting point. - * For a way of flooding a region defined by a specific border color rather than by its interior - * color, see gdImageFillToBorder(). - * The fill color can be gdTiled, resulting in a tile fill using another image as the tile. - * However, the tile image cannot be transparent. If the image you wish to fill with has a - * transparent color index, call gdImageTransparent on the tile image and set the transparent - * color index to -1 to turn off its transparency. - * - * To set the color index you have to use gdImageColorAllocate() function. - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage - * LOCAL blue, red - * - * // Create an image in memory - * pImage := gdImageCreate( 100, 100 ) - * - * // Allocate color - * blue := gdImageColorAllocate(pImage, 0, 0, 255) - * red := gdImageColorAllocate(pImage, 255, 0, 0) - * - * // Draw an ellipse - * gdImageArc(pImage, 50, 25, 98, 48, 0, 360, blue) - * - * // Fill the ellipse - * gdImageFill(pImage, 50, 50, red) - * - * // Save the image - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * // Destroy the image - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg(), gdImageArc() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageSetAntiAliased() + $CATEGORY$ + HBGD + $ONELINER$ + specify the actual foreground color to be used when drawing antialiased lines. + $SYNTAX$ + gdImageSetAntiAliased( , ) --> NIL + $ARGUMENTS$ + - Image pointer + - Color index of filling color + $RETURNS$ + NIL + $DESCRIPTION$ + "Antialiasing" is a process by which jagged edges associated with line drawing + can be reduced by blending the foreground color with an appropriate percentage of + the background, depending on how much of the pixel in question is actually within + the boundaries of the line being drawn. All line-drawing functions, such as gdImageLine(), + gdImageOpenPolygon() and gdImagePolygon(), will draw antialiased lines if the special "color" + gdAntiAliased constant is used when calling them. + + gdImageSetAntiAliased is used to specify the actual foreground color to be used when drawing + antialiased lines. You may set any color to be the foreground, however as of version 2.0.12 + an alpha channel component is not supported. + + Antialiased lines can be drawn on both truecolor and palette-based images. However, + attempts to draw antialiased lines on highly complex palette-based backgrounds may not give + satisfactory results, due to the limited number of colors available in the palette. Antialiased + line-drawing on simple backgrounds should work well with palette-based images; otherwise create + or fetch a truecolor image instead. + + You need not take any special action when you are finished with antialised line drawing. + + To set the color index you have to use gdImageColorAllocate() function. + + $EXAMPLES$ + #include "gd.ch" + + PROCEDURE Main() + LOCAL pImage + LOCAL blue, red + + // Create an image in memory + pImage := gdImageCreate( 100, 100 ) + + // Allocate color + /* Background color (first allocated) */ + blue := gdImageColorAllocate(pImage, 0, 0, 255) + red := gdImageColorAllocate(pImage, 255, 0, 0) + + gdImageSetAntiAliased(pImage, blue) + + // Draw a smooth line + gdImageLine(pImage, 0, 0, 99, 9, gdAntiAliased) + + // Save the image + gdImageJpeg( pImage, "myimage.jpg" ) + + // Destroy the image + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg(), gdImageLine(), gdAntiAliased, gdSetAntiAliasedDontBlend() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageSetAntiAliased() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * specify the actual foreground color to be used when drawing antialiased lines. - * $SYNTAX$ - * gdImageSetAntiAliased( , ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - Color index of filling color - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * "Antialiasing" is a process by which jagged edges associated with line drawing - * can be reduced by blending the foreground color with an appropriate percentage of - * the background, depending on how much of the pixel in question is actually within - * the boundaries of the line being drawn. All line-drawing functions, such as gdImageLine(), - * gdImageOpenPolygon() and gdImagePolygon(), will draw antialiased lines if the special "color" - * gdAntiAliased constant is used when calling them. - * - * gdImageSetAntiAliased is used to specify the actual foreground color to be used when drawing - * antialiased lines. You may set any color to be the foreground, however as of version 2.0.12 - * an alpha channel component is not supported. - * - * Antialiased lines can be drawn on both truecolor and palette-based images. However, - * attempts to draw antialiased lines on highly complex palette-based backgrounds may not give - * satisfactory results, due to the limited number of colors available in the palette. Antialiased - * line-drawing on simple backgrounds should work well with palette-based images; otherwise create - * or fetch a truecolor image instead. - * - * You need not take any special action when you are finished with antialised line drawing. - * - * To set the color index you have to use gdImageColorAllocate() function. - * - * $EXAMPLES$ - * - * #include "gd.ch" - * - * PROCEDURE Main() - * LOCAL pImage - * LOCAL blue, red - * - * // Create an image in memory - * pImage := gdImageCreate( 100, 100 ) - * - * // Allocate color - * /* Background color (first allocated) */ - * blue := gdImageColorAllocate(pImage, 0, 0, 255) - * red := gdImageColorAllocate(pImage, 255, 0, 0) - * - * gdImageSetAntiAliased(pImage, blue) - * - * // Draw a smooth line - * gdImageLine(pImage, 0, 0, 99, 9, gdAntiAliased) - * - * // Save the image - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * // Destroy the image - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg(), gdImageLine(), gdAntiAliased, gdSetAntiAliasedDontBlend() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdSetAntiAliasedDontBlend() + $CATEGORY$ + HBGD + $ONELINER$ + indicate the special color that the foreground should stand out more clearly against. + $SYNTAX$ + gdSetAntiAliasedDontBlend( , ) --> NIL + $ARGUMENTS$ + - Image pointer + - Color index of filling color + $RETURNS$ + NIL + $DESCRIPTION$ + Normally, when drawing lines with the special gdAntiAliased "color," blending with + the background to reduce jagged edges is the desired behavior. However, when it is + desired that lines not be blended with one particular color when it is encountered + in the background, the gdImageSetAntiAliasedDontBlend() function can be used to indicate + the special color that the foreground should stand out more clearly against. + + To set the color index you have to use gdImageColorAllocate() function. + + $EXAMPLES$ + #include "gd.ch" + + PROCEDURE Main() + LOCAL pImage + LOCAL black, white, blue + + // Create an image in memory + pImage := gdImageCreate( 100, 100 ) + + // Allocate color + /* Background color (first allocated) */ + black := gdImageColorAllocate(pImage, 0, 0, 0) + white := gdImageColorAllocate(pImage, 255, 255, 255) + blue := gdImageColorAllocate(pImage, 0, 0, 255) + + gdImageSetAntiAliased(pImage, blue) + + // The portion of the line that crosses this white rectangle will not be blended smoothly + gdImageSetAntiAliasedDontBlend(pImage, white) + + // Draw a smooth line + gdImageLine(pImage, 0, 0, 99, 9, gdAntiAliased) + + // Save the image + gdImageJpeg( pImage, "myimage.jpg" ) + + // Destroy the image + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg(), gdImageLine(), gdAntiAliased, gdSetAntiAlias() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdSetAntiAliasedDontBlend() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * indicate the special color that the foreground should stand out more clearly against. - * $SYNTAX$ - * gdSetAntiAliasedDontBlend( , ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - Color index of filling color - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * Normally, when drawing lines with the special gdAntiAliased "color," blending with - * the background to reduce jagged edges is the desired behavior. However, when it is - * desired that lines not be blended with one particular color when it is encountered - * in the background, the gdImageSetAntiAliasedDontBlend() function can be used to indicate - * the special color that the foreground should stand out more clearly against. - * - * To set the color index you have to use gdImageColorAllocate() function. - * - * $EXAMPLES$ - * - * #include "gd.ch" - * - * PROCEDURE Main() - * LOCAL pImage - * LOCAL black, white, blue - * - * // Create an image in memory - * pImage := gdImageCreate( 100, 100 ) - * - * // Allocate color - * /* Background color (first allocated) */ - * black := gdImageColorAllocate(pImage, 0, 0, 0) - * white := gdImageColorAllocate(pImage, 255, 255, 255) - * blue := gdImageColorAllocate(pImage, 0, 0, 255) - * - * gdImageSetAntiAliased(pImage, blue) - * - * // The portion of the line that crosses this white rectangle will not be blended smoothly - * gdImageSetAntiAliasedDontBlend(pImage, white) - * - * // Draw a smooth line - * gdImageLine(pImage, 0, 0, 99, 9, gdAntiAliased) - * - * // Save the image - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * // Destroy the image - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg(), gdImageLine(), gdAntiAliased, gdSetAntiAlias() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageSetBrush() + $CATEGORY$ + HBGD + $ONELINER$ + A "brush" is an image used to draw wide, shaped strokes in another image. + $SYNTAX$ + gdImageSetBrush( , ) --> NIL + $ARGUMENTS$ + - Image pointer + - Brush Image pointer + $RETURNS$ + NIL + $DESCRIPTION$ + A "brush" is an image used to draw wide, shaped strokes in another image. + Just as a paintbrush is not a single point, a brush image need not be a single pixel. + Any gd image can be used as a brush, and by setting the transparent color index of the + brush image with gdImageColorTransparent, a brush of any shape can be created. + All line-drawing functions, such as gdImageLine, gdImageOpenPolygon and gdImagePolygon, + will use the current brush if the special "color" gdBrushed or gdStyledBrushed is used + when calling them. + gdImageSetBrush is used to specify the brush to be used in a particular image. + You can set any image to be the brush. If the brush image does not have the same color + map as the first image, any colors missing from the first image will be allocated. + If not enough colors can be allocated, the closest colors already available will be used. + This allows arbitrary PNGs to be used as brush images. It also means, however, that you + should not set a brush unless you will actually use it; if you set a rapid succession of + different brush images, you can quickly fill your color map, and the results will not be + optimal. + + You need not take any special action when you are finished with a brush. As for any other image, + if you will not be using the brush image for any further purpose, you should call gdImageDestroy. + You must not use the color gdBrushed if the current brush has been destroyed; you can of course + set a new brush to replace it. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage, pBrush + LOCAL blue, red + + // Create an image in memory + pImage := gdImageCreate( 100, 100 ) + + // Open the brush PNG. For best results, portions of the brush that should be transparent + // (ie, not part of the brush shape) should have the transparent color index. + pBrush := gdImageCreateFromPng( "mybrush.png" ) + + // Allocate color (background color is the first allocate) + black := gdImageColorAllocate(pImage, 0, 0, 0) + + // Set the brush + gdImageSetBrush(pImage, pBrush) + + // Draw a line from the upper left corner to the lower + // right corner using the brush. + gdImageLine(pImage, 0, 0, 99, 99, gdBrushed) + + // Save the image + gdImageJpeg( pImage, "myimage.jpg" ) + + // Destroy the image + gdImageDestroy( pImage ) + + // Destroy the brush image + gdImageDestroy( pBrush ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg(), gdImageLine() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageSetBrush() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * A "brush" is an image used to draw wide, shaped strokes in another image. - * $SYNTAX$ - * gdImageSetBrush( , ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - Brush Image pointer - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * A "brush" is an image used to draw wide, shaped strokes in another image. - * Just as a paintbrush is not a single point, a brush image need not be a single pixel. - * Any gd image can be used as a brush, and by setting the transparent color index of the - * brush image with gdImageColorTransparent, a brush of any shape can be created. - * All line-drawing functions, such as gdImageLine, gdImageOpenPolygon and gdImagePolygon, - * will use the current brush if the special "color" gdBrushed or gdStyledBrushed is used - * when calling them. - * gdImageSetBrush is used to specify the brush to be used in a particular image. - * You can set any image to be the brush. If the brush image does not have the same color - * map as the first image, any colors missing from the first image will be allocated. - * If not enough colors can be allocated, the closest colors already available will be used. - * This allows arbitrary PNGs to be used as brush images. It also means, however, that you - * should not set a brush unless you will actually use it; if you set a rapid succession of - * different brush images, you can quickly fill your color map, and the results will not be - * optimal. - * - * You need not take any special action when you are finished with a brush. As for any other image, - * if you will not be using the brush image for any further purpose, you should call gdImageDestroy. - * You must not use the color gdBrushed if the current brush has been destroyed; you can of course - * set a new brush to replace it. - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage, pBrush - * LOCAL blue, red - * - * // Create an image in memory - * pImage := gdImageCreate( 100, 100 ) - * - * // Open the brush PNG. For best results, portions of the brush that should be transparent - * // (ie, not part of the brush shape) should have the transparent color index. - * pBrush := gdImageCreateFromPng( "mybrush.png" ) - * - * // Allocate color (background color is the first allocate) - * black := gdImageColorAllocate(pImage, 0, 0, 0) - * - * // Set the brush - * gdImageSetBrush(pImage, pBrush) - * - * // Draw a line from the upper left corner to the lower - * // right corner using the brush. - * gdImageLine(pImage, 0, 0, 99, 99, gdBrushed) - * - * // Save the image - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * // Destroy the image - * gdImageDestroy( pImage ) - * - * // Destroy the brush image - * gdImageDestroy( pBrush ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg(), gdImageLine() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageSetTile() + $CATEGORY$ + HBGD + $ONELINER$ + A "tile" is an image used to fill an area with a repeated pattern. + $SYNTAX$ + gdImageSetTile( , ) --> NIL + $ARGUMENTS$ + - Image pointer + - Tile Image pointer + $RETURNS$ + NIL + $DESCRIPTION$ + A "tile" is an image used to fill an area with a repeated pattern. + Any gd image can be used as a tile, and by setting the transparent color index of + the tile image with gdImageColorTransparent, a tile that allows certain parts of + the underlying area to shine through can be created. All region-filling functions, + such as gdImageFill and gdImageFilledPolygon, will use the current tile if the special + "color" gdTiled is used when calling them. + + gdImageSetTile is used to specify the tile to be used in a particular image. You can + set any image to be the tile. If the tile image does not have the same color map as + the first image, any colors missing from the first image will be allocated. If not + enough colors can be allocated, the closest colors already available will be used. + This allows arbitrary PNGs to be used as tile images. It also means, however, that you + should not set a tile unless you will actually use it; if you set a rapid succession of + different tile images, you can quickly fill your color map, and the results will not be optimal. + + You need not take any special action when you are finished with a tile. As for any other + image, if you will not be using the tile image for any further purpose, you should call + gdImageDestroy. You must not use the color gdTiled if the current tile has been destroyed; + you can of course set a new tile to replace it. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL pImage, pTile + LOCAL blue, red + + // Create an image in memory + pImage := gdImageCreate( 100, 100 ) + + // Open the tile PNG. For best results, portions of the + // tile that should be transparent (ie, allowing the + // background to shine through) should have the transparent + // color index. + pTile := gdImageCreateFromPng( "mytile.png" ) + + // Allocate color (background color is the first allocate) + black := gdImageColorAllocate(pImage, 0, 0, 0) + + // Set the tile + gdImageSetTile(pImage, pTile) + + // Fill an area using the tile + gdImageFilledRectangle(pImage, 25, 25, 75, 75, gdTiled) + + // Save the image + gdImageJpeg( pImage, "myimage.jpg" ) + + // Destroy the image + gdImageDestroy( pImage ) + + // Destroy the tile image + gdImageDestroy( pTile ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg(), gdImageFilledRectangle() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageSetTile() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * A "tile" is an image used to fill an area with a repeated pattern. - * $SYNTAX$ - * gdImageSetTile( , ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - Tile Image pointer - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * A "tile" is an image used to fill an area with a repeated pattern. - * Any gd image can be used as a tile, and by setting the transparent color index of - * the tile image with gdImageColorTransparent, a tile that allows certain parts of - * the underlying area to shine through can be created. All region-filling functions, - * such as gdImageFill and gdImageFilledPolygon, will use the current tile if the special - * "color" gdTiled is used when calling them. - * - * gdImageSetTile is used to specify the tile to be used in a particular image. You can - * set any image to be the tile. If the tile image does not have the same color map as - * the first image, any colors missing from the first image will be allocated. If not - * enough colors can be allocated, the closest colors already available will be used. - * This allows arbitrary PNGs to be used as tile images. It also means, however, that you - * should not set a tile unless you will actually use it; if you set a rapid succession of - * different tile images, you can quickly fill your color map, and the results will not be optimal. - * - * You need not take any special action when you are finished with a tile. As for any other - * image, if you will not be using the tile image for any further purpose, you should call - * gdImageDestroy. You must not use the color gdTiled if the current tile has been destroyed; - * you can of course set a new tile to replace it. - * - * $EXAMPLES$ - * - * PROCEDURE Main() - * LOCAL pImage, pTile - * LOCAL blue, red - * - * // Create an image in memory - * pImage := gdImageCreate( 100, 100 ) - * - * // Open the tile PNG. For best results, portions of the - * // tile that should be transparent (ie, allowing the - * // background to shine through) should have the transparent - * // color index. - * pTile := gdImageCreateFromPng( "mytile.png" ) - * - * // Allocate color (background color is the first allocate) - * black := gdImageColorAllocate(pImage, 0, 0, 0) - * - * // Set the tile - * gdImageSetTile(pImage, pTile) - * - * // Fill an area using the tile - * gdImageFilledRectangle(pImage, 25, 25, 75, 75, gdTiled) - * - * // Save the image - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * // Destroy the image - * gdImageDestroy( pImage ) - * - * // Destroy the tile image - * gdImageDestroy( pTile ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg(), gdImageFilledRectangle() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageSetStyle() + $CATEGORY$ + HBGD + $ONELINER$ + set any desired series of colors to be repeated during the drawing of a line. + $SYNTAX$ + gdImageSetStyle( , ) --> NIL + $ARGUMENTS$ + - Image pointer + - Array of colors and special colors used to "style" a line + $RETURNS$ + NIL + $DESCRIPTION$ + It is often desirable to draw dashed lines, dotted lines, and other variations + on a broken line. gdImageSetStyle can be used to set any desired series of colors, + including a special color that leaves the background intact, to be repeated during + the drawing of a line. + To use gdImageSetStyle, create an array of integers and assign them the desired series + of color values to be repeated. You can assign the special color value gdTransparent + to indicate that the existing color should be left unchanged for that particular pixel + (allowing a dashed line to be attractively drawn over an existing image). + + Then, to draw a line using the style, use the normal gdImageLine function with the + special color value gdStyled. + + The style array is copied when you set the style, so you need not be concerned with + keeping the array around indefinitely. This should not break existing code that assumes + styles are not copied. + + You can also combine styles and brushes to draw the brush image at intervals instead of + in a continuous stroke. When creating a style for use with a brush, the style values are + interpreted differently: zero (0) indicates pixels at which the brush should not be drawn, + while one (1) indicates pixels at which the brush should be drawn. To draw a styled, + brushed line, you must use the special color value gdStyledBrushed. + + $EXAMPLES$ + #include "gd.ch" + + PROCEDURE Main() + LOCAL pImage, aStyleDotted := {}, aStyleDashed := {} + LOCAL black, red + + // Create an image in memory + pImage := gdImageCreate( 100, 100 ) + + // Allocate color (background color is the first allocate) + black := gdImageColorAllocate(pImage, 0, 0, 0) + red := gdImageColorAllocate(pImage, 255, 0, 0) + + // Set up dotted style. Leave every other pixel alone. + aAdd( aStyleDotted, red ) + aAdd( aStyleDotted, gdTransparent ) + + // Set up dashed style. Three on, three off. + aAdd( aStyleDashed, red ) + aAdd( aStyleDashed, red ) + aAdd( aStyleDashed, red ) + aAdd( aStyleDashed, gdTransparent ) + aAdd( aStyleDashed, gdTransparent ) + aAdd( aStyleDashed, gdTransparent ) + + // Set dotted style. + gdImageSetStyle(pImage, aStyleDotted) + + // Draw a line from the upper left corner to the lower right corner. + gdImageLine(pImage, 0, 0, 99, 99, gdStyled) + + // Now the dashed line. + gdImageSetStyle(pImage, aStyleDashed) + gdImageLine(pimage, 0, 99, 0, 99, gdStyled) + + // Save the image + gdImageJpeg( pImage, "myimage.jpg" ) + + // Destroy the image + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg(), gdImageLine() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * gdImageSetStyle() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * set any desired series of colors to be repeated during the drawing of a line. - * $SYNTAX$ - * gdImageSetStyle( , ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - Array of colors and special colors used to "style" a line - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * It is often desirable to draw dashed lines, dotted lines, and other variations - * on a broken line. gdImageSetStyle can be used to set any desired series of colors, - * including a special color that leaves the background intact, to be repeated during - * the drawing of a line. - * To use gdImageSetStyle, create an array of integers and assign them the desired series - * of color values to be repeated. You can assign the special color value gdTransparent - * to indicate that the existing color should be left unchanged for that particular pixel - * (allowing a dashed line to be attractively drawn over an existing image). - * - * Then, to draw a line using the style, use the normal gdImageLine function with the - * special color value gdStyled. - * - * The style array is copied when you set the style, so you need not be concerned with - * keeping the array around indefinitely. This should not break existing code that assumes - * styles are not copied. - * - * You can also combine styles and brushes to draw the brush image at intervals instead of - * in a continuous stroke. When creating a style for use with a brush, the style values are - * interpreted differently: zero (0) indicates pixels at which the brush should not be drawn, - * while one (1) indicates pixels at which the brush should be drawn. To draw a styled, - * brushed line, you must use the special color value gdStyledBrushed. - * - * $EXAMPLES$ - * - * #include "gd.ch" - * - * PROCEDURE Main() - * LOCAL pImage, aStyleDotted := {}, aStyleDashed := {} - * LOCAL black, red - * - * // Create an image in memory - * pImage := gdImageCreate( 100, 100 ) - * - * // Allocate color (background color is the first allocate) - * black := gdImageColorAllocate(pImage, 0, 0, 0) - * red := gdImageColorAllocate(pImage, 255, 0, 0) - * - * // Set up dotted style. Leave every other pixel alone. - * aAdd( aStyleDotted, red ) - * aAdd( aStyleDotted, gdTransparent ) - * - * // Set up dashed style. Three on, three off. - * aAdd( aStyleDashed, red ) - * aAdd( aStyleDashed, red ) - * aAdd( aStyleDashed, red ) - * aAdd( aStyleDashed, gdTransparent ) - * aAdd( aStyleDashed, gdTransparent ) - * aAdd( aStyleDashed, gdTransparent ) - * - * // Set dotted style. - * gdImageSetStyle(pImage, aStyleDotted) - * - * // Draw a line from the upper left corner to the lower right corner. - * gdImageLine(pImage, 0, 0, 99, 99, gdStyled) - * - * // Now the dashed line. - * gdImageSetStyle(pImage, aStyleDashed) - * gdImageLine(pimage, 0, 99, 0, 99, gdStyled) - * - * // Save the image - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * // Destroy the image - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg(), gdImageLine() - * $END$ +/* $DOC$ + $FUNCNAME$ + gdImageSetThickness() + $CATEGORY$ + HBGD + $ONELINER$ + determines the width of lines drawn in pixels. + $SYNTAX$ + gdImageSetThickness( , ) --> NIL + $ARGUMENTS$ + - Image pointer + - width of line in pixel + $RETURNS$ + NIL + $DESCRIPTION$ + gdImageSetThickness determines the width of lines drawn by the gdImageLine, + gdImagePolygon, gdImageOpenPolygon and related functions, in pixels. + + $EXAMPLES$ + #include "gd.ch" + + PROCEDURE Main() + LOCAL pImage + LOCAL black, white + + // Create an image in memory + pImage := gdImageCreate( 100, 100 ) + + // Allocate color (background color is the first allocate) + black := gdImageColorAllocate(pImage, 0, 0, 0) + white := gdImageColorAllocate(pImage, 255, 255, 255) + + // Set thickness. + gdImageSetThickness(pImage, 4) + + // Draw a fat line from the upper left corner to the lower right corner. + gdImageLine(pImage, 0, 0, 99, 99, white) + + // Save the image + gdImageJpeg( pImage, "myimage.jpg" ) + + // Destroy the image + gdImageDestroy( pImage ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + GD Library + $PLATFORMS$ + All + $FILES$ + gdwrp.c + $SEEALSO$ + gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg(), gdImageLine() + $END$ */ - -/* $DOC$ - * $FUNCNAME$ - * gdImageSetThickness() - * $CATEGORY$ - * HBGD - * $ONELINER$ - * determines the width of lines drawn in pixels. - * $SYNTAX$ - * gdImageSetThickness( , ) --> NIL - * $ARGUMENTS$ - * - Image pointer - * - width of line in pixel - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * gdImageSetThickness determines the width of lines drawn by the gdImageLine, - * gdImagePolygon, gdImageOpenPolygon and related functions, in pixels. - * - * $EXAMPLES$ - * - * #include "gd.ch" - * - * PROCEDURE Main() - * LOCAL pImage - * LOCAL black, white - * - * // Create an image in memory - * pImage := gdImageCreate( 100, 100 ) - * - * // Allocate color (background color is the first allocate) - * black := gdImageColorAllocate(pImage, 0, 0, 0) - * white := gdImageColorAllocate(pImage, 255, 255, 255) - * - * // Set thickness. - * gdImageSetThickness(pImage, 4) - * - * // Draw a fat line from the upper left corner to the lower right corner. - * gdImageLine(pImage, 0, 0, 99, 99, white) - * - * // Save the image - * gdImageJpeg( pImage, "myimage.jpg" ) - * - * // Destroy the image - * gdImageDestroy( pImage ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * GD Library - * $PLATFORMS$ - * All - * $FILES$ - * gdwrp.c - * $SEEALSO$ - * gdImageDestroy(), gdImageCreate(), gdImageColorAllocate(), gdImageJpeg(), gdImageLine() - * $END$ - */ - diff --git a/harbour/contrib/hbgt/doc/en/hbgt.txt b/harbour/contrib/hbgt/doc/en/hbgt.txt index 7c36eab31c..20f217f6aa 100644 --- a/harbour/contrib/hbgt/doc/en/hbgt.txt +++ b/harbour/contrib/hbgt/doc/en/hbgt.txt @@ -2,714 +2,731 @@ * $Id$ */ -/* - * The following parts are Copyright of the individual authors. - * www - http://harbour-project.org - * - * Copyright 1999 Andy M Leighton - * Documentation - * - * FlagString functions GT_NEWFLAG, GT_SETFLAG, GT_CLRFLAG, and - * GT_ISFLAG are an original work by Dave Pearson and - * are placed in the public domain. - * - * See doc/license.txt for licensing terms. - * +/* $DOC$ + $FUNCNAME$ + GT_ASCPOS() + $CATEGORY$ + String Tools + $ONELINER$ + Return the ascii value of a specified character in a string + $SYNTAX$ + GT_Ascpos(, ) --> nAscVal + $ARGUMENTS$ + - The string + - The position in + $RETURNS$ + - The ascii value of substr(, , 1) + $DESCRIPTION$ + Return the ascii value of a specified character in a string + Equivalent (but much faster) to + asc(substr(cStr, nPos, 1) + + NOTE: + invalid parameters will return -1 + nPos > len(cStr) will return -2 + + This last behaviour is different to the Funcky function of the + same name. I changed the behaviour because some of the strings + I process contain embedded NULs. + $EXAMPLES$ + ? gt_ascpos("the cat sat on the mat", 3) // prints e + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + + $PLATFORMS$ + + $FILES$ + Library is libgt + $END$ */ -/* - * $DOC$ - * $FUNCNAME$ - * GT_ASCPOS() - * $CATEGORY$ - * String Tools - * $ONELINER$ - * Return the ascii value of a specified character in a string - * $SYNTAX$ - * GT_Ascpos(, ) --> nAscVal - * $ARGUMENTS$ - * - The string - * - The position in - * $RETURNS$ - * - The ascii value of substr(, , 1) - * $DESCRIPTION$ - * Return the ascii value of a specified character in a string - * Equivalent (but much faster) to - * asc(substr(cStr, nPos, 1) - * - * NOTE: - * invalid parameters will return -1 - * nPos > len(cStr) will return -2 - * - * This last behaviour is different to the Funcky function of the - * same name. I changed the behaviour because some of the strings - * I process contain embedded NULs. - * $EXAMPLES$ - * ? gt_ascpos("the cat sat on the mat", 3) // prints e - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * $PLATFORMS$ - * $FILES$ - * Library is libgt - * $END$ +/* $DOC$ + $FUNCNAME$ + GT_ASCIISUM() + $CATEGORY$ + String Tools + $ONELINER$ + Sum the ascii values in a string. + $SYNTAX$ + GT_AsciiSum() --> nSum + $ARGUMENTS$ + - The string to sum + $RETURNS$ + - The sum of all ascii values in . + $DESCRIPTION$ + Sum the ascii value of every character in the passed string + and return the result. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + + $PLATFORMS$ + + $FILES$ + Library is libgt + $END$ */ -/* - * $DOC$ - * $FUNCNAME$ - * GT_ASCIISUM() - * $CATEGORY$ - * String Tools - * $ONELINER$ - * Sum the ascii values in a string. - * $SYNTAX$ - * GT_AsciiSum() --> nSum - * $ARGUMENTS$ - * - The string to sum - * $RETURNS$ - * - The sum of all ascii values in . - * $DESCRIPTION$ - * Sum the ascii value of every character in the passed string - * and return the result. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * $PLATFORMS$ - * $FILES$ - * Library is libgt - * $END$ +/* $DOC$ + $FUNCNAME$ + GT_ATDIFF() + $CATEGORY$ + String Tools + $ONELINER$ + Return the position where two strings begin to differ + $SYNTAX$ + GT_AtDiff(, ) --> nPos + $ARGUMENTS$ + - A character string to compare + - The string to compare with + $RETURNS$ + - The position in where begins to differ + $DESCRIPTION$ + Return the position in where begins to differ. + If the strings differ in the first character GT_AtDiff() will + return 1. If the two strings are identical (or identical upto + the last character in ) the function will return 0. + + NOTE: + invalid parameters will return -1 + $EXAMPLES$ + ? gt_atDiff("the cat", "the rat") // prints 5 + ? gt_atDiff("the cat", "the ") // prints 0 + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + + $PLATFORMS$ + + $FILES$ + Library is libgt + $END$ */ -/* - * $DOC$ - * $FUNCNAME$ - * GT_ATDIFF() - * $CATEGORY$ - * String Tools - * $ONELINER$ - * Return the position where two strings begin to differ - * $SYNTAX$ - * GT_AtDiff(, ) --> nPos - * $ARGUMENTS$ - * - A character string to compare - * - The string to compare with - * $RETURNS$ - * - The position in where begins to differ - * $DESCRIPTION$ - * Return the position in where begins to differ. - * If the strings differ in the first character GT_AtDiff() will - * return 1. If the two strings are identical (or identical upto - * the last character in ) the function will return 0. - * - * NOTE: - * invalid parameters will return -1 - * $EXAMPLES$ - * ? gt_atDiff("the cat", "the rat") // prints 5 - * ? gt_atDiff("the cat", "the ") // prints 0 - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * $PLATFORMS$ - * $FILES$ - * Library is libgt - * $END$ +/* $DOC$ + $FUNCNAME$ + GT_CHAREVEN() + $CATEGORY$ + String Tools + $ONELINER$ + Return a string of all the characters in even positions + $SYNTAX$ + GT_CharEven() --> cRet + $ARGUMENTS$ + - A character string to extract chars from + $RETURNS$ + - A string of all the chars in even positions + $DESCRIPTION$ + Return a string consisting of all the characters in even + positions in . + + NOTE: + invalid parameters will return "" + $EXAMPLES$ + ? gt_CharEven("abcdefghijklm") // prints "bdfhjl" + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + + $PLATFORMS$ + + $FILES$ + Library is libgt + $END$ */ -/* - * $DOC$ - * $FUNCNAME$ - * GT_CHAREVEN() - * $CATEGORY$ - * String Tools - * $ONELINER$ - * Return a string of all the characters in even positions - * $SYNTAX$ - * GT_CharEven() --> cRet - * $ARGUMENTS$ - * - A character string to extract chars from - * $RETURNS$ - * - A string of all the chars in even positions - * $DESCRIPTION$ - * Return a string consisting of all the characters in even - * positions in . - * - * NOTE: - * invalid parameters will return "" - * $EXAMPLES$ - * ? gt_CharEven("abcdefghijklm") // prints "bdfhjl" - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * $PLATFORMS$ - * $FILES$ - * Library is libgt - * $END$ +/* $DOC$ + $FUNCNAME$ + GT_CHARMIX() + $CATEGORY$ + String Tools + $ONELINER$ + Amalgamate two strings to form the return value + $SYNTAX$ + GT_CharMix(, ) --> cRet + $ARGUMENTS$ + - A character string to mix + - A character string to mix with + $RETURNS$ + - A string consisting of all the characters in + mixed with all the characters in + $DESCRIPTION$ + Return a string consisting of all the characters in + mixed with the characters from . + + NOTE: + invalid parameters will return "" + $EXAMPLES$ + ? gt_CharMix("abc", "123") // prints "a1b2c3" + ? gt_CharMix("abcde", "123") // prints "a1b2c3de" + ? gt_CharMix("abc", "12345") // prints "a1b2c345" + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + + $PLATFORMS$ + + $FILES$ + Library is libgt + $END$ */ -/* - * $DOC$ - * $FUNCNAME$ - * GT_CHARMIX() - * $CATEGORY$ - * String Tools - * $ONELINER$ - * Amalgamate two strings to form the return value - * $SYNTAX$ - * GT_CharMix(, ) --> cRet - * $ARGUMENTS$ - * - A character string to mix - * - A character string to mix with - * $RETURNS$ - * - A string consisting of all the characters in - * mixed with all the characters in - * $DESCRIPTION$ - * Return a string consisting of all the characters in - * mixed with the characters from . - * - * NOTE: - * invalid parameters will return "" - * $EXAMPLES$ - * ? gt_CharMix("abc", "123") // prints "a1b2c3" - * ? gt_CharMix("abcde", "123") // prints "a1b2c3de" - * ? gt_CharMix("abc", "12345") // prints "a1b2c345" - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * $PLATFORMS$ - * $FILES$ - * Library is libgt - * $END$ +/* $DOC$ + $FUNCNAME$ + GT_CHARODD() + $CATEGORY$ + String Tools + $ONELINER$ + Return a string of all the characters in odd positions + $SYNTAX$ + GT_CharOdd() --> cRet + $ARGUMENTS$ + - A character string to extract chars from + $RETURNS$ + - A string of all the chars in odd positions + $DESCRIPTION$ + Return a string consisting of all the characters in odd + positions in . + + NOTE: + invalid parameters will return "" + $EXAMPLES$ + ? gt_CharOdd("abcdefghijklm") // prints "acegikm" + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + + $PLATFORMS$ + + $FILES$ + Library is libgt + $END$ */ -/* - * $DOC$ - * $FUNCNAME$ - * GT_CHARODD() - * $CATEGORY$ - * String Tools - * $ONELINER$ - * Return a string of all the characters in odd positions - * $SYNTAX$ - * GT_CharOdd() --> cRet - * $ARGUMENTS$ - * - A character string to extract chars from - * $RETURNS$ - * - A string of all the chars in odd positions - * $DESCRIPTION$ - * Return a string consisting of all the characters in odd - * positions in . - * - * NOTE: - * invalid parameters will return "" - * $EXAMPLES$ - * ? gt_CharOdd("abcdefghijklm") // prints "acegikm" - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * $PLATFORMS$ - * $FILES$ - * Library is libgt - * $END$ +/* $DOC$ + $FUNCNAME$ + GT_CHRCOUNT() + $CATEGORY$ + String Tools + $ONELINER$ + Count the number of times a character appears in a string + $SYNTAX$ + GT_ChrCount(, ) --> nFreq + $ARGUMENTS$ + - The character to find the frequence of + - The string in which to find the character + $RETURNS$ + nFreq - The number of times occurs in + $DESCRIPTION$ + GT_ChrCount() counts how many times a specified character + appears in a string. + + NOTE: + invalid parameters will return -1 + $EXAMPLES$ + ? GT_ChrCount("t", "the cat sat on the mat") // prints 4 + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + + $PLATFORMS$ + + $FILES$ + Library is libgt + $END$ */ -/* - * $DOC$ - * $FUNCNAME$ - * GT_CHRCOUNT() - * $CATEGORY$ - * String Tools - * $ONELINER$ - * Count the number of times a character appears in a string - * $SYNTAX$ - * GT_ChrCount(, ) --> nFreq - * $ARGUMENTS$ - * - The character to find the frequence of - * - The string in which to find the character - * $RETURNS$ - * nFreq - The number of times occurs in - * $DESCRIPTION$ - * GT_ChrCount() counts how many times a specified character - * appears in a string. - * - * NOTE: - * invalid parameters will return -1 - * $EXAMPLES$ - * ? GT_ChrCount("t", "the cat sat on the mat") // prints 4 - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * $PLATFORMS$ - * $FILES$ - * Library is libgt - * $END$ +/* $DOC$ + $FUNCNAME$ + GT_CHRFIRST() + $CATEGORY$ + String Tools + $ONELINER$ + Find which character occurs first in a string + $SYNTAX$ + GT_ChrFirst(, ) --> nAsc + $ARGUMENTS$ + - The set of characters to find + - The input string + $RETURNS$ + - The ASCII value of the first character in + which appears first in + $DESCRIPTION$ + Return the ascii value of a character in + which appears first in . + $EXAMPLES$ + ? chr(GT_ChrFirst("sa ", "This is a test")) // prints "s" + ? chr(GT_ChrFirst("et", "This is a test")) // prints "t" + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + + $PLATFORMS$ + + $FILES$ + Library is libgt + $END$ */ -/* - * $DOC$ - * $FUNCNAME$ - * GT_CHRFIRST() - * $CATEGORY$ - * String Tools - * $ONELINER$ - * Find which character occurs first in a string - * $SYNTAX$ - * GT_ChrFirst(, ) --> nAsc - * $ARGUMENTS$ - * - The set of characters to find - * - The input string - * $RETURNS$ - * - The ASCII value of the first character in - * which appears first in - * $DESCRIPTION$ - * Return the ascii value of a character in - * which appears first in . - * $EXAMPLES$ - * ? chr(GT_ChrFirst("sa ", "This is a test")) // prints "s" - * ? chr(GT_ChrFirst("et", "This is a test")) // prints "t" - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * $PLATFORMS$ - * $FILES$ - * Library is libgt - * $END$ +/* $DOC$ + $FUNCNAME$ + GT_CHRTOTAL() + $CATEGORY$ + String Tools + $ONELINER$ + Find number of times a set of characters appears in a string + $SYNTAX$ + GT_ChrTotal(, ) --> nTotOcc + $ARGUMENTS$ + - The set of characters + - The string to search + $RETURNS$ + - The number of times the characters specified in + appears in + $DESCRIPTION$ + Returns the numnber of occurrences of characters belonging + to the set in the string . If no characters + in appears in GT_ChrTotal() will return 0. + + NOTE: + invalid parameters will return -1 + $EXAMPLES$ + local cStr1 := "the cat sat on the mat" + + ? GT_ChrTotal("tae", cStr1) // prints 10 + ? GT_ChrTotal("zqw", cStr1) // prints 0 + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + + $PLATFORMS$ + + $FILES$ + Library is libgt + $END$ */ -/* - * $DOC$ - * $FUNCNAME$ - * GT_CHRTOTAL() - * $CATEGORY$ - * String Tools - * $ONELINER$ - * Find number of times a set of characters appears in a string - * $SYNTAX$ - * GT_ChrTotal(, ) --> nTotOcc - * $ARGUMENTS$ - * - The set of characters - * - The string to search - * $RETURNS$ - * - The number of times the characters specified in - * appears in - * $DESCRIPTION$ - * Returns the numnber of occurrences of characters belonging - * to the set in the string . If no characters - * in appears in GT_ChrTotal() will return 0. - * - * NOTE: - * invalid parameters will return -1 - * $EXAMPLES$ - * local cStr1 := "the cat sat on the mat" - * - * ? GT_ChrTotal("tae", cStr1) // prints 10 - * ? GT_ChrTotal("zqw", cStr1) // prints 0 - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * $PLATFORMS$ - * $FILES$ - * Library is libgt - * $END$ +/* $DOC$ + $FUNCNAME$ + GT_STRCOUNT() + $CATEGORY$ + String Tools + $ONELINER$ + Count the number of times a substring appears in a string + $SYNTAX$ + GT_StrCount(, ) --> nFreq + $ARGUMENTS$ + - The substring to find the frequence of + - The string in which to find the character + $RETURNS$ + - The number of times occurs in + $DESCRIPTION$ + GT_StrCount() counts how many times a specified substring + appears in a string. + If the substring does NOT appear in this function + will return 0. + If the substring is a single character use GT_ChrCount() as + it will be faster. + + NOTE: + invalid parameters will return -1 + $EXAMPLES$ + ? GT_StrCount("the", "the cat sat on the mat") // prints 2 + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + + $PLATFORMS$ + + $FILES$ + Library is libgt + $END$ */ -/* - * $DOC$ - * $FUNCNAME$ - * GT_STRCOUNT() - * $CATEGORY$ - * String Tools - * $ONELINER$ - * Count the number of times a substring appears in a string - * $SYNTAX$ - * GT_StrCount(, ) --> nFreq - * $ARGUMENTS$ - * - The substring to find the frequence of - * - The string in which to find the character - * $RETURNS$ - * - The number of times occurs in - * $DESCRIPTION$ - * GT_StrCount() counts how many times a specified substring - * appears in a string. - * If the substring does NOT appear in this function - * will return 0. - * If the substring is a single character use GT_ChrCount() as - * it will be faster. - * - * NOTE: - * invalid parameters will return -1 - * $EXAMPLES$ - * ? GT_StrCount("the", "the cat sat on the mat") // prints 2 - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * $PLATFORMS$ - * $FILES$ - * Library is libgt - * $END$ +/* $DOC$ + $FUNCNAME$ + GT_STRCSPN() + $CATEGORY$ + String Tools + $ONELINER$ + Return length of prefix in string of chars NOT in set. + $SYNTAX$ + GT_strcspn(, ) --> nLength + $ARGUMENTS$ + - The string to find the prefix in + - The set of characters + $RETURNS$ + - The length of a string upto a character in the set + $DESCRIPTION$ + Return the number of characters in the leading segment of a + string that consists solely of characters NOT in the set. + $EXAMPLES$ + ? GT_strcspn("this is a test", "as ") // prints 3 + ? GT_strcspn("this is a test", "elnjpq") // prints 11 + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + + $PLATFORMS$ + + $FILES$ + Library is libgt + $END$ */ -/* - * $DOC$ - * $FUNCNAME$ - * GT_STRCSPN() - * $CATEGORY$ - * String Tools - * $ONELINER$ - * Return length of prefix in string of chars NOT in set. - * $SYNTAX$ - * GT_strcspn(, ) --> nLength - * $ARGUMENTS$ - * - The string to find the prefix in - * - The set of characters - * $RETURNS$ - * - The length of a string upto a character in the set - * $DESCRIPTION$ - * Return the number of characters in the leading segment of a - * string that consists solely of characters NOT in the set. - * $EXAMPLES$ - * ? GT_strcspn("this is a test", "as ") // prints 3 - * ? GT_strcspn("this is a test", "elnjpq") // prints 11 - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * $PLATFORMS$ - * $FILES$ - * Library is libgt - * $END$ +/* $DOC$ + $FUNCNAME$ + GT_STRDIFF() + $CATEGORY$ + String Tools + $ONELINER$ + Return a string where it begins to differ from another + $SYNTAX$ + GT_StrDiff(, ) --> cRet + $ARGUMENTS$ + - A character string to compare + - The string to compare with + $RETURNS$ + - A string beginning at the position in where + begins to differ from + $DESCRIPTION$ + Return a string beginning at the position in where + begins to differ from . If the two strings are + identical (or identical upto the last character in ) + the function will return "". + + NOTE: + invalid parameters will return "" + $EXAMPLES$ + ? gt_strDiff("the cat", "the rat") // prints "rat" + ? gt_strDiff("the cat", "the ") // prints "" + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + + $PLATFORMS$ + + $FILES$ + Library is libgt + $END$ */ -/* - * $DOC$ - * $FUNCNAME$ - * GT_STRDIFF() - * $CATEGORY$ - * String Tools - * $ONELINER$ - * Return a string where it begins to differ from another - * $SYNTAX$ - * GT_StrDiff(, ) --> cRet - * $ARGUMENTS$ - * - A character string to compare - * - The string to compare with - * $RETURNS$ - * - A string beginning at the position in where - * begins to differ from - * $DESCRIPTION$ - * Return a string beginning at the position in where - * begins to differ from . If the two strings are - * identical (or identical upto the last character in ) - * the function will return "". - * - * NOTE: - * invalid parameters will return "" - * $EXAMPLES$ - * ? gt_strDiff("the cat", "the rat") // prints "rat" - * ? gt_strDiff("the cat", "the ") // prints "" - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * $PLATFORMS$ - * $FILES$ - * Library is libgt - * $END$ +/* $DOC$ + $FUNCNAME$ + GT_STREXPAND() + $CATEGORY$ + String Tools + $ONELINER$ + Insert fillers between characters in a passed string + $SYNTAX$ + GT_StrExpand(, [], []) --> cRet + $ARGUMENTS$ + - A character string to insert chars into + - The number of fill characters to insert (default 1) + - The fill chararacter (default space) + $RETURNS$ + - The input string with fill characters inserted between + every character in the original. + $DESCRIPTION$ + Inserts fill characters into a string. + + NOTE: + invalid parameters will return "" + $EXAMPLES$ + ? gt_strexpand("abc") // prints "a b c" + ? gt_strexpand("abc", 2) // prints "a b c" + ? gt_strexpand("abc", 2, '|') // prints "a||b||c" + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + + $PLATFORMS$ + + $FILES$ + Library is libgt + $END$ */ -/* - * $DOC$ - * $FUNCNAME$ - * GT_STREXPAND() - * $CATEGORY$ - * String Tools - * $ONELINER$ - * Insert fillers between characters in a passed string - * $SYNTAX$ - * GT_StrExpand(, [], []) --> cRet - * $ARGUMENTS$ - * - A character string to insert chars into - * - The number of fill characters to insert (default 1) - * - The fill chararacter (default space) - * $RETURNS$ - * - The input string with fill characters inserted between - * every character in the original. - * $DESCRIPTION$ - * Inserts fill characters into a string. - * - * NOTE: - * invalid parameters will return "" - * $EXAMPLES$ - * ? gt_strexpand("abc") // prints "a b c" - * ? gt_strexpand("abc", 2) // prints "a b c" - * ? gt_strexpand("abc", 2, '|') // prints "a||b||c" - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * $PLATFORMS$ - * $FILES$ - * Library is libgt - * $END$ +/* $DOC$ + $FUNCNAME$ + GT_STRLEFT() + $CATEGORY$ + String Tools + $ONELINER$ + Find length of prefix of a string + $SYNTAX$ + GT_StrLeft(, ) --> nLen + $ARGUMENTS$ + - The input string + - The set of characters to find + $RETURNS$ + nLen - The length of the prefix found. + $DESCRIPTION$ + Return the length of the leading segment in the passed string + that consists solely of the characters in the character + set . + + If no characters in the the search set are found, the function + shall return 0 + $EXAMPLES$ + ? GT_StrLeft("this is a test", "hsit ") // prints 8 + ? GT_StrLeft("this is a test", "hit a") // prints 3 + ? GT_StrLeft("this is a test", "zxy") // prints 0 + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + + $PLATFORMS$ + + $FILES$ + Library is libgt + $END$ */ -/* - * $DOC$ - * $FUNCNAME$ - * GT_STRLEFT() - * $CATEGORY$ - * String Tools - * $ONELINER$ - * Find length of prefix of a string - * $SYNTAX$ - * GT_StrLeft(, ) --> nLen - * $ARGUMENTS$ - * - The input string - * - The set of characters to find - * $RETURNS$ - * nLen - The length of the prefix found. - * $DESCRIPTION$ - * Return the length of the leading segment in the passed string - * that consists solely of the characters in the character - * set . - * - * If no characters in the the search set are found, the function - * shall return 0 - * $EXAMPLES$ - * ? GT_StrLeft("this is a test", "hsit ") // prints 8 - * ? GT_StrLeft("this is a test", "hit a") // prints 3 - * ? GT_StrLeft("this is a test", "zxy") // prints 0 - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * $PLATFORMS$ - * $FILES$ - * Library is libgt - * $END$ +/* $DOC$ + $FUNCNAME$ + GT_STRPBRK() + $CATEGORY$ + String Tools + $ONELINER$ + Return string after 1st char from a set + $SYNTAX$ + GT_StrpBrk(, ) --> cString + $ARGUMENTS$ + - The input string + - The set of characters to find + $RETURNS$ + - The input string after the first occurance of any + character from + $DESCRIPTION$ + Return a string after the first occurance of any character from + the input set . + $EXAMPLES$ + ? GT_Strpbrk("This is a test", "sa ") // prints "s is a test" + ? GT_Strpbrk("This is a test", "et") // prints "test" + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + + $PLATFORMS$ + + $FILES$ + Library is libgt + $END$ */ -/* - * $DOC$ - * $FUNCNAME$ - * GT_STRPBRK() - * $CATEGORY$ - * String Tools - * $ONELINER$ - * Return string after 1st char from a set - * $SYNTAX$ - * GT_StrpBrk(, ) --> cString - * $ARGUMENTS$ - * - The input string - * - The set of characters to find - * $RETURNS$ - * - The input string after the first occurance of any - * character from - * $DESCRIPTION$ - * Return a string after the first occurance of any character from - * the input set . - * $EXAMPLES$ - * ? GT_Strpbrk("This is a test", "sa ") // prints "s is a test" - * ? GT_Strpbrk("This is a test", "et") // prints "test" - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * $PLATFORMS$ - * $FILES$ - * Library is libgt - * $END$ +/* $DOC$ + $FUNCNAME$ + GT_STRRIGHT() + $CATEGORY$ + String Tools + $ONELINER$ + Find length of a suffix of a string + $SYNTAX$ + GT_StrRight(, ) --> nLen + $ARGUMENTS$ + - The input string + - The set of characters to find + $RETURNS$ + - The length of the prefix found. + $DESCRIPTION$ + Return the length of the trailing segment in the passed string + that consists solely of the characters in the character + set . + + If no characters in the the search set are found, the function + shall return 0 + $EXAMPLES$ + ? GT_StrRight("this is a test", "teas ") // prints 8 + ? GT_StrRight("this is a test", "tes h") // prints 5 + ? GT_StrRight("this is a test", "zxy") // prints 0 + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + + $PLATFORMS$ + + $FILES$ + Library is libgt + $END$ */ -/* - * $DOC$ - * $FUNCNAME$ - * GT_STRRIGHT() - * $CATEGORY$ - * String Tools - * $ONELINER$ - * Find length of a suffix of a string - * $SYNTAX$ - * GT_StrRight(, ) --> nLen - * $ARGUMENTS$ - * - The input string - * - The set of characters to find - * $RETURNS$ - * - The length of the prefix found. - * $DESCRIPTION$ - * Return the length of the trailing segment in the passed string - * that consists solely of the characters in the character - * set . - * - * If no characters in the the search set are found, the function - * shall return 0 - * $EXAMPLES$ - * ? GT_StrRight("this is a test", "teas ") // prints 8 - * ? GT_StrRight("this is a test", "tes h") // prints 5 - * ? GT_StrRight("this is a test", "zxy") // prints 0 - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * $PLATFORMS$ - * $FILES$ - * Library is libgt - * $END$ +/* $DOC$ + $FUNCNAME$ + GT_NEWFLAG() + $CATEGORY$ + General + $ONELINER$ + Create a new bit flag string. + $SYNTAX$ + GT_NewFlag() --> cFlagString + $ARGUMENTS$ + is the number of flags you wish to store. + $RETURNS$ + A string to hold the bit flags. All flags are set to FALSE. + $DESCRIPTION$ + GT_NewFlag() is used to construct a bit flag string. The bit flag + functions can be used for storing a large number of logical values + in a small space. + + To create a bit flag string you need to pass GT_NewFlag() a value + that is equal to or greater than the number of flags required (you + may want to allow for future expansion). Each character in the + string returned from GT_NewFlag() will hold 8 logical values. + $EXAMPLES$ + cFlags := GT_NewFlag(20) // Create a bit flag string for 20 + // logical values. + $SEEALSO$ + GT_SETFLAG() GT_CLRFLAG() GT_ISFLAG() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * GT_NEWFLAG() - * $CATEGORY$ - * General - * $ONELINER$ - * Create a new bit flag string. - * $SYNTAX$ - * GT_NewFlag() --> cFlagString - * $ARGUMENTS$ - * is the number of flags you wish to store. - * $RETURNS$ - * A string to hold the bit flags. All flags are set to FALSE. - * $DESCRIPTION$ - * GT_NewFlag() is used to construct a bit flag string. The bit flag - * functions can be used for storing a large number of logical values - * in a small space. - * - * To create a bit flag string you need to pass GT_NewFlag() a value - * that is equal to or greater than the number of flags required (you - * may want to allow for future expansion). Each character in the - * string returned from GT_NewFlag() will hold 8 logical values. - * $EXAMPLES$ - * cFlags := GT_NewFlag(20) // Create a bit flag string for 20 - * // logical values. - * $SEEALSO$ - * GT_SETFLAG() GT_CLRFLAG() GT_ISFLAG() - * $END$ +/* $DOC$ + $FUNCNAME$ + GT_SETFLAG() + $CATEGORY$ + General + $ONELINER$ + Set a number of flags to TRUE in a bit flag string. + $SYNTAX$ + GT_SetFlag(,[],[]) --> cFlagString + $ARGUMENTS$ + is a bit flag string created with GT_NewFlag() + + is the starting flag. This is an optional numeric value. + If not supplied it defaults to 1. + + is the ending flag. This is an optional numeric value. If + not supplied it defaults to . + $RETURNS$ + The bit map string with the new flag settings. + $DESCRIPTION$ + GT_SetFlag() is used to turn flags within the flag string on. + $EXAMPLES$ + cFlags := GT_NewFlag(20) // Create a bit flag string for 20 + // logical values. + + // Now set flags 10 to 15 to true. + + cFlags := GT_SetFlag(cFlags,10,15) + + // And set flag 18 to true. + + cFlags := GT_SetFlag(cFlags,18) + + // And set flag 1 to true. + + cFlags := GT_SetFlag(cFlags) + $SEEALSO$ + GT_NEWFLAG() GT_CLRFLAG() GT_ISFLAG() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * GT_SETFLAG() - * $CATEGORY$ - * General - * $ONELINER$ - * Set a number of flags to TRUE in a bit flag string. - * $SYNTAX$ - * GT_SetFlag(,[],[]) --> cFlagString - * $ARGUMENTS$ - * is a bit flag string created with GT_NewFlag() - * - * is the starting flag. This is an optional numeric value. - * If not supplied it defaults to 1. - * - * is the ending flag. This is an optional numeric value. If - * not supplied it defaults to . - * $RETURNS$ - * The bit map string with the new flag settings. - * $DESCRIPTION$ - * GT_SetFlag() is used to turn flags within the flag string on. - * $EXAMPLES$ - * cFlags := GT_NewFlag(20) // Create a bit flag string for 20 - * // logical values. - * - * // Now set flags 10 to 15 to true. - * - * cFlags := GT_SetFlag(cFlags,10,15) - * - * // And set flag 18 to true. - * - * cFlags := GT_SetFlag(cFlags,18) - * - * // And set flag 1 to true. - * - * cFlags := GT_SetFlag(cFlags) - * $SEEALSO$ - * GT_NEWFLAG() GT_CLRFLAG() GT_ISFLAG() - * $END$ +/* $DOC$ + $FUNCNAME$ + GT_CLRFLAG() + $CATEGORY$ + General + $ONELINER$ + Set a number of flags to FALSE in a bit flag string. + $SYNTAX$ + GT_ClrFlag(,[],[]) --> cFlagString + $ARGUMENTS$ + is a bit flag string created with GT_NewFlag() + + is the starting flag. This is an optional numeric value. + If not supplied it defaults to 1. + + is the ending flag. This is an optional numeric value. If + not supplied it defaults to . + $RETURNS$ + The bit map string with the new flag settings. + $DESCRIPTION$ + GT_ClrFlag() is used to turn flags within the flag string off. + $EXAMPLES$ + cFlags := GT_NewFlag(20) // Create a bit flag string for 20 + // logical values. + + // Now, turn them all on. + + cFlags := GT_SetFlag(cFlags,1,20) + + // Now set flags 10 to 15 to false. + + cFlags := GT_ClrFlag(cFlags,10,15) + + // And set flag 18 to false. + + cFlags := GT_ClrFlag(cFlags,18) + + // And set flag 1 to false. + + cFlags := GT_ClrFlag(cFlags) + $SEEALSO$ + GT_NEWFLAG() GT_SETFLAG() GT_ISFLAG() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * GT_CLRFLAG() - * $CATEGORY$ - * General - * $ONELINER$ - * Set a number of flags to FALSE in a bit flag string. - * $SYNTAX$ - * GT_ClrFlag(,[],[]) --> cFlagString - * $ARGUMENTS$ - * is a bit flag string created with GT_NewFlag() - * - * is the starting flag. This is an optional numeric value. - * If not supplied it defaults to 1. - * - * is the ending flag. This is an optional numeric value. If - * not supplied it defaults to . - * $RETURNS$ - * The bit map string with the new flag settings. - * $DESCRIPTION$ - * GT_ClrFlag() is used to turn flags within the flag string off. - * $EXAMPLES$ - * cFlags := GT_NewFlag(20) // Create a bit flag string for 20 - * // logical values. - * - * // Now, turn them all on. - * - * cFlags := GT_SetFlag(cFlags,1,20) - * - * // Now set flags 10 to 15 to false. - * - * cFlags := GT_ClrFlag(cFlags,10,15) - * - * // And set flag 18 to false. - * - * cFlags := GT_ClrFlag(cFlags,18) - * - * // And set flag 1 to false. - * - * cFlags := GT_ClrFlag(cFlags) - * $SEEALSO$ - * GT_NEWFLAG() GT_SETFLAG() GT_ISFLAG() - * $END$ - */ - -/* $DOC$ - * $FUNCNAME$ - * GT_ISFLAG() - * $CATEGORY$ - * General - * $ONELINER$ - * Test the setting of a flag in a bit flag string. - * $SYNTAX$ - * GT_IsFlag(,[]) --> lSetting - * $ARGUMENTS$ - * is a bit flag string created with GT_NewFlag() - * - * is the flag to be tested. - * $RETURNS$ - * A boolean value, TRUE if the flag is on, FALSE if it's off. - * $DESCRIPTION$ - * GT_IsFlag() is used to test the state of a flag with a bit flag - * string. - * $EXAMPLES$ - * - * // Print the setting of the flags in a flag string called ``cDave'' - * - * for nFlag := 1 to (len(cDave)*8) - * ? "Flag number ",nFlag," == ",GT_IsFlag(cDave,nFlag) - * next - * $SEEALSO$ - * GT_NEWFLAG() GT_SETFLAG() GT_CLRFLAG() - * $END$ +/* $DOC$ + $FUNCNAME$ + GT_ISFLAG() + $CATEGORY$ + General + $ONELINER$ + Test the setting of a flag in a bit flag string. + $SYNTAX$ + GT_IsFlag(,[]) --> lSetting + $ARGUMENTS$ + is a bit flag string created with GT_NewFlag() + + is the flag to be tested. + $RETURNS$ + A boolean value, TRUE if the flag is on, FALSE if it's off. + $DESCRIPTION$ + GT_IsFlag() is used to test the state of a flag with a bit flag + string. + $EXAMPLES$ + // Print the setting of the flags in a flag string called ``cDave'' + + for nFlag := 1 to (len(cDave)*8) + ? "Flag number ",nFlag," == ",GT_IsFlag(cDave,nFlag) + next + $SEEALSO$ + GT_NEWFLAG() GT_SETFLAG() GT_CLRFLAG() + $END$ */ diff --git a/harbour/contrib/hbmisc/doc/en/dates2.txt b/harbour/contrib/hbmisc/doc/en/dates2.txt index 56177d0ace..867aa718dd 100644 --- a/harbour/contrib/hbmisc/doc/en/dates2.txt +++ b/harbour/contrib/hbmisc/doc/en/dates2.txt @@ -2,336 +2,324 @@ * $Id$ */ -/* - * The following parts are Copyright of the individual authors. - * www - http://www.harbour-project.org - * - * Copyright 2000 Jose Lalin - * Documentation for: AMONTHS, ADAYS, ISLEAPYEAR, DAYSINMONTH, EOM, BOM, - * WOM, DOY, WOY, EOY, BOY - * - * See COPYING for licensing terms. - * +/* $DOC$ + $FUNCNAME$ + AMONTHS() + $CATEGORY$ + Date + $ONELINER$ + Returns an array with the months names. + $SYNTAX$ + AMONTHS() --> aMonths + $ARGUMENTS$ + None + $RETURNS$ + The array which holds the months names. + $DESCRIPTION$ + This function returns an array with all the months names in the + selected current language. + $EXAMPLES$ + aMonths := AMonths() + ? aMonths[ 1 ] // -> January + ? aMonths[ 1 ] // -> Enero (if the selected language is Spanish) + $STATUS$ + R + $COMPLIANCE$ + This function is new in Harbour. + $PLATFORMS$ + All + $FILES$ + Library is libmisc + $SEEALSO$ + ADAYS() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * AMONTHS() - * $CATEGORY$ - * Date - * $ONELINER$ - * Returns an array with the months names. - * $SYNTAX$ - * AMONTHS() --> aMonths - * $ARGUMENTS$ - * None - * $RETURNS$ - * The array which holds the months names. - * $DESCRIPTION$ - * This function returns an array with all the months names in the - * selected current language. - * $EXAMPLES$ - * aMonths := AMonths() - * ? aMonths[ 1 ] // -> January - * ? aMonths[ 1 ] // -> Enero (if the selected language is Spanish) - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is new in Harbour. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * ADAYS() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADAYS() + $CATEGORY$ + Date + $ONELINER$ + Returns an array with the days names. + $SYNTAX$ + ADAYS() --> aDays + $ARGUMENTS$ + None + $RETURNS$ + The array which holds the days names. + $DESCRIPTION$ + This function returns an array with all the days names in the + selected current language. + $EXAMPLES$ + aDays := ADays() + ? aDays[ 1 ] // -> Sunday + ? aDays[ 1 ] // -> Domingo (if the selected language is Spanish) + $STATUS$ + R + $COMPLIANCE$ + This function is new in Harbour. + $PLATFORMS$ + All + $FILES$ + Library is libmisc + $SEEALSO$ + ADAYS() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADAYS() - * $CATEGORY$ - * Date - * $ONELINER$ - * Returns an array with the days names. - * $SYNTAX$ - * ADAYS() --> aDays - * $ARGUMENTS$ - * None - * $RETURNS$ - * The array which holds the days names. - * $DESCRIPTION$ - * This function returns an array with all the days names in the - * selected current language. - * $EXAMPLES$ - * aDays := ADays() - * ? aDays[ 1 ] // -> Sunday - * ? aDays[ 1 ] // -> Domingo (if the selected language is Spanish) - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is new in Harbour. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * ADAYS() - * $END$ +/* $DOC$ + $FUNCNAME$ + ISLEAPYEAR() + $CATEGORY$ + Date + $ONELINER$ + Checks if the given date is a leap year. + $SYNTAX$ + ISLEAPYEAR( ) --> lTrueOrFalse + $ARGUMENTS$ + A valid date. + $RETURNS$ + A logical that indicates if the date year is leap + $DESCRIPTION$ + This function returns true if the given date is a leap year and + false if isn't. + $EXAMPLES$ + ? IsLeapYear( hb_SToD( "20000101" ) ) // -> .T. + ? IsLeapYear( hb_SToD( "20010101" ) ) // -> .F. + $STATUS$ + R + $COMPLIANCE$ + This function is new in Harbour. + $PLATFORMS$ + All + $FILES$ + Library is libmisc + $SEEALSO$ + DAYSINMONTH() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ISLEAPYEAR() - * $CATEGORY$ - * Date - * $ONELINER$ - * Checks if the given date is a leap year. - * $SYNTAX$ - * ISLEAPYEAR( ) --> lTrueOrFalse - * $ARGUMENTS$ - * A valid date. - * $RETURNS$ - * A logical that indicates if the date year is leap - * $DESCRIPTION$ - * This function returns true if the given date is a leap year and - * false if isn't. - * $EXAMPLES$ - * ? IsLeapYear( hb_SToD( "20000101" ) ) // -> .T. - * ? IsLeapYear( hb_SToD( "20010101" ) ) // -> .F. - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is new in Harbour. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * DAYSINMONTH() - * $END$ +/* $DOC$ + $FUNCNAME$ + DAYSINMONTH() + $CATEGORY$ + Date + $ONELINER$ + Gets the days in a month. + $SYNTAX$ + DAYSINMONTH( ) --> nDays + $ARGUMENTS$ + A valid date. + $RETURNS$ + The number of days of the month. + $DESCRIPTION$ + This function returns the number of days of the given date month. + $EXAMPLES$ + ? DaysInMonth( hb_SToD( "20000101" ) ) // -> 31 + ? DaysInMonth( hb_SToD( "20000201" ) ) // -> 29 + $STATUS$ + R + $COMPLIANCE$ + This function is new in Harbour. + $PLATFORMS$ + All + $FILES$ + Library is libmisc + $SEEALSO$ + IsLeapYear() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * DAYSINMONTH() - * $CATEGORY$ - * Date - * $ONELINER$ - * Gets the days in a month. - * $SYNTAX$ - * DAYSINMONTH( ) --> nDays - * $ARGUMENTS$ - * A valid date. - * $RETURNS$ - * The number of days of the month. - * $DESCRIPTION$ - * This function returns the number of days of the given date month. - * $EXAMPLES$ - * ? DaysInMonth( hb_SToD( "20000101" ) ) // -> 31 - * ? DaysInMonth( hb_SToD( "20000201" ) ) // -> 29 - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is new in Harbour. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * IsLeapYear() - * $END$ +/* $DOC$ + $FUNCNAME$ + EOM() + $CATEGORY$ + Date + $ONELINER$ + Gets the last day in a month. + $SYNTAX$ + EOM( ) --> dEOM + $ARGUMENTS$ + A valid date. + $RETURNS$ + The last day in the month. + $DESCRIPTION$ + This function returns the last day of a given month date. + $EXAMPLES$ + SET DATE ANSI + ? EOM( hb_SToD( "20000101" ) ) // -> "2000.01.31" + ? EOM( hb_SToD( "20000201" ) ) // -> "2000.02.29" + $STATUS$ + R + $COMPLIANCE$ + This function is new in Harbour. + $PLATFORMS$ + All + $FILES$ + Library is libmisc + $SEEALSO$ + BOM(),WOM() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * EOM() - * $CATEGORY$ - * Date - * $ONELINER$ - * Gets the last day in a month. - * $SYNTAX$ - * EOM( ) --> dEOM - * $ARGUMENTS$ - * A valid date. - * $RETURNS$ - * The last day in the month. - * $DESCRIPTION$ - * This function returns the last day of a given month date. - * $EXAMPLES$ - * SET DATE ANSI - * ? EOM( hb_SToD( "20000101" ) ) // -> "2000.01.31" - * ? EOM( hb_SToD( "20000201" ) ) // -> "2000.02.29" - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is new in Harbour. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * BOM(),WOM() - * $END$ +/* $DOC$ + $FUNCNAME$ + BOM() + $CATEGORY$ + Date + $ONELINER$ + Gets the first day in a month. + $SYNTAX$ + BOM( ) --> dBOM + $ARGUMENTS$ + A valid date. + $RETURNS$ + The first day in the month. + $DESCRIPTION$ + This function returns the first day of a given month date. + $EXAMPLES$ + SET DATE ANSI + ? BOM( hb_SToD( "20000125" ) ) // -> "2000.01.01" + ? BOM( hb_SToD( "20000224" ) ) // -> "2000.02.01" + $STATUS$ + R + $COMPLIANCE$ + This function is new in Harbour. + $PLATFORMS$ + All + $FILES$ + Library is libmisc + $SEEALSO$ + EOM(),WOM() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * BOM() - * $CATEGORY$ - * Date - * $ONELINER$ - * Gets the first day in a month. - * $SYNTAX$ - * BOM( ) --> dBOM - * $ARGUMENTS$ - * A valid date. - * $RETURNS$ - * The first day in the month. - * $DESCRIPTION$ - * This function returns the first day of a given month date. - * $EXAMPLES$ - * SET DATE ANSI - * ? BOM( hb_SToD( "20000125" ) ) // -> "2000.01.01" - * ? BOM( hb_SToD( "20000224" ) ) // -> "2000.02.01" - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is new in Harbour. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * EOM(),WOM() - * $END$ +/* $DOC$ + $FUNCNAME$ + DOY() + $CATEGORY$ + Date + $ONELINER$ + Gets the day number of the year. + $SYNTAX$ + DOY( ) --> nDay + $ARGUMENTS$ + A valid date. + $RETURNS$ + The day number + $DESCRIPTION$ + This function returns the day number of the year for a given date. + $EXAMPLES$ + ? DOY( hb_SToD( "20000131" ) ) // -> 31 + ? DOY( hb_SToD( "20000220" ) ) // -> 51 + $STATUS$ + R + $COMPLIANCE$ + This function is new in Harbour. + $PLATFORMS$ + All + $FILES$ + Library is libmisc + $SEEALSO$ + WOY() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * DOY() - * $CATEGORY$ - * Date - * $ONELINER$ - * Gets the day number of the year. - * $SYNTAX$ - * DOY( ) --> nDay - * $ARGUMENTS$ - * A valid date. - * $RETURNS$ - * The day number - * $DESCRIPTION$ - * This function returns the day number of the year for a given date. - * $EXAMPLES$ - * ? DOY( hb_SToD( "20000131" ) ) // -> 31 - * ? DOY( hb_SToD( "20000220" ) ) // -> 51 - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is new in Harbour. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * WOY() - * $END$ +/* $DOC$ + $FUNCNAME$ + WOY() + $CATEGORY$ + Date + $ONELINER$ + Gets the week number of the year. + $SYNTAX$ + WOY( , ) --> nWeek + $ARGUMENTS$ + A valid date. + $RETURNS$ + The week number + Flag that indicates if is in ISO format. + $DESCRIPTION$ + This function returns the week number of the year for a given date. + It returns the week number in ISO format ( range 0 - 52, by default + or passing TRUE as second parameter) or 1 - 52 if lIso is FALSE. + $EXAMPLES$ + ? WOY( hb_SToD( "20000131" ) ) // -> 3 + ? WOY( hb_SToD( "20000131" ), .F. ) // -> 4 + $STATUS$ + R + $COMPLIANCE$ + This function is new in Harbour. + $PLATFORMS$ + All + $FILES$ + Library is libmisc + $SEEALSO$ + DOY() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * WOY() - * $CATEGORY$ - * Date - * $ONELINER$ - * Gets the week number of the year. - * $SYNTAX$ - * WOY( , ) --> nWeek - * $ARGUMENTS$ - * A valid date. - * $RETURNS$ - * The week number - * Flag that indicates if is in ISO format. - * $DESCRIPTION$ - * This function returns the week number of the year for a given date. - * It returns the week number in ISO format ( range 0 - 52, by default - * or passing TRUE as second parameter) or 1 - 52 if lIso is FALSE. - * $EXAMPLES$ - * ? WOY( hb_SToD( "20000131" ) ) // -> 3 - * ? WOY( hb_SToD( "20000131" ), .F. ) // -> 4 - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is new in Harbour. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * DOY() - * $END$ +/* $DOC$ + $FUNCNAME$ + EOY() + $CATEGORY$ + Date + $ONELINER$ + Gets the last date of the year. + $SYNTAX$ + EOY( ) --> dEOY + $ARGUMENTS$ + A valid date. + $RETURNS$ + The last date of the year. + $DESCRIPTION$ + This function returns the last date of a given year date. + $EXAMPLES$ + SET DATE ANSI + ? EOY( hb_SToD( "20000101" ) ) // -> "2000.12.31" + ? EOY( hb_SToD( "20010101" ) ) // -> "2001.12.31" + $STATUS$ + R + $COMPLIANCE$ + This function is new in Harbour. + $PLATFORMS$ + All + $FILES$ + Library is libmisc + $SEEALSO$ + BOY() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * EOY() - * $CATEGORY$ - * Date - * $ONELINER$ - * Gets the last date of the year. - * $SYNTAX$ - * EOY( ) --> dEOY - * $ARGUMENTS$ - * A valid date. - * $RETURNS$ - * The last date of the year. - * $DESCRIPTION$ - * This function returns the last date of a given year date. - * $EXAMPLES$ - * SET DATE ANSI - * ? EOY( hb_SToD( "20000101" ) ) // -> "2000.12.31" - * ? EOY( hb_SToD( "20010101" ) ) // -> "2001.12.31" - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is new in Harbour. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * BOY() - * $END$ - */ - -/* $DOC$ - * $FUNCNAME$ - * BOY() - * $CATEGORY$ - * Date - * $ONELINER$ - * Gets the first date of the year. - * $SYNTAX$ - * BOY( ) --> dBOY - * $ARGUMENTS$ - * A valid date. - * $RETURNS$ - * The first day in the year. - * $DESCRIPTION$ - * This function returns the first date of a given year date. - * $EXAMPLES$ - * SET DATE ANSI - * ? BOY( hb_SToD( "20000125" ) ) // -> "2000.01.01" - * ? BOY( hb_SToD( "20010224" ) ) // -> "2001.01.01" - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is new in Harbour. - * $PLATFORMS$ - * All - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * EOY() - * $END$ +/* $DOC$ + $FUNCNAME$ + BOY() + $CATEGORY$ + Date + $ONELINER$ + Gets the first date of the year. + $SYNTAX$ + BOY( ) --> dBOY + $ARGUMENTS$ + A valid date. + $RETURNS$ + The first day in the year. + $DESCRIPTION$ + This function returns the first date of a given year date. + $EXAMPLES$ + SET DATE ANSI + ? BOY( hb_SToD( "20000125" ) ) // -> "2000.01.01" + ? BOY( hb_SToD( "20010224" ) ) // -> "2001.01.01" + $STATUS$ + R + $COMPLIANCE$ + This function is new in Harbour. + $PLATFORMS$ + All + $FILES$ + Library is libmisc + $SEEALSO$ + EOY() + $END$ */ diff --git a/harbour/contrib/hbmisc/doc/en/ht_class.txt b/harbour/contrib/hbmisc/doc/en/ht_class.txt index 75a24224c0..a46ca9ec55 100644 --- a/harbour/contrib/hbmisc/doc/en/ht_class.txt +++ b/harbour/contrib/hbmisc/doc/en/ht_class.txt @@ -2,93 +2,82 @@ * $Id$ */ -/* - * The following parts are Copyright of the individual authors. - * www - http://www.harbour-project.org - * - * Copyright 1999 David G. Holm - * Documentation - * - * See COPYING for licensing terms. - * - */ - -/* $DOC$ - * $FUNCNAME$ - * TFileRead() - * $CATEGORY$ - * Harbour Tools - * $ONELINER$ - * Read a file one line at a time - * $SYNTAX$ - * oFile := TFileRead():New( [, ] ) - * $ARGUMENTS$ - * is the required name of the file to be read. - * - * is the optional size to use when reading from the file. - * The default value is 4096 and the allowed range is 1 through 65535. - * Any value outside of this range causes the default value to be used. - * $RETURNS$ - * An instance of the File Reader class - * $DESCRIPTION$ - * TFileRead() is used to access a file one line at a time. You must - * specify the name of the file when an instance of the class is created. - * The class data should be considered private to the class. - * - * The class methods are as follows: - * - * New() Creates a new instance of the TFileRead class. - * - * Open([]) Opens the file for reading. The optional nFlags - * parameter can use any of the FOPEN() flags from - * fileio.ch. The default is FO_READ + FO_SHARED. - * Calling this method when the file is already - * open causes the next ReadLine() to start over - * from the beginning of the file. - - * Close() Closes the file. - * - * ReadLine() Returns one line from the file, stripping the - * newline characters. The following sequences are - * treated as one newline: 1) CR CR LF; 2) CR LF; - * 3) LF; and 4) CR. Note: LF CR is 2 newlines. - * Name() Returns the name of the file. - * - * IsOpen() Returns .T. if the file is open. - * - * MoreToRead() Returns .T. if there are more lines to be read - * (think of it as an inverse EOF function). - * - * Error() Returns .T. if an error has occurred. - * - * ErrorNo() Returns the current error code. - * - * ErrorMsg([]) Returns a formatted error message. - * $EXAMPLES$ - * PROCEDURE Main( cFile ) - * LOCAL oFile := TFileRead():New( cFile ) - * - * oFile:Open() - * IF oFile:Error() - * OutStd( oFile:ErrorMsg( "FileRead: " ) ) - * OutStd( hb_eol() ) - * ELSE - * DO WHILE oFile:MoreToRead() - * OutStd( oFile:ReadLine() ) - * OutStd( hb_eol() ) - * ENDDO - * oFile:Close() - * ENDIF - * RETURN - * $TESTS$ - * See Examples - * $STATUS$ - * R - * $COMPLIANCE$ - * This is a new Harbour Tools class - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * TClass() - * $END$ +/* $DOC$ + $FUNCNAME$ + TFileRead() + $CATEGORY$ + Harbour Tools + $ONELINER$ + Read a file one line at a time + $SYNTAX$ + oFile := TFileRead():New( [, ] ) + $ARGUMENTS$ + is the required name of the file to be read. + + is the optional size to use when reading from the file. + The default value is 4096 and the allowed range is 1 through 65535. + Any value outside of this range causes the default value to be used. + $RETURNS$ + An instance of the File Reader class + $DESCRIPTION$ + TFileRead() is used to access a file one line at a time. You must + specify the name of the file when an instance of the class is created. + The class data should be considered private to the class. + + The class methods are as follows: + + New() Creates a new instance of the TFileRead class. + + Open([]) Opens the file for reading. The optional nFlags + parameter can use any of the FOPEN() flags from + fileio.ch. The default is FO_READ + FO_SHARED. + Calling this method when the file is already + open causes the next ReadLine() to start over + from the beginning of the file. + + Close() Closes the file. + + ReadLine() Returns one line from the file, stripping the + newline characters. The following sequences are + treated as one newline: 1) CR CR LF; 2) CR LF; + 3) LF; and 4) CR. Note: LF CR is 2 newlines. + Name() Returns the name of the file. + + IsOpen() Returns .T. if the file is open. + + MoreToRead() Returns .T. if there are more lines to be read + (think of it as an inverse EOF function). + + Error() Returns .T. if an error has occurred. + + ErrorNo() Returns the current error code. + + ErrorMsg([]) Returns a formatted error message. + $EXAMPLES$ + PROCEDURE Main( cFile ) + LOCAL oFile := TFileRead():New( cFile ) + + oFile:Open() + IF oFile:Error() + OutStd( oFile:ErrorMsg( "FileRead: " ) ) + OutStd( hb_eol() ) + ELSE + DO WHILE oFile:MoreToRead() + OutStd( oFile:ReadLine() ) + OutStd( hb_eol() ) + ENDDO + oFile:Close() + ENDIF + RETURN + $TESTS$ + See Examples + $STATUS$ + R + $COMPLIANCE$ + This is a new Harbour Tools class + $FILES$ + Library is libmisc + $SEEALSO$ + TClass() + $END$ */ diff --git a/harbour/contrib/hbmisc/doc/en/ht_conv.txt b/harbour/contrib/hbmisc/doc/en/ht_conv.txt index 40ceb0b90a..baf1daf5e6 100644 --- a/harbour/contrib/hbmisc/doc/en/ht_conv.txt +++ b/harbour/contrib/hbmisc/doc/en/ht_conv.txt @@ -2,240 +2,228 @@ * $Id$ */ -/* - * The following parts are Copyright of the individual authors. - * www - http://www.harbour-project.org - * - * Copyright 1999 Luiz Rafael Culik - * Documentation - * - * See COPYING for licensing terms. - * +/* $DOC$ + $FUNCNAME$ + ISBIN() + $CATEGORY$ + Conversion Tools + $ONELINER$ + Check if the value is a Binary Number + $SYNTAX$ + ISBIN() -> + $ARGUMENTS$ + STRING TO BE CHECKED + $RETURNS$ + .T. IF THE STRING IS BYNARY,otherwise .F. + $DESCRIPTION$ + check if the passed string is a bynary number or not + $FILES$ + Library is libmisc + $SEEALSO$ + ISOCTAL(),ISDEC(),ISHEXA() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ISBIN() - * $CATEGORY$ - * Conversion Tools - * $ONELINER$ - * Check if the value is a Binary Number - * $SYNTAX$ - * ISBIN() -> - * $ARGUMENTS$ - * STRING TO BE CHECKED - * $RETURNS$ - * .T. IF THE STRING IS BYNARY,otherwise .F. - * $DESCRIPTION$ - * check if the passed string is a bynary number or not - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * ISOCTAL(),ISDEC(),ISHEXA() - * $END$ +/* $DOC$ + $FUNCNAME$ + ISOCTAL() + $CATEGORY$ + Conversion Tools + $ONELINER$ + Check if the value is a Octal Number + $SYNTAX$ + ISOCTAL() -> + $ARGUMENTS$ + STRING TO BE CHECKED + $RETURNS$ + .T. IF THE STRING IS OCTAL;otherwise .F. + $DESCRIPTION$ + check if the passed string is a octal number or not + $FILES$ + Library is libmisc + $SEEALSO$ + ISBIN(),ISDEC(),ISHEXA() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ISOCTAL() - * $CATEGORY$ - * Conversion Tools - * $ONELINER$ - * Check if the value is a Octal Number - * $SYNTAX$ - * ISOCTAL() -> - * $ARGUMENTS$ - * STRING TO BE CHECKED - * $RETURNS$ - * .T. IF THE STRING IS OCTAL;otherwise .F. - * $DESCRIPTION$ - * check if the passed string is a octal number or not - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * ISBIN(),ISDEC(),ISHEXA() - * $END$ +/* $DOC$ + $FUNCNAME$ + ISDEC() + $CATEGORY$ + Conversion Tools + $ONELINER$ + Check if the value is a Decimal Number + $SYNTAX$ + ISDEC() -> + $ARGUMENTS$ + STRING TO BE CHECKED + $RETURNS$ + .T. IF THE STRING IS DECIMAL;otherwise .F. + $DESCRIPTION$ + check if the passed string is a decimal number or not + $FILES$ + Library is libmisc + $SEEALSO$ + ISOCTAL(),ISBIN(),ISHEXA() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ISDEC() - * $CATEGORY$ - * Conversion Tools - * $ONELINER$ - * Check if the value is a Decimal Number - * $SYNTAX$ - * ISDEC() -> - * $ARGUMENTS$ - * STRING TO BE CHECKED - * $RETURNS$ - * .T. IF THE STRING IS DECIMAL;otherwise .F. - * $DESCRIPTION$ - * check if the passed string is a decimal number or not - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * ISOCTAL(),ISBIN(),ISHEXA() - * $END$ +/* $DOC$ + $FUNCNAME$ + ISHEXA() + $CATEGORY$ + Conversion Tools + $ONELINER$ + Check if the value is a Hexal Number + $SYNTAX$ + ISHEXA() -> + $ARGUMENTS$ + STRING TO BE CHECKED + $RETURNS$ + .T. IF THE STRING IS HEXA;otherwise .F. + $DESCRIPTION$ + check if the passed string is a hexa number or not + $FILES$ + Library is libmisc + $SEEALSO$ + ISOCTAL(),ISDEC(),ISBIN() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ISHEXA() - * $CATEGORY$ - * Conversion Tools - * $ONELINER$ - * Check if the value is a Hexal Number - * $SYNTAX$ - * ISHEXA() -> - * $ARGUMENTS$ - * STRING TO BE CHECKED - * $RETURNS$ - * .T. IF THE STRING IS HEXA;otherwise .F. - * $DESCRIPTION$ - * check if the passed string is a hexa number or not - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * ISOCTAL(),ISDEC(),ISBIN() - * $END$ +/* $DOC$ + $FUNCNAME$ + DECTOBIN() + $CATEGORY$ + Conversion Tools + $ONELINER$ + Converts a Decimal Value to Binary + $SYNTAX$ + DECTOBIN() -> + $ARGUMENTS$ + NUMBER TO BE CONVERTED + $RETURNS$ + NUMBER CONVERTED + $DESCRIPTION$ + This function converts a string from an decimal value + to an binary value. + $FILES$ + Library is libmisc + $SEEALSO$ + Dectohexa(),dectooctal() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * DECTOBIN() - * $CATEGORY$ - * Conversion Tools - * $ONELINER$ - * Converts a Decimal Value to Binary - * $SYNTAX$ - * DECTOBIN() -> - * $ARGUMENTS$ - * NUMBER TO BE CONVERTED - * $RETURNS$ - * NUMBER CONVERTED - * $DESCRIPTION$ - * This function converts a string from an decimal value - * to an binary value. - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * Dectohexa(),dectooctal() - * $END$ +/* $DOC$ + $FUNCNAME$ + DECTOOCTAL() + $CATEGORY$ + Conversion Tools + $ONELINER$ + Converts a Decimal Value to Octal + $SYNTAX$ + DECTOOCTAL() -> + $ARGUMENTS$ + NUMBER TO BE CONVERTED + $RETURNS$ + NUMBER CONVERTED + $DESCRIPTION$ + This function converts a string from an decimal value + to an octal value. + $FILES$ + Library is libmisc + $SEEALSO$ + Dectohexa(),dectobin() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * DECTOOCTAL() - * $CATEGORY$ - * Conversion Tools - * $ONELINER$ - * Converts a Decimal Value to Octal - * $SYNTAX$ - * DECTOOCTAL() -> - * $ARGUMENTS$ - * NUMBER TO BE CONVERTED - * $RETURNS$ - * NUMBER CONVERTED - * $DESCRIPTION$ - * This function converts a string from an decimal value - * to an octal value. - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * Dectohexa(),dectobin() - * $END$ +/* $DOC$ + $FUNCNAME$ + DECTOHEXA() + $CATEGORY$ + Conversion Tools + $ONELINER$ + Converts a Decimal Value to Hexa + $SYNTAX$ + DECTOHEXA() -> + $ARGUMENTS$ + NUMBER TO BE CONVERTED + $RETURNS$ + NUMBER CONVERTED + $DESCRIPTION$ + This function converts a string from an decimal value + to an hexadecimal value. + $FILES$ + Library is libmisc + $SEEALSO$ + Dectobin(),dectooctal() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * DECTOHEXA() - * $CATEGORY$ - * Conversion Tools - * $ONELINER$ - * Converts a Decimal Value to Hexa - * $SYNTAX$ - * DECTOHEXA() -> - * $ARGUMENTS$ - * NUMBER TO BE CONVERTED - * $RETURNS$ - * NUMBER CONVERTED - * $DESCRIPTION$ - * This function converts a string from an decimal value - * to an hexadecimal value. - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * Dectobin(),dectooctal() - * $END$ +/* $DOC$ + $FUNCNAME$ + BINTODEC() + $CATEGORY$ + Conversion Tools + $ONELINER$ + Converts a Binary Value to Decimal + $SYNTAX$ + BIntODEC() -> + $ARGUMENTS$ + NUMBER TO BE CONVERTED + $RETURNS$ + NUMBER CONVERTED + $DESCRIPTION$ + This function converts a string from an binary value + to a numeric decimal value. + $FILES$ + Library is libmisc + $SEEALSO$ + OctaltoDec(),HexatoDec() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * BINTODEC() - * $CATEGORY$ - * Conversion Tools - * $ONELINER$ - * Converts a Binary Value to Decimal - * $SYNTAX$ - * BIntODEC() -> - * $ARGUMENTS$ - * NUMBER TO BE CONVERTED - * $RETURNS$ - * NUMBER CONVERTED - * $DESCRIPTION$ - * This function converts a string from an binary value - * to a numeric decimal value. - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * OctaltoDec(),HexatoDec() - * $END$ +/* $DOC$ + $FUNCNAME$ + OCTALTODEC() + $CATEGORY$ + Conversion Tools + $ONELINER$ + Converts a Octal Value to Decimal + $SYNTAX$ + OCTALTODEC() -> + $ARGUMENTS$ + NUMBER TO BE CONVERTED + $RETURNS$ + NUMBER CONVERTED + $DESCRIPTION$ + This function converts a string from an octal value + to a numeric decimal value. + $FILES$ + Library is libmisc + $SEEALSO$ + BintoDec(),HexatoDec() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * OCTALTODEC() - * $CATEGORY$ - * Conversion Tools - * $ONELINER$ - * Converts a Octal Value to Decimal - * $SYNTAX$ - * OCTALTODEC() -> - * $ARGUMENTS$ - * NUMBER TO BE CONVERTED - * $RETURNS$ - * NUMBER CONVERTED - * $DESCRIPTION$ - * This function converts a string from an octal value - * to a numeric decimal value. - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * BintoDec(),HexatoDec() - * $END$ +/* $DOC$ + $FUNCNAME$ + HEXATODEC() + $CATEGORY$ + Conversion Tools + $ONELINER$ + Converts a Hexa Value to Decimal + $SYNTAX$ + HEXATODEC() -> + $ARGUMENTS$ + NUMBER TO BE CONVERTED + $RETURNS$ + NUMBER CONVERTED + $DESCRIPTION$ + This function converts a string from an hexadecimal value + to a numeric decimal value. + $FILES$ + Library is libmisc + $SEEALSO$ + OctaltoDec(),BintoDec() + $END$ */ - -/* $DOC$ - * $FUNCNAME$ - * HEXATODEC() - * $CATEGORY$ - * Conversion Tools - * $ONELINER$ - * Converts a Hexa Value to Decimal - * $SYNTAX$ - * HEXATODEC() -> - * $ARGUMENTS$ - * NUMBER TO BE CONVERTED - * $RETURNS$ - * NUMBER CONVERTED - * $DESCRIPTION$ - * This function converts a string from an hexadecimal value - * to a numeric decimal value. - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * OctaltoDec(),BintoDec() - * $END$ - */ - diff --git a/harbour/contrib/hbmisc/doc/en/ht_dbf.txt b/harbour/contrib/hbmisc/doc/en/ht_dbf.txt index e619e23878..b99e5a87f3 100644 --- a/harbour/contrib/hbmisc/doc/en/ht_dbf.txt +++ b/harbour/contrib/hbmisc/doc/en/ht_dbf.txt @@ -2,134 +2,121 @@ * $Id$ */ -/* - * The following parts are Copyright of the individual authors. - * www - http://www.harbour-project.org - * - * Copyright 2000 Alexander Kresin - * FIELDTYPE() documentation - * FIELDSIZE() documentation - * FIELDDECI() documentation - * - * See COPYING for licensing terms. - * +/* $DOC$ + $FUNCNAME$ + FIELDTYPE() + $CATEGORY$ + Database Tools + $ONELINER$ + Determines the type of a given field. + $SYNTAX$ + FIELDTYPE() --> cFieldType + $ARGUMENTS$ + Data field , which type need to be determined. + $RETURNS$ + FIELDTYPE() returns the character that designates the type of + a given field: + + 'C' character string; + 'N' numeric; + 'L' logical; + 'D' date; + 'M' memo. +
+ $DESCRIPTION$ + This function determines the type of a field, designated by its + number. + $EXAMPLES$ + PROCEDURE Main() + LOCAL i + USE tests NEW + FOR i := 1 TO FCount() + ? FieldType( i ) + NEXT + USE + RETURN + $STATUS$ + R + $COMPLIANCE$ + This function is CA-Cl*pper tools compatible + $FILES$ + Library is libmisc + $SEEALSO$ + FIELDSIZE(),FIELDDECI() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FIELDTYPE() - * $CATEGORY$ - * Database Tools - * $ONELINER$ - * Determines the type of a given field. - * $SYNTAX$ - * FIELDTYPE() --> cFieldType - * $ARGUMENTS$ - * Data field , which type need to be determined. - * $RETURNS$ - * FIELDTYPE() returns the character that designates the type of - * a given field: - * - * 'C' character string; - * 'N' numeric; - * 'L' logical; - * 'D' date; - * 'M' memo. - *
- * $DESCRIPTION$ - * This function determines the type of a field, designated by its - * number. - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL i - * USE tests NEW - * FOR i := 1 TO FCount() - * ? FieldType( i ) - * NEXT - * USE - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is CA-Cl*pper tools compatible - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * FIELDSIZE(),FIELDDECI() - * $END$ +/* $DOC$ + $FUNCNAME$ + FIELDSIZE() + $CATEGORY$ + Database tools + $ONELINER$ + Determines the size of a given field. + $SYNTAX$ + FIELDSIZE() --> nFieldSize + $ARGUMENTS$ + Data field , which size need to be determined. + $RETURNS$ + FIELDSIZE() returns the number that designates the size of a given + field. + $DESCRIPTION$ + This function determines the size of a field, designated by its number. + $EXAMPLES$ + PROCEDURE Main() + LOCAL i + USE tests NEW + FOR i := 1 TO FCount() + ? FieldSize( i ) + NEXT + USE + RETURN + xed> + $STATUS$ + R + $COMPLIANCE$ + This function is CA-Cl*pper tools compatible + $FILES$ + Library is libmisc + $SEEALSO$ + FIELDTYPE(),FIELDDECI() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FIELDSIZE() - * $CATEGORY$ - * Database tools - * $ONELINER$ - * Determines the size of a given field. - * $SYNTAX$ - * FIELDSIZE() --> nFieldSize - * $ARGUMENTS$ - * Data field , which size need to be determined. - * $RETURNS$ - * FIELDSIZE() returns the number that designates the size of a given - * field. - * $DESCRIPTION$ - * This function determines the size of a field, designated by its number. - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL i - * USE tests NEW - * FOR i := 1 TO FCount() - * ? FieldSize( i ) - * NEXT - * USE - * RETURN - * - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is CA-Cl*pper tools compatible - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * FIELDTYPE(),FIELDDECI() - * $END$ - */ - -/* $DOC$ - * $FUNCNAME$ - * FIELDDECI() - * $CATEGORY$ - * Database tools - * $ONELINER$ - * Determines the number of decimal places of a given numeric field. - * $SYNTAX$ - * FIELDDECI() --> nFieldDeci - * $ARGUMENTS$ - * Numeric data field , for which number of decimal - * places need to be determined. - * $RETURNS$ - * FIELDDECI() returns the numeric value that designates the number - * of decimal places of a given field. - * $DESCRIPTION$ - * This function determines the number of decimal places of a given numeric field. - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL i - * USE tests NEW - * FOR i := 1 TO FCount() - * ? FieldDeci( i ) - * NEXT - * USE - * RETURN - * - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is CA-Cl*pper tools compatible - * $FILES$ - * Library is libmisc - * $SEEALSO$ - * FIELDTYPE(),FIELDSIZE() - * $END$ +/* $DOC$ + $FUNCNAME$ + FIELDDECI() + $CATEGORY$ + Database tools + $ONELINER$ + Determines the number of decimal places of a given numeric field. + $SYNTAX$ + FIELDDECI() --> nFieldDeci + $ARGUMENTS$ + Numeric data field , for which number of decimal + places need to be determined. + $RETURNS$ + FIELDDECI() returns the numeric value that designates the number + of decimal places of a given field. + $DESCRIPTION$ + This function determines the number of decimal places of a given numeric field. + $EXAMPLES$ + PROCEDURE Main() + LOCAL i + USE tests NEW + FOR i := 1 TO FCount() + ? FieldDeci( i ) + NEXT + USE + RETURN + xed> + $STATUS$ + R + $COMPLIANCE$ + This function is CA-Cl*pper tools compatible + $FILES$ + Library is libmisc + $SEEALSO$ + FIELDTYPE(),FIELDSIZE() + $END$ */ diff --git a/harbour/contrib/hbmisc/doc/en/ht_doc.txt b/harbour/contrib/hbmisc/doc/en/ht_doc.txt index e92bbb5992..bbdcabe6cd 100644 --- a/harbour/contrib/hbmisc/doc/en/ht_doc.txt +++ b/harbour/contrib/hbmisc/doc/en/ht_doc.txt @@ -2,261 +2,250 @@ * $Id$ */ -/* - * The following parts are Copyright of the individual authors. - * www - http://www.harbour-project.org - * - * Copyright 1999 Luiz Rafael Culik - * Documentation - * - * See COPYING for licensing terms. - * +/* $DOC$ + $FUNCNAME$ + THtml() + $CATEGORY$ + Harbour Tools + $ONELINER$ + Html Class + $SYNTAX$ + oHtml:=THtml():New() --> oHtm + $ARGUMENTS$ + Name of the Html file to create + $RETURNS$ + An instance of the THtml Class + $DESCRIPTION$ + THtml() is a class that creates an .html file of the same + name you pass to the constructor. + The class methods are as follows: + New() Create a new instance of the THtml class + Close() Close the created file + WriteTitle() Write the file title + WritePar() Writes a paragraph + WriteParBold() Same as WritePar(), but the text is bold + WriteLink(,) Write a link to another topic + WriteText() Write any text + $EXAMPLES$ + PROCEDURE Main() + LOCAL oHtm + + oHtm := THTML():New( "www\harbour.html" ) + oHtm:WriteTitle( "Harbour Reference Guide" ) + oHtm:WritePar( "HARBOUR" ) + oHtm:WriteLink( "OverView" ) + oHtm:WriteLink( "License" ) + oHtm:WriteLink( "http://www.gnu.org/copyleft/gpl" ) + oHtm:WritePar( "See the Links Above" ) + oHtm:Close() + + RETURN + r> + $STATUS$ + R + $COMPLIANCE$ + This is a new Harbour Tools class + $PLATFORMS$ + ALL + $SEEALSO$ + TCLASS() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * THtml() - * $CATEGORY$ - * Harbour Tools - * $ONELINER$ - * Html Class - * $SYNTAX$ - * oHtml:=THtml():New() --> oHtm - * $ARGUMENTS$ - * Name of the Html file to create - * $RETURNS$ - * An instance of the THtml Class - * $DESCRIPTION$ - * THtml() is a class that creates an .html file of the same - * name you pass to the constructor. - * The class methods are as follows: - * New() Create a new instance of the THtml class - * Close() Close the created file - * WriteTitle() Write the file title - * WritePar() Writes a paragraph - * WriteParBold() Same as WritePar(), but the text is bold - * WriteLink(,) Write a link to another topic - * WriteText() Write any text - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL oHtm - * - * oHtm := THTML():New( "www\harbour.html" ) - * oHtm:WriteTitle( "Harbour Reference Guide" ) - * oHtm:WritePar( "HARBOUR" ) - * oHtm:WriteLink( "OverView" ) - * oHtm:WriteLink( "License" ) - * oHtm:WriteLink( "http://www.gnu.org/copyleft/gpl" ) - * oHtm:WritePar( "See the Links Above" ) - * oHtm:Close() - * - * RETURN - * - * $STATUS$ - * R - * $COMPLIANCE$ - * This is a new Harbour Tools class - * $PLATFORMS$ - * ALL - * $SEEALSO$ - * TCLASS() - * $END$ +/* $DOC$ + $FUNCNAME$ + TOs2() + $CATEGORY$ + Harbour Tools + $ONELINER$ + OS/2 Documentation Class + $SYNTAX$ + oNg:=TOs2():New() --> oOs2 + $ARGUMENTS$ + Name of the IPF Source file to create + $RETURNS$ + An instance of the TOs2 Class + $DESCRIPTION$ + TOs2() is a class that creates the OS/2 IPF Source + of the same name you pass to the constructor. + The class methods are as follows: + New() Create a new instance of the TOs2 class + Close() Close the created file + WriteTitle(,) Write the file title + WritePar() Write a paragraph + WriteParBold() Same as WritePar(), but the text is bold + WriteLink() Write a link to another topic + ScanLink() Scan the aLinkRef array for a valid topic + DosToOs2Text() Convert a Dos string to a OS/2 String + $EXAMPLES$ + PROCEDURE Main() + LOCAL oNg + + oNg := TOs2():New( "ngi\harbour.ngi" ) + oNg:WriteTitle( "Harbour Reference Guide" ) + oNg:WritePar( "HARBOUR" ) + oNg:WriteLink( "OverView" ) + oNg:WriteLink( "License" ) + + oNg:WritePar( "See the Links Above" ) + oNg:Close() + + RETURN + $STATUS$ + R + $COMPLIANCE$ + This is a new Harbour Tools class + $PLATFORMS$ + ALL + $SEEALSO$ + TNortonGuide() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * TOs2() - * $CATEGORY$ - * Harbour Tools - * $ONELINER$ - * OS/2 Documentation Class - * $SYNTAX$ - * oNg:=TOs2():New() --> oOs2 - * $ARGUMENTS$ - * Name of the IPF Source file to create - * $RETURNS$ - * An instance of the TOs2 Class - * $DESCRIPTION$ - * TOs2() is a class that creates the OS/2 IPF Source - * of the same name you pass to the constructor. - * The class methods are as follows: - * New() Create a new instance of the TOs2 class - * Close() Close the created file - * WriteTitle(,) Write the file title - * WritePar() Write a paragraph - * WriteParBold() Same as WritePar(), but the text is bold - * WriteLink() Write a link to another topic - * ScanLink() Scan the aLinkRef array for a valid topic - * DosToOs2Text() Convert a Dos string to a OS/2 String - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL oNg - * - * oNg := TOs2():New( "ngi\harbour.ngi" ) - * oNg:WriteTitle( "Harbour Reference Guide" ) - * oNg:WritePar( "HARBOUR" ) - * oNg:WriteLink( "OverView" ) - * oNg:WriteLink( "License" ) - * - * oNg:WritePar( "See the Links Above" ) - * oNg:Close() - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * This is a new Harbour Tools class - * $PLATFORMS$ - * ALL - * $SEEALSO$ - * TNortonGuide() - * $END$ +/* $DOC$ + $FUNCNAME$ + TNortonGuide() + $CATEGORY$ + Harbour Tools + $ONELINER$ + Norton Guide Class + $SYNTAX$ + oNg:=TNortonGuide():New() --> oNg + $ARGUMENTS$ + Name of the Ng Source file to create + $RETURNS$ + An instance of the TNortonGuide Class + $DESCRIPTION$ + TNortonGuide() is a class that creates the Norton Guide Source + Code of the same name you pass to the constructor. + The class methods are as follows: + New() Create an instance of the TNortonGuide class + Close() Close the created file + WriteTitle(,) Write the file title + WritePar() Write a paragraph + WriteParBold() Same as WritePar(), but the text is bold + WriteLink() Write a link to another topic + $EXAMPLES$ + PROCEDURE Main() + LOCAL oNg + + oNg := TNortonGuide():New( "ngi\harbour.ngi" ) + oNg:WriteTitle( "Harbour Reference Guide" ) + oNg:WritePar( "HARBOUR" ) + oNg:WriteLink( "OverView" ) + oNg:WriteLink( "License" ) + + oNg:WritePar( "See the Links Above" ) + oNg:Close() + + RETURN + $STATUS$ + R + $COMPLIANCE$ + This is a new Harbour Tools class + $PLATFORMS$ + ALL + $SEEALSO$ + TTroff(),TRtf(),THtml(),TOs2() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * TNortonGuide() - * $CATEGORY$ - * Harbour Tools - * $ONELINER$ - * Norton Guide Class - * $SYNTAX$ - * oNg:=TNortonGuide():New() --> oNg - * $ARGUMENTS$ - * Name of the Ng Source file to create - * $RETURNS$ - * An instance of the TNortonGuide Class - * $DESCRIPTION$ - * TNortonGuide() is a class that creates the Norton Guide Source - * Code of the same name you pass to the constructor. - * The class methods are as follows: - * New() Create an instance of the TNortonGuide class - * Close() Close the created file - * WriteTitle(,) Write the file title - * WritePar() Write a paragraph - * WriteParBold() Same as WritePar(), but the text is bold - * WriteLink() Write a link to another topic - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL oNg - * - * oNg := TNortonGuide():New( "ngi\harbour.ngi" ) - * oNg:WriteTitle( "Harbour Reference Guide" ) - * oNg:WritePar( "HARBOUR" ) - * oNg:WriteLink( "OverView" ) - * oNg:WriteLink( "License" ) - * - * oNg:WritePar( "See the Links Above" ) - * oNg:Close() - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * This is a new Harbour Tools class - * $PLATFORMS$ - * ALL - * $SEEALSO$ - * TTroff(),TRtf(),THtml(),TOs2() - * $END$ +/* $DOC$ + $FUNCNAME$ + TRtf() + $CATEGORY$ + Harbour Tools + $ONELINER$ + Rtf Class + $SYNTAX$ + oNg:=TRtf():New() --> oRtf + $ARGUMENTS$ + Name of the RTF file to create + $RETURNS$ + An instance of the TRtf Class + $DESCRIPTION$ + TRtf() is a class that creates the RTF Documentation Source + Code of the same name you pass to the constructor. + The class methods are as follows: + New() Create a new instance of the TRtf class + Close() Close the create file + WriteTitle(,) Write the file title + WritePar() Write a paragraph + WriteParBold() Same as WritePar(), but the text is bold + WriteLink() Write a link to another topic + WriteHeader() Write the RTF header + EndPar() Write the end paragraph delimiter + $EXAMPLES$ + PROCEDURE Main() + LOCAL oRtf + + oRtf := TRtf():New( "rtf\harbour.rtf" ) + oRtf:WriteHeader() + oRtf:WriteTitle( "Harbour Reference Guide" ) + oRtf:WritePar( "HARBOUR" ):Endpar() + oRtf:WriteLink( "OverView" ) + oRtf:WriteLink( "License" ) + + oRtf:WritePar( "See the Links Above" ):EndPar() + oRtf:Close() + + RETURN + $STATUS$ + R + $COMPLIANCE$ + This is a new Harbour Tools class + $PLATFORMS$ + ALL + $SEEALSO$ + TNortonGuide() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * TRtf() - * $CATEGORY$ - * Harbour Tools - * $ONELINER$ - * Rtf Class - * $SYNTAX$ - * oNg:=TRtf():New() --> oRtf - * $ARGUMENTS$ - * Name of the RTF file to create - * $RETURNS$ - * An instance of the TRtf Class - * $DESCRIPTION$ - * TRtf() is a class that creates the RTF Documentation Source - * Code of the same name you pass to the constructor. - * The class methods are as follows: - * New() Create a new instance of the TRtf class - * Close() Close the create file - * WriteTitle(,) Write the file title - * WritePar() Write a paragraph - * WriteParBold() Same as WritePar(), but the text is bold - * WriteLink() Write a link to another topic - * WriteHeader() Write the RTF header - * EndPar() Write the end paragraph delimiter - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL oRtf - * - * oRtf := TRtf():New( "rtf\harbour.rtf" ) - * oRtf:WriteHeader() - * oRtf:WriteTitle( "Harbour Reference Guide" ) - * oRtf:WritePar( "HARBOUR" ):Endpar() - * oRtf:WriteLink( "OverView" ) - * oRtf:WriteLink( "License" ) - * - * oRtf:WritePar( "See the Links Above" ):EndPar() - * oRtf:Close() - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * This is a new Harbour Tools class - * $PLATFORMS$ - * ALL - * $SEEALSO$ - * TNortonGuide() - * $END$ - */ - -/* $DOC$ - * $FUNCNAME$ - * TTroff() - * $CATEGORY$ - * Harbour Tools - * $ONELINER$ - * Troff Class - * $SYNTAX$ - * oTroff:=TTrof():New() --> oTrf - * $ARGUMENTS$ - * Name of the Troff file to create - * $RETURNS$ - * instance of the TTroff Class - * $DESCRIPTION$ - * TTroff() is a class that creates the TROFF Documentation Source - * Code of the same name you pass to the constructor. - * The class methods are as follows: - * New() Create a new instance of the THtml class - * Close() Close the created file - * WriteTitle(,) Write the file title - * WritePar() Write a paragraph - * WriteParBold() Same as WritePar(), but the text is bold - * WriteLink() Write a link to another topic - * WriteText() Writes text without formating - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL oTroff - * - * oTroff := TTroff():New( "tr\harbour.ngi" ) - * oTroff:WriteTitle( "Harbour Reference Guide" ) - * oTroff:WritePar( "HARBOUR" ) - * oTroff:WriteLink( "OverView" ) - * oTroff:WriteLink( "License" ) - * - * oTroff:WritePar( "See the Links Above" ) - * oTroff:Close() - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * This is a new Harbour Tools class - * $PLATFORMS$ - * ALL - * $SEEALSO$ - * TNortonGuide() - * $END$ +/* $DOC$ + $FUNCNAME$ + TTroff() + $CATEGORY$ + Harbour Tools + $ONELINER$ + Troff Class + $SYNTAX$ + oTroff:=TTrof():New() --> oTrf + $ARGUMENTS$ + Name of the Troff file to create + $RETURNS$ + instance of the TTroff Class + $DESCRIPTION$ + TTroff() is a class that creates the TROFF Documentation Source + Code of the same name you pass to the constructor. + The class methods are as follows: + New() Create a new instance of the THtml class + Close() Close the created file + WriteTitle(,) Write the file title + WritePar() Write a paragraph + WriteParBold() Same as WritePar(), but the text is bold + WriteLink() Write a link to another topic + WriteText() Writes text without formating + $EXAMPLES$ + PROCEDURE Main() + LOCAL oTroff + + oTroff := TTroff():New( "tr\harbour.ngi" ) + oTroff:WriteTitle( "Harbour Reference Guide" ) + oTroff:WritePar( "HARBOUR" ) + oTroff:WriteLink( "OverView" ) + oTroff:WriteLink( "License" ) + + oTroff:WritePar( "See the Links Above" ) + oTroff:Close() + + RETURN + $STATUS$ + R + $COMPLIANCE$ + This is a new Harbour Tools class + $PLATFORMS$ + ALL + $SEEALSO$ + TNortonGuide() + $END$ */ diff --git a/harbour/contrib/hbmisc/doc/en/ht_file.txt b/harbour/contrib/hbmisc/doc/en/ht_file.txt index fba91175a7..c4cf74a112 100644 --- a/harbour/contrib/hbmisc/doc/en/ht_file.txt +++ b/harbour/contrib/hbmisc/doc/en/ht_file.txt @@ -2,86 +2,86 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * CD() - * $CATEGORY$ - * Dos Tools - * $ONELINER$ - * Change the Current Directory - * $SYNTAX$ - * CD() --> lSuccess - * $ARGUMENTS$ - * DIR TO BE CHANGED - * $RETURNS$ - * .T. IF SUCESSFUL; otherwise .F. - * $DESCRIPTION$ - * CHANGE THE CURRENT DIRECTORY - * $EXAMPLES$ - * IF CD( "OLA" ) - * RETURN .T. - * ELSE - * RETURN .F. - * ENDIF - * $FILES$ - * Header is Fileio.ch - * $SEEALSO$ - * MD(),RD() - * $END$ +/* $DOC$ + $FUNCNAME$ + CD() + $CATEGORY$ + Dos Tools + $ONELINER$ + Change the Current Directory + $SYNTAX$ + CD() --> lSuccess + $ARGUMENTS$ + DIR TO BE CHANGED + $RETURNS$ + .T. IF SUCESSFUL; otherwise .F. + $DESCRIPTION$ + CHANGE THE CURRENT DIRECTORY + $EXAMPLES$ + IF CD( "OLA" ) + RETURN .T. + ELSE + RETURN .F. + ENDIF + $FILES$ + Header is Fileio.ch + $SEEALSO$ + MD(),RD() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * MD() - * $CATEGORY$ - * Dos Tools - * $ONELINER$ - * Creates a Directory - * $SYNTAX$ - * MD() -> - * $ARGUMENTS$ - * DIRECTORY TO BE CREATED - * $RETURNS$ - * .T. IF SUCESSFUL; otherwise .F. - * $DESCRIPTION$ - * CREATE A DIRECTORY - * $EXAMPLES$ - * IF MD( "OLA" ) - * RETURN .T. - * ELSE - * RETURN .F. - * ENDIF - * $FILES$ - * Header is Fileio.ch - * $SEEALSO$ - * CD(),MD() - * $END$ +/* $DOC$ + $FUNCNAME$ + MD() + $CATEGORY$ + Dos Tools + $ONELINER$ + Creates a Directory + $SYNTAX$ + MD() -> + $ARGUMENTS$ + DIRECTORY TO BE CREATED + $RETURNS$ + .T. IF SUCESSFUL; otherwise .F. + $DESCRIPTION$ + CREATE A DIRECTORY + $EXAMPLES$ + IF MD( "OLA" ) + RETURN .T. + ELSE + RETURN .F. + ENDIF + $FILES$ + Header is Fileio.ch + $SEEALSO$ + CD(),MD() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * RD() - * $CATEGORY$ - * Dos Tools - * $ONELINER$ - * Remove a Directory - * $SYNTAX$ - * RD() --> - * $ARGUMENTS$ - * DIR TO BE DELETED - * $RETURNS$ - * .T. IF SUCESSFUL; otherwise .F. - * $DESCRIPTION$ - * REMOVE A DIRECTORY - * $EXAMPLES$ - * IF RD( "OLA" ) - * RETURN .T. - * ELSE - * RETURN .F. - * ENDIF - * $FILES$ - * Header is Fileio.ch - * $SEEALSO$ - * CD(),MD() - * $END$ +/* $DOC$ + $FUNCNAME$ + RD() + $CATEGORY$ + Dos Tools + $ONELINER$ + Remove a Directory + $SYNTAX$ + RD() --> + $ARGUMENTS$ + DIR TO BE DELETED + $RETURNS$ + .T. IF SUCESSFUL; otherwise .F. + $DESCRIPTION$ + REMOVE A DIRECTORY + $EXAMPLES$ + IF RD( "OLA" ) + RETURN .T. + ELSE + RETURN .F. + ENDIF + $FILES$ + Header is Fileio.ch + $SEEALSO$ + CD(),MD() + $END$ */ diff --git a/harbour/contrib/hbmisc/doc/en/ht_str.txt b/harbour/contrib/hbmisc/doc/en/ht_str.txt index e84d40a841..8cd4998e2d 100644 --- a/harbour/contrib/hbmisc/doc/en/ht_str.txt +++ b/harbour/contrib/hbmisc/doc/en/ht_str.txt @@ -2,59 +2,48 @@ * $Id$ */ -/* - * The following parts are Copyright of the individual authors. - * www - http://www.harbour-project.org - * - * Copyright 1999-2001 Viktor Szakats (harbour syenar.net) - * STRFORMAT() documentation - * - * See COPYING for licensing terms. - * - */ - -/* $DOC$ - * $FUNCNAME$ - * StrFormat() - * $CATEGORY$ - * String Tools - * $ONELINER$ - * Format a string - * $SYNTAX$ - * StrFormat([, [, [, ...]]) --> cString - * $ARGUMENTS$ - * Holds the mask for the resulting string - * Holds the strings to be inserted in the mask - * maximum 9 of them can be specified. - * $RETURNS$ - * Return the mask with all the parameters inserted. - * $DESCRIPTION$ - * String replacment, can be useful when writing international - * apps. You can separate the constant strings from the variable ones. - * Each %1 - %9 marks will be replaced with the appropriate parameter - * from the parameter list. - * Marks can be in any order, and can be duplicated. - * You can print "%" character with "%%". - * $EXAMPLES$ - * StrFormat( "Please insert disk %1 to drive %2", hb_ntos( 2 ), "A:" ) - * StrFormat( "This is %1 from %2", "Victor", "Hungary" ) - * StrFormat( "%2 %1 %2", "Param1", "Param2" ) - * $TESTS$ - * ? StrFormat( "Please insert disk %1 to drive %2", hb_ntos( 2 ), "A:" ) - * ? StrFormat( "This is %1 from %2", "Victor", "Hungary" ) - * ? StrFormat( "%2 %1 %2", "Param1", "Param2" ) - * ? StrFormat( "Hello" ) - * ? StrFormat( "%1 - %2", "one" ) - * ? StrFormat( "%1 - %2", "one", "two" ) - * ? StrFormat( "%2 - %1", "one", "two" ) - * ? StrFormat( "%2 - %", "one", "two" ) - * ? StrFormat( "%% - %", "one", "two" ) - * ? StrFormat( "%9 - %", "one", "two" ) - * $STATUS$ - * Done - * $COMPLIANCE$ - * All platforms - * $FILES$ - * Library is libmisc - * $END$ +/* $DOC$ + $FUNCNAME$ + StrFormat() + $CATEGORY$ + String Tools + $ONELINER$ + Format a string + $SYNTAX$ + StrFormat([, [, [, ...]]) --> cString + $ARGUMENTS$ + Holds the mask for the resulting string + Holds the strings to be inserted in the mask + maximum 9 of them can be specified. + $RETURNS$ + Return the mask with all the parameters inserted. + $DESCRIPTION$ + String replacment, can be useful when writing international + apps. You can separate the constant strings from the variable ones. + Each %1 - %9 marks will be replaced with the appropriate parameter + from the parameter list. + Marks can be in any order, and can be duplicated. + You can print "%" character with "%%". + $EXAMPLES$ + StrFormat( "Please insert disk %1 to drive %2", hb_ntos( 2 ), "A:" ) + StrFormat( "This is %1 from %2", "Victor", "Hungary" ) + StrFormat( "%2 %1 %2", "Param1", "Param2" ) + $TESTS$ + ? StrFormat( "Please insert disk %1 to drive %2", hb_ntos( 2 ), "A:" ) + ? StrFormat( "This is %1 from %2", "Victor", "Hungary" ) + ? StrFormat( "%2 %1 %2", "Param1", "Param2" ) + ? StrFormat( "Hello" ) + ? StrFormat( "%1 - %2", "one" ) + ? StrFormat( "%1 - %2", "one", "two" ) + ? StrFormat( "%2 - %1", "one", "two" ) + ? StrFormat( "%2 - %", "one", "two" ) + ? StrFormat( "%% - %", "one", "two" ) + ? StrFormat( "%9 - %", "one", "two" ) + $STATUS$ + Done + $COMPLIANCE$ + All platforms + $FILES$ + Library is libmisc + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/aading.txt b/harbour/contrib/hbnf/doc/en/aading.txt index 7f88e6a2eb..3f870caf43 100644 --- a/harbour/contrib/hbnf/doc/en/aading.txt +++ b/harbour/contrib/hbnf/doc/en/aading.txt @@ -2,49 +2,49 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_AADDITION() - * $CATEGORY$ - * Array - * $ONELINER$ - * Add elements unique of source array to target array - * $SYNTAX$ - * FT_AADDITION( , [, [, ] ] ) ; - * -> aNewArray - * $ARGUMENTS$ - * is the primary array. - * - * is the secondary array. - * - * is a logical value denoting whether leading or - * trailing spaces should be included in the - * comparison. If .T., then ignores spaces in - * comparison, defaults to .T., .F. includes spaces. - * - * is a logical value denoting case sensitivity. - * If .T., then comparison is sensitive to case, - * defaults to .T., .F. ignores case. - * $RETURNS$ - * An array of the union of aList1 and aList2. - * $DESCRIPTION$ - * This function will add the elements unique of aList2 with aList1. - * It returns a new array including all the elements of aList1 - * plus the unique elements of aList2. - * $EXAMPLES$ - * aList1 := { "apple", "orange", "pear" } - * aList2 := { "apple ", "banana", "PEAR" } - * - * FT_AADDITION( aList1, aList2 ) - * // ignores spaces, sensitive to case - * // returns { "apple", "orange", "pear", "banana", "PEAR" } - * - * FT_AADDITION( aList1, aList2, , .F. ) - * // ignores spaces, not sensitive to case - * // returns { "apple", "orange", "pear", "banana" } - * - * FT_AADDITION( aList1, aList2, .F., .F. ) - * // sensitive to spaces, not sensitive to case - * // returns { "apple", "orange", "pear", "apple ", "banana" } - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_AADDITION() + $CATEGORY$ + Array + $ONELINER$ + Add elements unique of source array to target array + $SYNTAX$ + FT_AADDITION( , [, [, ] ] ) ; + -> aNewArray + $ARGUMENTS$ + is the primary array. + + is the secondary array. + + is a logical value denoting whether leading or + trailing spaces should be included in the + comparison. If .T., then ignores spaces in + comparison, defaults to .T., .F. includes spaces. + + is a logical value denoting case sensitivity. + If .T., then comparison is sensitive to case, + defaults to .T., .F. ignores case. + $RETURNS$ + An array of the union of aList1 and aList2. + $DESCRIPTION$ + This function will add the elements unique of aList2 with aList1. + It returns a new array including all the elements of aList1 + plus the unique elements of aList2. + $EXAMPLES$ + aList1 := { "apple", "orange", "pear" } + aList2 := { "apple ", "banana", "PEAR" } + + FT_AADDITION( aList1, aList2 ) + // ignores spaces, sensitive to case + // returns { "apple", "orange", "pear", "banana", "PEAR" } + + FT_AADDITION( aList1, aList2, , .F. ) + // ignores spaces, not sensitive to case + // returns { "apple", "orange", "pear", "banana" } + + FT_AADDITION( aList1, aList2, .F., .F. ) + // sensitive to spaces, not sensitive to case + // returns { "apple", "orange", "pear", "apple ", "banana" } + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/aavg.txt b/harbour/contrib/hbnf/doc/en/aavg.txt index 7353c893d9..1af3ea6c15 100644 --- a/harbour/contrib/hbnf/doc/en/aavg.txt +++ b/harbour/contrib/hbnf/doc/en/aavg.txt @@ -2,37 +2,37 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_AAVG() - * $CATEGORY$ - * Array - * $ONELINER$ - * Average numeric values in an array - * $SYNTAX$ - * FT_AAVG( [, [, ] ] ) -> nAverage - * $ARGUMENTS$ - * is the array containing the elements to be averaged. - * - * is the first array item to include, - * defaults to first element. - * - * is the last array element to include, - * defaults to all elements. - * $RETURNS$ - * The average of the specified array elements. - * $DESCRIPTION$ - * This function is used to get a numeric average of selected or all - * elements of an array. - * - * This routine requires FT_ASUM(). - * $EXAMPLES$ - * FT_AAVG( aSubTotals ) // Get Average of Entire Array - * - * FT_AAVG( aSubTotals, 5 ) // Get Average of 5th Element On - * - * FT_AAVG( aSubTotals, , 10 ) // Get Average of 1st 10 Elements - * - * FT_AAVG( aSubTotals, 5, 10 ) // Get Average of Elements 5-10 - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_AAVG() + $CATEGORY$ + Array + $ONELINER$ + Average numeric values in an array + $SYNTAX$ + FT_AAVG( [, [, ] ] ) -> nAverage + $ARGUMENTS$ + is the array containing the elements to be averaged. + + is the first array item to include, + defaults to first element. + + is the last array element to include, + defaults to all elements. + $RETURNS$ + The average of the specified array elements. + $DESCRIPTION$ + This function is used to get a numeric average of selected or all + elements of an array. + + This routine requires FT_ASUM(). + $EXAMPLES$ + FT_AAVG( aSubTotals ) // Get Average of Entire Array + + FT_AAVG( aSubTotals, 5 ) // Get Average of 5th Element On + + FT_AAVG( aSubTotals, , 10 ) // Get Average of 1st 10 Elements + + FT_AAVG( aSubTotals, 5, 10 ) // Get Average of Elements 5-10 + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/acctadj.txt b/harbour/contrib/hbnf/doc/en/acctadj.txt index 11d11029ed..f5c81e9ea8 100644 --- a/harbour/contrib/hbnf/doc/en/acctadj.txt +++ b/harbour/contrib/hbnf/doc/en/acctadj.txt @@ -2,59 +2,59 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ACCTADJ() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Adjust beginning or ending fiscal pd. dates to acctg. dates - * $SYNTAX$ - * FT_ACCTADJ( [ ], [ ] ) -> dDate - * $ARGUMENTS$ - * is any valid date in any valid format. - * Defaults to DATE() if not supplied. - * - * is a logical variable. .F. = adjust for beginning of - * period mode, .T. = adjust for end of period mode. Defaults to - * beginning of period mode. - * $RETURNS$ - * An adjusted date dependent upon mode and work week start day. - * $DESCRIPTION$ - * Called by other FT_ACCT.. functions. The algorithm is: - * - * Beginning of period mode: - * - * If dGivenDate is in last 3 days of work week - * Return next week's start date - * Else - * Return this week's start date - * Endif - * - * End of period mode: - * - * If dGivenDate is in last 4 days of work week - * Return this week's end date - * Else - * Return prior week's end date - * Endif - * $EXAMPLES$ - * Beginning of period mode (lIsEnd == .F.) - * - * dDate := SToD( "19910131" ) // In last 3 days of work week - * ? FT_ACCTADJ( dDate ) // 1991.02.03 (next week's start) - * - * dDate := SToD( "19910331" ) // Not in last 3 days of work week - * ? FT_ACCTADJ( dDate ) // 1991.03.31 (this week's start) - * - * End of period mode (lIsEnd == .T.) - * - * dDate := SToD( "19910131" ) // In last 4 days of work week - * ? FT_ACCTADJ( dDate, .T. ) // 1991.02.02 (this week's end) - * - * dDate := SToD( "19910331" ) // Not in last 4 days of work week - * ? FT_ACCTADJ( dDate, .T. ) // 1991.03.30 (prior week's end) - * $SEEALSO$ - * FT_DATECNFG() FT_DAYTOBOW() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ACCTADJ() + $CATEGORY$ + Date/Time + $ONELINER$ + Adjust beginning or ending fiscal pd. dates to acctg. dates + $SYNTAX$ + FT_ACCTADJ( [ ], [ ] ) -> dDate + $ARGUMENTS$ + is any valid date in any valid format. + Defaults to DATE() if not supplied. + + is a logical variable. .F. = adjust for beginning of + period mode, .T. = adjust for end of period mode. Defaults to + beginning of period mode. + $RETURNS$ + An adjusted date dependent upon mode and work week start day. + $DESCRIPTION$ + Called by other FT_ACCT.. functions. The algorithm is: + + Beginning of period mode: + + IF dGivenDate is in last 3 days of work week + Return next week's start date + ELSE + Return this week's start date + ENDIF + + End of period mode: + + IF dGivenDate is in last 4 days of work week + Return this week's end date + ELSE + Return prior week's end date + ENDIF + $EXAMPLES$ + Beginning of period mode (lIsEnd == .F.) + + dDate := SToD( "19910131" ) // In last 3 days of work week + ? FT_ACCTADJ( dDate ) // 1991.02.03 (next week's start) + + dDate := SToD( "19910331" ) // Not in last 3 days of work week + ? FT_ACCTADJ( dDate ) // 1991.03.31 (this week's start) + + End of period mode (lIsEnd == .T.) + + dDate := SToD( "19910131" ) // In last 4 days of work week + ? FT_ACCTADJ( dDate, .T. ) // 1991.02.02 (this week's end) + + dDate := SToD( "19910331" ) // Not in last 4 days of work week + ? FT_ACCTADJ( dDate, .T. ) // 1991.03.30 (prior week's end) + $SEEALSO$ + FT_DATECNFG() FT_DAYTOBOW() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/acctmnth.txt b/harbour/contrib/hbnf/doc/en/acctmnth.txt index d9c2813e48..8195a32ea1 100644 --- a/harbour/contrib/hbnf/doc/en/acctmnth.txt +++ b/harbour/contrib/hbnf/doc/en/acctmnth.txt @@ -2,56 +2,56 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ACCTMONTH() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Return accounting month data - * $SYNTAX$ - * FT_ACCTMONTH( [ ], [ ] ) -> aDateInfo - * $ARGUMENTS$ - * is any valid date in any date format. Defaults - * to current system date if not supplied. - * - * is a number from 1 to 12 signifying a month. - * Defaults to current month if not supplied. - * $RETURNS$ - * A three element array containing the following data: - * - * aDateInfo[ 1 ] - The year and month as a character string "YYYYMM" - * aDateInfo[ 2 ] - The beginning date of the accounting month - * aDateInfo[ 3 ] - The ending date of the accounting month - * $DESCRIPTION$ - * FT_ACCTMONTH() creates an array containing data about the - * accounting month containing the given date. - * - * An accounting period has the following characteristics: - * - * If the first week of the period contains 4 or more 'work' - * days, it is included in the period; otherwise, the first - * week was included in the prior period. - * - * If the last week of the period contains 4 or more 'work' - * days it is included in the period; otherwise, the last week - * is included in the next period. This results in 13 week - * 'quarters' and 4 or 5 week 'months'. Every 5 or 6 years, a - * 'quarter' will contain 14 weeks and the year will contain 53 - * weeks. - * $EXAMPLES$ - * // get info about accounting month containing 9/15/90 - * aDateInfo := FT_ACCTMONTH( SToD( "19900915" ) ) - * ? aDateInfo[ 1 ] // 199009 (9th month) - * ? aDateInfo[ 2 ] // 09/02/90 beginning of month 9 - * ? aDateInfo[ 3 ] // 09/29/90 end of month 9 - * - * // get info about accounting month 5 in year containing 9/15/90 - * aDateInfo := FT_ACCTMONTH( SToD( "19900915" ), 5 ) - * ? aDateInfo[ 1 ] // 199005 - * ? aDateInfo[ 2 ] // 04/29/89 beginning of month 5 - * ? aDateInfo[ 3 ] // 06/02/90 end of month 5 - * $SEEALSO$ - * FT_DATECNFG() FT_ACCTWEEK() FT_ACCTQTR() FT_ACCTYEAR() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ACCTMONTH() + $CATEGORY$ + Date/Time + $ONELINER$ + Return accounting month data + $SYNTAX$ + FT_ACCTMONTH( [ ], [ ] ) -> aDateInfo + $ARGUMENTS$ + is any valid date in any date format. Defaults + to current system date if not supplied. + + is a number from 1 to 12 signifying a month. + Defaults to current month if not supplied. + $RETURNS$ + A three element array containing the following data: + + aDateInfo[ 1 ] - The year and month as a character string "YYYYMM" + aDateInfo[ 2 ] - The beginning date of the accounting month + aDateInfo[ 3 ] - The ending date of the accounting month + $DESCRIPTION$ + FT_ACCTMONTH() creates an array containing data about the + accounting month containing the given date. + + An accounting period has the following characteristics: + + If the first week of the period contains 4 or more 'work' + days, it is included in the period; otherwise, the first + week was included in the prior period. + + If the last week of the period contains 4 or more 'work' + days it is included in the period; otherwise, the last week + is included in the next period. This results in 13 week + 'quarters' and 4 or 5 week 'months'. Every 5 or 6 years, a + 'quarter' will contain 14 weeks and the year will contain 53 + weeks. + $EXAMPLES$ + // get info about accounting month containing 9/15/90 + aDateInfo := FT_ACCTMONTH( SToD( "19900915" ) ) + ? aDateInfo[ 1 ] // 199009 (9th month) + ? aDateInfo[ 2 ] // 09/02/90 beginning of month 9 + ? aDateInfo[ 3 ] // 09/29/90 end of month 9 + + // get info about accounting month 5 in year containing 9/15/90 + aDateInfo := FT_ACCTMONTH( SToD( "19900915" ), 5 ) + ? aDateInfo[ 1 ] // 199005 + ? aDateInfo[ 2 ] // 04/29/89 beginning of month 5 + ? aDateInfo[ 3 ] // 06/02/90 end of month 5 + $SEEALSO$ + FT_DATECNFG() FT_ACCTWEEK() FT_ACCTQTR() FT_ACCTYEAR() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/acctqtr.txt b/harbour/contrib/hbnf/doc/en/acctqtr.txt index cb826a8ab2..729fd9582f 100644 --- a/harbour/contrib/hbnf/doc/en/acctqtr.txt +++ b/harbour/contrib/hbnf/doc/en/acctqtr.txt @@ -2,56 +2,56 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ACCTQTR() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Return accounting quarter data - * $SYNTAX$ - * FT_ACCTQTR( [ ], [ ] ) -> aDateinfo - * $ARGUMENTS$ - * is any valid date in any date format. Defaults - * to current system date if not supplied. - * - * is a number from 1 to 4 signifying a quarter. - * Defaults to current quarter if not supplied. - * $RETURNS$ - * A three element array containing the following data: - * - * aDateInfo[ 1 ] - The year and qtr. as a character string "YYYYQQ" - * aDateInfo[ 2 ] - The beginning date of the accounting quarter - * aDateInfo[ 3 ] - The ending date of the accounting quarter - * $DESCRIPTION$ - * FT_ACCTQTR() creates an array containing data about the - * accounting quarter containing the given date. - * - * An accounting period has the following characteristics: - * - * If the first week of the period contains 4 or more 'work' - * days, it is included in the period; otherwise, the first - * week was included in the prior period. - * - * If the last week of the period contains 4 or more 'work' - * days it is included in the period; otherwise, the last week - * is included in the next period. This results in 13 week - * 'quarters' and 4 or 5 week 'months'. Every 5 or 6 years, a - * 'quarter' will contain 14 weeks and the year will contain 53 - * weeks. - * $EXAMPLES$ - * // get info about accounting month containing 9/15/90 - * aDateInfo := FT_ACCTQTR( SToD( "19900915" ) ) - * ? aDateInfo[ 1 ] // 199003 (3rd quarter) - * ? aDateInfo[ 2 ] // 07/01/90 beginning of quarter 3 - * ? aDateInfo[ 3 ] // 09/29/90 end of quarter 3 - * - * // get info about accounting qtr. 2 in year containing 9/15/90 - * aDateInfo := FT_ACCTQTR( SToD( "19900915" ), 2 ) - * ? aDateInfo[ 1 ] // 199002 - * ? aDateInfo[ 2 ] // 04/01/89 beginning of quarter 2 - * ? aDateInfo[ 3 ] // 06/30/90 end of quarter 2 - * $SEEALSO$ - * FT_DATECNFG() FT_ACCTWEEK() FT_ACCTMONTH() FT_ACCTYEAR() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ACCTQTR() + $CATEGORY$ + Date/Time + $ONELINER$ + Return accounting quarter data + $SYNTAX$ + FT_ACCTQTR( [ ], [ ] ) -> aDateinfo + $ARGUMENTS$ + is any valid date in any date format. Defaults + to current system date if not supplied. + + is a number from 1 to 4 signifying a quarter. + Defaults to current quarter if not supplied. + $RETURNS$ + A three element array containing the following data: + + aDateInfo[ 1 ] - The year and qtr. as a character string "YYYYQQ" + aDateInfo[ 2 ] - The beginning date of the accounting quarter + aDateInfo[ 3 ] - The ending date of the accounting quarter + $DESCRIPTION$ + FT_ACCTQTR() creates an array containing data about the + accounting quarter containing the given date. + + An accounting period has the following characteristics: + + If the first week of the period contains 4 or more 'work' + days, it is included in the period; otherwise, the first + week was included in the prior period. + + If the last week of the period contains 4 or more 'work' + days it is included in the period; otherwise, the last week + is included in the next period. This results in 13 week + 'quarters' and 4 or 5 week 'months'. Every 5 or 6 years, a + 'quarter' will contain 14 weeks and the year will contain 53 + weeks. + $EXAMPLES$ + // get info about accounting month containing 9/15/90 + aDateInfo := FT_ACCTQTR( SToD( "19900915" ) ) + ? aDateInfo[ 1 ] // 199003 (3rd quarter) + ? aDateInfo[ 2 ] // 07/01/90 beginning of quarter 3 + ? aDateInfo[ 3 ] // 09/29/90 end of quarter 3 + + // get info about accounting qtr. 2 in year containing 9/15/90 + aDateInfo := FT_ACCTQTR( SToD( "19900915" ), 2 ) + ? aDateInfo[ 1 ] // 199002 + ? aDateInfo[ 2 ] // 04/01/89 beginning of quarter 2 + ? aDateInfo[ 3 ] // 06/30/90 end of quarter 2 + $SEEALSO$ + FT_DATECNFG() FT_ACCTWEEK() FT_ACCTMONTH() FT_ACCTYEAR() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/acctweek.txt b/harbour/contrib/hbnf/doc/en/acctweek.txt index 912f93cbf6..c7e351836b 100644 --- a/harbour/contrib/hbnf/doc/en/acctweek.txt +++ b/harbour/contrib/hbnf/doc/en/acctweek.txt @@ -2,56 +2,56 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ACCTWEEK() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Return accounting week data - * $SYNTAX$ - * FT_ACCTWEEK( [ ], [ ] ) -> aDateInfo - * $ARGUMENTS$ - * is any valid date in any date format. Defaults - * to current system date if not supplied. - * - * is a number from 1 to 52 signifying a week. - * Defaults to current week if not supplied. - * $RETURNS$ - * A three element array containing the following data: - * - * aDateInfo[ 1 ] - The year and week as a character string "YYYYWW" - * aDateInfo[ 2 ] - The beginning date of the accounting week - * aDateInfo[ 3 ] - The ending date of the accounting week - * $DESCRIPTION$ - * FT_ACCTWEEK() returns an array containing data about the - * accounting week containing the given date. - * - * An accounting period has the following characteristics: - * - * If the first week of the period contains 4 or more 'work' - * days, it is included in the period; otherwise, the first - * week was included in the prior period. - * - * If the last week of the period contains 4 or more 'work' - * days it is included in the period; otherwise, the last week - * is included in the next period. This results in 13 week - * 'quarters' and 4 or 5 week 'months'. Every 5 or 6 years, a - * 'quarter' will contain 14 weeks and the year will contain 53 - * weeks. - * $EXAMPLES$ - * // get info about accounting week containing 9/15/90 - * aDateInfo := FT_ACCTWEEK( SToD( "19900915" ) ) - * ? aDateInfo[ 1 ] // 199037 (37th week) - * ? aDateInfo[ 2 ] // 09/09/90 beginning of week 37 - * ? aDateInfo[ 3 ] // 09/15/90 end of week 37 - * - * // get info about accounting week 25 in year containing 9/15/90 - * aDateInfo := FT_ACCTWEEK( SToD( "19900915" ), 25 ) - * ? aDateInfo[ 1 ] // 199025 - * ? aDateInfo[ 2 ] // 06/17/89 beginning of week 25 - * ? aDateInfo[ 3 ] // 06/23/90 end of week 25 - * $SEEALSO$ - * FT_DATECNFG() FT_ACCTMONTH() FT_ACCTQTR() FT_ACCTYEAR() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ACCTWEEK() + $CATEGORY$ + Date/Time + $ONELINER$ + Return accounting week data + $SYNTAX$ + FT_ACCTWEEK( [ ], [ ] ) -> aDateInfo + $ARGUMENTS$ + is any valid date in any date format. Defaults + to current system date if not supplied. + + is a number from 1 to 52 signifying a week. + Defaults to current week if not supplied. + $RETURNS$ + A three element array containing the following data: + + aDateInfo[ 1 ] - The year and week as a character string "YYYYWW" + aDateInfo[ 2 ] - The beginning date of the accounting week + aDateInfo[ 3 ] - The ending date of the accounting week + $DESCRIPTION$ + FT_ACCTWEEK() returns an array containing data about the + accounting week containing the given date. + + An accounting period has the following characteristics: + + If the first week of the period contains 4 or more 'work' + days, it is included in the period; otherwise, the first + week was included in the prior period. + + If the last week of the period contains 4 or more 'work' + days it is included in the period; otherwise, the last week + is included in the next period. This results in 13 week + 'quarters' and 4 or 5 week 'months'. Every 5 or 6 years, a + 'quarter' will contain 14 weeks and the year will contain 53 + weeks. + $EXAMPLES$ + // get info about accounting week containing 9/15/90 + aDateInfo := FT_ACCTWEEK( SToD( "19900915" ) ) + ? aDateInfo[ 1 ] // 199037 (37th week) + ? aDateInfo[ 2 ] // 09/09/90 beginning of week 37 + ? aDateInfo[ 3 ] // 09/15/90 end of week 37 + + // get info about accounting week 25 in year containing 9/15/90 + aDateInfo := FT_ACCTWEEK( SToD( "19900915" ), 25 ) + ? aDateInfo[ 1 ] // 199025 + ? aDateInfo[ 2 ] // 06/17/89 beginning of week 25 + ? aDateInfo[ 3 ] // 06/23/90 end of week 25 + $SEEALSO$ + FT_DATECNFG() FT_ACCTMONTH() FT_ACCTQTR() FT_ACCTYEAR() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/acctyear.txt b/harbour/contrib/hbnf/doc/en/acctyear.txt index a637fe1ce5..f69d9f2969 100644 --- a/harbour/contrib/hbnf/doc/en/acctyear.txt +++ b/harbour/contrib/hbnf/doc/en/acctyear.txt @@ -2,47 +2,47 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ACCTYEAR() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Return accounting year data - * $SYNTAX$ - * FT_ACCTYEAR( [ ] ) -> aDateInfo - * $ARGUMENTS$ - * is any valid date in any date format. Defaults - * to current system date if not supplied. - * $RETURNS$ - * A three element array containing the following data: - * - * aDateInfo[ 1 ] - The year as a character string "YYYY" - * aDateInfo[ 2 ] - The beginning date of the accounting year - * aDateInfo[ 3 ] - The ending date of the accounting year - * $DESCRIPTION$ - * FT_ACCTYEAR() creates an array containing data about the - * accounting year containing the given date. - * - * An accounting period has the following characteristics: - * - * If the first week of the period contains 4 or more 'work' - * days, it is included in the period; otherwise, the first - * week was included in the prior period. - * - * If the last week of the period contains 4 or more 'work' - * days it is included in the period; otherwise, the last week - * is included in the next period. This results in 13 week - * 'quarters' and 4 or 5 week 'months'. Every 5 or 6 years, a - * 'quarter' will contain 14 weeks and the year will contain 53 - * weeks. - * $EXAMPLES$ - * // get info about accounting year containing 9/15/90 - * aDateInfo := FT_ACCTYEAR( SToD( "19900915" ) ) - * ? aDateInfo[ 1 ] // 1990 - * ? aDateInfo[ 2 ] // 12/31/89 beginning of year - * ? aDateInfo[ 3 ] // 12/29/90 end of year - * $SEEALSO$ - * FT_DATECNFG() FT_ACCTWEEK() FT_ACCTMONTH() FT_ACCTQTR() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ACCTYEAR() + $CATEGORY$ + Date/Time + $ONELINER$ + Return accounting year data + $SYNTAX$ + FT_ACCTYEAR( [ ] ) -> aDateInfo + $ARGUMENTS$ + is any valid date in any date format. Defaults + to current system date if not supplied. + $RETURNS$ + A three element array containing the following data: + + aDateInfo[ 1 ] - The year as a character string "YYYY" + aDateInfo[ 2 ] - The beginning date of the accounting year + aDateInfo[ 3 ] - The ending date of the accounting year + $DESCRIPTION$ + FT_ACCTYEAR() creates an array containing data about the + accounting year containing the given date. + + An accounting period has the following characteristics: + + If the first week of the period contains 4 or more 'work' + days, it is included in the period; otherwise, the first + week was included in the prior period. + + If the last week of the period contains 4 or more 'work' + days it is included in the period; otherwise, the last week + is included in the next period. This results in 13 week + 'quarters' and 4 or 5 week 'months'. Every 5 or 6 years, a + 'quarter' will contain 14 weeks and the year will contain 53 + weeks. + $EXAMPLES$ + // get info about accounting year containing 9/15/90 + aDateInfo := FT_ACCTYEAR( SToD( "19900915" ) ) + ? aDateInfo[ 1 ] // 1990 + ? aDateInfo[ 2 ] // 12/31/89 beginning of year + ? aDateInfo[ 3 ] // 12/29/90 end of year + $SEEALSO$ + FT_DATECNFG() FT_ACCTWEEK() FT_ACCTMONTH() FT_ACCTQTR() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/adapter.txt b/harbour/contrib/hbnf/doc/en/adapter.txt index af89956ca0..3de7b06ee1 100644 --- a/harbour/contrib/hbnf/doc/en/adapter.txt +++ b/harbour/contrib/hbnf/doc/en/adapter.txt @@ -2,46 +2,46 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ADAPTER() - * $CATEGORY$ - * Video - * $ONELINER$ - * Report the type of video adapter installed - * $SYNTAX$ - * FT_ADAPTER() -> nResult - * $ARGUMENTS$ - * None - * $RETURNS$ - * Integer representing type of video adapter - * - * 0 - monochrome - * 1 - CGA - * 2 - EGA - * 3 - VGA - * $DESCRIPTION$ - * This function is valuable if you use a graphics library and need to - * know what type of graphics adapter is installed. - * - * The source code is written to adhere to Turbo Assembler's IDEAL mode. - * To use another assembler, you will need to rearrange the PROC and - * SEGMENT directives, and also the ENDP and ENDS directives (a very - * minor task). - * $EXAMPLES$ - * iVideo := FT_ADAPTER() - * - * DO CASE - * CASE iVideo == 0 - * QOut( "You have a monochrome adapter." ) - * CASE iVideo == 1 - * QOut( "You have a CGA adapter." ) - * CASE iVideo == 2 - * QOut( "You have an EGA adapter." ) - * CASE iVideo == 3 - * QOut( "You have a VGA adapter." ) - * ENDCASE - * $SEEALSO$ - * FT_SETMODE() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ADAPTER() + $CATEGORY$ + Video + $ONELINER$ + Report the type of video adapter installed + $SYNTAX$ + FT_ADAPTER() -> nResult + $ARGUMENTS$ + None + $RETURNS$ + Integer representing type of video adapter + + 0 - monochrome + 1 - CGA + 2 - EGA + 3 - VGA + $DESCRIPTION$ + This function is valuable if you use a graphics library and need to + know what type of graphics adapter is installed. + + The source code is written to adhere to Turbo Assembler's IDEAL mode. + To use another assembler, you will need to rearrange the PROC and + SEGMENT directives, and also the ENDP and ENDS directives (a very + minor task). + $EXAMPLES$ + iVideo := FT_ADAPTER() + + DO CASE + CASE iVideo == 0 + QOut( "You have a monochrome adapter." ) + CASE iVideo == 1 + QOut( "You have a CGA adapter." ) + CASE iVideo == 2 + QOut( "You have an EGA adapter." ) + CASE iVideo == 3 + QOut( "You have a VGA adapter." ) + ENDCASE + $SEEALSO$ + FT_SETMODE() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/adessort.txt b/harbour/contrib/hbnf/doc/en/adessort.txt index 148f0c124a..bdcf4de790 100644 --- a/harbour/contrib/hbnf/doc/en/adessort.txt +++ b/harbour/contrib/hbnf/doc/en/adessort.txt @@ -2,34 +2,34 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ADESSORT() - * $CATEGORY$ - * Array - * $ONELINER$ - * Sort an array in descending order - * $SYNTAX$ - * FT_ADESSORT( [, [, ] ] ) -> aSorted - * $ARGUMENTS$ - * is the array to be sorted - * - * is the first array item to include in the sort, - * defaults to first element - * - * is the last array element to include in the sort, - * defaults to all elements - * $RETURNS$ - * The array, sorted in descending order. - * $DESCRIPTION$ - * This function is used to sort an array in descending order, i.e., Z-A - * $EXAMPLES$ - * FT_ADESSORT( aNames ) // Sort the Entire Array - * - * FT_ADESSORT( aNames, 5 ) // Sort from the 5th Element On - * - * FT_ADESSORT( aNames, , 10 ) // Sort the 1st 10 Elements - * - * FT_ADESSORT( aNames, 5, 10 ) // Sort Elements 5-10 - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ADESSORT() + $CATEGORY$ + Array + $ONELINER$ + Sort an array in descending order + $SYNTAX$ + FT_ADESSORT( [, [, ] ] ) -> aSorted + $ARGUMENTS$ + is the array to be sorted + + is the first array item to include in the sort, + defaults to first element + + is the last array element to include in the sort, + defaults to all elements + $RETURNS$ + The array, sorted in descending order. + $DESCRIPTION$ + This function is used to sort an array in descending order, i.e., Z-A + $EXAMPLES$ + FT_ADESSORT( aNames ) // Sort the Entire Array + + FT_ADESSORT( aNames, 5 ) // Sort from the 5th Element On + + FT_ADESSORT( aNames, , 10 ) // Sort the 1st 10 Elements + + FT_ADESSORT( aNames, 5, 10 ) // Sort Elements 5-10 + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/aemaxlen.txt b/harbour/contrib/hbnf/doc/en/aemaxlen.txt index feefea18b3..1536feca3d 100644 --- a/harbour/contrib/hbnf/doc/en/aemaxlen.txt +++ b/harbour/contrib/hbnf/doc/en/aemaxlen.txt @@ -2,47 +2,47 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_AEMAXLEN() - * $CATEGORY$ - * Array - * $ONELINER$ - * Find longest element within an array - * $SYNTAX$ - * FT_AEMAXLEN( [, [, [, ] ] ] ) ; - * -> nMaxlen - * $ARGUMENTS$ - * is the array containing the elements to be measured. - * - * is the array dimension to be measured, - * defaults to first dimension. - * - * is the starting array element to include, - * defaults to first array element. - * - * is the number of array elements to process from - * from , defaults to remaining elements - * in array. - * $RETURNS$ - * The length of the longest size element of an array. - * $DESCRIPTION$ - * This function will measure each element of an array - * dimension and return the longest element. - * $EXAMPLES$ - * FT_AEMAXLEN( aArray ) // Measure the 1st dimension of an Array - * - * FT_AEMAXLEN( aArray, 2 ) // Measure the 2nd dimension of an Array - * - * FT_AEMAXLEN( aArray, 2, , 9 ) // Measure Elements 1-9 of the - * 2nd dimension or subarray - * - * FT_AEMAXLEN( aArray, 3, 5, 9 ) // Measure Elements 5-9 of the - * 3rd dimension or subarray - * - * FT_AEMAXLEN( aArray, 3, 5 ) // Measure Elements 5 to last in the - * 3rd dimension or subarray - * $SEEALSO$ - * FT_AEMINLEN() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_AEMAXLEN() + $CATEGORY$ + Array + $ONELINER$ + Find longest element within an array + $SYNTAX$ + FT_AEMAXLEN( [, [, [, ] ] ] ) ; + -> nMaxlen + $ARGUMENTS$ + is the array containing the elements to be measured. + + is the array dimension to be measured, + defaults to first dimension. + + is the starting array element to include, + defaults to first array element. + + is the number of array elements to process from + from , defaults to remaining elements + in array. + $RETURNS$ + The length of the longest size element of an array. + $DESCRIPTION$ + This function will measure each element of an array + dimension and return the longest element. + $EXAMPLES$ + FT_AEMAXLEN( aArray ) // Measure the 1st dimension of an Array + + FT_AEMAXLEN( aArray, 2 ) // Measure the 2nd dimension of an Array + + FT_AEMAXLEN( aArray, 2, , 9 ) // Measure Elements 1-9 of the + 2nd dimension or subarray + + FT_AEMAXLEN( aArray, 3, 5, 9 ) // Measure Elements 5-9 of the + 3rd dimension or subarray + + FT_AEMAXLEN( aArray, 3, 5 ) // Measure Elements 5 to last in the + 3rd dimension or subarray + $SEEALSO$ + FT_AEMINLEN() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/aeminlen.txt b/harbour/contrib/hbnf/doc/en/aeminlen.txt index d0dab38047..2b46682a6d 100644 --- a/harbour/contrib/hbnf/doc/en/aeminlen.txt +++ b/harbour/contrib/hbnf/doc/en/aeminlen.txt @@ -2,44 +2,44 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_AEMINLEN() - * $CATEGORY$ - * Array - * $ONELINER$ - * Find shortest element within an array - * $SYNTAX$ - * FT_AEMINLEN( [, [, [, ] ] ] ) - * -> nMinlen - * $ARGUMENTS$ - * is the array containing the elements to be measured. - * - * is the array dimension to be measured, - * defaults to first dimension. - * - * is the starting array element to include, - * defaults to first array element. - * - * is the number of array elements to process from - * from , defaults to remaining elements - * in array. - * $RETURNS$ - * The length of the shortest size element of an array. - * $DESCRIPTION$ - * This function will measure each element of an array - * dimension and return the shortest element. - * $EXAMPLES$ - * FT_AEMINLEN( aArray ) // Measure the 1st dimension of an Array - * - * FT_AEMINLEN( aArray, 2 ) // Measure the 2nd dimension of an Array - * - * FT_AEMINLEN( aArray, 2, , 9 ) // Measure Elements 1-9 of 2nd dimension - * - * FT_AEMINLEN( aArray, 3, 5, 9 ) // Measure Elements 5-9 of 3rd dimension - * - * FT_AEMINLEN( aArray, 3, 5 ) // Measure Elements 5 to end of 3rd dimension - * $SEEALSO$ - * FT_AEMAXLEN() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_AEMINLEN() + $CATEGORY$ + Array + $ONELINER$ + Find shortest element within an array + $SYNTAX$ + FT_AEMINLEN( [, [, [, ] ] ] ) + -> nMinlen + $ARGUMENTS$ + is the array containing the elements to be measured. + + is the array dimension to be measured, + defaults to first dimension. + + is the starting array element to include, + defaults to first array element. + + is the number of array elements to process from + from , defaults to remaining elements + in array. + $RETURNS$ + The length of the shortest size element of an array. + $DESCRIPTION$ + This function will measure each element of an array + dimension and return the shortest element. + $EXAMPLES$ + FT_AEMINLEN( aArray ) // Measure the 1st dimension of an Array + + FT_AEMINLEN( aArray, 2 ) // Measure the 2nd dimension of an Array + + FT_AEMINLEN( aArray, 2, , 9 ) // Measure Elements 1-9 of 2nd dimension + + FT_AEMINLEN( aArray, 3, 5, 9 ) // Measure Elements 5-9 of 3rd dimension + + FT_AEMINLEN( aArray, 3, 5 ) // Measure Elements 5 to end of 3rd dimension + $SEEALSO$ + FT_AEMAXLEN() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/alt.txt b/harbour/contrib/hbnf/doc/en/alt.txt index f1e7ff5f75..20c3b38f2b 100644 --- a/harbour/contrib/hbnf/doc/en/alt.txt +++ b/harbour/contrib/hbnf/doc/en/alt.txt @@ -2,29 +2,29 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ALT() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Determine status of the Alt key - * $SYNTAX$ - * FT_ALT() -> lValue - * $ARGUMENTS$ - * None - * $RETURNS$ - * .T. if Alt key is pressed, .F. if otherwise. - * $DESCRIPTION$ - * This function is useful for times you need to know whether or not the - * Alt key is pressed, such as during a MemoEdit(). - * $EXAMPLES$ - * IF FT_ALT() - * @ 24, 0 SAY "Alt" - * ELSE - * @ 24, 0 SAY " " - * ENDIF - * $SEEALSO$ - * FT_CAPLOCK() FT_CTRL() FT_NUMLOCK() FT_PRTSCR() FT_SHIFT() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ALT() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Determine status of the Alt key + $SYNTAX$ + FT_ALT() -> lValue + $ARGUMENTS$ + None + $RETURNS$ + .T. if Alt key is pressed, .F. if otherwise. + $DESCRIPTION$ + This function is useful for times you need to know whether or not the + Alt key is pressed, such as during a MemoEdit(). + $EXAMPLES$ + IF FT_ALT() + @ 24, 0 SAY "Alt" + ELSE + @ 24, 0 SAY " " + ENDIF + $SEEALSO$ + FT_CAPLOCK() FT_CTRL() FT_NUMLOCK() FT_PRTSCR() FT_SHIFT() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/amedian.txt b/harbour/contrib/hbnf/doc/en/amedian.txt index 164ecf2304..b9fff3629a 100644 --- a/harbour/contrib/hbnf/doc/en/amedian.txt +++ b/harbour/contrib/hbnf/doc/en/amedian.txt @@ -2,41 +2,41 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_AMEDIAN() - * $CATEGORY$ - * Array - * $ONELINER$ - * Find middle value in array, or average of two middle values - * $SYNTAX$ - * FT_AMEDIAN( [, [, ] ] ) - * -> nMedian - * $ARGUMENTS$ - * is the array containing the elements to be averaged. - * - * is the first array element to include, - * defaults to first element. - * - * is the last array element to include, - * defaults to last element. - * $RETURNS$ - * The median average of the array elements - * $DESCRIPTION$ - * This function sorts the elements of a numeric array and - * then returns the value in the middle element of the sorted - * array. If there is no exact middle value, then it returns - * the average of the two middle values. Half of the elements - * are > median and half are < median. A median average may - * more reflect a more useful average when there are extreme - * values in the set. - * $EXAMPLES$ - * FT_AMEDIAN( aArray ) // Return Median for entire array - * - * FT_AMEDIAN( aArray, 2 ) // Return Median for elements from 2 to end - * - * FT_AMEDIAN( aArray, , 9 ) // Return Median for 1st 9 elements - * - * FT_AMEDIAN( aArray, 8, 40 ) // Return Median for elements 8 to 40 - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_AMEDIAN() + $CATEGORY$ + Array + $ONELINER$ + Find middle value in array, or average of two middle values + $SYNTAX$ + FT_AMEDIAN( [, [, ] ] ) + -> nMedian + $ARGUMENTS$ + is the array containing the elements to be averaged. + + is the first array element to include, + defaults to first element. + + is the last array element to include, + defaults to last element. + $RETURNS$ + The median average of the array elements + $DESCRIPTION$ + This function sorts the elements of a numeric array and + then returns the value in the middle element of the sorted + array. If there is no exact middle value, then it returns + the average of the two middle values. Half of the elements + are > median and half are < median. A median average may + more reflect a more useful average when there are extreme + values in the set. + $EXAMPLES$ + FT_AMEDIAN( aArray ) // Return Median for entire array + + FT_AMEDIAN( aArray, 2 ) // Return Median for elements from 2 to end + + FT_AMEDIAN( aArray, , 9 ) // Return Median for 1st 9 elements + + FT_AMEDIAN( aArray, 8, 40 ) // Return Median for elements 8 to 40 + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/anomatch.txt b/harbour/contrib/hbnf/doc/en/anomatch.txt index c6d1daa0f7..3e38aa8da7 100644 --- a/harbour/contrib/hbnf/doc/en/anomatch.txt +++ b/harbour/contrib/hbnf/doc/en/anomatch.txt @@ -2,45 +2,45 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ANOMATCHES() - * $CATEGORY$ - * Array - * $ONELINER$ - * Find the number of array elements meeting a condition - * $SYNTAX$ - * FT_ANOMATCHES( , ; - * [, [, ] ] ) -> nNoOfMatches - * $ARGUMENTS$ - * is the array to be searched - * - * is a code block containing the expression for - * the array elements to be tested with. Each element is passed - * as a parameter to the block. If the block returns .T., the - * number of matches will be incremented by one. - * - * is the first array item to include in the search, - * defaults to first element. - * - * is the last array element to include in the search, - * defaults to all elements. - * $RETURNS$ - * The number of elements that cause the code block to return .T. - * $DESCRIPTION$ - * This function returns the number of array elements that, when passed - * to the supplied code block, cause that code block to return a .T. value. - * $EXAMPLES$ - * // Search the Entire Array - * FT_ANOMATCHES( aTries, {| x | x <= 100 } ) - * - * // Search from the 5th Element On - * FT_ANOMATCHES( aCodes, {| x | Upper( x ) == cCurrentCode }, 5 ) - * - * // Search the 1st 10 Elements - * FT_ANOMATCHES( aDates, {| x | IS_BETWEEN( Date() - 7, x, Date() + 7 ) }, 10 ) - * - * // Search Elements 5-10 - * FT_ANOMATCHES( aNames, {| x | x <= cLastGoodName }, 5, 10 ) - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ANOMATCHES() + $CATEGORY$ + Array + $ONELINER$ + Find the number of array elements meeting a condition + $SYNTAX$ + FT_ANOMATCHES( , ; + [, [, ] ] ) -> nNoOfMatches + $ARGUMENTS$ + is the array to be searched + + is a code block containing the expression for + the array elements to be tested with. Each element is passed + as a parameter to the block. If the block returns .T., the + number of matches will be incremented by one. + + is the first array item to include in the search, + defaults to first element. + + is the last array element to include in the search, + defaults to all elements. + $RETURNS$ + The number of elements that cause the code block to return .T. + $DESCRIPTION$ + This function returns the number of array elements that, when passed + to the supplied code block, cause that code block to return a .T. value. + $EXAMPLES$ + // Search the Entire Array + FT_ANOMATCHES( aTries, {| x | x <= 100 } ) + + // Search from the 5th Element On + FT_ANOMATCHES( aCodes, {| x | Upper( x ) == cCurrentCode }, 5 ) + + // Search the 1st 10 Elements + FT_ANOMATCHES( aDates, {| x | IS_BETWEEN( Date() - 7, x, Date() + 7 ) }, 10 ) + + // Search Elements 5-10 + FT_ANOMATCHES( aNames, {| x | x <= cLastGoodName }, 5, 10 ) + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/any2any.txt b/harbour/contrib/hbnf/doc/en/any2any.txt index ba1bc490e9..a675283d1d 100644 --- a/harbour/contrib/hbnf/doc/en/any2any.txt +++ b/harbour/contrib/hbnf/doc/en/any2any.txt @@ -2,35 +2,35 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_XTOY() - * $CATEGORY$ - * Conversion - * $ONELINER$ - * Convert from any data type to any other data type - * $SYNTAX$ - * FT_XTOY( , ; - * [, ] ) -> xResult - * $ARGUMENTS$ - * is the value to convert. - * - * is the type of value to convert to - * ("C","D","L","N","A" or "B"). - * - * is a logical to signal if 'Y' or 'N' is to be returned - * if Converting a logical, otherwise '.T.' or '.F.' will be returned - * for logicals. - * $RETURNS$ - * The original value converted to the new type. - * $DESCRIPTION$ - * This function converts a value of character, date, numeric, logical, - * array or code block type to any of the other type. While it is - * guaranteed to return a value of the correct type, that value may not - * be meaningful (i.e., converting from a code block returns an EMPTY() - * value of the desired type). - * $EXAMPLES$ - * nNumericValue := FT_XTOY( cInputValue, "N" ) - * IF FT_XTOY( nInputValue, "L" ) - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_XTOY() + $CATEGORY$ + Conversion + $ONELINER$ + Convert from any data type to any other data type + $SYNTAX$ + FT_XTOY( , ; + [, ] ) -> xResult + $ARGUMENTS$ + is the value to convert. + + is the type of value to convert to + ("C","D","L","N","A" or "B"). + + is a logical to signal if 'Y' or 'N' is to be returned + if Converting a logical, otherwise '.T.' or '.F.' will be returned + for logicals. + $RETURNS$ + The original value converted to the new type. + $DESCRIPTION$ + This function converts a value of character, date, numeric, logical, + array or code block type to any of the other type. While it is + guaranteed to return a value of the correct type, that value may not + be meaningful (i.e., converting from a code block returns an EMPTY() + value of the desired type). + $EXAMPLES$ + nNumericValue := FT_XTOY( cInputValue, "N" ) + IF FT_XTOY( nInputValue, "L" ) + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/aredit.txt b/harbour/contrib/hbnf/doc/en/aredit.txt index 4e421f3715..ef4fd6c963 100644 --- a/harbour/contrib/hbnf/doc/en/aredit.txt +++ b/harbour/contrib/hbnf/doc/en/aredit.txt @@ -2,74 +2,74 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_AREDIT() - * $CATEGORY$ - * Array - * $ONELINER$ - * 2 dimensional array editing function using TBrowse - * $SYNTAX$ - * FT_AREDIT( , , , , , ; - * , , [, ] ) -> xElement - * $ARGUMENTS$ - * , , , are coordinates for TBrowse - * - * is name of 2 dimensional to array edit - * - * is pointer for element in array - * - * is array of column headings - * - * is array of blocks describing each array element - * - * [ ] is get editing function for handling individual elements - * $RETURNS$ - * Value of element positioned on when exit FT_AREDIT() - * The type of this value depends on what is displayed. - * $DESCRIPTION$ - * This function allows you to position yourself in an array, - * add and delete rows with the and keys, - * and pass a UDF with information to edit the individual gets. - * $EXAMPLES$ - * FT_AREDIT(3, 5, 18, 75, ar, @nElem, aHeadings, aBlocks) - * - * This example will allow you to browse a 2 dimensional array - * But you can't edit it since there is no GetBlock UDF - * It allows the user to hit ENTER to select an element or ESC to - * return 0 - * - * * This second example shows how to edit a 2 dimensional array - * * as might be done to edit an invoice - * - * LOCAL i, ar[ 3, 26 ], aBlocks[ 3 ], aHeadings[ 3 ] - * LOCAL nElem := 1, bGetFunc - * - * * Set up two dimensional array "ar" - * - * FOR i := 1 TO 26 - * ar[ 1, i ] := i // 1 -> 26 Numeric - * ar[ 2, i ] := Chr( Asc( "A" ) + i - 1 ) // "A" -> "Z" Character - * ar[ 3, i ] := Chr( Asc( "Z" ) - i + 1 ) // "Z" -> "A" Character - * NEXT - * - * * SET UP aHeadings Array for column headings - * - * aHeadings := { "Numbers", "Letters", "Reverse" } - * - * * Need to set up individual array blocks for each TBrowse column - * - * aBlocks[ 1 ] := {|| Str( ar[ 1, nElem ], 2 ) } // prevent default 10 spaces - * aBlocks[ 2 ] := {|| ar[ 2, nElem ] } - * aBlocks[ 3 ] := {|| ar[ 3, nElem ] } - * - * * set up TestGet() as the passed Get Function so FT_ArEdit knows how - * * to edit the individual gets. - * - * bGetFunc := {| b, ar, nDim, nElem | TestGet( b, ar, nDim, nElem ) } - * SetColor( "N/W, W/N, , , W/N" ) - * CLS - * FT_AREDIT( 3, 5, 18, 75, ar, @nElem, aHeadings, aBlocks, bGetFunc ) - * - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_AREDIT() + $CATEGORY$ + Array + $ONELINER$ + 2 dimensional array editing function using TBrowse + $SYNTAX$ + FT_AREDIT( , , , , , ; + , , [, ] ) -> xElement + $ARGUMENTS$ + , , , are coordinates for TBrowse + + is name of 2 dimensional to array edit + + is pointer for element in array + + is array of column headings + + is array of blocks describing each array element + + [ ] is get editing function for handling individual elements + $RETURNS$ + Value of element positioned on when exit FT_AREDIT() + The type of this value depends on what is displayed. + $DESCRIPTION$ + This function allows you to position yourself in an array, + add and delete rows with the and keys, + and pass a UDF with information to edit the individual gets. + $EXAMPLES$ + FT_AREDIT(3, 5, 18, 75, ar, @nElem, aHeadings, aBlocks) + + This example will allow you to browse a 2 dimensional array + But you can't edit it since there is no GetBlock UDF + It allows the user to hit ENTER to select an element or ESC to + return 0 + + * This second example shows how to edit a 2 dimensional array + * as might be done to edit an invoice + + LOCAL i, ar[ 3, 26 ], aBlocks[ 3 ], aHeadings[ 3 ] + LOCAL nElem := 1, bGetFunc + + * Set up two dimensional array "ar" + + FOR i := 1 TO 26 + ar[ 1, i ] := i // 1 -> 26 Numeric + ar[ 2, i ] := Chr( Asc( "A" ) + i - 1 ) // "A" -> "Z" Character + ar[ 3, i ] := Chr( Asc( "Z" ) - i + 1 ) // "Z" -> "A" Character + NEXT + + * SET UP aHeadings Array for column headings + + aHeadings := { "Numbers", "Letters", "Reverse" } + + * Need to set up individual array blocks for each TBrowse column + + aBlocks[ 1 ] := {|| Str( ar[ 1, nElem ], 2 ) } // prevent default 10 spaces + aBlocks[ 2 ] := {|| ar[ 2, nElem ] } + aBlocks[ 3 ] := {|| ar[ 3, nElem ] } + + * set up TestGet() as the passed Get Function so FT_ArEdit knows how + * to edit the individual gets. + + bGetFunc := {| b, ar, nDim, nElem | TestGet( b, ar, nDim, nElem ) } + SetColor( "N/W, W/N, , , W/N" ) + CLS + FT_AREDIT( 3, 5, 18, 75, ar, @nElem, aHeadings, aBlocks, bGetFunc ) + + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/asum.txt b/harbour/contrib/hbnf/doc/en/asum.txt index 642618612b..7055bd799c 100644 --- a/harbour/contrib/hbnf/doc/en/asum.txt +++ b/harbour/contrib/hbnf/doc/en/asum.txt @@ -2,35 +2,35 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ASUM() - * $CATEGORY$ - * Array - * $ONELINER$ - * Sum the elements of an array - * $SYNTAX$ - * FT_ASUM( [, [, ] ] ) -> nSum - * $ARGUMENTS$ - * is the array containing the elements to be summed. - * - * is the first array item to include, - * defaults to first element. - * - * is the last array element to include, - * defaults to all elements. - * $RETURNS$ - * The sum of the elements of the array or the lengths of the elements. - * $DESCRIPTION$ - * This function is to sum the elements of a numeric array or to sum the - * lengths of a character array. - * $EXAMPLES$ - * FT_ASUM( aSubTotals ) // Sum the Entire Array - * - * FT_ASUM( aSubTotals, 5 ) // Sum from the 5th Element On - * - * FT_ASUM( aSubTotals, , 10 ) // Sum the 1st 10 Elements - * - * FT_ASUM( aSubTotals, 5, 10 ) // Sum Elements 5-10 - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ASUM() + $CATEGORY$ + Array + $ONELINER$ + Sum the elements of an array + $SYNTAX$ + FT_ASUM( [, [, ] ] ) -> nSum + $ARGUMENTS$ + is the array containing the elements to be summed. + + is the first array item to include, + defaults to first element. + + is the last array element to include, + defaults to all elements. + $RETURNS$ + The sum of the elements of the array or the lengths of the elements. + $DESCRIPTION$ + This function is to sum the elements of a numeric array or to sum the + lengths of a character array. + $EXAMPLES$ + FT_ASUM( aSubTotals ) // Sum the Entire Array + + FT_ASUM( aSubTotals, 5 ) // Sum from the 5th Element On + + FT_ASUM( aSubTotals, , 10 ) // Sum the 1st 10 Elements + + FT_ASUM( aSubTotals, 5, 10 ) // Sum Elements 5-10 + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/at2.txt b/harbour/contrib/hbnf/doc/en/at2.txt index 6ebbb493e8..c5fc21b4b3 100644 --- a/harbour/contrib/hbnf/doc/en/at2.txt +++ b/harbour/contrib/hbnf/doc/en/at2.txt @@ -2,80 +2,80 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_AT2() - * $CATEGORY$ - * String - * $ONELINER$ - * Find position of the nth occurrence of a substring - * $SYNTAX$ - * FT_AT2( , [, [, ] ] ) -> nPos - * $ARGUMENTS$ - * is the character substring to search for. - * - * is the character string to search. - * - * is the occurrence of cSearch to look for, - * defaults to 1. - * - * is a logical value denoting case sensitivity. - * If .F., then search is NOT sensitive to case, - * defaults to .T. - * $RETURNS$ - * The position of the nth occurrence of a substring - * $DESCRIPTION$ - * This function will find the nth occurrence of a substring - * within a string. - * $EXAMPLES$ - * cSearch := "t" - * cTarget := "This is the day that the Lord has made." - * - * FT_AT2( cSearch, cTarget ) // Returns ( 9 ) - * - * FT_AT2( cSearch, cTarget, 2 ) // Returns ( 17 ) - * - * FT_AT2( cSearch, cTarget, 2, .F. ) // Returns ( 9 ) - * $SEEALSO$ - * FT_FINDITH(), FT_RAT2() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_AT2() + $CATEGORY$ + String + $ONELINER$ + Find position of the nth occurrence of a substring + $SYNTAX$ + FT_AT2( , [, [, ] ] ) -> nPos + $ARGUMENTS$ + is the character substring to search for. + + is the character string to search. + + is the occurrence of cSearch to look for, + defaults to 1. + + is a logical value denoting case sensitivity. + If .F., then search is NOT sensitive to case, + defaults to .T. + $RETURNS$ + The position of the nth occurrence of a substring + $DESCRIPTION$ + This function will find the nth occurrence of a substring + within a string. + $EXAMPLES$ + cSearch := "t" + cTarget := "This is the day that the Lord has made." + + FT_AT2( cSearch, cTarget ) // Returns ( 9 ) + + FT_AT2( cSearch, cTarget, 2 ) // Returns ( 17 ) + + FT_AT2( cSearch, cTarget, 2, .F. ) // Returns ( 9 ) + $SEEALSO$ + FT_FINDITH(), FT_RAT2() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_RAT2() - * $CATEGORY$ - * String - * $ONELINER$ - * Find position of the reversed nth occurrence of a substring - * $SYNTAX$ - * FT_RAT2( , [, [, ] ] ) -> nPos - * $ARGUMENTS$ - * is the character substring to search for. - * - * is the character string to search. - * - * is the occurrence of cSearch to look for, - * defaults to 1. - * - * is a logical value denoting case sensitivity. - * If .F., then search is NOT sensitive to case, - * defaults to .T. - * $RETURNS$ - * The position of the nth occurrence of a reversed substring - * $DESCRIPTION$ - * This function will find the nth occurrence of a reversed - * substring within a string. - * $EXAMPLES$ - * cSearch := "t" - * cTarget := "This is the day that the Lord has made." - * - * FT_RAT2( cSearch, cTarget ) // Returns ( 22 ) - * - * FT_RAT2( cSearch, cTarget, 2 ) // Returns ( 20 ) - * - * FT_RAT2( cSearch, cTarget, 2, .F. ) // Returns ( 22 ) - * $SEEALSO$ - * FT_FINDITH(), FT_AT2() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_RAT2() + $CATEGORY$ + String + $ONELINER$ + Find position of the reversed nth occurrence of a substring + $SYNTAX$ + FT_RAT2( , [, [, ] ] ) -> nPos + $ARGUMENTS$ + is the character substring to search for. + + is the character string to search. + + is the occurrence of cSearch to look for, + defaults to 1. + + is a logical value denoting case sensitivity. + If .F., then search is NOT sensitive to case, + defaults to .T. + $RETURNS$ + The position of the nth occurrence of a reversed substring + $DESCRIPTION$ + This function will find the nth occurrence of a reversed + substring within a string. + $EXAMPLES$ + cSearch := "t" + cTarget := "This is the day that the Lord has made." + + FT_RAT2( cSearch, cTarget ) // Returns ( 22 ) + + FT_RAT2( cSearch, cTarget, 2 ) // Returns ( 20 ) + + FT_RAT2( cSearch, cTarget, 2, .F. ) // Returns ( 22 ) + $SEEALSO$ + FT_FINDITH(), FT_AT2() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/bitclr.txt b/harbour/contrib/hbnf/doc/en/bitclr.txt index 36c78b9d52..30ecf2779d 100644 --- a/harbour/contrib/hbnf/doc/en/bitclr.txt +++ b/harbour/contrib/hbnf/doc/en/bitclr.txt @@ -2,44 +2,44 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_BITCLR() - * $CATEGORY$ - * String - * $ONELINER$ - * Clear (reset) selected bit in a byte - * $SYNTAX$ - * FT_BITCLR( , ) -> cByte - * $ARGUMENTS$ - * is a character from Chr(0) to Chr(255). - * - * is a number from 0 to 7 conforming to standard - * right-to-left bit numbering convention and representing the - * position of the bit within the byte. - * $RETURNS$ - * Returns new byte, with designated bit cleared (reset). - * If parameters are faulty, returns NIL. - * $DESCRIPTION$ - * In effect, ANDs argument byte with a byte that has all bits set except - * the target bit. If bit is already clear (0), it remains clear. - * Note: Calls FT_ISBIT() which is also in this Library. - * - * This function is presented to illustrate that bit-wise operations - * are possible with Clipper code. For greater speed, write .c or - * .asm versions and use the Clipper Extend system. - * $EXAMPLES$ - * This code would clear bit 4 in a byte represented by Chr( 115 ): - * - * cNewByte := FT_BITCLR( Chr( 115 ), 4 ) - * ? Asc( cNewbyte ) // result: 99 - * ? cNewByte // result: "c" - * - * This code would clear bit 5 in the byte represented by letter "A": - * - * FT_BITCLR( "A", 5 ) // result: "A", since - * // bit 5 already clear - * $SEEALSO$ - * FT_BITSET() FT_ISBIT() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_BITCLR() + $CATEGORY$ + String + $ONELINER$ + Clear (reset) selected bit in a byte + $SYNTAX$ + FT_BITCLR( , ) -> cByte + $ARGUMENTS$ + is a character from Chr(0) to Chr(255). + + is a number from 0 to 7 conforming to standard + right-to-left bit numbering convention and representing the + position of the bit within the byte. + $RETURNS$ + Returns new byte, with designated bit cleared (reset). + If parameters are faulty, returns NIL. + $DESCRIPTION$ + In effect, ANDs argument byte with a byte that has all bits set except + the target bit. If bit is already clear (0), it remains clear. + Note: Calls FT_ISBIT() which is also in this Library. + + This function is presented to illustrate that bit-wise operations + are possible with Clipper code. For greater speed, write .c or + .asm versions and use the Clipper Extend system. + $EXAMPLES$ + This code would clear bit 4 in a byte represented by Chr( 115 ): + + cNewByte := FT_BITCLR( Chr( 115 ), 4 ) + ? Asc( cNewbyte ) // result: 99 + ? cNewByte // result: "c" + + This code would clear bit 5 in the byte represented by letter "A": + + FT_BITCLR( "A", 5 ) // result: "A", since + // bit 5 already clear + $SEEALSO$ + FT_BITSET() FT_ISBIT() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/bitset.txt b/harbour/contrib/hbnf/doc/en/bitset.txt index e90fcbe6d3..98363615c3 100644 --- a/harbour/contrib/hbnf/doc/en/bitset.txt +++ b/harbour/contrib/hbnf/doc/en/bitset.txt @@ -2,45 +2,45 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_BITSET() - * $CATEGORY$ - * String - * $ONELINER$ - * Set selected bit in a byte - * $SYNTAX$ - * FT_BITSET( , ) -> cByte - * $ARGUMENTS$ - * is a character from Chr(0) to Chr(255). - * - * is a number from 0 to 7 conforming to standard right-to-left - * bit numbering convention and representing the position of the bit - * within the byte. - * $RETURNS$ - * Returns new byte, with designated bit set. If parameters are faulty, - * returns NIL. - * $DESCRIPTION$ - * In effect, ORs argument byte with a byte that has only the target bit - * set. If bit is already set, it remains set. - * Note: Calls FT_ISBIT() which is also in this Library. - * - * This function is presented to illustrate that bit-wise operations - * are possible with Clipper code. For greater speed, write .c or - * .asm versions and use the Clipper Extend system. - * $EXAMPLES$ - * This code would set bit 4 in a byte represented by Chr( 107 ): - * - * cNewbyte := FT_BITSET( Chr( 107 ), 4 ) - * ? Asc( cNewbyte ) // result: 123 - * ? cNewbyte // result: "{" - * - * - * This code would set bit 5 in the byte represented by the letter "A". - * - * ? FT_BITSET( "A", 5 ) // result: "a" - * // bit 5 set - * $SEEALSO$ - * FT_BITCLR() FT_ISBIT() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_BITSET() + $CATEGORY$ + String + $ONELINER$ + Set selected bit in a byte + $SYNTAX$ + FT_BITSET( , ) -> cByte + $ARGUMENTS$ + is a character from Chr(0) to Chr(255). + + is a number from 0 to 7 conforming to standard right-to-left + bit numbering convention and representing the position of the bit + within the byte. + $RETURNS$ + Returns new byte, with designated bit set. If parameters are faulty, + returns NIL. + $DESCRIPTION$ + In effect, ORs argument byte with a byte that has only the target bit + set. If bit is already set, it remains set. + Note: Calls FT_ISBIT() which is also in this Library. + + This function is presented to illustrate that bit-wise operations + are possible with Clipper code. For greater speed, write .c or + .asm versions and use the Clipper Extend system. + $EXAMPLES$ + This code would set bit 4 in a byte represented by Chr( 107 ): + + cNewbyte := FT_BITSET( Chr( 107 ), 4 ) + ? Asc( cNewbyte ) // result: 123 + ? cNewbyte // result: "{" + + + This code would set bit 5 in the byte represented by the letter "A". + + ? FT_BITSET( "A", 5 ) // result: "a" + // bit 5 set + $SEEALSO$ + FT_BITCLR() FT_ISBIT() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/blink.txt b/harbour/contrib/hbnf/doc/en/blink.txt index 8570608cd0..045ee71d95 100644 --- a/harbour/contrib/hbnf/doc/en/blink.txt +++ b/harbour/contrib/hbnf/doc/en/blink.txt @@ -2,30 +2,30 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_BLINK() - * $CATEGORY$ - * Menus/Prompts - * $ONELINER$ - * Display a blinking message on the screen - * $SYNTAX$ - * FT_BLINK( , [ ], [ ] ) -> NIL - * $ARGUMENTS$ - * is the string to blink. - * - * is an optional screen row for @...SAY, default current. - * - * is an optional screen col for @...say, default current. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * A quick way to blink a msg on screen in the CURRENT colors. - * Restores colors on return. - * $EXAMPLES$ - * FT_BLINK( "WAIT", 5, 10 ) // Blinks "WAIT" in current colors @ 5,10 - * - * @ 5,10 SAY "WAIT - Printing Report" - * FT_BLINK( "..." ) // Blink "..." after wait message... - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_BLINK() + $CATEGORY$ + Menus/Prompts + $ONELINER$ + Display a blinking message on the screen + $SYNTAX$ + FT_BLINK( , [ ], [ ] ) -> NIL + $ARGUMENTS$ + is the string to blink. + + is an optional screen row for @...SAY, default current. + + is an optional screen col for @...say, default current. + $RETURNS$ + NIL + $DESCRIPTION$ + A quick way to blink a msg on screen in the CURRENT colors. + Restores colors on return. + $EXAMPLES$ + FT_BLINK( "WAIT", 5, 10 ) // Blinks "WAIT" in current colors @ 5,10 + + @ 5,10 SAY "WAIT - Printing Report" + FT_BLINK( "..." ) // Blink "..." after wait message... + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/byt2bit.txt b/harbour/contrib/hbnf/doc/en/byt2bit.txt index 2556470f7c..911a5f7e8c 100644 --- a/harbour/contrib/hbnf/doc/en/byt2bit.txt +++ b/harbour/contrib/hbnf/doc/en/byt2bit.txt @@ -2,41 +2,41 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_BYT2BIT() - * $CATEGORY$ - * Conversion - * $ONELINER$ - * Convert byte to string of 1's and 0's - * $SYNTAX$ - * FT_BYT2BIT( ) -> cBitPattern - * $ARGUMENTS$ - * is the byte to convert. - * $RETURNS$ - * 9-character string, consisting of 1's and 0's, representing bits 0 - * through 7 of parameter byte, with space between bits 3 and 4. Returns - * NIL if parameters are faulty. - * $DESCRIPTION$ - * Can be used to show results of bit manipulation, both before and after. - * Binary representation follows right-to-left convention of bit position - * numbering, 0 through 7. Space between high and low nibbles for clarity - * and easy comparison to hexadecimal notation. - * - * This function is presented to illustrate that bit-wise operations - * are possible with Clipper code. For greater speed, write .c or - * .asm versions and use the Clipper Extend system. - * $EXAMPLES$ - * These three code lines perform a bitwise AND on bytes with values of - * Chr(20) and Chr(36), and deliver the result as a string in binary (bit) - * format. - * - * ? FT_BYT2BIT( Chr( 20 ) ) // byte1: '0001 0100' - * ? FT_BYT2BIT( Chr( 36 ) ) // byte2: '0010 0100' - * - * ? FT_BYT2BIT( FT_BYTEAND( Chr( 20 ), Chr( 36 ) ) ) - * // result: '0000 0100' - * $SEEALSO$ - * FT_BYT2HEX() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_BYT2BIT() + $CATEGORY$ + Conversion + $ONELINER$ + Convert byte to string of 1's and 0's + $SYNTAX$ + FT_BYT2BIT( ) -> cBitPattern + $ARGUMENTS$ + is the byte to convert. + $RETURNS$ + 9-character string, consisting of 1's and 0's, representing bits 0 + through 7 of parameter byte, with space between bits 3 and 4. Returns + NIL if parameters are faulty. + $DESCRIPTION$ + Can be used to show results of bit manipulation, both before and after. + Binary representation follows right-to-left convention of bit position + numbering, 0 through 7. Space between high and low nibbles for clarity + and easy comparison to hexadecimal notation. + + This function is presented to illustrate that bit-wise operations + are possible with Clipper code. For greater speed, write .c or + .asm versions and use the Clipper Extend system. + $EXAMPLES$ + These three code lines perform a bitwise AND on bytes with values of + Chr(20) and Chr(36), and deliver the result as a string in binary (bit) + format. + + ? FT_BYT2BIT( Chr( 20 ) ) // byte1: '0001 0100' + ? FT_BYT2BIT( Chr( 36 ) ) // byte2: '0010 0100' + + ? FT_BYT2BIT( FT_BYTEAND( Chr( 20 ), Chr( 36 ) ) ) + // result: '0000 0100' + $SEEALSO$ + FT_BYT2HEX() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/byt2hex.txt b/harbour/contrib/hbnf/doc/en/byt2hex.txt index 2ed485a1a0..f92db02a43 100644 --- a/harbour/contrib/hbnf/doc/en/byt2hex.txt +++ b/harbour/contrib/hbnf/doc/en/byt2hex.txt @@ -2,38 +2,38 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_BYT2HEX() - * $CATEGORY$ - * Conversion - * $ONELINER$ - * Convert byte to hexadecimal version of its binary value - * $SYNTAX$ - * FT_BYT2HEX( cByte ) -> cHexValue - * $ARGUMENTS$ - * is the byte to convert. - * $RETURNS$ - * Three-character string, consisting of two digits of hexadecimal - * notation and letter 'h' to signify hex. Returns NIL if parameters are - * faulty. - * $DESCRIPTION$ - * Can be used to show results of bit manipulation, both before and after. - * - * This function is presented to illustrate that bit-wise operations - * are possible with Clipper code. For greater speed, write .c or - * .asm versions and use the Clipper Extend system. - * $EXAMPLES$ - * These three code lines perform a bitwise AND on bytes with values of - * Chr(20) and Chr(36), and deliver the result as a string in hexadecimal - * format, using 'h' to signify hexadecimal. - * - * ? FT_BYT2HEX( Chr( 20 ) ) // byte1: '14h' - * ? FT_BYT2HEX( Chr( 36 ) ) // byte2: '24h' - * - * ? FT_BYT2HEX( FT_BYTEAND( Chr( 20 ), Chr( 36 ) ) ) - * // result: '04h' - * $SEEALSO$ - * FT_BYT2BIT() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_BYT2HEX() + $CATEGORY$ + Conversion + $ONELINER$ + Convert byte to hexadecimal version of its binary value + $SYNTAX$ + FT_BYT2HEX( cByte ) -> cHexValue + $ARGUMENTS$ + is the byte to convert. + $RETURNS$ + Three-character string, consisting of two digits of hexadecimal + notation and letter 'h' to signify hex. Returns NIL if parameters are + faulty. + $DESCRIPTION$ + Can be used to show results of bit manipulation, both before and after. + + This function is presented to illustrate that bit-wise operations + are possible with Clipper code. For greater speed, write .c or + .asm versions and use the Clipper Extend system. + $EXAMPLES$ + These three code lines perform a bitwise AND on bytes with values of + Chr(20) and Chr(36), and deliver the result as a string in hexadecimal + format, using 'h' to signify hexadecimal. + + ? FT_BYT2HEX( Chr( 20 ) ) // byte1: '14h' + ? FT_BYT2HEX( Chr( 36 ) ) // byte2: '24h' + + ? FT_BYT2HEX( FT_BYTEAND( Chr( 20 ), Chr( 36 ) ) ) + // result: '04h' + $SEEALSO$ + FT_BYT2BIT() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/byteand.txt b/harbour/contrib/hbnf/doc/en/byteand.txt index 58cc01c3d6..cf8e78c1e5 100644 --- a/harbour/contrib/hbnf/doc/en/byteand.txt +++ b/harbour/contrib/hbnf/doc/en/byteand.txt @@ -2,38 +2,38 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_BYTEAND() - * $CATEGORY$ - * String - * $ONELINER$ - * Perform bit-wise AND on two ASCII characters (bytes) - * $SYNTAX$ - * FT_BYTEAND( , ) -> cByte - * $ARGUMENTS$ - * and are characters from Chr(0) TO Chr(255). - * May be passed in Chr() form, as character literals, or as expressions - * evaluating to Chr() values. - * $RETURNS$ - * Returns resulting byte, in Chr() form. If parameters are faulty, - * returns NIL. - * $DESCRIPTION$ - * Can be used for any bit-wise masking operation. In effect, this is a - * bit-by-bit AND operation. Equivalent to AND assembler instruction. - * - * This function is presented to illustrate that bit-wise operations - * are possible with Clipper code. For greater speed, write .c or - * .asm versions and use the Clipper Extend system. - * $EXAMPLES$ - * This code would mask out the high nibble (four most significant bits) - * of the byte represented by Chr(123) and leave the low nibble bits as in - * the parameter byte. - * - * cNewbyte := FT_BYTEAND( Chr( 123 ), Chr( 15 ) ) - * ? Asc( cNewByte ) // result: 11 - * ? cNewByte // result: non-printable character - * $SEEALSO$ - * FT_BYTEOR() FT_BYTEXOR() FT_BYTENOT() FT_BYTENEG() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_BYTEAND() + $CATEGORY$ + String + $ONELINER$ + Perform bit-wise AND on two ASCII characters (bytes) + $SYNTAX$ + FT_BYTEAND( , ) -> cByte + $ARGUMENTS$ + and are characters from Chr(0) TO Chr(255). + May be passed in Chr() form, as character literals, or as expressions + evaluating to Chr() values. + $RETURNS$ + Returns resulting byte, in Chr() form. If parameters are faulty, + returns NIL. + $DESCRIPTION$ + Can be used for any bit-wise masking operation. In effect, this is a + bit-by-bit AND operation. Equivalent to AND assembler instruction. + + This function is presented to illustrate that bit-wise operations + are possible with Clipper code. For greater speed, write .c or + .asm versions and use the Clipper Extend system. + $EXAMPLES$ + This code would mask out the high nibble (four most significant bits) + of the byte represented by Chr(123) and leave the low nibble bits as in + the parameter byte. + + cNewbyte := FT_BYTEAND( Chr( 123 ), Chr( 15 ) ) + ? Asc( cNewByte ) // result: 11 + ? cNewByte // result: non-printable character + $SEEALSO$ + FT_BYTEOR() FT_BYTEXOR() FT_BYTENOT() FT_BYTENEG() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/byteneg.txt b/harbour/contrib/hbnf/doc/en/byteneg.txt index 2499201f0d..3a905e41bd 100644 --- a/harbour/contrib/hbnf/doc/en/byteneg.txt +++ b/harbour/contrib/hbnf/doc/en/byteneg.txt @@ -2,36 +2,36 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_BYTENEG() - * $CATEGORY$ - * String - * $ONELINER$ - * Perform bit-wise negation on an ASCII character - * $SYNTAX$ - * FT_BYTENEG( ) -> cNewByte - * $ARGUMENTS$ - * is a character from Chr(0) to Chr(255). - * May be passed in Chr() form, as character literal, or - * as expression evaluating to Chr() value. - * $RETURNS$ - * Returns resulting byte, in Chr() form. If parameters are faulty, - * returns NIL. - * $DESCRIPTION$ - * Can be used for bit-wise byte manipulation. In effect, this is a - * bit-by-bit NEG (two's complement) operation. Equivalent to NEG - * assembler instruction. - * - * This function is presented to illustrate that bit-wise operations - * are possible with Clipper code. For greater speed, write .c or - * .asm versions and use the Clipper Extend system. - * $EXAMPLES$ - * This code performs a bit-wise NEG on byte represented by Chr( 32 ): - * - * cNewByte := FT_BYTENOT( Chr( 32 ) ) - * ? Asc( cNewByte ) // result: 224 - * $SEEALSO$ - * FT_BYTEOR() FT_BYTEXOR() FT_BYTENOT() FT_BYTEAND() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_BYTENEG() + $CATEGORY$ + String + $ONELINER$ + Perform bit-wise negation on an ASCII character + $SYNTAX$ + FT_BYTENEG( ) -> cNewByte + $ARGUMENTS$ + is a character from Chr(0) to Chr(255). + May be passed in Chr() form, as character literal, or + as expression evaluating to Chr() value. + $RETURNS$ + Returns resulting byte, in Chr() form. If parameters are faulty, + returns NIL. + $DESCRIPTION$ + Can be used for bit-wise byte manipulation. In effect, this is a + bit-by-bit NEG (two's complement) operation. Equivalent to NEG + assembler instruction. + + This function is presented to illustrate that bit-wise operations + are possible with Clipper code. For greater speed, write .c or + .asm versions and use the Clipper Extend system. + $EXAMPLES$ + This code performs a bit-wise NEG on byte represented by Chr( 32 ): + + cNewByte := FT_BYTENOT( Chr( 32 ) ) + ? Asc( cNewByte ) // result: 224 + $SEEALSO$ + FT_BYTEOR() FT_BYTEXOR() FT_BYTENOT() FT_BYTEAND() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/bytenot.txt b/harbour/contrib/hbnf/doc/en/bytenot.txt index e8e1a9ecb0..793af7b7bb 100644 --- a/harbour/contrib/hbnf/doc/en/bytenot.txt +++ b/harbour/contrib/hbnf/doc/en/bytenot.txt @@ -2,36 +2,36 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_BYTENOT() - * $CATEGORY$ - * String - * $ONELINER$ - * Perform bit-wise NOT on an ASCII character (byte) - * $SYNTAX$ - * FT_BYTENOT( ) -> cNewByte - * $ARGUMENTS$ - * is a character from Chr(0) to Chr(255). - * May be passed in Chr() form, as character literal, or - * as expression evaluating to Chr() value. - * $RETURNS$ - * Returns resulting byte, in Chr() form. If parameters are faulty, - * returns NIL. - * $DESCRIPTION$ - * Can be used for bitwise byte manipulation. In effect, this is a - * bit-by-bit NOT (one's complement) operation. Equivalent to the - * NOT assembler instruction. - * - * This function is presented to illustrate that bit-wise operations - * are possible with Clipper code. For greater speed, write .c or - * .asm versions and use the Clipper Extend system. - * $EXAMPLES$ - * This code performs a bitwise NOT on byte represented by Chr( 32 ): - * - * cNewByte := FT_BYTENOT( Chr( 32 ) ) - * ? Asc( cNewByte ) // result: 223 - * $SEEALSO$ - * FT_BYTEOR() FT_BYTEXOR() FT_BYTENEG() FT_BYTEAND() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_BYTENOT() + $CATEGORY$ + String + $ONELINER$ + Perform bit-wise NOT on an ASCII character (byte) + $SYNTAX$ + FT_BYTENOT( ) -> cNewByte + $ARGUMENTS$ + is a character from Chr(0) to Chr(255). + May be passed in Chr() form, as character literal, or + as expression evaluating to Chr() value. + $RETURNS$ + Returns resulting byte, in Chr() form. If parameters are faulty, + returns NIL. + $DESCRIPTION$ + Can be used for bitwise byte manipulation. In effect, this is a + bit-by-bit NOT (one's complement) operation. Equivalent to the + NOT assembler instruction. + + This function is presented to illustrate that bit-wise operations + are possible with Clipper code. For greater speed, write .c or + .asm versions and use the Clipper Extend system. + $EXAMPLES$ + This code performs a bitwise NOT on byte represented by Chr( 32 ): + + cNewByte := FT_BYTENOT( Chr( 32 ) ) + ? Asc( cNewByte ) // result: 223 + $SEEALSO$ + FT_BYTEOR() FT_BYTEXOR() FT_BYTENEG() FT_BYTEAND() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/byteor.txt b/harbour/contrib/hbnf/doc/en/byteor.txt index 1f2d4ca906..5005ad6bd3 100644 --- a/harbour/contrib/hbnf/doc/en/byteor.txt +++ b/harbour/contrib/hbnf/doc/en/byteor.txt @@ -2,37 +2,37 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_BYTEOR() - * $CATEGORY$ - * String - * $ONELINER$ - * Perform bit-wise OR on two ASCII characters (bytes) - * $SYNTAX$ - * FT_BYTEOR( , ) -> cNewByte - * $ARGUMENTS$ - * and are characters from Chr(0) TO Chr(255). - * May be passed in Chr() form, as character literals, or as - * expressions evaluating to Chr() values. - * $RETURNS$ - * Returns resulting byte, in Chr() form. If parameters are faulty, - * returns NIL. - * $DESCRIPTION$ - * Can be used for bit-wise byte manipulation. In effect, this is a - * bit-by-bit OR operation. Equivalent to OR assembler instruction. - * - * This function is presented to illustrate that bit-wise operations - * are possible with Clipper code. For greater speed, write .c or - * .asm versions and use the Clipper Extend system. - * $EXAMPLES$ - * This code performs a bit-wise OR on two bytes represented - * by Chr( 20 ) and Chr( 10 ): - * - * cNewByte := FT_BYTEOR( Chr( 20 ), Chr( 10 ) ) - * ? Asc( cNewByte ) // result: 30 - * ? cNewByte // result: non-printable character - * $SEEALSO$ - * FT_BYTEXOR() FT_BYTENOT() FT_BYTENEG() FT_BYTEAND() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_BYTEOR() + $CATEGORY$ + String + $ONELINER$ + Perform bit-wise OR on two ASCII characters (bytes) + $SYNTAX$ + FT_BYTEOR( , ) -> cNewByte + $ARGUMENTS$ + and are characters from Chr(0) TO Chr(255). + May be passed in Chr() form, as character literals, or as + expressions evaluating to Chr() values. + $RETURNS$ + Returns resulting byte, in Chr() form. If parameters are faulty, + returns NIL. + $DESCRIPTION$ + Can be used for bit-wise byte manipulation. In effect, this is a + bit-by-bit OR operation. Equivalent to OR assembler instruction. + + This function is presented to illustrate that bit-wise operations + are possible with Clipper code. For greater speed, write .c or + .asm versions and use the Clipper Extend system. + $EXAMPLES$ + This code performs a bit-wise OR on two bytes represented + by Chr( 20 ) and Chr( 10 ): + + cNewByte := FT_BYTEOR( Chr( 20 ), Chr( 10 ) ) + ? Asc( cNewByte ) // result: 30 + ? cNewByte // result: non-printable character + $SEEALSO$ + FT_BYTEXOR() FT_BYTENOT() FT_BYTENEG() FT_BYTEAND() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/bytexor.txt b/harbour/contrib/hbnf/doc/en/bytexor.txt index 9670992424..e17eaa2d6b 100644 --- a/harbour/contrib/hbnf/doc/en/bytexor.txt +++ b/harbour/contrib/hbnf/doc/en/bytexor.txt @@ -2,37 +2,37 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_BYTEXOR() - * $CATEGORY$ - * String - * $ONELINER$ - * Perform bit-wise XOR on two ASCII characters (bytes) - * $SYNTAX$ - * FT_BYTEXOR( , ) -> cNewByte - * $ARGUMENTS$ - * and are characters from Chr(0) to Chr(255). - * May be passed in Chr() form, as character literals, or - * as expressions evaluating to Chr() values. - * $RETURNS$ - * Returns resulting byte, in Chr() form. If parameters are faulty, - * returns NIL. - * $DESCRIPTION$ - * Can be used for bit-wise byte manipulation. In effect, this is a - * bit-by-bit XOR operation. Equivalent to XOR assembler instruction. - * - * This function is presented to illustrate that bit-wise operations - * are possible with Clipper code. For greater speed, write .c or - * .asm versions and use the Clipper Extend system. - * $EXAMPLES$ - * This code performs a bit-wise XOR on two bytes represented - * by Chr( 32 ) and Chr( 55 ): - * - * cNewByte := FT_BYTEXOR( Chr( 32 ), Chr( 55 ) ) - * ? Asc( cNewByte ) // result: 23 - * ? cNewByte // result: non-printable character - * $SEEALSO$ - * FT_BYTEOR() FT_BYTENOT() FT_BYTENEG() FT_BYTEAND() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_BYTEXOR() + $CATEGORY$ + String + $ONELINER$ + Perform bit-wise XOR on two ASCII characters (bytes) + $SYNTAX$ + FT_BYTEXOR( , ) -> cNewByte + $ARGUMENTS$ + and are characters from Chr(0) to Chr(255). + May be passed in Chr() form, as character literals, or + as expressions evaluating to Chr() values. + $RETURNS$ + Returns resulting byte, in Chr() form. If parameters are faulty, + returns NIL. + $DESCRIPTION$ + Can be used for bit-wise byte manipulation. In effect, this is a + bit-by-bit XOR operation. Equivalent to XOR assembler instruction. + + This function is presented to illustrate that bit-wise operations + are possible with Clipper code. For greater speed, write .c or + .asm versions and use the Clipper Extend system. + $EXAMPLES$ + This code performs a bit-wise XOR on two bytes represented + by Chr( 32 ) and Chr( 55 ): + + cNewByte := FT_BYTEXOR( Chr( 32 ), Chr( 55 ) ) + ? Asc( cNewByte ) // result: 23 + ? cNewByte // result: non-printable character + $SEEALSO$ + FT_BYTEOR() FT_BYTENOT() FT_BYTENEG() FT_BYTEAND() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/calendar.txt b/harbour/contrib/hbnf/doc/en/calendar.txt index 67f7afbb1b..6b58e0ba15 100644 --- a/harbour/contrib/hbnf/doc/en/calendar.txt +++ b/harbour/contrib/hbnf/doc/en/calendar.txt @@ -2,73 +2,73 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_CALENDAR() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Display date/time calendar, find a date, return calendar data. - * $SYNTAX$ - * FT_CALENDAR ( [ ], [ ], [ ], [ ] , - * [ ] ) -> aRetVal - * $ARGUMENTS$ - * is an optional screen row for calendar display, - * default row 1. - * - * is an optional screen col for calendar display, - * default col 63. - * - * is an optional color string for displayed messages, - * default is bright white text over green background. - * - * is an optional logical variable. If true (.T.), - * it uses FT_SHADOW() to add a transparent shadow - * to the display, default (.F.). - * - * is an optional logical variable. If true, uses - * FT_XBOX to display a four line help message - * if the F1 key is pressed, default (.F.). - * - * $RETURNS$ - * aRetVal is an 8 element array containing date, month, day, year, - * month (in character format), day of the week, julian day - * and current time. - * - * $DESCRIPTION$ - * FT_CALENDAR() simply displays today's date, time and julian - * day in a two line display with an optional box shadow. Cursor keys may - * be used to page through the calendar by day, week, month or year - * increments. Returns an 8 element array of calendar data: - * - * Element Value - * [1] Date in current date format. - * [2] Numeric month number. - * [3] Numeric day number. - * [4] Numeric year number. - * [5] Month in character format. - * [6] Day of the week in character format. - * [7] Numeric Julian day. - * [8] Current time in time format. - * - * WARNING: FT_CALENDAR uses FT_SHADOW and FT_XBOX - * from the Nanforum Toolkit! - * - * $EXAMPLES$ - * LOCAL aRetVal[ 8 ] - * CLS - * aRetVal := FT_CALENDAR( 10, 40, "W+/RB", .T., .T. ) - * ? aRetVal[ 1 ] // Result: 04/20/91 - * ? aRetVal[ 2 ] // Result: 4 - * ? aRetVal[ 3 ] // Result: 20 - * ? aRetVal[ 4 ] // Result: 1991 - * ? aRetVal[ 5 ] // Result: April - * ? aRetVal[ 6 ] // Result: Saturday - * ? aRetVal[ 7 ] // Result: 110 - * ? aRetVal[ 8 ] // Result: 12:45:20 - * - * $SEEALSO$ - * FT_DAYOFYR() - * - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_CALENDAR() + $CATEGORY$ + Date/Time + $ONELINER$ + Display date/time calendar, find a date, return calendar data. + $SYNTAX$ + FT_CALENDAR ( [ ], [ ], [ ], [ ] , + [ ] ) -> aRetVal + $ARGUMENTS$ + is an optional screen row for calendar display, + default row 1. + + is an optional screen col for calendar display, + default col 63. + + is an optional color string for displayed messages, + default is bright white text over green background. + + is an optional logical variable. If true (.T.), + it uses FT_SHADOW() to add a transparent shadow + to the display, default (.F.). + + is an optional logical variable. If true, uses + FT_XBOX to display a four line help message + if the F1 key is pressed, default (.F.). + + $RETURNS$ + aRetVal is an 8 element array containing date, month, day, year, + month (in character format), day of the week, julian day + and current time. + + $DESCRIPTION$ + FT_CALENDAR() simply displays today's date, time and julian + day in a two line display with an optional box shadow. Cursor keys may + be used to page through the calendar by day, week, month or year + increments. Returns an 8 element array of calendar data: + + Element Value + [1] Date in current date format. + [2] Numeric month number. + [3] Numeric day number. + [4] Numeric year number. + [5] Month in character format. + [6] Day of the week in character format. + [7] Numeric Julian day. + [8] Current time in time format. + + WARNING: FT_CALENDAR uses FT_SHADOW and FT_XBOX + from the Nanforum Toolkit! + + $EXAMPLES$ + LOCAL aRetVal[ 8 ] + CLS + aRetVal := FT_CALENDAR( 10, 40, "W+/RB", .T., .T. ) + ? aRetVal[ 1 ] // Result: 04/20/91 + ? aRetVal[ 2 ] // Result: 4 + ? aRetVal[ 3 ] // Result: 20 + ? aRetVal[ 4 ] // Result: 1991 + ? aRetVal[ 5 ] // Result: April + ? aRetVal[ 6 ] // Result: Saturday + ? aRetVal[ 7 ] // Result: 110 + ? aRetVal[ 8 ] // Result: 12:45:20 + + $SEEALSO$ + FT_DAYOFYR() + + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/caplock.txt b/harbour/contrib/hbnf/doc/en/caplock.txt index 30167ce3f2..5936dd5d7f 100644 --- a/harbour/contrib/hbnf/doc/en/caplock.txt +++ b/harbour/contrib/hbnf/doc/en/caplock.txt @@ -2,31 +2,31 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_CAPLOCK() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Determine and optionally change the status of CapLock key - * $SYNTAX$ - * FT_CAPLOCK([ ]) -> lCurrentSetting - * $ARGUMENTS$ - * is optional and if supplied is the new setting - * for the CapLock key. Specify .T. to turn CapLock on, or .F. to - * turn it off. - * $RETURNS$ - * .T. if CapLock is set, .F. if it isn't set. The value returned - * represents the setting in effect prior to any changes that might - * by made by . - * $DESCRIPTION$ - * This function is useful if you need to know or set the status of the - * CapLock key for some reason. - * $EXAMPLES$ - * IF FT_CAPLOCK() - * ? "CapLock is active" - * ENDIF - * $SEEALSO$ - * FT_ALT() FT_CTRL() FT_NUMLOCK() FT_PRTSCR() FT_SHIFT() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_CAPLOCK() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Determine and optionally change the status of CapLock key + $SYNTAX$ + FT_CAPLOCK([ ]) -> lCurrentSetting + $ARGUMENTS$ + is optional and if supplied is the new setting + for the CapLock key. Specify .T. to turn CapLock on, or .F. to + turn it off. + $RETURNS$ + .T. if CapLock is set, .F. if it isn't set. The value returned + represents the setting in effect prior to any changes that might + by made by . + $DESCRIPTION$ + This function is useful if you need to know or set the status of the + CapLock key for some reason. + $EXAMPLES$ + IF FT_CAPLOCK() + ? "CapLock is active" + ENDIF + $SEEALSO$ + FT_ALT() FT_CTRL() FT_NUMLOCK() FT_PRTSCR() FT_SHIFT() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/chdir.txt b/harbour/contrib/hbnf/doc/en/chdir.txt index b8c9f9c51e..133e672947 100644 --- a/harbour/contrib/hbnf/doc/en/chdir.txt +++ b/harbour/contrib/hbnf/doc/en/chdir.txt @@ -2,32 +2,32 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_CHDIR() - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Change the current directory - * $SYNTAX$ - * FT_CHDIR( ) -> nResult - * $ARGUMENTS$ - * is the name of the desired directory. - * $RETURNS$ - * 0 if successful - * 3 if path not found - * 99 if invalid parameters passed - * $DESCRIPTION$ - * Use this function if you prefer to change the active directory - * instead of relying on the SET PATH command. - * - * The source code is written to adhere to Turbo Assembler's IDEAL mode. - * To use another assembler, you will need to rearrange the PROC and - * SEGMENT directives, and also the ENDP and ENDS directives (a very - * minor task). - * $EXAMPLES$ - * FT_CHDIR( "C:\harbour" ) - * FT_CHDIR( hb_ps() ) - * FT_CHDIR( ".." + hb_ps() + "hbnf" ) - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_CHDIR() + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Change the current directory + $SYNTAX$ + FT_CHDIR( ) -> nResult + $ARGUMENTS$ + is the name of the desired directory. + $RETURNS$ + 0 if successful + 3 if path not found + 99 if invalid parameters passed + $DESCRIPTION$ + Use this function if you prefer to change the active directory + instead of relying on the SET PATH command. + + The source code is written to adhere to Turbo Assembler's IDEAL mode. + To use another assembler, you will need to rearrange the PROC and + SEGMENT directives, and also the ENDP and ENDS directives (a very + minor task). + $EXAMPLES$ + FT_CHDIR( "C:\harbour" ) + FT_CHDIR( hb_ps() ) + FT_CHDIR( ".." + hb_ps() + "hbnf" ) + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/cint86.txt b/harbour/contrib/hbnf/doc/en/cint86.txt index 031c391b42..ebf245b092 100644 --- a/harbour/contrib/hbnf/doc/en/cint86.txt +++ b/harbour/contrib/hbnf/doc/en/cint86.txt @@ -2,151 +2,151 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_INT86() - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Execute a software interrupt - * $SYNTAX$ - * FT_INT86( , ) -> lResult - * $ARGUMENTS$ - * is the interrupt to execute. - * - * is an array that contains values to be loaded - * into the various CPU registers. The correspondence between - * registers and array elements is as follows: - * - * aElement[1] == AX register - * aElement[2] == BX register - * aElement[3] == CX register - * aElement[4] == DX register - * aElement[5] == SI register - * aElement[6] == DI register - * aElement[7] == BP register - * aElement[8] == DS register - * aElement[9] == ES register - * aElement[10] == Flags register - * $RETURNS$ - * .T. if all parameters valid and the function was able - * to execute the desired interrupt. - * .F. if invalid parameters passed. If you call this function in - * protected mode, .F. may also be returned if an allocation - * of low DOS memory fails. - * - * n addition, the array elements will contain whatever values were in - * he CPU registers immediately after the interrupt was executed. If - * ither of the string parameters were altered by the interrupt, these - * hanges will be reflected as well. - * $DESCRIPTION$ - * It is occasionally useful to be able to call interrupts directly from - * Clipper, without having to write a separate routine in C or ASM. This - * function allows you that capability. - * - * Given Clipper's high-level orientation, this function is necessarily - * somewhat messy to use. First, declare an array of ten elements to - * hold the eight values for the CPU registers and two string parameters. - * Then initialize the array elements with the values that you want the - * CPU registers to contain when the interrupt is executed. You need not - * initialize all the elements. For example, if the interrupt requires - * you to specify values for AX, DX, and DS, you would only need to - * initialize elements 1, 4, and 8. - * - * Once you have done the required register setup, call FT_INT86(), - * passing the interrupt number and the register array as parameters. - * The function will load the CPU with your specified values, execute the - * interrupt, and then store the contents of the CPU registers back into - * your array. This will allow you to evaluate the results of the - * interrupt. - * - * Some interrupt services require you to pass the address of a string in - * a pair of registers. This function is capable of handling these sorts - * of situations, but it will take a little work on your part. If you need - * to pass a string that uses the DS register, store the string in element - * 8; if you need to pass a string that uses the ES register, store the - * string in element 9. FT_INT86() will detect that you've supplied a - * string instead of a numeric value and will behave accordingly. - * - * That takes care of obtaining the segment portion of the pointer. To - * specify which register is to contain the offset, use the values REG_DS - * and REG_ES which are defined in the FTINT86.CH file. When one of these - * values is found in an array element, it alerts FT_Int86() to use the - * offset portion of a pointer instead of a numeric value. REG_DS tells - * FT_Int86() to use the offset of the string in element 8, while REG_ES - * tells FT_Int86() to use the offset of the string in element 9. - * - * All the CPU registers are sixteen bits in size. Some, however, are - * also split into two 8-bit registers. This function is only capable of - * receiving and returning registers that are 16 bits in size. To split - * a 16-bit register into two 8-bit values, you can use the - * pseudo-functions HighByte() and LowByte(), contained in the .CH file. - * - * To alter an 8-bit number so it will appear in the high-order byte of a - * register when passed to the FT_INT86() function, use the MakeHI() - * pseudo-function contained in the .CH file. - * - * When run in real mode, this function is a shell for __ftint86(), - * which is written in assembler and does the actual work of executing - * the interrupt. __ftint86() is callable from C, so feel free to - * incorporate it into any C routines for which it might be useful. The - * source for __ftint86() can be found in the file AINT86.ASM. - * - * When run in protected mode, this function is a shell for cpmiInt86(), - * which is written in assembler and makes a DPMI call to drop into - * real mode and execute the interrupt. cpmiInt86() is also callable - * from C, so feel free to incorporate it into any C routines for which - * it might be useful. cpmiInt86() is part of the CPMI API. See the - * CPMI documentation for more information. - * $EXAMPLES$ - * * This example shows how to call the DOS "create file" service. Take - * * special note of how to set up string parameters. - * - * #include "ftint86.ch" - * - * LOCAL aRegs[ 10 ] // Declare the register array - * aRegs[ AX ] := makehi( 60 ) // DOS service, create file - * aRegs[ CX ] := 0 // Specify file attribute - * - * * Pay attention here, this is crucial. Note how to set up the string - * * so it appears in DS:DX. - * - * aRegs[ DS ] := "C:\misc\myfile.xxx" - * aRegs[ DX ] := REG_DS - * FT_INT86( 33, aRegs ) // Make the call to the DOS interrupt - * - * - * * This example shows how to call the DOS "get current directory" - * * service. This one also uses a string parameter, but note that it - * * uses a different offset register. - * - * #include "ftint86.ch" - * - * LOCAL aRegs[ 10 ] - * aRegs[ AX ] := makehi( 71 ) - * aRegs[ DX ] := 0 // Choose default drive - * - * * This service requires a 64-byte buffer whose address is in DS:SI. DOS - * * will fill the buffer with the current directory. - * - * aRegs[ DS ] := Space( 64 ) - * aRegs[ SI ] := REG_DS - * FT_INT86( 33, aRegs ) - * - * ? aRegs[ DS ] // Display the directory name - * - * - * - * * For the sake of completeness, here's an example that doesn't use a - * * string. This one changes the video mode. - * - * #include "ftint86.ch" - * - * LOCAL aRegs[ 10 ] - * - * aRegs[ AX ] := 16 // Choose hi-res graphics - * FT_INT86( 16, aRegs ) - * $INCLUDE$ - * ftint86.ch - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_INT86() + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Execute a software interrupt + $SYNTAX$ + FT_INT86( , ) -> lResult + $ARGUMENTS$ + is the interrupt to execute. + + is an array that contains values to be loaded + into the various CPU registers. The correspondence between + registers and array elements is as follows: + + aElement[1] == AX register + aElement[2] == BX register + aElement[3] == CX register + aElement[4] == DX register + aElement[5] == SI register + aElement[6] == DI register + aElement[7] == BP register + aElement[8] == DS register + aElement[9] == ES register + aElement[10] == Flags register + $RETURNS$ + .T. if all parameters valid and the function was able + to execute the desired interrupt. + .F. if invalid parameters passed. If you call this function in + protected mode, .F. may also be returned if an allocation + of low DOS memory fails. + + n addition, the array elements will contain whatever values were in + he CPU registers immediately after the interrupt was executed. If + ither of the string parameters were altered by the interrupt, these + hanges will be reflected as well. + $DESCRIPTION$ + It is occasionally useful to be able to call interrupts directly from + Clipper, without having to write a separate routine in C or ASM. This + function allows you that capability. + + Given Clipper's high-level orientation, this function is necessarily + somewhat messy to use. First, declare an array of ten elements to + hold the eight values for the CPU registers and two string parameters. + Then initialize the array elements with the values that you want the + CPU registers to contain when the interrupt is executed. You need not + initialize all the elements. For example, if the interrupt requires + you to specify values for AX, DX, and DS, you would only need to + initialize elements 1, 4, and 8. + + Once you have done the required register setup, call FT_INT86(), + passing the interrupt number and the register array as parameters. + The function will load the CPU with your specified values, execute the + interrupt, and then store the contents of the CPU registers back into + your array. This will allow you to evaluate the results of the + interrupt. + + Some interrupt services require you to pass the address of a string in + a pair of registers. This function is capable of handling these sorts + of situations, but it will take a little work on your part. If you need + to pass a string that uses the DS register, store the string in element + 8; if you need to pass a string that uses the ES register, store the + string in element 9. FT_INT86() will detect that you've supplied a + string instead of a numeric value and will behave accordingly. + + That takes care of obtaining the segment portion of the pointer. To + specify which register is to contain the offset, use the values REG_DS + and REG_ES which are defined in the FTINT86.CH file. When one of these + values is found in an array element, it alerts FT_Int86() to use the + offset portion of a pointer instead of a numeric value. REG_DS tells + FT_Int86() to use the offset of the string in element 8, while REG_ES + tells FT_Int86() to use the offset of the string in element 9. + + All the CPU registers are sixteen bits in size. Some, however, are + also split into two 8-bit registers. This function is only capable of + receiving and returning registers that are 16 bits in size. To split + a 16-bit register into two 8-bit values, you can use the + pseudo-functions HighByte() and LowByte(), contained in the .CH file. + + To alter an 8-bit number so it will appear in the high-order byte of a + register when passed to the FT_INT86() function, use the MakeHI() + pseudo-function contained in the .CH file. + + When run in real mode, this function is a shell for __ftint86(), + which is written in assembler and does the actual work of executing + the interrupt. __ftint86() is callable from C, so feel free to + incorporate it into any C routines for which it might be useful. The + source for __ftint86() can be found in the file AINT86.ASM. + + When run in protected mode, this function is a shell for cpmiInt86(), + which is written in assembler and makes a DPMI call to drop into + real mode and execute the interrupt. cpmiInt86() is also callable + from C, so feel free to incorporate it into any C routines for which + it might be useful. cpmiInt86() is part of the CPMI API. See the + CPMI documentation for more information. + $EXAMPLES$ + * This example shows how to call the DOS "create file" service. Take + * special note of how to set up string parameters. + + #include "ftint86.ch" + + LOCAL aRegs[ 10 ] // Declare the register array + aRegs[ AX ] := makehi( 60 ) // DOS service, create file + aRegs[ CX ] := 0 // Specify file attribute + + * Pay attention here, this is crucial. Note how to set up the string + * so it appears in DS:DX. + + aRegs[ DS ] := "C:\misc\myfile.xxx" + aRegs[ DX ] := REG_DS + FT_INT86( 33, aRegs ) // Make the call to the DOS interrupt + + + * This example shows how to call the DOS "get current directory" + * service. This one also uses a string parameter, but note that it + * uses a different offset register. + + #include "ftint86.ch" + + LOCAL aRegs[ 10 ] + aRegs[ AX ] := makehi( 71 ) + aRegs[ DX ] := 0 // Choose default drive + + * This service requires a 64-byte buffer whose address is in DS:SI. DOS + * will fill the buffer with the current directory. + + aRegs[ DS ] := Space( 64 ) + aRegs[ SI ] := REG_DS + FT_INT86( 33, aRegs ) + + ? aRegs[ DS ] // Display the directory name + + + + * For the sake of completeness, here's an example that doesn't use a + * string. This one changes the video mode. + + #include "ftint86.ch" + + LOCAL aRegs[ 10 ] + + aRegs[ AX ] := 16 // Choose hi-res graphics + FT_INT86( 16, aRegs ) + $INCLUDE$ + ftint86.ch + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/clrsel.txt b/harbour/contrib/hbnf/doc/en/clrsel.txt index 2826713428..0c73f236b6 100644 --- a/harbour/contrib/hbnf/doc/en/clrsel.txt +++ b/harbour/contrib/hbnf/doc/en/clrsel.txt @@ -2,101 +2,101 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ClrSel() - * $CATEGORY$ - * Menus/Prompts - * $ONELINER$ - * User Selectable Colour Routine - * $SYNTAX$ - * FT_ClrSel( , [ ], [ ] -> aClrData - * $ARGUMENTS$ - * is an array of subarrays, with each subarray containing - * information about the colour settings. - * - * The subarray has the following structure: - * - * [1] cName is the name of this colour setting i.e. "Pick List" - * Maximum length is 20 bytes - * - * [2] cClrStr is the current colour string - * Default is "W/N,N/W,N/N,N/N,N/W" - * - * If Setting type is "M" (Menu) the colours are... - * 1. Prompt Colour - * 2. Message Colour - * 3. HotKey Colour - * 4. LightBar Colour - * 5. LightBar HotKey Colour - * - * Note: While there are many ways to code the individual - * colour combinations, they should be in the same - * format that gets returned from SETCOLOR(), so - * the defaults can be found in the colour palette. - * - * foreground [+] / background [*] - * i.e. "GR+/BG*, N/W*, N+/N, , W/N" - * - * [3] cType is the type of colour setting - * Default is "W" (Window) - * - * T = Title Only 1 colour element - * D = Desktop Background colour and character - * M = Menu For FT_Menuto() style menus - * W = Window Windows with radio buttons - * G = Get For use with @ SAY... - * B = Browse For tBrowse() and *dbEdit() - * A = aChoice Pick-lists etc... - * - * W/G/B/A are functionally the same but will provide - * a more appropriate test display. - * - * [4] cFillChar is the character (for desktop background only) - * Default is Chr(177) "▒▒▒▒▒▒▒▒▒▒▒▒▒▒" - * - * - * .T. use colour palette - * .F. use monochrome palette - * - * Default is the ISCOLOR() setting - * - * 2 Byte character string for colour test display - * - * Default is the Chr(254)+Chr(254) "■■" - * - * $RETURNS$ - * An array identical to the one passed, with new selected colours - * $DESCRIPTION$ - * This function allows users to select their own colour combinations - * for all the different types of screen I/O in a typical application. - * This facilitates an easy implementation of Ted Means' replacement - * of the @..PROMPT/MENU TO found in the NanForum Toolkit. If you are - * not using FT_MENUTO(), you can specify "A" for setting type and have - * a normal colour string returned. - * $EXAMPLES$ - * LOCAL aClrs := {} - * LOCAL lColour := IsColor() - * LOCAL cChr := Chr( 254 ) + Chr( 254 ) - * - * SET SCOREBOARD Off - * SETBLINK( .F. ) // Allow bright backgrounds - * - * *.... a typical application might have the following different settings - * * normally these would be stored in a .dbf/.dbv - * aClrs := {; - * { "Desktop", "N/BG", "D", "▒" }, ; - * { "Title", "N/W", "T" }, ; - * { "Top Menu", "N/BG,N/W,W+/BG,W+/N,GR+/N", "M" }, ; - * { "Sub Menu", "W+/N*,GR+/N*,GR+/N*,W+/R,G+/R","M" }, ; - * { "Standard Gets", "W/B, W+/N,,, W/N", "G" }, ; - * { "Nested Gets", "N/BG, W+/N,,, W/N", "G" }, ; - * { "Help", "N/G, W+/N,,, W/N", "W" }, ; - * { "Error Messages", "W+/R*,N/GR*,,,N/R*", "W" }, ; - * { "Database Query", "N/BG, N/GR*,,,N+/BG", "B" }, ; - * { "Pick List", "N/GR*,W+/B,,, BG/GR*", "A" } ; - * } - * - * aClrs := FT_ClrSel( aClrs, lColour, cChr ) - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ClrSel() + $CATEGORY$ + Menus/Prompts + $ONELINER$ + User Selectable Colour Routine + $SYNTAX$ + FT_ClrSel( , [ ], [ ] -> aClrData + $ARGUMENTS$ + is an array of subarrays, with each subarray containing + information about the colour settings. + + The subarray has the following structure: + + [1] cName is the name of this colour setting i.e. "Pick List" + Maximum length is 20 bytes + + [2] cClrStr is the current colour string + Default is "W/N,N/W,N/N,N/N,N/W" + + If Setting type is "M" (Menu) the colours are... + 1. Prompt Colour + 2. Message Colour + 3. HotKey Colour + 4. LightBar Colour + 5. LightBar HotKey Colour + + Note: While there are many ways to code the individual + colour combinations, they should be in the same + format that gets returned from SETCOLOR(), so + the defaults can be found in the colour palette. + + foreground [+] / background [*] + i.e. "GR+/BG*, N/W*, N+/N, , W/N" + + [3] cType is the type of colour setting + Default is "W" (Window) + + T = Title Only 1 colour element + D = Desktop Background colour and character + M = Menu For FT_Menuto() style menus + W = Window Windows with radio buttons + G = Get For use with @ SAY... + B = Browse For tBrowse() and *dbEdit() + A = aChoice Pick-lists etc... + + W/G/B/A are functionally the same but will provide + a more appropriate test display. + + [4] cFillChar is the character (for desktop background only) + Default is Chr(177) "▒▒▒▒▒▒▒▒▒▒▒▒▒▒" + + + .T. use colour palette + .F. use monochrome palette + + Default is the ISCOLOR() setting + + 2 Byte character string for colour test display + + Default is the Chr(254)+Chr(254) "■■" + + $RETURNS$ + An array identical to the one passed, with new selected colours + $DESCRIPTION$ + This function allows users to select their own colour combinations + for all the different types of screen I/O in a typical application. + This facilitates an easy implementation of Ted Means' replacement + of the @..PROMPT/MENU TO found in the NanForum Toolkit. If you are + not using FT_MENUTO(), you can specify "A" for setting type and have + a normal colour string returned. + $EXAMPLES$ + LOCAL aClrs := {} + LOCAL lColour := IsColor() + LOCAL cChr := Chr( 254 ) + Chr( 254 ) + + SET SCOREBOARD Off + SETBLINK( .F. ) // Allow bright backgrounds + + *.... a typical application might have the following different settings + * normally these would be stored in a .dbf/.dbv + aClrs := {; + { "Desktop", "N/BG", "D", "▒" }, ; + { "Title", "N/W", "T" }, ; + { "Top Menu", "N/BG,N/W,W+/BG,W+/N,GR+/N", "M" }, ; + { "Sub Menu", "W+/N*,GR+/N*,GR+/N*,W+/R,G+/R","M" }, ; + { "Standard Gets", "W/B, W+/N,,, W/N", "G" }, ; + { "Nested Gets", "N/BG, W+/N,,, W/N", "G" }, ; + { "Help", "N/G, W+/N,,, W/N", "W" }, ; + { "Error Messages", "W+/R*,N/GR*,,,N/R*", "W" }, ; + { "Database Query", "N/BG, N/GR*,,,N+/BG", "B" }, ; + { "Pick List", "N/GR*,W+/B,,, BG/GR*", "A" } ; + } + + aClrs := FT_ClrSel( aClrs, lColour, cChr ) + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/cntryset.txt b/harbour/contrib/hbnf/doc/en/cntryset.txt index 3da1132784..4f06a62de7 100644 --- a/harbour/contrib/hbnf/doc/en/cntryset.txt +++ b/harbour/contrib/hbnf/doc/en/cntryset.txt @@ -2,32 +2,32 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_SETCENTURY() - * $CATEGORY$ - * Environment - * $ONELINER$ - * Check/Set the CENTURY Setting - * $SYNTAX$ - * FT_SETCENTURY( [ ] ) -> - * $ARGUMENTS$ - * lNewSetState - Boolean to Set CENTURY - * .F. - Toggle CENTURY off - * .T. - Toggle CENTURY on - * If not specified, leave CENTURY as is - * $RETURNS$ - * The state of the CENTURY setting upon entry to the routine - * $DESCRIPTION$ - * This function returns the state (ON/OFF, TRUE/FALSE) of the CENTURY - * and optionally sets it ON or OFF. - * $EXAMPLES$ - * lOldState := FT_SETCENTURY() // Get current CENTURY Setting - * - * lOldState := FT_SETCENTURY( .T. ) // Get the current CENTURY Setting - * // and turn it on (set it to TRUE) - * - * lOldState := FT_SETCENTURY( .F. ) // Get the current CENTURY Setting - * // and turn it off (set it to FALSE) - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SETCENTURY() + $CATEGORY$ + Environment + $ONELINER$ + Check/Set the CENTURY Setting + $SYNTAX$ + FT_SETCENTURY( [ ] ) -> + $ARGUMENTS$ + lNewSetState - Boolean to Set CENTURY + .F. - Toggle CENTURY off + .T. - Toggle CENTURY on + If not specified, leave CENTURY as is + $RETURNS$ + The state of the CENTURY setting upon entry to the routine + $DESCRIPTION$ + This function returns the state (ON/OFF, TRUE/FALSE) of the CENTURY + and optionally sets it ON or OFF. + $EXAMPLES$ + lOldState := FT_SETCENTURY() // Get current CENTURY Setting + + lOldState := FT_SETCENTURY( .T. ) // Get the current CENTURY Setting + // and turn it on (set it to TRUE) + + lOldState := FT_SETCENTURY( .F. ) // Get the current CENTURY Setting + // and turn it off (set it to FALSE) + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/color2n.txt b/harbour/contrib/hbnf/doc/en/color2n.txt index 1b69a92cb2..bf2b1389d0 100644 --- a/harbour/contrib/hbnf/doc/en/color2n.txt +++ b/harbour/contrib/hbnf/doc/en/color2n.txt @@ -2,30 +2,30 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_COLOR2N() - * $CATEGORY$ - * String - * $ONELINER$ - * Returns the numeric complement of a Clipper color string - * $SYNTAX$ - * FT_COLOR2N( ) -> nValue - * $ARGUMENTS$ - * is a Clipper color string - * $RETURNS$ - * The numeric complement of a color string or 0 if passed color - * is invalid. - * $DESCRIPTION$ - * This function is useful when calling other functions that expect - * a numeric color parameter. It is often more convenient to pass - * a converted color string than having to calculate or look up the - * corresponding number. - * $EXAMPLES$ - * nColor := FT_COLOR2N( "gr+/b" ) // returns 30 - * - * FT_SETATTR( 0, 0, 10, 10, nColor ) - * $SEEALSO$ - * FT_N2COLOR() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_COLOR2N() + $CATEGORY$ + String + $ONELINER$ + Returns the numeric complement of a Clipper color string + $SYNTAX$ + FT_COLOR2N( ) -> nValue + $ARGUMENTS$ + is a Clipper color string + $RETURNS$ + The numeric complement of a color string or 0 if passed color + is invalid. + $DESCRIPTION$ + This function is useful when calling other functions that expect + a numeric color parameter. It is often more convenient to pass + a converted color string than having to calculate or look up the + corresponding number. + $EXAMPLES$ + nColor := FT_COLOR2N( "gr+/b" ) // returns 30 + + FT_SETATTR( 0, 0, 10, 10, nColor ) + $SEEALSO$ + FT_N2COLOR() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/ctrl.txt b/harbour/contrib/hbnf/doc/en/ctrl.txt index cd6dc5359e..82a4ac95b9 100644 --- a/harbour/contrib/hbnf/doc/en/ctrl.txt +++ b/harbour/contrib/hbnf/doc/en/ctrl.txt @@ -2,29 +2,29 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_CTRL() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Determine status of the Ctrl key - * $SYNTAX$ - * FT_CTRL() -> lValue - * $ARGUMENTS$ - * None - * $RETURNS$ - * .T. if Ctrl key is pressed, .F. if otherwise. - * $DESCRIPTION$ - * This function is useful for times you need to know whether or not - * the Ctrl key is pressed, such as during a MemoEdit(). - * $EXAMPLES$ - * IF FT_CTRL() - * @ 24, 0 say "Ctrl" - * ELSE - * @ 24, 0 say " " - * ENDIF - * $SEEALSO$ - * FT_CAPLOCK() FT_NUMLOCK() FT_PRTSCR() FT_SHIFT() FT_ALT() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_CTRL() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Determine status of the Ctrl key + $SYNTAX$ + FT_CTRL() -> lValue + $ARGUMENTS$ + None + $RETURNS$ + .T. if Ctrl key is pressed, .F. if otherwise. + $DESCRIPTION$ + This function is useful for times you need to know whether or not + the Ctrl key is pressed, such as during a MemoEdit(). + $EXAMPLES$ + IF FT_CTRL() + @ 24, 0 say "Ctrl" + ELSE + @ 24, 0 say " " + ENDIF + $SEEALSO$ + FT_CAPLOCK() FT_NUMLOCK() FT_PRTSCR() FT_SHIFT() FT_ALT() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/d2e.txt b/harbour/contrib/hbnf/doc/en/d2e.txt index e8c43f9601..8880dcd159 100644 --- a/harbour/contrib/hbnf/doc/en/d2e.txt +++ b/harbour/contrib/hbnf/doc/en/d2e.txt @@ -2,34 +2,34 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_D2E() - * $CATEGORY$ - * Conversion - * $ONELINER$ - * Convert decimal to scientific notation - * $SYNTAX$ - * FT_D2E( , ) -> - * $ARGUMENTS$ - * Decimal number to convert - * - * Number of decimal places in result. - * Defaults to 6 decimal places. - * $RETURNS$ - * A string representing a number in - * scientific notation - * $DESCRIPTION$ - * Given a decimal number and the desired precision, - * a string representing the equivalent in scientific - * notation is returned. - * $EXAMPLES$ - * ? FT_D2E( 12.345, 2 ) -> 1.23E1 - * - * ? FT_D2E( -12.345, 3 ) -> -1.235E1 - * - * ? FT_D2E( 0.00000543, 2 ) -> 5.43E-6 - * $SEEALSO$ - * FT_E2D() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_D2E() + $CATEGORY$ + Conversion + $ONELINER$ + Convert decimal to scientific notation + $SYNTAX$ + FT_D2E( , ) -> + $ARGUMENTS$ + Decimal number to convert + + Number of decimal places in result. + Defaults to 6 decimal places. + $RETURNS$ + A string representing a number in + scientific notation + $DESCRIPTION$ + Given a decimal number and the desired precision, + a string representing the equivalent in scientific + notation is returned. + $EXAMPLES$ + ? FT_D2E( 12.345, 2 ) -> 1.23E1 + + ? FT_D2E( -12.345, 3 ) -> -1.235E1 + + ? FT_D2E( 0.00000543, 2 ) -> 5.43E-6 + $SEEALSO$ + FT_E2D() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/datecnfg.txt b/harbour/contrib/hbnf/doc/en/datecnfg.txt index 41b0d73663..f3a438efe1 100644 --- a/harbour/contrib/hbnf/doc/en/datecnfg.txt +++ b/harbour/contrib/hbnf/doc/en/datecnfg.txt @@ -2,77 +2,77 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_DATECNFG() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Set beginning of year/week for FT_ date functions - * $SYNTAX$ - * FT_DATECNFG( [ ], [ ] ) -> aDateInfo - * $ARGUMENTS$ - * is a character date string in the user's system date - * format, i.e., the same as the user would enter for CTOD(). If - * this argument is NIL, the current value is unchanged. - * - * Note: The year portion of the date string must be present and - * be a valid year; however, it has no real meaning. - * - * is a number from 1 to 7 (1 = Sunday) indicating the - * desired start of a work week. If this argument is NIL, - * the current value is unchanged. - * - * $RETURNS$ - * A 2-element array containing the following information: - * - * aDateInfo[1] - an ANSI date string indicating the beginning - * date of the year. Only the month and day are - * meaningful. - * - * aDateInfo[2] - the number of the first day of the week - * (1 = Sunday) - * - * $DESCRIPTION$ - * FT_DATECNFG() is called internally by many of the date functions - * in the library to determine the beginning of year date and - * beginning of week day. - * - * The default beginning of the year is January 1st and the default - * beginning of the week is Sunday (day 1). Either or both of these - * settings may be changed by calling FT_DATECNFG() with the proper - * arguments. They will retain their values for the duration of the - * program or until they are changed again by a subsequent call to - * FT_DATECNFG(). - * - * It is not necessary to call FT_DATECNFG() unless you need to - * change the defaults. - * - * FT_DATECNFG() affects the following library functions: - * - * FT_WEEK() FT_ACCTWEEK() FT_DAYTOBOW() - * FT_MONTH() FT_ACCTMONTH() FT_DAYOFYR() - * FT_QTR() FT_ACCTQTR() FT_ACCTADJ() - * FT_YEAR() FT_ACCTYEAR() - * $EXAMPLES$ - * // Configure library date functions to begin year on - * // July 1st. - * - * FT_DATECNFG( "07/01/80" ) // year is insignificant - * - * // Examples of return values: - * - * // System date format: American aArray[1] aArray[2] - * - * aArray := FT_DATECNFG() // "1980.01.01" 1 (Sun.) - * aArray := FT_DATECNFG( "07/01/80" ) // "1980.07.01" 1 (Sun.) - * aArray := FT_DATECNFG( "07/01/80", 2 ) // "1980.07.01" 2 (Mon.) - * aArray := FT_DATECNFG( , 2 ) // "1980.01.01" 2 (Mon.) - * - * // System date format: British - * - * aArray := FT_DATECNFG( "01/07/80", 2 ) // "1980.07.01" 2 (Mon.) - * $SEEALSO$ - * FT_ACCTADJ() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_DATECNFG() + $CATEGORY$ + Date/Time + $ONELINER$ + Set beginning of year/week for FT_ date functions + $SYNTAX$ + FT_DATECNFG( [ ], [ ] ) -> aDateInfo + $ARGUMENTS$ + is a character date string in the user's system date + format, i.e., the same as the user would enter for CTOD(). If + this argument is NIL, the current value is unchanged. + + Note: The year portion of the date string must be present and + be a valid year; however, it has no real meaning. + + is a number from 1 to 7 (1 = Sunday) indicating the + desired start of a work week. If this argument is NIL, + the current value is unchanged. + + $RETURNS$ + A 2-element array containing the following information: + + aDateInfo[1] - an ANSI date string indicating the beginning + date of the year. Only the month and day are + meaningful. + + aDateInfo[2] - the number of the first day of the week + (1 = Sunday) + + $DESCRIPTION$ + FT_DATECNFG() is called internally by many of the date functions + in the library to determine the beginning of year date and + beginning of week day. + + The default beginning of the year is January 1st and the default + beginning of the week is Sunday (day 1). Either or both of these + settings may be changed by calling FT_DATECNFG() with the proper + arguments. They will retain their values for the duration of the + program or until they are changed again by a subsequent call to + FT_DATECNFG(). + + It is not necessary to call FT_DATECNFG() unless you need to + change the defaults. + + FT_DATECNFG() affects the following library functions: + + FT_WEEK() FT_ACCTWEEK() FT_DAYTOBOW() + FT_MONTH() FT_ACCTMONTH() FT_DAYOFYR() + FT_QTR() FT_ACCTQTR() FT_ACCTADJ() + FT_YEAR() FT_ACCTYEAR() + $EXAMPLES$ + // Configure library date functions to begin year on + // July 1st. + + FT_DATECNFG( "07/01/80" ) // year is insignificant + + // Examples of return values: + + // System date format: American aArray[1] aArray[2] + + aArray := FT_DATECNFG() // "1980.01.01" 1 (Sun.) + aArray := FT_DATECNFG( "07/01/80" ) // "1980.07.01" 1 (Sun.) + aArray := FT_DATECNFG( "07/01/80", 2 ) // "1980.07.01" 2 (Mon.) + aArray := FT_DATECNFG( , 2 ) // "1980.01.01" 2 (Mon.) + + // System date format: British + + aArray := FT_DATECNFG( "01/07/80", 2 ) // "1980.07.01" 2 (Mon.) + $SEEALSO$ + FT_ACCTADJ() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/dayofyr.txt b/harbour/contrib/hbnf/doc/en/dayofyr.txt index f234045fc3..a73a8991bb 100644 --- a/harbour/contrib/hbnf/doc/en/dayofyr.txt +++ b/harbour/contrib/hbnf/doc/en/dayofyr.txt @@ -2,62 +2,62 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_DAYOFYR() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Return calendar, fiscal or accounting day data - * $SYNTAX$ - * FT_DAYOFYR( [ ], [ ], [ ] ) - * -> aDateInfo - * $ARGUMENTS$ - * is any valid date in any valid format. Defaults - * to current system date if not supplied. - * - * is a number from 1 to 371, signifying a day of a year. - * Defaults to current day if not supplied. - * - * is a logical which specifies the type of year to base - * the return value on: .F. = calendar or fiscal year, - * .T. = accounting year. - * $RETURNS$ - * A three element array containing the following data: - * - * If is specified: - * - * aDateInfo[ 1 ] - The date of the specified day number - * aDateInfo[ 2 ] - The beginning date of the year - * aDateInfo[ 3 ] - The ending date of the year - * - * If is not specified: - * - * aDateInfo[ 1 ] - The year and day as a character string "YYYYDDD" - * aDateInfo[ 2 ] - The beginning date of the year - * aDateInfo[ 3 ] - The ending date of the year - * $DESCRIPTION$ - * FT_DAYOFYR() returns an array containing data about a day in the - * calendar or fiscal year containing the given date. - * - * The beginning of year date defaults to January 1st but may be - * changed with FT_DATECNFG(). - * $EXAMPLES$ - * aDateInfo := FT_DAYOFYR( SToD( "19910331" ) ) - * ? aDateInfo[ 1 ] // 1991090 (90th day of year 1991) - * ? aDateInfo[ 2 ] // 01/01/91 - * ? aDateInfo[ 3 ] // 12/31/91 - * - * aDateInfo := FT_DAYOFYR( , 90 ) // assume current date is 3/31/91 - * ? aDateInfo[ 1 ] // 03/31/91 (90th day of year) - * ? aDateInfo[ 2 ] // 01/01/91 - * ? aDateInfo[ 3 ] // 12/31/91 - * - * aDateInfo := FT_DAYOFYR( , 90, .T. ) - * ? aDateInfo[ 1 ] // 03/29/91 (90th day of accounting year) - * ? aDateInfo[ 2 ] // 12/30/90 (1st day of accounting year) - * ? aDateInfo[ 3 ] // 12/28/91 (last day of accounting year) - * $SEEALSO$ - * FT_DATECNFG() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_DAYOFYR() + $CATEGORY$ + Date/Time + $ONELINER$ + Return calendar, fiscal or accounting day data + $SYNTAX$ + FT_DAYOFYR( [ ], [ ], [ ] ) + -> aDateInfo + $ARGUMENTS$ + is any valid date in any valid format. Defaults + to current system date if not supplied. + + is a number from 1 to 371, signifying a day of a year. + Defaults to current day if not supplied. + + is a logical which specifies the type of year to base + the return value on: .F. = calendar or fiscal year, + .T. = accounting year. + $RETURNS$ + A three element array containing the following data: + + If is specified: + + aDateInfo[ 1 ] - The date of the specified day number + aDateInfo[ 2 ] - The beginning date of the year + aDateInfo[ 3 ] - The ending date of the year + + If is not specified: + + aDateInfo[ 1 ] - The year and day as a character string "YYYYDDD" + aDateInfo[ 2 ] - The beginning date of the year + aDateInfo[ 3 ] - The ending date of the year + $DESCRIPTION$ + FT_DAYOFYR() returns an array containing data about a day in the + calendar or fiscal year containing the given date. + + The beginning of year date defaults to January 1st but may be + changed with FT_DATECNFG(). + $EXAMPLES$ + aDateInfo := FT_DAYOFYR( SToD( "19910331" ) ) + ? aDateInfo[ 1 ] // 1991090 (90th day of year 1991) + ? aDateInfo[ 2 ] // 01/01/91 + ? aDateInfo[ 3 ] // 12/31/91 + + aDateInfo := FT_DAYOFYR( , 90 ) // assume current date is 3/31/91 + ? aDateInfo[ 1 ] // 03/31/91 (90th day of year) + ? aDateInfo[ 2 ] // 01/01/91 + ? aDateInfo[ 3 ] // 12/31/91 + + aDateInfo := FT_DAYOFYR( , 90, .T. ) + ? aDateInfo[ 1 ] // 03/29/91 (90th day of accounting year) + ? aDateInfo[ 2 ] // 12/30/90 (1st day of accounting year) + ? aDateInfo[ 3 ] // 12/28/91 (last day of accounting year) + $SEEALSO$ + FT_DATECNFG() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/daytobow.txt b/harbour/contrib/hbnf/doc/en/daytobow.txt index 9ecbecd6d6..64b65ba457 100644 --- a/harbour/contrib/hbnf/doc/en/daytobow.txt +++ b/harbour/contrib/hbnf/doc/en/daytobow.txt @@ -2,39 +2,39 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_DAYTOBOW() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Calculate no. of days between date and beginning of week - * $SYNTAX$ - * FT_DAYTOBOW( [ ] ) -> nDays - * $ARGUMENTS$ - * is any valid date in any valid date format. - * Defaults to current date if not supplied. - * $RETURNS$ - * A positive number of days to beginning of week, range 0 to 6. - * $DESCRIPTION$ - * FT_DAYTOBOW() returns the number of days to the beginning of the - * week. Normally this will be one less than the value that - * would be returned by the Clipper function DOW(), unless the - * day for the beginning of the week has been changed with - * FT_DATECNFG(). - * $EXAMPLES$ - * dDate := SToD( "19900915" ) - * - * ? DOW( dDate ) // 7 - * ? CDOW( dDate ) // Saturday - * ? FT_DAYTOBOW( dDate ) // 6 - * - * // change beginning of week to Friday (yeah!) - * FT_DATECNFG( , 6 ) - * ? DOW( dDate ) // 7 - * ? CDOW( dDate ) // Saturday - * ? FT_DAYTOBOW( dDate ) // 1 - * $SEEALSO$ - * FT_DATECNFG() FT_ACCTWEEK() FT_WEEK() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_DAYTOBOW() + $CATEGORY$ + Date/Time + $ONELINER$ + Calculate no. of days between date and beginning of week + $SYNTAX$ + FT_DAYTOBOW( [ ] ) -> nDays + $ARGUMENTS$ + is any valid date in any valid date format. + Defaults to current date if not supplied. + $RETURNS$ + A positive number of days to beginning of week, range 0 to 6. + $DESCRIPTION$ + FT_DAYTOBOW() returns the number of days to the beginning of the + week. Normally this will be one less than the value that + would be returned by the Clipper function DOW(), unless the + day for the beginning of the week has been changed with + FT_DATECNFG(). + $EXAMPLES$ + dDate := SToD( "19900915" ) + + ? DOW( dDate ) // 7 + ? CDOW( dDate ) // Saturday + ? FT_DAYTOBOW( dDate ) // 6 + + // change beginning of week to Friday (yeah!) + FT_DATECNFG( , 6 ) + ? DOW( dDate ) // 7 + ? CDOW( dDate ) // Saturday + ? FT_DAYTOBOW( dDate ) // 1 + $SEEALSO$ + FT_DATECNFG() FT_ACCTWEEK() FT_WEEK() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/dectobin.txt b/harbour/contrib/hbnf/doc/en/dectobin.txt index fcd867c3b1..1cd97cfec7 100644 --- a/harbour/contrib/hbnf/doc/en/dectobin.txt +++ b/harbour/contrib/hbnf/doc/en/dectobin.txt @@ -2,24 +2,24 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_DEC2BIN() - * $CATEGORY$ - * Conversion - * $ONELINER$ - * Convert decimal to binary - * $SYNTAX$ - * FT_DEC2BIN( ) -> cBinaryNumber - * $ARGUMENTS$ - * is the numeric expression to be converted. - * $RETURNS$ - * A character string representing in binary format. - * $DESCRIPTION$ - * This function can be used in conjunction with any bit-wise - * operations. - * $EXAMPLES$ - * ? FT_DEC2BIN( 255 ) // "11111111" - * ? FT_DEC2BIN( 2 ) // "00000010" - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_DEC2BIN() + $CATEGORY$ + Conversion + $ONELINER$ + Convert decimal to binary + $SYNTAX$ + FT_DEC2BIN( ) -> cBinaryNumber + $ARGUMENTS$ + is the numeric expression to be converted. + $RETURNS$ + A character string representing in binary format. + $DESCRIPTION$ + This function can be used in conjunction with any bit-wise + operations. + $EXAMPLES$ + ? FT_DEC2BIN( 255 ) // "11111111" + ? FT_DEC2BIN( 2 ) // "00000010" + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/default.txt b/harbour/contrib/hbnf/doc/en/default.txt index fc040df94a..b8ba273737 100644 --- a/harbour/contrib/hbnf/doc/en/default.txt +++ b/harbour/contrib/hbnf/doc/en/default.txt @@ -2,31 +2,31 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_DEFAULT() - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Retrieve and optionally change the current default drive - * $SYNTAX$ - * FT_DEFAULT( [ ] ) -> cDrive - * $ARGUMENTS$ - * is optional, and if specified is the new default drive. - * $RETURNS$ - * The current default drive. If a change of default drive is requested, - * the return value is the drive AFTER the change is made. This allows - * you to make sure you specified a valid drive (i.e. if you attempt to - * change the default drive, and the function returns a different drive - * letter than the one you specified, then the drive does not exist). - * $DESCRIPTION$ - * Useful any time you need to know or change the default drive. - * $EXAMPLES$ - * cDrive := FT_DEFAULT() // Get the current drive - * FT_DEFAULT( "C" ) // Switch to drive C - * - * IF !( FT_DEFAULT( "E" ) == "E" ) - * QOut( "Drive E does not exist!" ) - * ENDIF - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_DEFAULT() + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Retrieve and optionally change the current default drive + $SYNTAX$ + FT_DEFAULT( [ ] ) -> cDrive + $ARGUMENTS$ + is optional, and if specified is the new default drive. + $RETURNS$ + The current default drive. If a change of default drive is requested, + the return value is the drive AFTER the change is made. This allows + you to make sure you specified a valid drive (i.e. if you attempt to + change the default drive, and the function returns a different drive + letter than the one you specified, then the drive does not exist). + $DESCRIPTION$ + Useful any time you need to know or change the default drive. + $EXAMPLES$ + cDrive := FT_DEFAULT() // Get the current drive + FT_DEFAULT( "C" ) // Switch to drive C + + IF !( FT_DEFAULT( "E" ) == "E" ) + QOut( "Drive E does not exist!" ) + ENDIF + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/descendn.txt b/harbour/contrib/hbnf/doc/en/descendn.txt index a9b16327d5..46ef9a1cb2 100644 --- a/harbour/contrib/hbnf/doc/en/descendn.txt +++ b/harbour/contrib/hbnf/doc/en/descendn.txt @@ -2,25 +2,25 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_Descend() - * $CATEGORY$ - * Conversion - * $ONELINER$ - * Create a descending index key value - * $SYNTAX$ - * FT_Descend( ) -> - * $ARGUMENTS$ - * is any expression of character, numeric, date, or logical type. - * $RETURNS$ - * The inverse of - * $DESCRIPTION$ - * This function is a replacement for CA-Cl*pper's Descend() function, - * which is known to produce memory corruption occassionally. - * $EXAMPLES$ - * ? FT_Descend( 1 ) // Returns -1 - * $SEEALSO$ - * FT_XTOY() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_Descend() + $CATEGORY$ + Conversion + $ONELINER$ + Create a descending index key value + $SYNTAX$ + FT_Descend( ) -> + $ARGUMENTS$ + is any expression of character, numeric, date, or logical type. + $RETURNS$ + The inverse of + $DESCRIPTION$ + This function is a replacement for CA-Cl*pper's Descend() function, + which is known to produce memory corruption occassionally. + $EXAMPLES$ + ? FT_Descend( 1 ) // Returns -1 + $SEEALSO$ + FT_XTOY() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/dfile.txt b/harbour/contrib/hbnf/doc/en/dfile.txt index 0b297c6420..0be265490f 100644 --- a/harbour/contrib/hbnf/doc/en/dfile.txt +++ b/harbour/contrib/hbnf/doc/en/dfile.txt @@ -2,86 +2,86 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_DFSETUP() - * $CATEGORY$ - * File I/O - * $ONELINER$ - * Set up parameters for FT_DISPFILE() - * $SYNTAX$ - * FT_DFSETUP( , , , , , ; - * , , , , ; - * , , , ) -> nResult - * $ARGUMENTS$ - * - text file to display (full path and filename) - * - upper row of window - * - left col of window - * - lower row of window - * - right col of window - * - line to place highlight at startup - * - normal text color (numeric attribute) - * - text highlight color (numeric attribute) - * - terminating key list (each byte of string is a - * key code) - * - act-like-a-browse-routine flag - * - col increment for left/right arrows - * - right margin - anything to right is truncated - * - size of the paging buffer - * $RETURNS$ - * 0 if successful, FError() code if not - * $DESCRIPTION$ - * Note: make sure you allocate a buffer large enough to hold enough - * data for the number of lines that you have in the window. Use the - * following formula as a guideline: - * - * buffer size = (# of line) + 1 * RMargin - * - * This is the smallest you should make the buffer. For normal use, - * 4096 bytes is recommended - * $EXAMPLES$ - * @ 4, 9 TO 11, 71 - * - * FT_DFSETUP( "test.txt", 5, 10, 10, 70, 1, 7, 15,; - * "AaBb" + Chr( 143 ), .T., 5, 132, 4096 ) - * - * cKey := FT_DISPFILE() - * - * FT_DFCLOSE() - * - * @ 20, 0 SAY "Key that terminated FT_DISPFILE() was: " + "[" + cKey + "]" - * $SEEALSO$ - * FT_DISPFILE() FT_DFCLOSE() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_DFSETUP() + $CATEGORY$ + File I/O + $ONELINER$ + Set up parameters for FT_DISPFILE() + $SYNTAX$ + FT_DFSETUP( , , , , , ; + , , , , ; + , , , ) -> nResult + $ARGUMENTS$ + - text file to display (full path and filename) + - upper row of window + - left col of window + - lower row of window + - right col of window + - line to place highlight at startup + - normal text color (numeric attribute) + - text highlight color (numeric attribute) + - terminating key list (each byte of string is a + key code) + - act-like-a-browse-routine flag + - col increment for left/right arrows + - right margin - anything to right is truncated + - size of the paging buffer + $RETURNS$ + 0 if successful, FError() code if not + $DESCRIPTION$ + Note: make sure you allocate a buffer large enough to hold enough + data for the number of lines that you have in the window. Use the + following formula as a guideline: + + buffer size = (# of line) + 1 * RMargin + + This is the smallest you should make the buffer. For normal use, + 4096 bytes is recommended + $EXAMPLES$ + @ 4, 9 TO 11, 71 + + FT_DFSETUP( "test.txt", 5, 10, 10, 70, 1, 7, 15,; + "AaBb" + Chr( 143 ), .T., 5, 132, 4096 ) + + cKey := FT_DISPFILE() + + FT_DFCLOSE() + + @ 20, 0 SAY "Key that terminated FT_DISPFILE() was: " + "[" + cKey + "]" + $SEEALSO$ + FT_DISPFILE() FT_DFCLOSE() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_DFCLOSE() - * $CATEGORY$ - * File I/O - * $ONELINER$ - * Close file displayed by FT_DISPFILE() - * $SYNTAX$ - * FT_DFCLOSE() -> NIL - * $ARGUMENTS$ - * None - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * Closes the file opened by FT_DFSETUP() - * $EXAMPLES$ - * @ 4, 9 TO 11, 71 - * - * FT_DFSETUP( "test.txt", 5, 10, 10, 70, 1, 7, 15,; - * "AaBb" + Chr( 143 ), .T., 5, 132, 4096 ) - * - * cKey := FT_DISPFILE() - * - * FT_DFCLOSE() - * - * @ 20, 0 SAY "Key that terminated FT_DISPFILE() was: " + "[" + cKey + "]" - * $SEEALSO$ - * FT_DFSETUP() FT_DISPFILE() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_DFCLOSE() + $CATEGORY$ + File I/O + $ONELINER$ + Close file displayed by FT_DISPFILE() + $SYNTAX$ + FT_DFCLOSE() -> NIL + $ARGUMENTS$ + None + $RETURNS$ + NIL + $DESCRIPTION$ + Closes the file opened by FT_DFSETUP() + $EXAMPLES$ + @ 4, 9 TO 11, 71 + + FT_DFSETUP( "test.txt", 5, 10, 10, 70, 1, 7, 15,; + "AaBb" + Chr( 143 ), .T., 5, 132, 4096 ) + + cKey := FT_DISPFILE() + + FT_DFCLOSE() + + @ 20, 0 SAY "Key that terminated FT_DISPFILE() was: " + "[" + cKey + "]" + $SEEALSO$ + FT_DFSETUP() FT_DISPFILE() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/diskfunc.txt b/harbour/contrib/hbnf/doc/en/diskfunc.txt index 41539e34bd..8a93491e8d 100644 --- a/harbour/contrib/hbnf/doc/en/diskfunc.txt +++ b/harbour/contrib/hbnf/doc/en/diskfunc.txt @@ -2,51 +2,51 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_DSKSIZE() - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Return the maximum capacity of a fixed disk - * $SYNTAX$ - * FT_DSKSIZE( [ ] ) -> nMaxCapacity - * $ARGUMENTS$ - * is the fixed disk to query. If no drive is sent, the - * operation will be performed on the default drive. Send without - * the ":". - * $RETURNS$ - * An integer representing the maximum disk capacity in bytes. - * $DESCRIPTION$ - * Function utilizing FT_INT86() to return Maximum Disk Size. - * Uses FT_INT86() through the internal function _ftDiskInfo(). - * $EXAMPLES$ - * ? FT_DSKSIZE() // Maximum capacity for default drive - * ? FT_DSKSIZE( "D" ) // Maximum capacity for Drive D: - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_DSKSIZE() + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Return the maximum capacity of a fixed disk + $SYNTAX$ + FT_DSKSIZE( [ ] ) -> nMaxCapacity + $ARGUMENTS$ + is the fixed disk to query. If no drive is sent, the + operation will be performed on the default drive. Send without + the ":". + $RETURNS$ + An integer representing the maximum disk capacity in bytes. + $DESCRIPTION$ + Function utilizing FT_INT86() to return Maximum Disk Size. + Uses FT_INT86() through the internal function _ftDiskInfo(). + $EXAMPLES$ + ? FT_DSKSIZE() // Maximum capacity for default drive + ? FT_DSKSIZE( "D" ) // Maximum capacity for Drive D: + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_DSKFREE() - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Return the amount of available disk space - * $SYNTAX$ - * FT_DSKFREE( [ ] ) -> nSpaceAvail - * $ARGUMENTS$ - * is the fixed disk to query. If no parameter is passed - * the operation will be performed on the default drive. Do not - * include the ":". - * $RETURNS$ - * Integer representing the available disk space in bytes. - * $DESCRIPTION$ - * Function to return the available space on the passed - * drive letter or the default drive if no drive is passed. - * - * Uses FT_INT86() through the internal function _ftDiskInfo(). - * $EXAMPLES$ - * ? FT_DSKFREE() // Returns free space on default drive. - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_DSKFREE() + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Return the amount of available disk space + $SYNTAX$ + FT_DSKFREE( [ ] ) -> nSpaceAvail + $ARGUMENTS$ + is the fixed disk to query. If no parameter is passed + the operation will be performed on the default drive. Do not + include the ":". + $RETURNS$ + Integer representing the available disk space in bytes. + $DESCRIPTION$ + Function to return the available space on the passed + drive letter or the default drive if no drive is passed. + + Uses FT_INT86() through the internal function _ftDiskInfo(). + $EXAMPLES$ + ? FT_DSKFREE() // Returns free space on default drive. + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/dispc.txt b/harbour/contrib/hbnf/doc/en/dispc.txt index 4de30a6b3f..8b9d3c4947 100644 --- a/harbour/contrib/hbnf/doc/en/dispc.txt +++ b/harbour/contrib/hbnf/doc/en/dispc.txt @@ -2,63 +2,63 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_DISPFILE() - * $CATEGORY$ - * File I/O - * $ONELINER$ - * Browse a text file - * $SYNTAX$ - * FT_DISPFILE() -> cExitkey - * $ARGUMENTS$ - * None - * $RETURNS$ - * The ASCII keystroke that terminated FT_DISPFILE() - * $DESCRIPTION$ - * This routine displays a text file within a defined window using as - * little memory as possible. The text file to display has to be - * present or an error value of 0 is returned (as a character.) - * - * Assumptions: The routine assumes that all lines are terminated - * with a CR/LF sequence (0x0d and 0x0a). - * - * Note: Make sure you allocate a buffer large enough to hold - * enough data for the number of lines that you have - * in the window. Use the following formula as a - * guideline - buffer size = (# of line) + 1 * RMargin - * this is the smallest you should make the buffer and - * for normal use I recommend 4096 bytes. - * - * Cursor Keys: Up, Down - moves the highlight line - * Left, Right - moves the window over nColSkip col's - * Home - moves the window to the far left - * End - moves the window to the nRMargin column - * PgUp, PgDn - moves the highlight one page - * Ctrl-PgUp - moves the highlight to the file top - * Ctrl-PgDn - moves the highlight to the file bottom - * Ctrl-Right - moves the window 16 col's to the right - * Ctrl-Left - moves the window 16 col's to the left - * - * Esc, Return - terminates the function - * - * All other keys are ignored unless they are specified - * within cExitKeys parameter. This list will tell the - * routine what keys terminate the function. Special - * keys must be passed by a unique value and that value - * can be found by looking in the keys.h file. - * $EXAMPLES$ - * @ 4, 9 TO 11, 71 - * - * FT_DFSETUP( "test.txt", 5, 10, 10, 70, 1, 7, 15,; - * "AaBb" + Chr( 143 ), .T., 5, 132, 4096 ) - * - * cKey := FT_DISPFILE() - * - * FT_DFCLOSE() - * - * @ 20, 0 SAY "Key that terminated FT_DISPFILE() was: " + "[" + cKey + "]" - * $SEEALSO$ - * FT_DFSETUP() FT_DFCLOSE() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_DISPFILE() + $CATEGORY$ + File I/O + $ONELINER$ + Browse a text file + $SYNTAX$ + FT_DISPFILE() -> cExitkey + $ARGUMENTS$ + None + $RETURNS$ + The ASCII keystroke that terminated FT_DISPFILE() + $DESCRIPTION$ + This routine displays a text file within a defined window using as + little memory as possible. The text file to display has to be + present or an error value of 0 is returned (as a character.) + + Assumptions: The routine assumes that all lines are terminated + with a CR/LF sequence (0x0d and 0x0a). + + Note: Make sure you allocate a buffer large enough to hold + enough data for the number of lines that you have + in the window. Use the following formula as a + guideline - buffer size = (# of line) + 1 * RMargin + this is the smallest you should make the buffer and + for normal use I recommend 4096 bytes. + + Cursor Keys: Up, Down - moves the highlight line + Left, Right - moves the window over nColSkip col's + Home - moves the window to the far left + End - moves the window to the nRMargin column + PgUp, PgDn - moves the highlight one page + Ctrl-PgUp - moves the highlight to the file top + Ctrl-PgDn - moves the highlight to the file bottom + Ctrl-Right - moves the window 16 col's to the right + Ctrl-Left - moves the window 16 col's to the left + + Esc, Return - terminates the function + + All other keys are ignored unless they are specified + within cExitKeys parameter. This list will tell the + routine what keys terminate the function. Special + keys must be passed by a unique value and that value + can be found by looking in the keys.h file. + $EXAMPLES$ + @ 4, 9 TO 11, 71 + + FT_DFSETUP( "test.txt", 5, 10, 10, 70, 1, 7, 15,; + "AaBb" + Chr( 143 ), .T., 5, 132, 4096 ) + + cKey := FT_DISPFILE() + + FT_DFCLOSE() + + @ 20, 0 SAY "Key that terminated FT_DISPFILE() was: " + "[" + cKey + "]" + $SEEALSO$ + FT_DFSETUP() FT_DFCLOSE() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/dispmsg.txt b/harbour/contrib/hbnf/doc/en/dispmsg.txt index 0c0a2e22eb..b9f9b6f357 100644 --- a/harbour/contrib/hbnf/doc/en/dispmsg.txt +++ b/harbour/contrib/hbnf/doc/en/dispmsg.txt @@ -2,94 +2,94 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_DISPMSG() - * $CATEGORY$ - * Menus/Prompts - * $ONELINER$ - * Display a message and optionally waits for a keypress - * $SYNTAX$ - * FT_DISPMSG( , [ ], - * [ ], [ ], - * [ ], [ ] ) -> lKeyMatch - * $ARGUMENTS$ - * is a multidimensional array of messages to be - * displayed and the color attributes for each message. - * - * The first dimension of the array contains one or more elements, - * each representing one line in the message box, up to the maximum - * number of rows on the screen. - * - * Within each line of the message individual characters or groups - * of characters may be delimited with braces ([]). The braces will - * be stripped out and the character(s) inside those braces will be - * highlighted. - * - * The second dimension of the array contains a color attribute for - * the corresponding element in dimension one, plus one additional - * element for the color of the box border. Dimension two will - * always contain one more element than dimension one. If an - * attribute is omitted, the last color selected will be used. - * - * is a character string of one or more keys to check - * for. If omitted, the message is displayed and control is returned - * to the calling procedure. If one character is specified, - * FT_DISPMSG() waits for one keypress, restores the screen and - * returns. If multiple characters are specified, FT_DISPMSG() - * remains in a loop until one of the specified keys has been - * pressed, then restores the screen and returns. - * - * is the upper row for the message box. If omitted, the - * box is centered vertically. - * - * is the leftmost column for the box. If omitted, the - * box is centered horizontally. - * - * is a string of characters or a variable for the box - * border. See the DISPBOX() function. If omitted, a double box is - * drawn. - * - * is a logical variable. If true (.T.) or omitted, it - * uses FT_SHADOW() to add a transparent shadow to the box. If - * false (.F.), the box is drawn without the shadow. - * $RETURNS$ - * If is not specified, FT_DISPMSG() will return false - * (.F.). - * - * If is a one-character string, FT_DISPMSG() will return - * true (.T.) if the user presses that key, or false (.F.) if any - * other key is pressed. - * - * If consists of multiple characters, it will lock the - * user in a loop until one of those keys are pressed and return the - * INKEY() value of the keypress. - * $DESCRIPTION$ - * FT_DISPMSG() is a multi-purpose pop-up for user messages. - * Multiple lines may be displayed, each with a different attribute. - * The box will be automatically centered on the screen, or the row - * and/or column can be specified by the programmer. It also centers - * each line of the message within the box. - * $EXAMPLES$ - * The following example displays a simple two-line message - * and returns immediately to the calling routine. - * - * FT_DISPMSG( { { "Printing Report" , ; - * "Press [ESC] To Interrupt" } , ; - * { "W+/B*", "W/B", "GR+/B" } } ) - * - * The next example displays a message and waits for a key press. - * - * FT_DISPMSG( { { "Press [D] To Confirm Deletion" , ; - * "Or Any Other Key To Abort" } , ; - * { "W+/B", "W+/B", "GR+/B" } } , ; - * "D" ) - * - * The next example displays a one-line message centered on row 5 - * and returns to the calling procedure. - * - * FT_DISPMSG( { { "Please Do Not Interrupt" } , ; - * { "W+/B", "GR+/B" } } , ; - * , 5, ) - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_DISPMSG() + $CATEGORY$ + Menus/Prompts + $ONELINER$ + Display a message and optionally waits for a keypress + $SYNTAX$ + FT_DISPMSG( , [ ], + [ ], [ ], + [ ], [ ] ) -> lKeyMatch + $ARGUMENTS$ + is a multidimensional array of messages to be + displayed and the color attributes for each message. + + The first dimension of the array contains one or more elements, + each representing one line in the message box, up to the maximum + number of rows on the screen. + + Within each line of the message individual characters or groups + of characters may be delimited with braces ([]). The braces will + be stripped out and the character(s) inside those braces will be + highlighted. + + The second dimension of the array contains a color attribute for + the corresponding element in dimension one, plus one additional + element for the color of the box border. Dimension two will + always contain one more element than dimension one. If an + attribute is omitted, the last color selected will be used. + + is a character string of one or more keys to check + for. If omitted, the message is displayed and control is returned + to the calling procedure. If one character is specified, + FT_DISPMSG() waits for one keypress, restores the screen and + returns. If multiple characters are specified, FT_DISPMSG() + remains in a loop until one of the specified keys has been + pressed, then restores the screen and returns. + + is the upper row for the message box. If omitted, the + box is centered vertically. + + is the leftmost column for the box. If omitted, the + box is centered horizontally. + + is a string of characters or a variable for the box + border. See the DISPBOX() function. If omitted, a double box is + drawn. + + is a logical variable. If true (.T.) or omitted, it + uses FT_SHADOW() to add a transparent shadow to the box. If + false (.F.), the box is drawn without the shadow. + $RETURNS$ + If is not specified, FT_DISPMSG() will return false + (.F.). + + If is a one-character string, FT_DISPMSG() will return + true (.T.) if the user presses that key, or false (.F.) if any + other key is pressed. + + If consists of multiple characters, it will lock the + user in a loop until one of those keys are pressed and return the + INKEY() value of the keypress. + $DESCRIPTION$ + FT_DISPMSG() is a multi-purpose pop-up for user messages. + Multiple lines may be displayed, each with a different attribute. + The box will be automatically centered on the screen, or the row + and/or column can be specified by the programmer. It also centers + each line of the message within the box. + $EXAMPLES$ + The following example displays a simple two-line message + and returns immediately to the calling routine. + + FT_DISPMSG( { { "Printing Report" , ; + "Press [ESC] To Interrupt" } , ; + { "W+/B*", "W/B", "GR+/B" } } ) + + The next example displays a message and waits for a key press. + + FT_DISPMSG( { { "Press [D] To Confirm Deletion" , ; + "Or Any Other Key To Abort" } , ; + { "W+/B", "W+/B", "GR+/B" } } , ; + "D" ) + + The next example displays a one-line message centered on row 5 + and returns to the calling procedure. + + FT_DISPMSG( { { "Please Do Not Interrupt" } , ; + { "W+/B", "GR+/B" } } , ; + , 5, ) + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/dosver.txt b/harbour/contrib/hbnf/doc/en/dosver.txt index ad74db0f14..07c6339edc 100644 --- a/harbour/contrib/hbnf/doc/en/dosver.txt +++ b/harbour/contrib/hbnf/doc/en/dosver.txt @@ -2,34 +2,34 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_DOSVER - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Return the current DOS major and minor version as a string - * $SYNTAX$ - * FT_DOSVER() -> - * $ARGUMENTS$ - * None - * $RETURNS$ - * A character string with the major version number first, a - * period ("."), then the minor version number (e.g., "3.30") - * $DESCRIPTION$ - * FT_DOSVER() invokes DOS interrupt 21h, service 30 in order to - * return the current DOS version. It does this by setting up - * an array corresponding to machine registers and then calling - * the toolkit function FT_INT86(). - * - * It returns a character string corresponding to the DOS - * version, as follows: The major version, a period ("."), then - * the minor version. - * - * - * $EXAMPLES$ - * PROCEDURE Main() - * ? "Dos version: " + FT_DOSVER() - * RETURN - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_DOSVER + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Return the current DOS major and minor version as a string + $SYNTAX$ + FT_DOSVER() -> + $ARGUMENTS$ + None + $RETURNS$ + A character string with the major version number first, a + period ("."), then the minor version number (e.g., "3.30") + $DESCRIPTION$ + FT_DOSVER() invokes DOS interrupt 21h, service 30 in order to + return the current DOS version. It does this by setting up + an array corresponding to machine registers and then calling + the toolkit function FT_INT86(). + + It returns a character string corresponding to the DOS + version, as follows: The major version, a period ("."), then + the minor version. + + + $EXAMPLES$ + PROCEDURE Main() + ? "Dos version: " + FT_DOSVER() + RETURN + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/e2d.txt b/harbour/contrib/hbnf/doc/en/e2d.txt index ea5f61aef2..c3c550d9d1 100644 --- a/harbour/contrib/hbnf/doc/en/e2d.txt +++ b/harbour/contrib/hbnf/doc/en/e2d.txt @@ -2,29 +2,29 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_E2D() - * $CATEGORY$ - * Conversion - * $ONELINER$ - * Convert scientific notation string to a decimal - * $SYNTAX$ - * FT_E2D( ) -> - * $ARGUMENTS$ - * Scientific notation string to convert - * $RETURNS$ - * Decimal number - * $DESCRIPTION$ - * Given a string in the format x.yEz, the decimal - * equivalent is returned. - * $EXAMPLES$ - * ? FT_E2D( "1.23E1" ) -> 12.3 - * - * ? FT_E2D( "-1.235E1" ) -> -12.35 - * - * ? ft_d2e( "5.43E-6" ) -> 0.0000543 - * $SEEALSO$ - * FT_D2E() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_E2D() + $CATEGORY$ + Conversion + $ONELINER$ + Convert scientific notation string to a decimal + $SYNTAX$ + FT_E2D( ) -> + $ARGUMENTS$ + Scientific notation string to convert + $RETURNS$ + Decimal number + $DESCRIPTION$ + Given a string in the format x.yEz, the decimal + equivalent is returned. + $EXAMPLES$ + ? FT_E2D( "1.23E1" ) -> 12.3 + + ? FT_E2D( "-1.235E1" ) -> -12.35 + + ? ft_d2e( "5.43E-6" ) -> 0.0000543 + $SEEALSO$ + FT_D2E() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/easter.txt b/harbour/contrib/hbnf/doc/en/easter.txt index d40a0cc52c..732d5e0c41 100644 --- a/harbour/contrib/hbnf/doc/en/easter.txt +++ b/harbour/contrib/hbnf/doc/en/easter.txt @@ -2,28 +2,28 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_EASTER() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Return the date of Easter - * $SYNTAX$ - * FT_EASTER( ) -> dEdate - * $ARGUMENTS$ - * xYear can be a character, date or numeric describing the year - * for which you wish to receive the date of Easter. - * $RETURNS$ - * The actual date that Easter occurs. - * $DESCRIPTION$ - * Returns the date of Easter for any year after 1582 up to Clipper's - * limit which the manual states is 9999, but the Guide agrees with - * the actual imposed limit of 2999. - * - * This function can be useful in calender type programs that indicate - * when holidays occur. - * $EXAMPLES$ - * dEdate := FT_EASTER( 1990 ) // returns 04/15/1990 - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_EASTER() + $CATEGORY$ + Date/Time + $ONELINER$ + Return the date of Easter + $SYNTAX$ + FT_EASTER( ) -> dEdate + $ARGUMENTS$ + xYear can be a character, date or numeric describing the year + for which you wish to receive the date of Easter. + $RETURNS$ + The actual date that Easter occurs. + $DESCRIPTION$ + Returns the date of Easter for any year after 1582 up to Clipper's + limit which the manual states is 9999, but the Guide agrees with + the actual imposed limit of 2999. + + This function can be useful in calender type programs that indicate + when holidays occur. + $EXAMPLES$ + dEdate := FT_EASTER( 1990 ) // returns 04/15/1990 + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/elapmil.txt b/harbour/contrib/hbnf/doc/en/elapmil.txt index ce89a62e01..d1b71082e7 100644 --- a/harbour/contrib/hbnf/doc/en/elapmil.txt +++ b/harbour/contrib/hbnf/doc/en/elapmil.txt @@ -2,28 +2,28 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ELAPMIN() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Return difference, in minutes, between two mil format times. - * $SYNTAX$ - * FT_ELAPMIN( , ) -> nMINUTES - * $ARGUMENTS$ - * character strings of military form "hhmm", - * where 0<=hh<24. - * $RETURNS$ - * - * $DESCRIPTION$ - * Finds the arithmetic difference between time two times - * (time 2 - time 1). - * If time 2 is smaller than time 1, a NEGATIVE value is returned. - * $EXAMPLES$ - * FT_ELAPMIN( "1718", "2040" ) -> 322 - * FT_ELAPMIN( "2040", "1718" ) -> -322 - * $SEEALSO$ - * FT_ELTIME() FT_MIL2MIN() FT_MIN2MIL() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ELAPMIN() + $CATEGORY$ + Date/Time + $ONELINER$ + Return difference, in minutes, between two mil format times. + $SYNTAX$ + FT_ELAPMIN( , ) -> nMINUTES + $ARGUMENTS$ + character strings of military form "hhmm", + where 0<=hh<24. + $RETURNS$ + + $DESCRIPTION$ + Finds the arithmetic difference between time two times + (time 2 - time 1). + If time 2 is smaller than time 1, a NEGATIVE value is returned. + $EXAMPLES$ + FT_ELAPMIN( "1718", "2040" ) -> 322 + FT_ELAPMIN( "2040", "1718" ) -> -322 + $SEEALSO$ + FT_ELTIME() FT_MIL2MIN() FT_MIN2MIL() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/elapsed.txt b/harbour/contrib/hbnf/doc/en/elapsed.txt index f3643d7849..2e3386d807 100644 --- a/harbour/contrib/hbnf/doc/en/elapsed.txt +++ b/harbour/contrib/hbnf/doc/en/elapsed.txt @@ -2,44 +2,44 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ELAPSED() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Return elapsed time between two days and/or times - * $SYNTAX$ - * FT_ELAPSED([ ], [ ], ; - * , ) -> aTimedata - * $ARGUMENTS$ - * is any valid date in any date format. Defaults to DATE(). - * - * is any valid date in any date format. Defaults to DATE(). - * - * is a valid Time string of the format 'hh:mm:ss' where - * hh is hours in 24-hour format. - * - * is a valid Time string of the format 'hh:mm:ss' where - * hh is hours in 24-hour format. - * $RETURNS$ - * A two-dimensional array containing elapsed time data. - * $DESCRIPTION$ - * FT_ELAPSED() calculates the elapsed time between two Date/Time events. - * - * It returns an array which contains the following data: - * - * aRetVal[ 1, 1 ] Integer Days aRetVal[ 1, 2 ] Total Days (nn.nnnn) - * aRetVal[ 2, 1 ] Integer Hours aRetVal[ 2, 2 ] Total Hours (nn.nnnn) - * aRetVal[ 3, 1 ] Integer Minutes aRetVal[ 3, 2 ] Total Minutes (nn.nnnn) - * aRetVal[ 4, 1 ] Integer Seconds aRetVal[ 4, 2 ] Total Seconds (nn) - * $EXAMPLES$ - * FT_ELAPSED( SToD( "19901128" ), SToD( "19901130" ), "08:00:00", "12:10:30" ) - * will return: - * - * aRetVal[ 1, 1 ] -> 2 (Days) aRetVal[ 1, 2 ] -> 2.1740 Days - * aRetVal[ 2, 1 ] -> 4 (Hours) aRetVal[ 2, 2 ] -> 52.1750 Hours - * aRetVal[ 3, 1 ] -> 10 (Minutes) aRetVal[ 3, 2 ] -> 3130.5000 Minutes - * aRetVal[ 4, 1 ] -> 30 (Seconds) aRetVal[ 4, 2 ] -> 187830 Seconds - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ELAPSED() + $CATEGORY$ + Date/Time + $ONELINER$ + Return elapsed time between two days and/or times + $SYNTAX$ + FT_ELAPSED([ ], [ ], ; + , ) -> aTimedata + $ARGUMENTS$ + is any valid date in any date format. Defaults to DATE(). + + is any valid date in any date format. Defaults to DATE(). + + is a valid Time string of the format 'hh:mm:ss' where + hh is hours in 24-hour format. + + is a valid Time string of the format 'hh:mm:ss' where + hh is hours in 24-hour format. + $RETURNS$ + A two-dimensional array containing elapsed time data. + $DESCRIPTION$ + FT_ELAPSED() calculates the elapsed time between two Date/Time events. + + It returns an array which contains the following data: + + aRetVal[ 1, 1 ] Integer Days aRetVal[ 1, 2 ] Total Days (nn.nnnn) + aRetVal[ 2, 1 ] Integer Hours aRetVal[ 2, 2 ] Total Hours (nn.nnnn) + aRetVal[ 3, 1 ] Integer Minutes aRetVal[ 3, 2 ] Total Minutes (nn.nnnn) + aRetVal[ 4, 1 ] Integer Seconds aRetVal[ 4, 2 ] Total Seconds (nn) + $EXAMPLES$ + FT_ELAPSED( SToD( "19901128" ), SToD( "19901130" ), "08:00:00", "12:10:30" ) + will return: + + aRetVal[ 1, 1 ] -> 2 (Days) aRetVal[ 1, 2 ] -> 2.1740 Days + aRetVal[ 2, 1 ] -> 4 (Hours) aRetVal[ 2, 2 ] -> 52.1750 Hours + aRetVal[ 3, 1 ] -> 10 (Minutes) aRetVal[ 3, 2 ] -> 3130.5000 Minutes + aRetVal[ 4, 1 ] -> 30 (Seconds) aRetVal[ 4, 2 ] -> 187830 Seconds + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/eltime.txt b/harbour/contrib/hbnf/doc/en/eltime.txt index c31fc1d1fd..83f27e54b1 100644 --- a/harbour/contrib/hbnf/doc/en/eltime.txt +++ b/harbour/contrib/hbnf/doc/en/eltime.txt @@ -2,28 +2,28 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ELTIME() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Compute difference between times in hours, minutes, seconds. - * $SYNTAX$ - * FT_ELTIME( , ) -> cDiff - * $ARGUMENTS$ - * character strings representing times in - * hh:mm:ss format. - * $RETURNS$ - * character string representing time difference in - * hh:mm:ss format. - * $DESCRIPTION$ - * Return the absolute difference between two times in hh:mm:ss format - * in character hours, minutes and seconds (hh:mm:ss). - * $EXAMPLES$ - * FT_ELTIME( "22:40:12", "23:55:17" ) // 01:15:05 - * FT_ELTIME( "23:55:17", "22:40:12" ) // 01:15:05 - * $SEEALSO$ - * FT_ELAPMIN() FT_MIL2MIN() FT_MIN2MIL() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ELTIME() + $CATEGORY$ + Date/Time + $ONELINER$ + Compute difference between times in hours, minutes, seconds. + $SYNTAX$ + FT_ELTIME( , ) -> cDiff + $ARGUMENTS$ + character strings representing times in + hh:mm:ss format. + $RETURNS$ + character string representing time difference in + hh:mm:ss format. + $DESCRIPTION$ + Return the absolute difference between two times in hh:mm:ss format + in character hours, minutes and seconds (hh:mm:ss). + $EXAMPLES$ + FT_ELTIME( "22:40:12", "23:55:17" ) // 01:15:05 + FT_ELTIME( "23:55:17", "22:40:12" ) // 01:15:05 + $SEEALSO$ + FT_ELAPMIN() FT_MIL2MIN() FT_MIN2MIL() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/findith.txt b/harbour/contrib/hbnf/doc/en/findith.txt index 37f09b696e..b7c1e8890d 100644 --- a/harbour/contrib/hbnf/doc/en/findith.txt +++ b/harbour/contrib/hbnf/doc/en/findith.txt @@ -2,37 +2,37 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_FINDITH() - * $CATEGORY$ - * String - * $ONELINER$ - * Find the "ith" occurrence of a substring within a string - * $SYNTAX$ - * FT_FINDITH( , , ; - * [, ] ) -> - * $ARGUMENTS$ - * is the string to search for. - * - * is the string to search. - * - * is the number of the occurrence to find. - * - * is a logical indicating if the search is to be case - * sensitive. The default is no case sensitivity (.F.). - * $RETURNS$ - * The position in the string cCheckIn of the ith occurrence of cCheckFor. - * $DESCRIPTION$ - * This function finds the position in a string of the "ith" time another - * string appears in it. - * $EXAMPLES$ - * // Find the Position in cMemoString of - * // the 10th Occurrence of "the", case - * // insensitive - * - * nNextPosition := FT_FINDITH( "the", cMemoString, 10 ) - * $SEEALSO$ - * FT_AT2() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_FINDITH() + $CATEGORY$ + String + $ONELINER$ + Find the "ith" occurrence of a substring within a string + $SYNTAX$ + FT_FINDITH( , , ; + [, ] ) -> + $ARGUMENTS$ + is the string to search for. + + is the string to search. + + is the number of the occurrence to find. + + is a logical indicating if the search is to be case + sensitive. The default is no case sensitivity (.F.). + $RETURNS$ + The position in the string cCheckIn of the ith occurrence of cCheckFor. + $DESCRIPTION$ + This function finds the position in a string of the "ith" time another + string appears in it. + $EXAMPLES$ + // Find the Position in cMemoString of + // the 10th Occurrence of "the", case + // insensitive + + nNextPosition := FT_FINDITH( "the", cMemoString, 10 ) + $SEEALSO$ + FT_AT2() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/firstday.txt b/harbour/contrib/hbnf/doc/en/firstday.txt index 28ec1a72ee..2b15262f26 100644 --- a/harbour/contrib/hbnf/doc/en/firstday.txt +++ b/harbour/contrib/hbnf/doc/en/firstday.txt @@ -2,30 +2,30 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_FDAY() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Return first day of the month - * $SYNTAX$ - * FT_FDAY( [ ] ) -> dFirstDay - * $ARGUMENTS$ - * is a date within a month for which you want to find - * the first date of that month. If not passed or is an incorrect type, - * defaults to current system date. - * $RETURNS$ - * A Clipper date value representing the first date of the month. - * $DESCRIPTION$ - * This function will return the first day of the month of the date - * passed, or the first day of the current month if no argument is - * supplied. - * $EXAMPLES$ - * dDate := SToD( "19900915" ) - * ? FT_FDAY( dDate ) // 09/01/90 - * ? FT_FDAY() // 03/01/91 (current month) - * $SEEALSO$ - * FT_LDAY() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_FDAY() + $CATEGORY$ + Date/Time + $ONELINER$ + Return first day of the month + $SYNTAX$ + FT_FDAY( [ ] ) -> dFirstDay + $ARGUMENTS$ + is a date within a month for which you want to find + the first date of that month. If not passed or is an incorrect type, + defaults to current system date. + $RETURNS$ + A Clipper date value representing the first date of the month. + $DESCRIPTION$ + This function will return the first day of the month of the date + passed, or the first day of the current month if no argument is + supplied. + $EXAMPLES$ + dDate := SToD( "19900915" ) + ? FT_FDAY( dDate ) // 09/01/90 + ? FT_FDAY() // 03/01/91 (current month) + $SEEALSO$ + FT_LDAY() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/floptst.txt b/harbour/contrib/hbnf/doc/en/floptst.txt index 8f00f6f54d..4ccc586b60 100644 --- a/harbour/contrib/hbnf/doc/en/floptst.txt +++ b/harbour/contrib/hbnf/doc/en/floptst.txt @@ -2,53 +2,53 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_FLOPTST() - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Test diskette drive status - * $SYNTAX$ - * FT_FLOPTST( ) -> nStatus - * $ARGUMENTS$ - * is the diskette drive number, 0 = A:, 1 = B: - * $RETURNS$ - * -1 - Wrong Parameters - * 0 - Drive Loaded and ready to read or write - * 1 - Drive Door Open or Diskette inserted upside down - * 2 - Diskette is unformatted - * 3 - Write protected - * 4 - Undetermined - * $DESCRIPTION$ - * FT_FLOPTST() is designed as a full replacement for ISDRIVE(). Where - * ISDRIVE() returns just .T. or .F. depending if the diskette drive is - * ready or not, FT_FLOPTST() returns a numeric code designating the - * diskette drive's status. - * - * FT_FLOPTST() is particularly useful in backup and restore programs - * that need to test the floppy drive before writing/reading from a - * floppy disk. - * - * No testing has been performed on systems with more than 2 floppy - * drives. If the third drive is "C" and the fourth "D" then there - * should be no problems. - * - * This function does not currently check subst'd drives. So if you - * have SUBST E: A:\ then FT_FLOPTST( Asc( "E" ) - Asc( "A" ) ) == 4 - * Any suggestions to fix this limitation are appreciated. - * - * $EXAMPLES$ - * iStatus := FT_FLOPTST( 0 ) - * DO CASE - * CASE iStatus == 1 - * ? "The door to drive A is open." - * CASE iStatus == 2 - * ? "The diskette in drive A is not formatted." - * CASE iStatus == 3 - * ? "The diskette in drive A is write-protected." - * CASE iStatus == 4 - * ? "Something is wrong with drive A, but I don't know what." - * ENDCASE - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_FLOPTST() + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Test diskette drive status + $SYNTAX$ + FT_FLOPTST( ) -> nStatus + $ARGUMENTS$ + is the diskette drive number, 0 = A:, 1 = B: + $RETURNS$ + -1 - Wrong Parameters + 0 - Drive Loaded and ready to read or write + 1 - Drive Door Open or Diskette inserted upside down + 2 - Diskette is unformatted + 3 - Write protected + 4 - Undetermined + $DESCRIPTION$ + FT_FLOPTST() is designed as a full replacement for ISDRIVE(). Where + ISDRIVE() returns just .T. or .F. depending if the diskette drive is + ready or not, FT_FLOPTST() returns a numeric code designating the + diskette drive's status. + + FT_FLOPTST() is particularly useful in backup and restore programs + that need to test the floppy drive before writing/reading from a + floppy disk. + + No testing has been performed on systems with more than 2 floppy + drives. If the third drive is "C" and the fourth "D" then there + should be no problems. + + This function does not currently check subst'd drives. So if you + have SUBST E: A:\ then FT_FLOPTST( Asc( "E" ) - Asc( "A" ) ) == 4 + Any suggestions to fix this limitation are appreciated. + + $EXAMPLES$ + iStatus := FT_FLOPTST( 0 ) + DO CASE + CASE iStatus == 1 + ? "The door to drive A is open." + CASE iStatus == 2 + ? "The diskette in drive A is not formatted." + CASE iStatus == 3 + ? "The diskette in drive A is write-protected." + CASE iStatus == 4 + ? "Something is wrong with drive A, but I don't know what." + ENDCASE + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/ftattr.txt b/harbour/contrib/hbnf/doc/en/ftattr.txt index f5dd05fd71..8314388aa1 100644 --- a/harbour/contrib/hbnf/doc/en/ftattr.txt +++ b/harbour/contrib/hbnf/doc/en/ftattr.txt @@ -2,76 +2,76 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_SAVEATT() - * $CATEGORY$ - * Video - * $ONELINER$ - * Save the attribute bytes of a specified screen region. - * $SYNTAX$ - * FT_SAVEATT( , , , ) -> cAttributes - * $ARGUMENTS$ - * , , , and define the screen region. - * $RETURNS$ - * A character string containing the screen attribute bytes for the - * specified region. If the memory to store the return value could - * not be allocated, the function returns NIL. - * $DESCRIPTION$ - * This function is similar to Clipper's SaveScreen(), except that it only - * saves the attribute bytes. This is useful if you want to change the - * screen color without affecting the text. - * - * *** INTERNALS ALERT *** - * - * This function calls the Clipper internal __gtMaxCol to obtain the - * maximum column value for the current video mode. If you're too gutless - * to use internals, then this function isn't for you. - * $EXAMPLES$ - * // Save attributes of row 4 - * cBuffer := FT_SAVEATT( 4, 0, 4, MaxCol() ) - * - * // Save attributes from middle of screen - * cBuffer := FT_SAVEATT( 10, 20, 14, 59 ) - * $SEEALSO$ - * FT_RESTATT() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SAVEATT() + $CATEGORY$ + Video + $ONELINER$ + Save the attribute bytes of a specified screen region. + $SYNTAX$ + FT_SAVEATT( , , , ) -> cAttributes + $ARGUMENTS$ + , , , and define the screen region. + $RETURNS$ + A character string containing the screen attribute bytes for the + specified region. If the memory to store the return value could + not be allocated, the function returns NIL. + $DESCRIPTION$ + This function is similar to Clipper's SaveScreen(), except that it only + saves the attribute bytes. This is useful if you want to change the + screen color without affecting the text. + + *** INTERNALS ALERT *** + + This function calls the Clipper internal __gtMaxCol to obtain the + maximum column value for the current video mode. If you're too gutless + to use internals, then this function isn't for you. + $EXAMPLES$ + // Save attributes of row 4 + cBuffer := FT_SAVEATT( 4, 0, 4, MaxCol() ) + + // Save attributes from middle of screen + cBuffer := FT_SAVEATT( 10, 20, 14, 59 ) + $SEEALSO$ + FT_RESTATT() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_RESTATT() - * $CATEGORY$ - * Video - * $ONELINER$ - * Restore the attribute bytes of a specified screen region. - * $SYNTAX$ - * FT_RESTATT( , , , , ) -> NIL - * $ARGUMENTS$ - * , , , and define the screen region. - * is a character string containing the attribute bytes - * for the screen region. This will most often be a string - * previously returned by FT_SAVEATT(), but any character - * string may be used (provided it is of the proper size). - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * This function is similar to Clipper's RestScreen(), except that it only - * restores the attribute bytes. This is useful if you want to change the - * screen color without affecting the text. - * - * *** INTERNALS ALERT *** - * - * This function calls the Clipper internals __gtSave and __gtRest to - * manipulate the the screen image. If you're too gutless to use - * internals, then this function isn't for you. - * $EXAMPLES$ - * // Restore attributes of row 4 - * FT_RESTATT( 4, 0, 4, MaxCol(), cBuffer ) - * - * // Restore attributes to middle of screen - * FT_RESTATT( 10, 20, 14, 59, cBuffer ) - * $SEEALSO$ - * FT_SAVEATT() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_RESTATT() + $CATEGORY$ + Video + $ONELINER$ + Restore the attribute bytes of a specified screen region. + $SYNTAX$ + FT_RESTATT( , , , , ) -> NIL + $ARGUMENTS$ + , , , and define the screen region. + is a character string containing the attribute bytes + for the screen region. This will most often be a string + previously returned by FT_SAVEATT(), but any character + string may be used (provided it is of the proper size). + $RETURNS$ + NIL + $DESCRIPTION$ + This function is similar to Clipper's RestScreen(), except that it only + restores the attribute bytes. This is useful if you want to change the + screen color without affecting the text. + + *** INTERNALS ALERT *** + + This function calls the Clipper internals __gtSave and __gtRest to + manipulate the the screen image. If you're too gutless to use + internals, then this function isn't for you. + $EXAMPLES$ + // Restore attributes of row 4 + FT_RESTATT( 4, 0, 4, MaxCol(), cBuffer ) + + // Restore attributes to middle of screen + FT_RESTATT( 10, 20, 14, 59, cBuffer ) + $SEEALSO$ + FT_SAVEATT() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/fttext.txt b/harbour/contrib/hbnf/doc/en/fttext.txt index 89840114b5..8b6b65ef69 100644 --- a/harbour/contrib/hbnf/doc/en/fttext.txt +++ b/harbour/contrib/hbnf/doc/en/fttext.txt @@ -2,716 +2,716 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_FUSE() - * $CATEGORY$ - * File I/O - * $ONELINER$ - * Open or close a text file for use by the FT_F* functions - * $SYNTAX$ - * FT_FUSE( [ ] [, ] ) -> nHandle | 0 - * - * $ARGUMENTS$ - * ^b^n is the text file you want to open. If not specified, - * the file currently open, if any, will be closed. - * - * ^b^n is the open mode for the file. Please refer to the - * discussion of open modes under FOPEN() in the Clipper manual - * and fileio.ch for a list of allowable open modes. If not - * specified, the file will be opened with a mode of - * FO_READ + FO_SHARED (64). - * - * $RETURNS$ - * If ^b^n is passed and the file is opened successfully, an - * integer containing the text file's workarea. If the file cannot be - * opened, -1 will be returned. In this case, check the return value - * of ^bft_fError()^n for the cause of the error. - * - * If FT_FUSE() is called without any arguments, it will close the - * text file in the current "text area" and return 0. - * - * If a read error occurs ^ft_fError()^n will contain the error code. - * - * $DESCRIPTION$ - * The FT_F*() file functions are for reading text files, that is, - * files where each line (record) is delimited by a CRLF pair. - * - * Each file is opened in its own "workarea", similar to the concept - * use by dbf files. As provided, a maximum of 10 files (in 10 - * workareas) can be opened (assuming there are sufficient file - * handles available). That number may be increased by modifying - * the #define TEXT_WORKAREAS in the C source code and recompiling. - * - * $EXAMPLES$ - * #include "fileio.ch" - * - * // open a text file for reading - * ft_fUse( "text.txt" ) - * - * // open a text file for reading and writing - * ft_fUse( "text.txt", FO_READWRITE + FO_SHARED ) - * - * // close file - * ft_fUse() - * - * $SEEALSO$ - * FT_FUSE() FT_FSELECT() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_FUSE() + $CATEGORY$ + File I/O + $ONELINER$ + Open or close a text file for use by the FT_F* functions + $SYNTAX$ + FT_FUSE( [ ] [, ] ) -> nHandle | 0 + + $ARGUMENTS$ + ^b^n is the text file you want to open. If not specified, + the file currently open, if any, will be closed. + + ^b^n is the open mode for the file. Please refer to the + discussion of open modes under FOPEN() in the Clipper manual + and fileio.ch for a list of allowable open modes. If not + specified, the file will be opened with a mode of + FO_READ + FO_SHARED (64). + + $RETURNS$ + If ^b^n is passed and the file is opened successfully, an + integer containing the text file's workarea. If the file cannot be + opened, -1 will be returned. In this case, check the return value + of ^bft_fError()^n for the cause of the error. + + If FT_FUSE() is called without any arguments, it will close the + text file in the current "text area" and return 0. + + If a read error occurs ^ft_fError()^n will contain the error code. + + $DESCRIPTION$ + The FT_F*() file functions are for reading text files, that is, + files where each line (record) is delimited by a CRLF pair. + + Each file is opened in its own "workarea", similar to the concept + use by dbf files. As provided, a maximum of 10 files (in 10 + workareas) can be opened (assuming there are sufficient file + handles available). That number may be increased by modifying + the #define TEXT_WORKAREAS in the C source code and recompiling. + + $EXAMPLES$ + #include "fileio.ch" + + // open a text file for reading + ft_fUse( "text.txt" ) + + // open a text file for reading and writing + ft_fUse( "text.txt", FO_READWRITE + FO_SHARED ) + + // close file + ft_fUse() + + $SEEALSO$ + FT_FUSE() FT_FSELECT() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_FSELECT() - * $CATEGORY$ - * File I/O - * $ONELINER$ - * Select a text file workarea - * $SYNTAX$ - * FT_FSELECT( [ ] ) -> nPreviousArea - * - * $ARGUMENTS$ - * ^b^n is the text file workarea to select. - * - * $RETURNS$ - * The current selected text file area. - * - * $DESCRIPTION$ - * This function selects a text file "workarea" from 1 to 10. A - * file may or may not be open in the selected area. - * - * Passing 0 for ^b^n selects the next available workarea, - * similar to Clipper's SELECT 0 command. If no more workareas are - * available the current workarea is not changed. - * - * Each file is opened in its own "workarea", similar to the concept - * used by dbf files. As provided, a maximum of 10 files (in 10 - * workareas) can be opened (assuming there are sufficient file - * handles available). That number may be increased by modifying - * the #define TEXT_WORKAREAS in the C source code and recompiling. - * - * All the FT_F*() file functions operate on the file in the currently - * selected text file workarea. - * - * Text file workareas are separate from and independent of Clipper's - * database workareas. - * - * $EXAMPLES$ - * FT_FSELECT( 1 ) - * - * nFile1 := FT_FUSE( "temp.c" ) - * - * ? FT_FLASTRE() // no. of lines in temp.c - * - * FT_FSELECT( 2 ) - * - * nFile2 := FT_FUSE( "temp.h" ) - * - * ? FT_FLASTRE() // no. of lines in temp.h - * - * $SEEALSO$ - * FT_FUSE() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_FSELECT() + $CATEGORY$ + File I/O + $ONELINER$ + Select a text file workarea + $SYNTAX$ + FT_FSELECT( [ ] ) -> nPreviousArea + + $ARGUMENTS$ + ^b^n is the text file workarea to select. + + $RETURNS$ + The current selected text file area. + + $DESCRIPTION$ + This function selects a text file "workarea" from 1 to 10. A + file may or may not be open in the selected area. + + Passing 0 for ^b^n selects the next available workarea, + similar to Clipper's SELECT 0 command. If no more workareas are + available the current workarea is not changed. + + Each file is opened in its own "workarea", similar to the concept + used by dbf files. As provided, a maximum of 10 files (in 10 + workareas) can be opened (assuming there are sufficient file + handles available). That number may be increased by modifying + the #define TEXT_WORKAREAS in the C source code and recompiling. + + All the FT_F*() file functions operate on the file in the currently + selected text file workarea. + + Text file workareas are separate from and independent of Clipper's + database workareas. + + $EXAMPLES$ + FT_FSELECT( 1 ) + + nFile1 := FT_FUSE( "temp.c" ) + + ? FT_FLASTRE() // no. of lines in temp.c + + FT_FSELECT( 2 ) + + nFile2 := FT_FUSE( "temp.h" ) + + ? FT_FLASTRE() // no. of lines in temp.h + + $SEEALSO$ + FT_FUSE() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_FGOTOP() - * $CATEGORY$ - * File I/O - * $ONELINER$ - * Go to the first record in a text file - * $SYNTAX$ - * FT_FGOTOP() -> NIL - * - * $ARGUMENTS$ - * None - * - * $RETURNS$ - * NIL - * - * $DESCRIPTION$ - * This function moves the record pointer to the first record - * in the currently selected text file workarea. - * - * A text file "record" is a line of text terminated by a CRLF pair. - * - * $EXAMPLES$ - * FT_FUSE( "text.c" ) // open text file - * - * DO WHILE !FT_FEOF() - * - * ? FT_FREADLN() // read thru file - * - * FT_FSKIP() - * - * ENDDO - * - * FT_FGOTOP() // go back to top - * - * ? FT_FRECNO() // 1 - * - * $SEEALSO$ - * FT_FSELECT() FT_FUSE() FT_FRECNO() FT_FGOBOT() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_FGOTOP() + $CATEGORY$ + File I/O + $ONELINER$ + Go to the first record in a text file + $SYNTAX$ + FT_FGOTOP() -> NIL + + $ARGUMENTS$ + None + + $RETURNS$ + NIL + + $DESCRIPTION$ + This function moves the record pointer to the first record + in the currently selected text file workarea. + + A text file "record" is a line of text terminated by a CRLF pair. + + $EXAMPLES$ + FT_FUSE( "text.c" ) // open text file + + DO WHILE !FT_FEOF() + + ? FT_FREADLN() // read thru file + + FT_FSKIP() + + ENDDO + + FT_FGOTOP() // go back to top + + ? FT_FRECNO() // 1 + + $SEEALSO$ + FT_FSELECT() FT_FUSE() FT_FRECNO() FT_FGOBOT() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_FERROR() - * $CATEGORY$ - * File I/O - * $ONELINER$ - * Return the error code for a text file operation - * $SYNTAX$ - * FT_FERROR() -> nErrorNo - * - * $ARGUMENTS$ - * None - * - * $RETURNS$ - * The DOS error code if one occurred. See a reference on DOS error - * codes for an explanation of what the code means. - * - * $DESCRIPTION$ - * This function returns the DOS error code associated with a file - * operation on the currently selected text file. - * - * Errors could stem from any open, create, read or write operation, - * among others. - * - * $EXAMPLES$ - * IF ft_fUse( "text.c" ) < 0 // open text file - * err := ft_fError() - * ? 'Error opening file "rext.c", error code (' + ; - * hb_ntos( err ) + ')' - * ENDIF - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_FERROR() + $CATEGORY$ + File I/O + $ONELINER$ + Return the error code for a text file operation + $SYNTAX$ + FT_FERROR() -> nErrorNo + + $ARGUMENTS$ + None + + $RETURNS$ + The DOS error code if one occurred. See a reference on DOS error + codes for an explanation of what the code means. + + $DESCRIPTION$ + This function returns the DOS error code associated with a file + operation on the currently selected text file. + + Errors could stem from any open, create, read or write operation, + among others. + + $EXAMPLES$ + IF ft_fUse( "text.c" ) < 0 // open text file + err := ft_fError() + ? 'Error opening file "rext.c", error code (' + ; + hb_ntos( err ) + ')' + ENDIF + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_FRECNO() - * $CATEGORY$ - * File I/O - * $ONELINER$ - * Return the current record number of a text file - * $SYNTAX$ - * FT_FRECNO() -> nRecNo - * - * $ARGUMENTS$ - * None - * - * $RETURNS$ - * The current record number of a text file or 0 if no file is open. - * - * $DESCRIPTION$ - * This function returns the current record number of the file open - * in the currently selected text file workarea. - * - * A text file "record" is a line of text terminated by a CRLF pair. - * - * $EXAMPLES$ - * FT_FUSE( "text.c" ) // open text file - * - * DO WHILE ! FT_FEOF() - * - * ? FT_FREADLN() // read thru file - * - * FT_FSKIP() - * - * ENDDO - * - * FT_FGOTOP() // go back to top - * - * ? FT_FRECNO() // 1 - * - * $SEEALSO$ - * FT_FSELECT() FT_FUSE() FT_FGOTOP() FT_FGOBOT() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_FRECNO() + $CATEGORY$ + File I/O + $ONELINER$ + Return the current record number of a text file + $SYNTAX$ + FT_FRECNO() -> nRecNo + + $ARGUMENTS$ + None + + $RETURNS$ + The current record number of a text file or 0 if no file is open. + + $DESCRIPTION$ + This function returns the current record number of the file open + in the currently selected text file workarea. + + A text file "record" is a line of text terminated by a CRLF pair. + + $EXAMPLES$ + FT_FUSE( "text.c" ) // open text file + + DO WHILE ! FT_FEOF() + + ? FT_FREADLN() // read thru file + + FT_FSKIP() + + ENDDO + + FT_FGOTOP() // go back to top + + ? FT_FRECNO() // 1 + + $SEEALSO$ + FT_FSELECT() FT_FUSE() FT_FGOTOP() FT_FGOBOT() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_FGOBOT() - * $CATEGORY$ - * File I/O - * $ONELINER$ - * Go to the last record in a text file - * $SYNTAX$ - * FT_FGOBOT() -> NIL - * - * $ARGUMENTS$ - * None - * - * $RETURNS$ - * NIL - * - * $DESCRIPTION$ - * This function moves the record pointer to the last record of the - * file in the currently selected text file workarea. - * - * If a read error occurs ^ft_fError()^n will contain the error code. - * - * A text file "record" is a line of text terminated by a CRLF pair. - * - * $EXAMPLES$ - * // read last line - * FT_FUSE( "text.c" ) - * - * FT_FGOBOT() - * - * ? FT_FREADLN() - * - * $SEEALSO$ - * FT_FSELECT() FT_FUSE() FT_FGOTOP() FT_FRECNO() FT_FREADLN() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_FGOBOT() + $CATEGORY$ + File I/O + $ONELINER$ + Go to the last record in a text file + $SYNTAX$ + FT_FGOBOT() -> NIL + + $ARGUMENTS$ + None + + $RETURNS$ + NIL + + $DESCRIPTION$ + This function moves the record pointer to the last record of the + file in the currently selected text file workarea. + + If a read error occurs ^ft_fError()^n will contain the error code. + + A text file "record" is a line of text terminated by a CRLF pair. + + $EXAMPLES$ + // read last line + FT_FUSE( "text.c" ) + + FT_FGOBOT() + + ? FT_FREADLN() + + $SEEALSO$ + FT_FSELECT() FT_FUSE() FT_FGOTOP() FT_FRECNO() FT_FREADLN() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_FSKIP() - * $CATEGORY$ - * File I/O - * $ONELINER$ - * Move the record pointer to a new position in a text file - * $SYNTAX$ - * FT_FSKIP( [ ] ) -> nLinesSkipped - * - * $ARGUMENTS$ - * is the number of lines to skip. Defaults to 1 if - * not specified. - * - * $RETURNS$ - * The number of lines actually skipped. If the file's EOF or - * BOF was encountered before ^b^n could be skipped, the - * return value will be less than ^b^n. - * - * $DESCRIPTION$ - * This function moves the text file record pointer, similar to - * the CLIPPER SKIP command. - * - * Use the return value to determine how many records were actually - * skipped, for example to write a custom skipper function for - * TBrowse'g text files. - * - * If a read error occurs ^ft_fError()^n will contain the error code. - * - * A text file "record" is a line of text terminated by a CRLF pair. - * - * $EXAMPLES$ - * // display each record of a text file - * - * FT_FUSE( "text.c" ) - * - * DO WHILE ! FT_FEOF() - * - * ? FT_FREADLN() - * - * FT_FSKIP() - * - * ENDDO - * - * - * $SEEALSO$ - * FT_FRECNO() FT_FGOTOP() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_FSKIP() + $CATEGORY$ + File I/O + $ONELINER$ + Move the record pointer to a new position in a text file + $SYNTAX$ + FT_FSKIP( [ ] ) -> nLinesSkipped + + $ARGUMENTS$ + is the number of lines to skip. Defaults to 1 if + not specified. + + $RETURNS$ + The number of lines actually skipped. If the file's EOF or + BOF was encountered before ^b^n could be skipped, the + return value will be less than ^b^n. + + $DESCRIPTION$ + This function moves the text file record pointer, similar to + the CLIPPER SKIP command. + + Use the return value to determine how many records were actually + skipped, for example to write a custom skipper function for + TBrowse'g text files. + + If a read error occurs ^ft_fError()^n will contain the error code. + + A text file "record" is a line of text terminated by a CRLF pair. + + $EXAMPLES$ + // display each record of a text file + + FT_FUSE( "text.c" ) + + DO WHILE ! FT_FEOF() + + ? FT_FREADLN() + + FT_FSKIP() + + ENDDO + + + $SEEALSO$ + FT_FRECNO() FT_FGOTOP() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_FREADLN() - * $CATEGORY$ - * File I/O - * $ONELINER$ - * Read a line from the currently selected text file - * $SYNTAX$ - * FT_FREADLN() -> cLine - * - * $ARGUMENTS$ - * None - * - * $RETURNS$ - * A string containing the current record in a text file. - * - * $DESCRIPTION$ - * This function returns a line of text read from the file in the - * currently selected text file workarea. Text lines are delimited - * with a CRLF pair. The record pointer is not moved. - * - * Currently the maximum record size is 4096 characters. You may - * increase the maximum record size by changing the value of ^b#define - * ^bBUFFSIZE^n in the C source and recompiling, however you should - * consider the performance implications if you do (all read and writes - * use this buffer size, including ft_fSkip()'s and ft_fGoto()'s). - * - * If a read error occurs ^ft_fError()^n will contain the error code. - * - * A text file "record" is a line of text terminated by a CRLF pair. - * - * $EXAMPLES$ - * // display each record of a text file - * - * FT_FUSE( "text.c" ) - * - * DO WHILE ! FT_FEOF() - * - * ? FT_FREADLN() - * - * FT_FSKIP() - * - * ENDDO - * - * $SEEALSO$ - * FT_FUSE() FT_FWRITELN() FT_FRECNO() FT_FGOTOP() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_FREADLN() + $CATEGORY$ + File I/O + $ONELINER$ + Read a line from the currently selected text file + $SYNTAX$ + FT_FREADLN() -> cLine + + $ARGUMENTS$ + None + + $RETURNS$ + A string containing the current record in a text file. + + $DESCRIPTION$ + This function returns a line of text read from the file in the + currently selected text file workarea. Text lines are delimited + with a CRLF pair. The record pointer is not moved. + + Currently the maximum record size is 4096 characters. You may + increase the maximum record size by changing the value of ^b#define + ^bBUFFSIZE^n in the C source and recompiling, however you should + consider the performance implications if you do (all read and writes + use this buffer size, including ft_fSkip()'s and ft_fGoto()'s). + + If a read error occurs ^ft_fError()^n will contain the error code. + + A text file "record" is a line of text terminated by a CRLF pair. + + $EXAMPLES$ + // display each record of a text file + + FT_FUSE( "text.c" ) + + DO WHILE ! FT_FEOF() + + ? FT_FREADLN() + + FT_FSKIP() + + ENDDO + + $SEEALSO$ + FT_FUSE() FT_FWRITELN() FT_FRECNO() FT_FGOTOP() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_FDELETE() - * $CATEGORY$ - * File I/O - * $ONELINER$ - * Deletes a line from the currently selected text file - * $SYNTAX$ - * FT_FDELETE( [ ] ) -> lSuccess - * - * $ARGUMENTS$ - * ^b^n is the number of lines to be eliminated, beginning with - * the current record position. - * - * If ^b^n is omitted, the current record is deleted only. - * - * $RETURNS$ - * TRUE if successful, otherwise check ^ft_fError()^n for error code. - * - * $DESCRIPTION$ - * This function deletes one or several lines of text from the file - * in the currently selected text file workarea. Text lines are - * delimited with a CRLF pair. The record pointer is not moved, - * unless the deleted lines occur at the end of the file, in which - * case ^bft_fRecno()^n will equal ^bft_fLastRe()^n and ^bft_fEOF()^n - * will be set to TRUE. - * - * $EXAMPLES$ - * // delete the next 4 lines from a file - * FT_FUSE( "test.txt" ) - * - * FT_FDELETE( 4 ) - * - * $SEEALSO$ - * FT_FAPPEND() FT_FRECNO() FT_FINSERT() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_FDELETE() + $CATEGORY$ + File I/O + $ONELINER$ + Deletes a line from the currently selected text file + $SYNTAX$ + FT_FDELETE( [ ] ) -> lSuccess + + $ARGUMENTS$ + ^b^n is the number of lines to be eliminated, beginning with + the current record position. + + If ^b^n is omitted, the current record is deleted only. + + $RETURNS$ + TRUE if successful, otherwise check ^ft_fError()^n for error code. + + $DESCRIPTION$ + This function deletes one or several lines of text from the file + in the currently selected text file workarea. Text lines are + delimited with a CRLF pair. The record pointer is not moved, + unless the deleted lines occur at the end of the file, in which + case ^bft_fRecno()^n will equal ^bft_fLastRe()^n and ^bft_fEOF()^n + will be set to TRUE. + + $EXAMPLES$ + // delete the next 4 lines from a file + FT_FUSE( "test.txt" ) + + FT_FDELETE( 4 ) + + $SEEALSO$ + FT_FAPPEND() FT_FRECNO() FT_FINSERT() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_FINSERT() - * $CATEGORY$ - * File I/O - * $ONELINER$ - * Inserts a line in the currently selected text file - * $SYNTAX$ - * FT_FINSERT( [ ] ) -> lSuccess - * - * $ARGUMENTS$ - * ^b^n is the number of lines that should be inserted at the - * current record position. - * - * If ^b^n is omitted, one record is inserted. - * - * $RETURNS$ - * ^blSuccess^n is TRUE if the insert succeeded, FALSE if not. If - * false check the return value of ^bft_fError()^n for the reason. - * - * $DESCRIPTION$ - * This function inserts a line of text in the file in the currently - * selected text file workarea. Text lines are delimited with a - * CRLF pair. - * - * The record pointer is not moved. - * - * A text file "record" is a line of text terminated by a CRLF pair. - * Each line inserted with this function will be empty. - * - * $EXAMPLES$ - * // add a couple of blank lines of text to a file - * ft_fUse( "test.txt" ) - * - * ft_fGoTo( 10 ) - * - * ft_fInsert( 5 ) - * - * $SEEALSO$ - * FT_FAPPEND() FT_FRECNO() FT_FDELETE() FT_FLASTRE() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_FINSERT() + $CATEGORY$ + File I/O + $ONELINER$ + Inserts a line in the currently selected text file + $SYNTAX$ + FT_FINSERT( [ ] ) -> lSuccess + + $ARGUMENTS$ + ^b^n is the number of lines that should be inserted at the + current record position. + + If ^b^n is omitted, one record is inserted. + + $RETURNS$ + ^blSuccess^n is TRUE if the insert succeeded, FALSE if not. If + false check the return value of ^bft_fError()^n for the reason. + + $DESCRIPTION$ + This function inserts a line of text in the file in the currently + selected text file workarea. Text lines are delimited with a + CRLF pair. + + The record pointer is not moved. + + A text file "record" is a line of text terminated by a CRLF pair. + Each line inserted with this function will be empty. + + $EXAMPLES$ + // add a couple of blank lines of text to a file + ft_fUse( "test.txt" ) + + ft_fGoTo( 10 ) + + ft_fInsert( 5 ) + + $SEEALSO$ + FT_FAPPEND() FT_FRECNO() FT_FDELETE() FT_FLASTRE() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_FAPPEND() - * $CATEGORY$ - * File I/O - * $ONELINER$ - * Appends a line to the currently selected text file - * $SYNTAX$ - * FT_FAPPEND( [ < nLines > ] ) -> NIL - * - * $ARGUMENTS$ - * is the number of lines that should be appended to the - * end of the currently selected text file. - * - * If is omitted, one record is appended. - * - * $RETURNS$ - * lSuccess. If FALSE, check ^bft_fError()^n for the error code. - * - * $DESCRIPTION$ - * This function appends a line of text to the file in the currently - * selected text file workarea. Text lines are delimited with a - * CRLF pair. The record pointer is moved to the last appended - * record. - * - * Multiple lines may be appended with one call to FT_FAPPEND(). - * - * A text file "record" is a line of text terminated by a CRLF pair. - * Each line appended with this function will be empty. - * - * NOTE: Occasionally a text file may contain a non-CRLF terminated - * line, at the end of the file ("stragglers"). This function assumes - * these stragglers to be the last line of the file, and begins - * appending the new lines after this line. In other words, if the - * last line in the text file is not terminated with a CRLF pair prior - * to calling FT_FAPPEND(), the function will terminate that last line - * before appending any new lines. - * - * $EXAMPLES$ - * // add a blank line of text to a file - * FT_FUSE( "test.txt" ) - * - * ? FT_FRECNO() // displays 5 - * - * FT_FAPPEND() - * - * ? FT_FRECNO() // displays 6 - * - * $SEEALSO$ - * FT_FRECNO() FT_FDELETE() FT_FINSERT() FT_FLASTRE() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_FAPPEND() + $CATEGORY$ + File I/O + $ONELINER$ + Appends a line to the currently selected text file + $SYNTAX$ + FT_FAPPEND( [ < nLines > ] ) -> NIL + + $ARGUMENTS$ + is the number of lines that should be appended to the + end of the currently selected text file. + + If is omitted, one record is appended. + + $RETURNS$ + lSuccess. If FALSE, check ^bft_fError()^n for the error code. + + $DESCRIPTION$ + This function appends a line of text to the file in the currently + selected text file workarea. Text lines are delimited with a + CRLF pair. The record pointer is moved to the last appended + record. + + Multiple lines may be appended with one call to FT_FAPPEND(). + + A text file "record" is a line of text terminated by a CRLF pair. + Each line appended with this function will be empty. + + NOTE: Occasionally a text file may contain a non-CRLF terminated + line, at the end of the file ("stragglers"). This function assumes + these stragglers to be the last line of the file, and begins + appending the new lines after this line. In other words, if the + last line in the text file is not terminated with a CRLF pair prior + to calling FT_FAPPEND(), the function will terminate that last line + before appending any new lines. + + $EXAMPLES$ + // add a blank line of text to a file + FT_FUSE( "test.txt" ) + + ? FT_FRECNO() // displays 5 + + FT_FAPPEND() + + ? FT_FRECNO() // displays 6 + + $SEEALSO$ + FT_FRECNO() FT_FDELETE() FT_FINSERT() FT_FLASTRE() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_FWRITELN() - * $CATEGORY$ - * File I/O - * $ONELINER$ - * Write a line to the currently selected text file - * $SYNTAX$ - * FT_FWRITELN( < cData >, [ < lInsert > ] ) -> lSuccess - * - * $ARGUMENTS$ - * is a string of data to write to the file at the current - * record position. - * - * is a logical indicating whether the contents - * of the current record are to be preserved, that is, if lInsert - * evaluates to .T., the a new record is inserted at the current - * position. The current record then is pushed down to FT_FRECNO()+1. - * - * If lInsert is .F. or omitted, the current record is replaced by - * cData. - * - * $RETURNS$ - * TRUE if successful, otherwise check ^ft_fError()^n for error code. - * - * $DESCRIPTION$ - * This function writes a line of text to the file in the currently - * selected text file workarea. Text lines are delimited with a - * CRLF pair. The record pointer is not moved. - * - * The contents of the current record are updated to reflect the new - * new line written, unless the Insert option is selected. - * - * Writing a null string has the effect of clearing the current line - * if in overstrike mode, else inserting a new line (same as - * FT_FINSERT()). - * - * A text file "record" is a line of text terminated by a CRLF pair. - * - * $EXAMPLES$ - * // write a line of text to a file - * - * FT_FUSE( "config.sys" ) - * - * DO WHILE UPPER( FT_FREADLN() ) != "FILES=" .AND. !F_FEOF() - * - * FT_FSKIP() - * - * ENDDO - * - * FT_FWRITELN( "FILES=30", FT_FEOF() ) - * - * $SEEALSO$ - * FT_FREADLN() FT_FRECNO() FT_FINSERT() FT_FDELETE() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_FWRITELN() + $CATEGORY$ + File I/O + $ONELINER$ + Write a line to the currently selected text file + $SYNTAX$ + FT_FWRITELN( < cData >, [ < lInsert > ] ) -> lSuccess + + $ARGUMENTS$ + is a string of data to write to the file at the current + record position. + + is a logical indicating whether the contents + of the current record are to be preserved, that is, if lInsert + evaluates to .T., the a new record is inserted at the current + position. The current record then is pushed down to FT_FRECNO()+1. + + If lInsert is .F. or omitted, the current record is replaced by + cData. + + $RETURNS$ + TRUE if successful, otherwise check ^ft_fError()^n for error code. + + $DESCRIPTION$ + This function writes a line of text to the file in the currently + selected text file workarea. Text lines are delimited with a + CRLF pair. The record pointer is not moved. + + The contents of the current record are updated to reflect the new + new line written, unless the Insert option is selected. + + Writing a null string has the effect of clearing the current line + if in overstrike mode, else inserting a new line (same as + FT_FINSERT()). + + A text file "record" is a line of text terminated by a CRLF pair. + + $EXAMPLES$ + // write a line of text to a file + + FT_FUSE( "config.sys" ) + + DO WHILE UPPER( FT_FREADLN() ) != "FILES=" .AND. !F_FEOF() + + FT_FSKIP() + + ENDDO + + FT_FWRITELN( "FILES=30", FT_FEOF() ) + + $SEEALSO$ + FT_FREADLN() FT_FRECNO() FT_FINSERT() FT_FDELETE() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_FLASTRE() - * $CATEGORY$ - * File I/O - * $ONELINER$ - * Get the no. of records in the currently selected text file - * $SYNTAX$ - * FT_FLASTRE() -> nLastRecordNum - * - * $ARGUMENTS$ - * None - * - * $RETURNS$ - * An integer containing the number of records in the text file in - * the currently selected text file workarea, or zero if no file - * is currently open in the workarea. - * - * $DESCRIPTION$ - * This function returns the number of the last record in a text file. - * - * A text file "record" is a line of text terminated by a CRLF pair. - * - * $EXAMPLES$ - * FT_FUSE( "text.c" ) - * - * ? FT_FLASTRE() - * - * $SEEALSO$ - * FT_FUSE() FT_FRECNO() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_FLASTRE() + $CATEGORY$ + File I/O + $ONELINER$ + Get the no. of records in the currently selected text file + $SYNTAX$ + FT_FLASTRE() -> nLastRecordNum + + $ARGUMENTS$ + None + + $RETURNS$ + An integer containing the number of records in the text file in + the currently selected text file workarea, or zero if no file + is currently open in the workarea. + + $DESCRIPTION$ + This function returns the number of the last record in a text file. + + A text file "record" is a line of text terminated by a CRLF pair. + + $EXAMPLES$ + FT_FUSE( "text.c" ) + + ? FT_FLASTRE() + + $SEEALSO$ + FT_FUSE() FT_FRECNO() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_FEOF() - * $CATEGORY$ - * File I/O - * $ONELINER$ - * Determine if end of text file has been encountered - * $SYNTAX$ - * FT_FEOF() -> lResult - * - * $ARGUMENTS$ - * None - * - * $RETURNS$ - * .T. if an attempt was made to skip past the last record of - * the currently selected text file, otherwise .F. - * - * $DESCRIPTION$ - * This function is similar to the CLIPPER Eof() function. - * - * A text file "record" is a line of text terminated by a CRLF pair. - * - * $EXAMPLES$ - * FT_FUSE( "fttext.c" ) - * - * ? FT_FEOF() // .F. - * - * FT_FSKIP() - * - * ? FT_FEOF() // .T. - * - * $SEEALSO$ - * FT_FUSE() FT_FSKIP() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_FEOF() + $CATEGORY$ + File I/O + $ONELINER$ + Determine if end of text file has been encountered + $SYNTAX$ + FT_FEOF() -> lResult + + $ARGUMENTS$ + None + + $RETURNS$ + .T. if an attempt was made to skip past the last record of + the currently selected text file, otherwise .F. + + $DESCRIPTION$ + This function is similar to the CLIPPER Eof() function. + + A text file "record" is a line of text terminated by a CRLF pair. + + $EXAMPLES$ + FT_FUSE( "fttext.c" ) + + ? FT_FEOF() // .F. + + FT_FSKIP() + + ? FT_FEOF() // .T. + + $SEEALSO$ + FT_FUSE() FT_FSKIP() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_FBOF() - * $CATEGORY$ - * File I/O - * $ONELINER$ - * Determine if attempt to skip past beginning of text file - * $SYNTAX$ - * FT_FBOF() -> lResult - * - * $ARGUMENTS$ - * None - * - * $RETURNS$ - * .T. if an attempt was made to skip past the first record of - * the currently selected text file, otherwise .F. - * - * $DESCRIPTION$ - * This function is similar to the CLIPPER Bof() function. - * - * A text file "record" is a line of text terminated by a CRLF pair. - * - * $EXAMPLES$ - * FT_FUSE( "fttext.c" ) - * - * FT_FGOTOP() - * - * ? FT_FBOF() // .F. - * - * FT_FSKIP( -1 ) - * - * ? FT_FBOF() // .T. - * - * $SEEALSO$ - * FT_FSKIP() FT_EOF() FT_GOTOP() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_FBOF() + $CATEGORY$ + File I/O + $ONELINER$ + Determine if attempt to skip past beginning of text file + $SYNTAX$ + FT_FBOF() -> lResult + + $ARGUMENTS$ + None + + $RETURNS$ + .T. if an attempt was made to skip past the first record of + the currently selected text file, otherwise .F. + + $DESCRIPTION$ + This function is similar to the CLIPPER Bof() function. + + A text file "record" is a line of text terminated by a CRLF pair. + + $EXAMPLES$ + FT_FUSE( "fttext.c" ) + + FT_FGOTOP() + + ? FT_FBOF() // .F. + + FT_FSKIP( -1 ) + + ? FT_FBOF() // .T. + + $SEEALSO$ + FT_FSKIP() FT_EOF() FT_GOTOP() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_FGOTO() - * $CATEGORY$ - * File I/O - * $ONELINER$ - * Move record pointer to specific record in a text file - * $SYNTAX$ - * FT_FGOTO( nLine ) -> NIL - * - * $ARGUMENTS$ - * is the record number to go to. - * - * $RETURNS$ - * NIL - * - * $DESCRIPTION$ - * This function moves the record pointer to a specific record - * in the file in the currently selected text file workarea. If - * the record number requested is greater than the number of records - * in the file, the record pointer will be positioned at the last - * record. - * - * Internally, the function operates differently depending on how - * you invoke it. Passing a value for ^b^n results in what - * is effectively a skip operation, which is fairly quick. However - * if you pass 0 for ^b^n, e.g. ft_fGoTo( 0 ), the function - * internally goes to the top of the file, then skips down the - * required number of records. Hence if your file is relatively - * large and the current record is a high number, you may see some - * delay as ft_fGoTo(0) skips through the file. - * - * A text file "record" is a line of text terminated by a CRLF pair. - * - * $EXAMPLES$ - * // read 5th line of text from file - * - * ft_fUse( "fttext.c" ) - * - * ft_fGoTo(5) - * - * cText := ft_fReadLN() - * - * $SEEALSO$ - * FT_FRECNO() FT_FGOTOP() FT_FREADLN() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_FGOTO() + $CATEGORY$ + File I/O + $ONELINER$ + Move record pointer to specific record in a text file + $SYNTAX$ + FT_FGOTO( nLine ) -> NIL + + $ARGUMENTS$ + is the record number to go to. + + $RETURNS$ + NIL + + $DESCRIPTION$ + This function moves the record pointer to a specific record + in the file in the currently selected text file workarea. If + the record number requested is greater than the number of records + in the file, the record pointer will be positioned at the last + record. + + Internally, the function operates differently depending on how + you invoke it. Passing a value for ^b^n results in what + is effectively a skip operation, which is fairly quick. However + if you pass 0 for ^b^n, e.g. ft_fGoTo( 0 ), the function + internally goes to the top of the file, then skips down the + required number of records. Hence if your file is relatively + large and the current record is a high number, you may see some + delay as ft_fGoTo(0) skips through the file. + + A text file "record" is a line of text terminated by a CRLF pair. + + $EXAMPLES$ + // read 5th line of text from file + + ft_fUse( "fttext.c" ) + + ft_fGoTo(5) + + cText := ft_fReadLN() + + $SEEALSO$ + FT_FRECNO() FT_FGOTOP() FT_FREADLN() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/gcd.txt b/harbour/contrib/hbnf/doc/en/gcd.txt index dcbc8db2aa..1b2f5c0bc5 100644 --- a/harbour/contrib/hbnf/doc/en/gcd.txt +++ b/harbour/contrib/hbnf/doc/en/gcd.txt @@ -2,29 +2,29 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_GCD() - * $CATEGORY$ - * Math - * $ONELINER$ - * Calculate greatest common divisor of two numbers - * $SYNTAX$ - * FT_GCD( , ) -> nGCD - * $ARGUMENTS$ - * is the first number to find the GCD of. - * - * is the second number to find the GCD of. - * $RETURNS$ - * The greatest common divisor of the 2 numbers, or 0 if either is 0. - * $DESCRIPTION$ - * This function calculates the greatest common divisor between 2 numbers, - * i.e., the largest number that will divide into both numbers evenly. It - * will return zero (0) if either number is zero. - * $EXAMPLES$ - * ? FT_GCD( 10, 15 ) // Result: 5 - * ? FT_GCD( 108, 54 ) // Result: 54 - * ? FT_GCD( 102, 54 ) // Result: 6 - * ? FT_GCD( 111, 17 ) // Result: 1 - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_GCD() + $CATEGORY$ + Math + $ONELINER$ + Calculate greatest common divisor of two numbers + $SYNTAX$ + FT_GCD( , ) -> nGCD + $ARGUMENTS$ + is the first number to find the GCD of. + + is the second number to find the GCD of. + $RETURNS$ + The greatest common divisor of the 2 numbers, or 0 if either is 0. + $DESCRIPTION$ + This function calculates the greatest common divisor between 2 numbers, + i.e., the largest number that will divide into both numbers evenly. It + will return zero (0) if either number is zero. + $EXAMPLES$ + ? FT_GCD( 10, 15 ) // Result: 5 + ? FT_GCD( 108, 54 ) // Result: 54 + ? FT_GCD( 102, 54 ) // Result: 6 + ? FT_GCD( 111, 17 ) // Result: 1 + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/getenvrn.txt b/harbour/contrib/hbnf/doc/en/getenvrn.txt index 78cacd7a89..5a3740371f 100644 --- a/harbour/contrib/hbnf/doc/en/getenvrn.txt +++ b/harbour/contrib/hbnf/doc/en/getenvrn.txt @@ -2,65 +2,65 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_GETE() - * $CATEGORY$ - * Environment - * $ONELINER$ - * Return the entire current environment - * $SYNTAX$ - * FT_GETE( [ @ ] ) -> nNumStrings - * $ARGUMENTS$ - * is the variable to receive the environment data. - * - * can be a character type variable, in which case - * the function will place all environment strings in the variable - * separated by carriage return/line feeds (chr 13 + Chr(10)). - * - * can be an array type, in which case the function - * will place each string in an array element. The array MUST be - * declared with the proper number of elements prior to passing it - * to the function. This can be done by calling FT_GETE() without - * parameters first to get the number of strings in the environment. - * - * Note that the argument MUST be passed by reference. Since arrays - * are by nature passed by reference, the "@" symbol is optional when - * passing an array. - * - * If no argument is passed, FT_GETE() merely returns the number - * of strings in the environment. - * $RETURNS$ - * FT_GETE() returns the total number of strings found in the - * current program's environment. - * $DESCRIPTION$ - * This function stores ALL of the current program's environment - * variables in either a block of text lines or in an array. It is - * useful for looking at the entire environment at once, or recording - * a snapshot of it to a file for later inspection, such as when a - * program error occurs. If the value of ONE SPECIFIC variable is - * desired, use Clipper's built-in GETE() function. - * $EXAMPLES$ - * Get the environment in text form and browse it: - * - * cEnvBlock := "" - * nNumStrings := FT_GETE( @cEnvBlock ) - * @ 0, 0 TO MaxRow() - 1, MaxCol() - * @ MaxRow(), 0 SAY 'Browse strings, press ESC to exit...' - * MemoWrit( cEnvBlock, 1, 1, MaxRow() - 2, MaxCol() - 1, .F. ) - * - * Get the environment in text form and write it to a file: - * - * cEnvBlock := "" - * FT_GETE( @cEnvBlock ) - * MEMOWRIT( "environ.txt", cEnvBlock ) - * - * Get the environment in Array form: - * - * aEnvArray := Array( FT_GETE() ) - * FT_GETE( aEnvArray ) - * ? aEnvArray[ 1 ] // "COMSPEC=C:\command.com" - * ? aEnvArray[ 2 ] // "PATH=C:\;C:\util;C:\harbour" - * ... etc ... - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_GETE() + $CATEGORY$ + Environment + $ONELINER$ + Return the entire current environment + $SYNTAX$ + FT_GETE( [ @ ] ) -> nNumStrings + $ARGUMENTS$ + is the variable to receive the environment data. + + can be a character type variable, in which case + the function will place all environment strings in the variable + separated by carriage return/line feeds (chr 13 + Chr(10)). + + can be an array type, in which case the function + will place each string in an array element. The array MUST be + declared with the proper number of elements prior to passing it + to the function. This can be done by calling FT_GETE() without + parameters first to get the number of strings in the environment. + + Note that the argument MUST be passed by reference. Since arrays + are by nature passed by reference, the "@" symbol is optional when + passing an array. + + If no argument is passed, FT_GETE() merely returns the number + of strings in the environment. + $RETURNS$ + FT_GETE() returns the total number of strings found in the + current program's environment. + $DESCRIPTION$ + This function stores ALL of the current program's environment + variables in either a block of text lines or in an array. It is + useful for looking at the entire environment at once, or recording + a snapshot of it to a file for later inspection, such as when a + program error occurs. If the value of ONE SPECIFIC variable is + desired, use Clipper's built-in GETE() function. + $EXAMPLES$ + Get the environment in text form and browse it: + + cEnvBlock := "" + nNumStrings := FT_GETE( @cEnvBlock ) + @ 0, 0 TO MaxRow() - 1, MaxCol() + @ MaxRow(), 0 SAY 'Browse strings, press ESC to exit...' + MemoWrit( cEnvBlock, 1, 1, MaxRow() - 2, MaxCol() - 1, .F. ) + + Get the environment in text form and write it to a file: + + cEnvBlock := "" + FT_GETE( @cEnvBlock ) + MEMOWRIT( "environ.txt", cEnvBlock ) + + Get the environment in Array form: + + aEnvArray := Array( FT_GETE() ) + FT_GETE( aEnvArray ) + ? aEnvArray[ 1 ] // "COMSPEC=C:\command.com" + ? aEnvArray[ 2 ] // "PATH=C:\;C:\util;C:\harbour" + ... etc ... + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/hex2dec.txt b/harbour/contrib/hbnf/doc/en/hex2dec.txt index 4f4ea08d3d..17e1713795 100644 --- a/harbour/contrib/hbnf/doc/en/hex2dec.txt +++ b/harbour/contrib/hbnf/doc/en/hex2dec.txt @@ -2,26 +2,26 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_HEX2DEC() - * $CATEGORY$ - * Conversion - * $ONELINER$ - * Convert a hex number to decimal - * $SYNTAX$ - * FT_HEX2DEC( ) -> nDecNum - * $ARGUMENTS$ - * is a character string representing a hex number. - * $RETURNS$ - * A decimal number. - * $DESCRIPTION$ - * Converts a hexadecimal number to a BASE 10 decimal number. - * Useful for using FT_INT86(). - * $EXAMPLES$ - * FT_INT86( HEX2DEC( "21" ), aRegs ) - * - * Converts 21h, the Dos Interrupt, to its decimal equivalent, - * 33, for use by FT_INT86(). - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_HEX2DEC() + $CATEGORY$ + Conversion + $ONELINER$ + Convert a hex number to decimal + $SYNTAX$ + FT_HEX2DEC( ) -> nDecNum + $ARGUMENTS$ + is a character string representing a hex number. + $RETURNS$ + A decimal number. + $DESCRIPTION$ + Converts a hexadecimal number to a BASE 10 decimal number. + Useful for using FT_INT86(). + $EXAMPLES$ + FT_INT86( HEX2DEC( "21" ), aRegs ) + + Converts 21h, the Dos Interrupt, to its decimal equivalent, + 33, for use by FT_INT86(). + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/iamidle.txt b/harbour/contrib/hbnf/doc/en/iamidle.txt index 62e8e5aa0f..10f7eb3255 100644 --- a/harbour/contrib/hbnf/doc/en/iamidle.txt +++ b/harbour/contrib/hbnf/doc/en/iamidle.txt @@ -2,40 +2,40 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_IAmIdle() - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Inform the operating system that the application is idle. - * $SYNTAX$ - * FT_IAmIdle() -> lSuccess - * $ARGUMENTS$ - * None - * $RETURNS$ - * .T. if supported, .F. otherwise. - * $DESCRIPTION$ - * Some multitasking operating environments (e.g. Windows or OS/2) can - * function more efficiently when applications release the CPU during - * idle states. This function allows you "announce" to the operating - * system that your application is idle. - * - * Note that if you use this function in conjunction with FT_OnIdle(), - * you can cause Clipper to automatically release the CPU whenever - * Clipper itself detects an idle state. - * $EXAMPLES$ - * DO WHILE Inkey() != K_ESC - * FT_IAmIdle() // Wait for ESC and announce idleness - * ENDDO - * - * * Here's another way to do it: - * - * FT_OnIdle( {|| FT_IAmIdle() } ) - * - * Inkey( 0 ) // Automatically reports idleness until key - * // is pressed! - * $SEEALSO$ - * FT_OnIdle() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_IAmIdle() + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Inform the operating system that the application is idle. + $SYNTAX$ + FT_IAmIdle() -> lSuccess + $ARGUMENTS$ + None + $RETURNS$ + .T. if supported, .F. otherwise. + $DESCRIPTION$ + Some multitasking operating environments (e.g. Windows or OS/2) can + function more efficiently when applications release the CPU during + idle states. This function allows you "announce" to the operating + system that your application is idle. + + Note that if you use this function in conjunction with FT_OnIdle(), + you can cause Clipper to automatically release the CPU whenever + Clipper itself detects an idle state. + $EXAMPLES$ + DO WHILE Inkey() != K_ESC + FT_IAmIdle() // Wait for ESC and announce idleness + ENDDO + + * Here's another way to do it: + + FT_OnIdle( {|| FT_IAmIdle() } ) + + Inkey( 0 ) // Automatically reports idleness until key + // is pressed! + $SEEALSO$ + FT_OnIdle() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/idle.txt b/harbour/contrib/hbnf/doc/en/idle.txt index 87222bd3e7..a71834753c 100644 --- a/harbour/contrib/hbnf/doc/en/idle.txt +++ b/harbour/contrib/hbnf/doc/en/idle.txt @@ -2,42 +2,42 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_Idle() - * $CATEGORY$ - * Event - * $ONELINER$ - * Generate an idle event to allow incremental garbage collection. - * $SYNTAX$ - * FT_Idle() - * $ARGUMENTS$ - * None - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * During memory-intensive operations that do not generate much in - * the way of idle states, the Clipper runtime may not get a chance to - * perform garbage collection of discarded memory. This can eventually - * lead to any of a variety of memory-related internal errors. - * - * This function attempts to alleviate the problem by providing a - * mechanism by which an idle event can be artifically generated at - * will. The idle event will cause the CA-Cl*pper runtime to perform - * an incremental memory scavenge. - * - * This function makes use of an undocumented interal routine. If this - * this fact makes you uncomfortable then don't use this function, you - * miserable jello-spined lump of human debris. - * $EXAMPLES$ - * DO WHILE Whatever // Some batch process - * - * Something() // Create 'n' discard a bunch of stuff - * - * FT_Idle() // Take out the garbage - * - * ENDDO - * $SEEALSO$ - * FT_OnIdle() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_Idle() + $CATEGORY$ + Event + $ONELINER$ + Generate an idle event to allow incremental garbage collection. + $SYNTAX$ + FT_Idle() + $ARGUMENTS$ + None + $RETURNS$ + NIL + $DESCRIPTION$ + During memory-intensive operations that do not generate much in + the way of idle states, the Clipper runtime may not get a chance to + perform garbage collection of discarded memory. This can eventually + lead to any of a variety of memory-related internal errors. + + This function attempts to alleviate the problem by providing a + mechanism by which an idle event can be artifically generated at + will. The idle event will cause the CA-Cl*pper runtime to perform + an incremental memory scavenge. + + This function makes use of an undocumented interal routine. If this + this fact makes you uncomfortable then don't use this function, you + miserable jello-spined lump of human debris. + $EXAMPLES$ + DO WHILE Whatever // Some batch process + + Something() // Create 'n' discard a bunch of stuff + + FT_Idle() // Take out the garbage + + ENDDO + $SEEALSO$ + FT_OnIdle() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/inp.txt b/harbour/contrib/hbnf/doc/en/inp.txt index 236977b193..effbf5705c 100644 --- a/harbour/contrib/hbnf/doc/en/inp.txt +++ b/harbour/contrib/hbnf/doc/en/inp.txt @@ -2,31 +2,31 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_INP() - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Retrieve a byte from a specified I/O port - * $SYNTAX$ - * FT_INP( ) -> nValue - * $ARGUMENTS$ - * is the port from which to retrieve the byte. If it is - * invalid in any way, the function will return zero. - * $RETURNS$ - * The byte retrieved. - * $DESCRIPTION$ - * It may sometimes be useful to read a byte from a port without having - * to resort to C or assembler. This function allows you to do so. - * - * The source code is written to adhere to Turbo Assembler's IDEAL mode. - * To use another assembler, you will need to rearrange the PROC and - * SEGMENT directives, and also the ENDP and ENDS directives (a very - * minor task). - * $EXAMPLES$ - * byte := FT_INP( 100 ) // read a byte from port 100 (064h) - * $SEEALSO$ - * FT_OUTP() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_INP() + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Retrieve a byte from a specified I/O port + $SYNTAX$ + FT_INP( ) -> nValue + $ARGUMENTS$ + is the port from which to retrieve the byte. If it is + invalid in any way, the function will return zero. + $RETURNS$ + The byte retrieved. + $DESCRIPTION$ + It may sometimes be useful to read a byte from a port without having + to resort to C or assembler. This function allows you to do so. + + The source code is written to adhere to Turbo Assembler's IDEAL mode. + To use another assembler, you will need to rearrange the PROC and + SEGMENT directives, and also the ENDP and ENDS directives (a very + minor task). + $EXAMPLES$ + byte := FT_INP( 100 ) // read a byte from port 100 (064h) + $SEEALSO$ + FT_OUTP() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/invclr.txt b/harbour/contrib/hbnf/doc/en/invclr.txt index 22ea3c0a9c..fb287389a8 100644 --- a/harbour/contrib/hbnf/doc/en/invclr.txt +++ b/harbour/contrib/hbnf/doc/en/invclr.txt @@ -2,25 +2,25 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_INVCLR() - * $CATEGORY$ - * Conversion - * $ONELINER$ - * Get the inverse of a color - * $SYNTAX$ - * FT_INVCLR( [ ] ) -> cColor - * $ARGUMENTS$ - * is the color to get the inverse of. Defaults to - * current color. - * $RETURNS$ - * The inverse of the passed color. - * $DESCRIPTION$ - * This function inverts a passed color (in the Clipper format: ??/??), - * e.g., "W/N" is converted to "N/W". - * $EXAMPLES$ - * cInverse := FT_INVCLR() // Get Inverse of Current Color - * cInvErr := FT_INVCLR( cErrColor ) // Get Inverse of cErrorColor - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_INVCLR() + $CATEGORY$ + Conversion + $ONELINER$ + Get the inverse of a color + $SYNTAX$ + FT_INVCLR( [ ] ) -> cColor + $ARGUMENTS$ + is the color to get the inverse of. Defaults to + current color. + $RETURNS$ + The inverse of the passed color. + $DESCRIPTION$ + This function inverts a passed color (in the Clipper format: ??/??), + e.g., "W/N" is converted to "N/W". + $EXAMPLES$ + cInverse := FT_INVCLR() // Get Inverse of Current Color + cInvErr := FT_INVCLR( cErrColor ) // Get Inverse of cErrorColor + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/isbit.txt b/harbour/contrib/hbnf/doc/en/isbit.txt index b6848f399a..904fea43e1 100644 --- a/harbour/contrib/hbnf/doc/en/isbit.txt +++ b/harbour/contrib/hbnf/doc/en/isbit.txt @@ -2,44 +2,44 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ISBIT() - * $CATEGORY$ - * String - * $ONELINER$ - * Test the status of an individual bit - * $SYNTAX$ - * FT_ISBIT( , ) -> lResult - * $ARGUMENTS$ - * is a character from Chr(0) to Chr(255) - * - * is a number from 0 to 7 conforming to standard right-to-left - * bit-numbering convention and representing the position of the - * bit within the byte. - * $RETURNS$ - * .T. if designated bit is set (1), .F. if not set (0), NIL if - * invalid parameters. - * $DESCRIPTION$ - * Tests for status of any selected bit in the byte passed as a parameter. - * Byte must be presented in Chr() form, as a literal constant, or as the - * one-byte character result of an expression. - * - * This function is presented to illustrate that bit-wise operations - * are possible with Clipper code. For greater speed, write .c or - * .asm versions and use the Clipper Extend system. - * $EXAMPLES$ - * This code tests whether bit 3 is set in the byte represented by - * Chr( 107 ): - * - * lBitflag := FT_ISBIT( Chr( 107 ), 3 ) - * ? lBitflag // result: .T. - * - * This code tests whether bit 5 is set in the byte represented by ASCII - * 65 (letter "A") - * - * ? FT_ISBIT( "A", 5 ) // result: .F. - * $SEEALSO$ - * FT_BITSET() FT_BITCLR() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ISBIT() + $CATEGORY$ + String + $ONELINER$ + Test the status of an individual bit + $SYNTAX$ + FT_ISBIT( , ) -> lResult + $ARGUMENTS$ + is a character from Chr(0) to Chr(255) + + is a number from 0 to 7 conforming to standard right-to-left + bit-numbering convention and representing the position of the + bit within the byte. + $RETURNS$ + .T. if designated bit is set (1), .F. if not set (0), NIL if + invalid parameters. + $DESCRIPTION$ + Tests for status of any selected bit in the byte passed as a parameter. + Byte must be presented in Chr() form, as a literal constant, or as the + one-byte character result of an expression. + + This function is presented to illustrate that bit-wise operations + are possible with Clipper code. For greater speed, write .c or + .asm versions and use the Clipper Extend system. + $EXAMPLES$ + This code tests whether bit 3 is set in the byte represented by + Chr( 107 ): + + lBitflag := FT_ISBIT( Chr( 107 ), 3 ) + ? lBitflag // result: .T. + + This code tests whether bit 5 is set in the byte represented by ASCII + 65 (letter "A") + + ? FT_ISBIT( "A", 5 ) // result: .F. + $SEEALSO$ + FT_BITSET() FT_BITCLR() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/isbiton.txt b/harbour/contrib/hbnf/doc/en/isbiton.txt index 29196a2106..7f5b88afeb 100644 --- a/harbour/contrib/hbnf/doc/en/isbiton.txt +++ b/harbour/contrib/hbnf/doc/en/isbiton.txt @@ -2,33 +2,33 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ISBITON() - * $CATEGORY$ - * String - * $ONELINER$ - * Determine the state of individual bits in a number - * $SYNTAX$ - * FT_ISBITON( , ) -> lResult - * $ARGUMENTS$ - * is an integer for which a bit state needs to be checked. - * - * is a number from 0 to 15 that indicates which bit to test. - * $RETURNS$ - * .T. if the specified bit was on., .F. if off. - * $DESCRIPTION$ - * This function is useful when dealing with binary integers. It will - * come in very handy if you use the FT_INT86() function, because the - * CPU flags are returned as a series of bits. Using this function, you - * can determine the state of each CPU flag. - * $EXAMPLES$ - * IF FT_ISBITON( nCPUFlags, 0 ) - * ? "The carry flag was set." - * ENDIF - * - * IF FT_ISBITON( nCPUFlags, 7 ) - * ? "The sign flag was set." - * ENDIF - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ISBITON() + $CATEGORY$ + String + $ONELINER$ + Determine the state of individual bits in a number + $SYNTAX$ + FT_ISBITON( , ) -> lResult + $ARGUMENTS$ + is an integer for which a bit state needs to be checked. + + is a number from 0 to 15 that indicates which bit to test. + $RETURNS$ + .T. if the specified bit was on., .F. if off. + $DESCRIPTION$ + This function is useful when dealing with binary integers. It will + come in very handy if you use the FT_INT86() function, because the + CPU flags are returned as a series of bits. Using this function, you + can determine the state of each CPU flag. + $EXAMPLES$ + IF FT_ISBITON( nCPUFlags, 0 ) + ? "The carry flag was set." + ENDIF + + IF FT_ISBITON( nCPUFlags, 7 ) + ? "The sign flag was set." + ENDIF + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/isprint.txt b/harbour/contrib/hbnf/doc/en/isprint.txt index a69232137b..8a13955297 100644 --- a/harbour/contrib/hbnf/doc/en/isprint.txt +++ b/harbour/contrib/hbnf/doc/en/isprint.txt @@ -2,64 +2,64 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ISPRINT() - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Check printer status - * $SYNTAX$ - * FT_ISPRINT( [ ] ) -> lResult - * $ARGUMENTS$ - * is optional and is the device to test (LPT2, COM1, etc.). - * If omitted, the function will default to the PRN device. - * $RETURNS$ - * .T. if device is ready for output. - * .F. if one of the following conditions occurs: - * 1) The device is not ready. - * 2) The device does not exist. - * 3) DOS couldn't open the device for some reason - * (such as no file handles available). - * $DESCRIPTION$ - * The Clipper IsPrinter() function is somewhat limited because it only - * works with LPT1. Furthermore, it talks directly to the hardware, so - * if you have redirected LPT1 via the DOS MODE command, the IsPrinter() - * function will return erroneous results. - * - * This function offers a better alternative. Instead of talking to the - * hardware, it issues a DOS call that checks to see if the device is - * ready or not. That gives DOS an opportunity to deal with any - * redirections, and since you pass the device name as a parameter, you - * can test any device, not just LPT1 (note that the function defaults - * to PRN if you fail to pass a valid parameter). - * - * The function also temporarily traps the DOS critical error handler so - * you don't get any nasty error messages if the device isn't ready. It - * restores the old critical error handler before exiting. - * - * Note that although this function is mainly designed for testing - * printers, you can also check to see if a drive is ready. Since DOS - * thinks the NUL device exists on every drive, you can pass a drive - * letter followed by NUL as a parameter. If DOS is able to open the - * NUL device, then the drive is ready, otherwise the door is open or - * something else is wrong. - * - * The source code is written to adhere to Turbo Assembler's IDEAL mode. - * To use another assembler, you will need to rearrange the PROC and - * SEGMENT directives, and also the ENDP and ENDS directives (a very - * minor task). - * $EXAMPLES$ - * IF ! FT_ISPRINT() - * ? "PRN is not ready!" - * ENDIF - * - * IF ! FT_ISPRINT( "COM2" ) - * ? "Check the device on COM2. Something is wrong." - * ENDIF - * - * IF ! FT_ISPRINT( "A:\nul" ) - * ? "Oops, better check drive A!" - * ENDIF - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ISPRINT() + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Check printer status + $SYNTAX$ + FT_ISPRINT( [ ] ) -> lResult + $ARGUMENTS$ + is optional and is the device to test (LPT2, COM1, etc.). + If omitted, the function will default to the PRN device. + $RETURNS$ + .T. if device is ready for output. + .F. if one of the following conditions occurs: + 1) The device is not ready. + 2) The device does not exist. + 3) DOS couldn't open the device for some reason + (such as no file handles available). + $DESCRIPTION$ + The Clipper IsPrinter() function is somewhat limited because it only + works with LPT1. Furthermore, it talks directly to the hardware, so + if you have redirected LPT1 via the DOS MODE command, the IsPrinter() + function will return erroneous results. + + This function offers a better alternative. Instead of talking to the + hardware, it issues a DOS call that checks to see if the device is + ready or not. That gives DOS an opportunity to deal with any + redirections, and since you pass the device name as a parameter, you + can test any device, not just LPT1 (note that the function defaults + to PRN if you fail to pass a valid parameter). + + The function also temporarily traps the DOS critical error handler so + you don't get any nasty error messages if the device isn't ready. It + restores the old critical error handler before exiting. + + Note that although this function is mainly designed for testing + printers, you can also check to see if a drive is ready. Since DOS + thinks the NUL device exists on every drive, you can pass a drive + letter followed by NUL as a parameter. If DOS is able to open the + NUL device, then the drive is ready, otherwise the door is open or + something else is wrong. + + The source code is written to adhere to Turbo Assembler's IDEAL mode. + To use another assembler, you will need to rearrange the PROC and + SEGMENT directives, and also the ENDP and ENDS directives (a very + minor task). + $EXAMPLES$ + IF ! FT_ISPRINT() + ? "PRN is not ready!" + ENDIF + + IF ! FT_ISPRINT( "COM2" ) + ? "Check the device on COM2. Something is wrong." + ENDIF + + IF ! FT_ISPRINT( "A:\nul" ) + ? "Oops, better check drive A!" + ENDIF + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/isshare.txt b/harbour/contrib/hbnf/doc/en/isshare.txt index 92b52a6824..d0a9624508 100644 --- a/harbour/contrib/hbnf/doc/en/isshare.txt +++ b/harbour/contrib/hbnf/doc/en/isshare.txt @@ -2,31 +2,31 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ISSHARE() - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Determine if DOS "Share" is installed - * $SYNTAX$ - * FT_ISSHARE() -> nRetCode - * $ARGUMENTS$ - * None - * $RETURNS$ - * nRetcode will be set as follows on exit: - * - * 0 if SHARE not loaded but ok to load - * 1 if SHARE not loaded and not ok to load - * 255 if SHARE loaded - * $DESCRIPTION$ - * Uses DOS interrupt 2Fh (MultiPlex interrupt), service 10h - * to determine if DOS SHARE.COM is loaded. - * $EXAMPLES$ - * IF FT_ISSHARE() != 255 - * ? "SHARE must be loaded!" - * ENDIF - * $SEEALSO$ - * FT_INT86() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ISSHARE() + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Determine if DOS "Share" is installed + $SYNTAX$ + FT_ISSHARE() -> nRetCode + $ARGUMENTS$ + None + $RETURNS$ + nRetcode will be set as follows on exit: + + 0 if SHARE not loaded but ok to load + 1 if SHARE not loaded and not ok to load + 255 if SHARE loaded + $DESCRIPTION$ + Uses DOS interrupt 2Fh (MultiPlex interrupt), service 10h + to determine if DOS SHARE.COM is loaded. + $EXAMPLES$ + IF FT_ISSHARE() != 255 + ? "SHARE must be loaded!" + ENDIF + $SEEALSO$ + FT_INT86() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/kspeed.txt b/harbour/contrib/hbnf/doc/en/kspeed.txt index 83f29ddee5..ce8598a523 100644 --- a/harbour/contrib/hbnf/doc/en/kspeed.txt +++ b/harbour/contrib/hbnf/doc/en/kspeed.txt @@ -2,67 +2,67 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_SETRATE() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Set the keyboard delay and repeat rate on PC/AT & PS/2 - * $SYNTAX$ - * FT_SETRATE( [ ] [, ] ) -> NIL - * $ARGUMENTS$ - * is the keyboard delay time. - * - * is the keyboard repeat rate. - * - * ┌───────────────────────┐ ┌────────────────────────┐ - * │ nDelayTime DELAY │ │ RepeatRate SPEED │ - * ├───────────────────────┤ ├────────────────────────┤ - * │ 0 250ms │ │ 0 30.0cps │ - * │ 1 (default) 500ms │ │ 1 26.7cps │ - * │ 2 750ms │ │ 2 24.0cps │ - * │ 3 1000ms │ │ 3 21.8cps │ - * └───────────────────────┘ │ 4 20.0cps │ - * │ 5 18.5cps │ - * │ 6 17.1cps │ - * │ 7 16.0cps │ - * │ 8 15.0cps │ - * │ 9 13.3cps │ - * │ 10 12.0cps │ - * │ 11 10.9cps │ - * │ 12 (default) 10.0cps │ - * │ 13 9.2cps │ - * │ 14 8.6cps │ - * │ 15 8.0cps │ - * │ 16 7.5cps │ - * │ 17 6.7cps │ - * │ 18 6.0cps │ - * │ 19 5.5cps │ - * │ 20 5.0cps │ - * │ 21 4.6cps │ - * │ 22 4.3cps │ - * │ 23 4.0cps │ - * │ 24 3.7cps │ - * │ 25 3.3cps │ - * │ 26 3.0cps │ - * │ 27 2.7cps │ - * │ 28 2.5cps │ - * │ 29 2.3cps │ - * │ 30 2.1cps │ - * │ 31 2.0cps │ - * └────────────────────────┘ - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * This routine is used to adjust the IBM PC/AT and PS/2 "typematic" - * repeat and delay feature. This is used to allow the users of your - * application to adjust these speeds to the most comfortable level. - * - * This source code is written for Microsoft Assembler v5.1. - * $EXAMPLES$ - * FT_SETRATE( 0, 0 ) // Set keyboard to fastest possible settings - * FT_SETRATE() // Set keyboard to AT defaults (10.9cps,500ms delay) - * FT_SETRATE( 11, 1 ) // Set keyboard to PS/2 defaults (10cps,500ms delay) - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SETRATE() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Set the keyboard delay and repeat rate on PC/AT & PS/2 + $SYNTAX$ + FT_SETRATE( [ ] [, ] ) -> NIL + $ARGUMENTS$ + is the keyboard delay time. + + is the keyboard repeat rate. + + ┌───────────────────────┐ ┌────────────────────────┐ + │ nDelayTime DELAY │ │ RepeatRate SPEED │ + ├───────────────────────┤ ├────────────────────────┤ + │ 0 250ms │ │ 0 30.0cps │ + │ 1 (default) 500ms │ │ 1 26.7cps │ + │ 2 750ms │ │ 2 24.0cps │ + │ 3 1000ms │ │ 3 21.8cps │ + └───────────────────────┘ │ 4 20.0cps │ + │ 5 18.5cps │ + │ 6 17.1cps │ + │ 7 16.0cps │ + │ 8 15.0cps │ + │ 9 13.3cps │ + │ 10 12.0cps │ + │ 11 10.9cps │ + │ 12 (default) 10.0cps │ + │ 13 9.2cps │ + │ 14 8.6cps │ + │ 15 8.0cps │ + │ 16 7.5cps │ + │ 17 6.7cps │ + │ 18 6.0cps │ + │ 19 5.5cps │ + │ 20 5.0cps │ + │ 21 4.6cps │ + │ 22 4.3cps │ + │ 23 4.0cps │ + │ 24 3.7cps │ + │ 25 3.3cps │ + │ 26 3.0cps │ + │ 27 2.7cps │ + │ 28 2.5cps │ + │ 29 2.3cps │ + │ 30 2.1cps │ + │ 31 2.0cps │ + └────────────────────────┘ + $RETURNS$ + NIL + $DESCRIPTION$ + This routine is used to adjust the IBM PC/AT and PS/2 "typematic" + repeat and delay feature. This is used to allow the users of your + application to adjust these speeds to the most comfortable level. + + This source code is written for Microsoft Assembler v5.1. + $EXAMPLES$ + FT_SETRATE( 0, 0 ) // Set keyboard to fastest possible settings + FT_SETRATE() // Set keyboard to AT defaults (10.9cps,500ms delay) + FT_SETRATE( 11, 1 ) // Set keyboard to PS/2 defaults (10cps,500ms delay) + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/lastday.txt b/harbour/contrib/hbnf/doc/en/lastday.txt index d86d9d0104..caa6b83123 100644 --- a/harbour/contrib/hbnf/doc/en/lastday.txt +++ b/harbour/contrib/hbnf/doc/en/lastday.txt @@ -2,30 +2,30 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_LDAY() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Return last day of the month - * $SYNTAX$ - * FT_LDAY( [ ] ) -> dLastDay - * $ARGUMENTS$ - * is a date within a month for which you want to find - * the last date of that month. If not passed or is an incorrect - * type, defaults to current system date. - * $RETURNS$ - * A Clipper date value representing the last date of the month. - * $DESCRIPTION$ - * This function will return the last day of the month of the date - * passed, or the last day of the current month if no argument is - * supplied. - * $EXAMPLES$ - * dDate := SToD( "19900915" ) - * ? FT_LDAY( dDate ) // 09/30/90 - * ? FT_LDAY() // 03/31/91 (current month) - * $SEEALSO$ - * FT_FDAY() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_LDAY() + $CATEGORY$ + Date/Time + $ONELINER$ + Return last day of the month + $SYNTAX$ + FT_LDAY( [ ] ) -> dLastDay + $ARGUMENTS$ + is a date within a month for which you want to find + the last date of that month. If not passed or is an incorrect + type, defaults to current system date. + $RETURNS$ + A Clipper date value representing the last date of the month. + $DESCRIPTION$ + This function will return the last day of the month of the date + passed, or the last day of the current month if no argument is + supplied. + $EXAMPLES$ + dDate := SToD( "19900915" ) + ? FT_LDAY( dDate ) // 09/30/90 + ? FT_LDAY() // 03/31/91 (current month) + $SEEALSO$ + FT_FDAY() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/linked.txt b/harbour/contrib/hbnf/doc/en/linked.txt index 005645766d..ee694ed47b 100644 --- a/harbour/contrib/hbnf/doc/en/linked.txt +++ b/harbour/contrib/hbnf/doc/en/linked.txt @@ -2,44 +2,44 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_LINKED() - * $CATEGORY$ - * Environment - * $ONELINER$ - * Determine if a function was linked in - * $SYNTAX$ - * FT_LINKED( ) -> lResult - * $ARGUMENTS$ - * is a character string containing one or more function - * calls - * $RETURNS$ - * .T. if all functions within the string are currently linked into - * the application, .F. if one or more aren't. See below for a - * definition of "function." - * $DESCRIPTION$ - * This function would be used in data driven application to determine - * whether or not a macro compiled function was linked in. - * - * Several functions can be passed, and nested, in . - * - * Caveat: Some function calls are converted by the preprocessor - * into other function calls. You cannot have these types of - * functions in a macro compiled string as they never exist at - * runtime. FT_LINKED will correctly tell you that they are invalid. - * - * For instance: there is no function called SORT() in any of the - * Nantucket LIBraries, but it is a valid CLIPPER command because the - * preprocessor will convert it to other function calls. - * - * - * $EXAMPLES$ - * cString := "FT_GoodFunc( BadFunc( 3, 2 ) )" - * IF FT_LINKED( cString ) - * Eval( &( "{||" + cString + "}" ) ) - * ELSE - * Alert( "Error: " + cString + " was not linked in. Called by FT_LINKED()" ) - * ENDIF - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_LINKED() + $CATEGORY$ + Environment + $ONELINER$ + Determine if a function was linked in + $SYNTAX$ + FT_LINKED( ) -> lResult + $ARGUMENTS$ + is a character string containing one or more function + calls + $RETURNS$ + .T. if all functions within the string are currently linked into + the application, .F. if one or more aren't. See below for a + definition of "function." + $DESCRIPTION$ + This function would be used in data driven application to determine + whether or not a macro compiled function was linked in. + + Several functions can be passed, and nested, in . + + Caveat: Some function calls are converted by the preprocessor + into other function calls. You cannot have these types of + functions in a macro compiled string as they never exist at + runtime. FT_LINKED will correctly tell you that they are invalid. + + For instance: there is no function called SORT() in any of the + Nantucket LIBraries, but it is a valid CLIPPER command because the + preprocessor will convert it to other function calls. + + + $EXAMPLES$ + cString := "FT_GoodFunc( BadFunc( 3, 2 ) )" + IF FT_LINKED( cString ) + Eval( &( "{||" + cString + "}" ) ) + ELSE + Alert( "Error: " + cString + " was not linked in. Called by FT_LINKED()" ) + ENDIF + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/madd.txt b/harbour/contrib/hbnf/doc/en/madd.txt index 7781bc2aee..8621449959 100644 --- a/harbour/contrib/hbnf/doc/en/madd.txt +++ b/harbour/contrib/hbnf/doc/en/madd.txt @@ -2,48 +2,48 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MADD() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Add or subtract months to/from a date - * $SYNTAX$ - * FT_MADD( [ ], [ ], [ ] ) - * -> dDate - * $ARGUMENTS$ - * is any valid date in any date format. Defaults to - * current system date if not supplied. - * - * is the number of months to be added or subtracted. - * Defaults to 0 if not supplied. - * - * is a logical variable indicating whether or not to - * force the returned date to the last date of the month. It only - * affects the returned date if is an end-of-month date. - * $RETURNS$ - * A date. - * $DESCRIPTION$ - * FT_MADD() adds or subtracts months to/from a given date. - * - * If MakeEOM is passed and dGivenDate is the last day of a month, - * it will return the EOM of calculated month. Otherwise it will - * return the same day as the day of the passed date. - * $EXAMPLES$ - * dDate := SToD( "19900915" ) - * ? FT_MADD( dDate, 1 ) // 10/15/90 - * ? FT_MADD( dDate, -2 ) // 07/15/90 - * - * // force EOM - * dDate := SToD( "19910430" ) - * ? FT_MADD( dDate, 1 ) // 05/30/91 - * ? FT_MADD( dDate, 1, .T. ) // 05/31/91 <- forced EOM - * ? FT_MADD( dDate, 2 ) // 06/30/91 - * ? FT_MADD( dDate, 2, .T. ) // 06/30/91 <- June only has 30 days - * ? FT_MADD( dDate, 3 ) // 07/30/91 - * ? FT_MADD( dDate, 3, .T. ) // 07/31/91 <- forced EOM - * $SEEALSO$ - * FT_DAYOFYR() FT_DAYTOBOW() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MADD() + $CATEGORY$ + Date/Time + $ONELINER$ + Add or subtract months to/from a date + $SYNTAX$ + FT_MADD( [ ], [ ], [ ] ) + -> dDate + $ARGUMENTS$ + is any valid date in any date format. Defaults to + current system date if not supplied. + + is the number of months to be added or subtracted. + Defaults to 0 if not supplied. + + is a logical variable indicating whether or not to + force the returned date to the last date of the month. It only + affects the returned date if is an end-of-month date. + $RETURNS$ + A date. + $DESCRIPTION$ + FT_MADD() adds or subtracts months to/from a given date. + + If MakeEOM is passed and dGivenDate is the last day of a month, + it will return the EOM of calculated month. Otherwise it will + return the same day as the day of the passed date. + $EXAMPLES$ + dDate := SToD( "19900915" ) + ? FT_MADD( dDate, 1 ) // 10/15/90 + ? FT_MADD( dDate, -2 ) // 07/15/90 + + // force EOM + dDate := SToD( "19910430" ) + ? FT_MADD( dDate, 1 ) // 05/30/91 + ? FT_MADD( dDate, 1, .T. ) // 05/31/91 <- forced EOM + ? FT_MADD( dDate, 2 ) // 06/30/91 + ? FT_MADD( dDate, 2, .T. ) // 06/30/91 <- June only has 30 days + ? FT_MADD( dDate, 3 ) // 07/30/91 + ? FT_MADD( dDate, 3, .T. ) // 07/31/91 <- forced EOM + $SEEALSO$ + FT_DAYOFYR() FT_DAYTOBOW() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/menu1.txt b/harbour/contrib/hbnf/doc/en/menu1.txt index f4764e08df..558da2ee6e 100644 --- a/harbour/contrib/hbnf/doc/en/menu1.txt +++ b/harbour/contrib/hbnf/doc/en/menu1.txt @@ -2,174 +2,174 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MENU1() - * $CATEGORY$ - * Menus/Prompts - * $ONELINER$ - * Pulldown menu system - * $SYNTAX$ - * FT_MENU1( , , , - * [, ], [ ] ) -> NIL - * $ARGUMENTS$ - * is a character array containing the names to appear - * on the menu bar. - * - * is a multi-dimensional array with one element for each - * selection to appear on the pulldown menus. - * - * is an array containing the colors for the menu groups. - * - * is a numeric value that determines the row for the menu - * bar. If omitted, it defaults to 0. - * - * is a logical variable. If true (.T.) or omitted, it - * uses FT_SHADOW() to add a transparent shadow to the each - * pulldown menu. If false (.F.), the menu is drawn without - * the shadow. - * - * All arguments except nTopRow and lShadow are required. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * FT_MENU1() is a function that displays a pulldown menu for each item - * on the menu bar and executes the corresponding function for the item - * selected. When a called function returns false, FT_MENU1 returns - * control to the calling program. - * - * Valid keystrokes and their corresponding actions: - * - * Home - Activates Pulldown for first item on the menu bar - * End - Activates Pulldown for last item on the menu bar - * Left Arrow - Activates next Pulldown to the left - * Right Arrow - Activates next Pulldown to the right - * Tab - Same as Right Arrow - * Shift-Tab - Same as Left Arrow - * Page Up - Top item on current Pulldown menu - * Page Down - Bottom item on current Pulldown menu - * Enter - Selects current item - * Alpha Character - Moves to closest match and selects - * Alt- - Moves to corresponding menu bar item - * Escape - Prompts for confirmation and either returns to - * the calling routine or resumes - * $EXAMPLES$ - * // Declare arrays - * LOCAL aColors := {} - * LOCAL aBar := { " ENTER/EDIT ", " REPORTS ", " DISPLAY " } - * - * // Include the following two lines of code in your program, as is. - * // The first creates aOptions with the same length as aBar. The - * // second assigns a three-element array to each element of aOptions. - * LOCAL aOptions[ Len( aBar ) ] - * AEval( aBar, {| x, i | aOptions[ i ] := { {}, {}, {} } } ) - * - * // fill color array - * // Box Border, Menu Options, Menu Bar, Current Selection, Unselected - * aColors := iif( lColor, { "W+/G", "N/G", "N/G", "N/W", "N+/G" }, ; - * { "W+/N", "W+/N", "W/N", "N/W","W/N" } ) - * - * // array for first pulldown menu - * FT_FILL( aOptions[ 1 ], "A. Execute A Dummy Procedure" , {|| fubar() }, .T. ) - * FT_FILL( aOptions[ 1 ], "B. Enter Daily Charges" , {|| .T. }, .F. ) - * FT_FILL( aOptions[ 1 ], "C. Enter Payments On Accounts", {|| .T. }, .T. ) - * - * // array for second pulldown menu - * FT_FILL( aOptions[ 2 ], "A. Print Member List" , {|| .T. }, .T. ) - * FT_FILL( aOptions[ 2 ], "B. Print Active Auto Charges" , {|| .T. }, .T. ) - * - * // array for third pulldown menu - * FT_FILL( aOptions[ 3 ], "A. Transaction Totals Display", {|| .T. }, .T. ) - * FT_FILL( aOptions[ 3 ], "B. Display Invoice Totals" , {|| .T. }, .T. ) - * FT_FILL( aOptions[ 3 ], "C. Exit To DOS" , {|| .F. }, .T. ) - * - * Call FT_FILL() once for each item on each pulldown menu, passing it - * three parameters: - * - * FT_FILL( , , - * - * is a character string which will be displayed on - * the pulldown menu. - * - * should contain one of the following: - * - * A function name to execute, which in turn should return .T. or .F. - * FT_MENU1 WILL RETURN CONTROL TO THE CALLING PROGRAM IF .F. IS - * RETURNED OR CONTINUE IF .T. IS RETURNED. - * - * .F. WHICH WILL CAUSE FT_MENU1 TO RETURN CONTROL TO THE CALLING - * PROGRAM. - * - * .T. WHICH WILL DO NOTHING. THIS ALLOWS THE DEVELOPER TO DESIGN A - * SKELETON MENU STRUCTURE PRIOR TO COMPLETING ALL OF THE SUBROUTINES. - * - * // CALL FT_MENU1 - * FT_MENU1( aBar, aOptions, aColors, 0 ) - * - * NOTE: FT_MENU1() disables Alt-C and Alt-D in order to make them - * available for the menu bar. It enables Alt-D and resets - * Alt-C to its previous state prior to calling each function. - * $SEEALSO$ - * FT_FILL() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MENU1() + $CATEGORY$ + Menus/Prompts + $ONELINER$ + Pulldown menu system + $SYNTAX$ + FT_MENU1( , , , + [, ], [ ] ) -> NIL + $ARGUMENTS$ + is a character array containing the names to appear + on the menu bar. + + is a multi-dimensional array with one element for each + selection to appear on the pulldown menus. + + is an array containing the colors for the menu groups. + + is a numeric value that determines the row for the menu + bar. If omitted, it defaults to 0. + + is a logical variable. If true (.T.) or omitted, it + uses FT_SHADOW() to add a transparent shadow to the each + pulldown menu. If false (.F.), the menu is drawn without + the shadow. + + All arguments except nTopRow and lShadow are required. + $RETURNS$ + NIL + $DESCRIPTION$ + FT_MENU1() is a function that displays a pulldown menu for each item + on the menu bar and executes the corresponding function for the item + selected. When a called function returns false, FT_MENU1 returns + control to the calling program. + + Valid keystrokes and their corresponding actions: + + Home - Activates Pulldown for first item on the menu bar + End - Activates Pulldown for last item on the menu bar + Left Arrow - Activates next Pulldown to the left + Right Arrow - Activates next Pulldown to the right + Tab - Same as Right Arrow + Shift-Tab - Same as Left Arrow + Page Up - Top item on current Pulldown menu + Page Down - Bottom item on current Pulldown menu + Enter - Selects current item + Alpha Character - Moves to closest match and selects + Alt- - Moves to corresponding menu bar item + Escape - Prompts for confirmation and either returns to + the calling routine or resumes + $EXAMPLES$ + // Declare arrays + LOCAL aColors := {} + LOCAL aBar := { " ENTER/EDIT ", " REPORTS ", " DISPLAY " } + + // Include the following two lines of code in your program, as is. + // The first creates aOptions with the same length as aBar. The + // second assigns a three-element array to each element of aOptions. + LOCAL aOptions[ Len( aBar ) ] + AEval( aBar, {| x, i | aOptions[ i ] := { {}, {}, {} } } ) + + // fill color array + // Box Border, Menu Options, Menu Bar, Current Selection, Unselected + aColors := iif( lColor, { "W+/G", "N/G", "N/G", "N/W", "N+/G" }, ; + { "W+/N", "W+/N", "W/N", "N/W","W/N" } ) + + // array for first pulldown menu + FT_FILL( aOptions[ 1 ], "A. Execute A Dummy Procedure" , {|| fubar() }, .T. ) + FT_FILL( aOptions[ 1 ], "B. Enter Daily Charges" , {|| .T. }, .F. ) + FT_FILL( aOptions[ 1 ], "C. Enter Payments On Accounts", {|| .T. }, .T. ) + + // array for second pulldown menu + FT_FILL( aOptions[ 2 ], "A. Print Member List" , {|| .T. }, .T. ) + FT_FILL( aOptions[ 2 ], "B. Print Active Auto Charges" , {|| .T. }, .T. ) + + // array for third pulldown menu + FT_FILL( aOptions[ 3 ], "A. Transaction Totals Display", {|| .T. }, .T. ) + FT_FILL( aOptions[ 3 ], "B. Display Invoice Totals" , {|| .T. }, .T. ) + FT_FILL( aOptions[ 3 ], "C. Exit To DOS" , {|| .F. }, .T. ) + + Call FT_FILL() once for each item on each pulldown menu, passing it + three parameters: + + FT_FILL( , , + + is a character string which will be displayed on + the pulldown menu. + + should contain one of the following: + + A function name to execute, which in turn should return .T. or .F. + FT_MENU1 WILL RETURN CONTROL TO THE CALLING PROGRAM IF .F. IS + RETURNED OR CONTINUE IF .T. IS RETURNED. + + .F. WHICH WILL CAUSE FT_MENU1 TO RETURN CONTROL TO THE CALLING + PROGRAM. + + .T. WHICH WILL DO NOTHING. THIS ALLOWS THE DEVELOPER TO DESIGN A + SKELETON MENU STRUCTURE PRIOR TO COMPLETING ALL OF THE SUBROUTINES. + + // CALL FT_MENU1 + FT_MENU1( aBar, aOptions, aColors, 0 ) + + NOTE: FT_MENU1() disables Alt-C and Alt-D in order to make them + available for the menu bar. It enables Alt-D and resets + Alt-C to its previous state prior to calling each function. + $SEEALSO$ + FT_FILL() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_FILL() - * $CATEGORY$ - * Menus/Prompts - * $ONELINER$ - * Declare menu options for FT_MENU1() - * $SYNTAX$ - * FT_FILL( , , , - * ) -> NIL - * $ARGUMENTS$ - * is a sub-array of in FT_MENU1() - * denoting the group in which to include the selection -- - * e.g., acOptions[ 1 ] - * - * is the character string that will appear on - * the menu. - * - * is the code block to be executed when that menu - * option is selected. i.e. {|| MyFunction() } would execute - * the function called MyFunction(). {|| .F. } would exit the - * FT_MENU1 and return to the calling routine. {|| .T. } would - * do nothing. - * - * is a logical variable that determines whether - * the corresponding menu option is selectable or not. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * FT_FILL() is a function used to set up the menu options prior - * to calling FT_MENU1(). - * $EXAMPLES$ - * FT_FILL( aOptions[ 1 ], "A. Execute A Dummy Procedure" , {|| fubar() }, .T. ) - * - * The above would be added to the sub-menu associated with the first menu - * bar item, would execute the function FUBAR() when that option was - * selected, and would be selectable. - * - * - * FT_FILL( aOptions[ 3 ], "B. Enter Daily Charges" , {|| .T. }, .F. ) - * - * The above would be added to the sub-menu associated with the third menu - * bar item, and would be unselectable. - * - * - * FT_FILL( aOptions[ 2 ], "C. Enter Payments On Accounts", {|| .T. }, .T. ) - * - * The above would be added to the sub-menu associated with the second menu - * bar item, and would be selectable, but would do nothing when selected. - * - * - * FT_FILL( aOptions[ 4 ], "C. Exit" , {|| .F. }, .T. ) - * - * The above would be added to the sub-menu associated with the fourth menu - * bar item, and would be selectable, and would exit FT_MENU1() when chosen. - * $SEEALSO$ - * FT_MENU1() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_FILL() + $CATEGORY$ + Menus/Prompts + $ONELINER$ + Declare menu options for FT_MENU1() + $SYNTAX$ + FT_FILL( , , , + ) -> NIL + $ARGUMENTS$ + is a sub-array of in FT_MENU1() + denoting the group in which to include the selection -- + e.g., acOptions[ 1 ] + + is the character string that will appear on + the menu. + + is the code block to be executed when that menu + option is selected. i.e. {|| MyFunction() } would execute + the function called MyFunction(). {|| .F. } would exit the + FT_MENU1 and return to the calling routine. {|| .T. } would + do nothing. + + is a logical variable that determines whether + the corresponding menu option is selectable or not. + $RETURNS$ + NIL + $DESCRIPTION$ + FT_FILL() is a function used to set up the menu options prior + to calling FT_MENU1(). + $EXAMPLES$ + FT_FILL( aOptions[ 1 ], "A. Execute A Dummy Procedure" , {|| fubar() }, .T. ) + + The above would be added to the sub-menu associated with the first menu + bar item, would execute the function FUBAR() when that option was + selected, and would be selectable. + + + FT_FILL( aOptions[ 3 ], "B. Enter Daily Charges" , {|| .T. }, .F. ) + + The above would be added to the sub-menu associated with the third menu + bar item, and would be unselectable. + + + FT_FILL( aOptions[ 2 ], "C. Enter Payments On Accounts", {|| .T. }, .T. ) + + The above would be added to the sub-menu associated with the second menu + bar item, and would be selectable, but would do nothing when selected. + + + FT_FILL( aOptions[ 4 ], "C. Exit" , {|| .F. }, .T. ) + + The above would be added to the sub-menu associated with the fourth menu + bar item, and would be selectable, and would exit FT_MENU1() when chosen. + $SEEALSO$ + FT_MENU1() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/menutonf.txt b/harbour/contrib/hbnf/doc/en/menutonf.txt index 034fa9cd1b..111e73882c 100644 --- a/harbour/contrib/hbnf/doc/en/menutonf.txt +++ b/harbour/contrib/hbnf/doc/en/menutonf.txt @@ -2,195 +2,195 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_Prompt() - * $CATEGORY$ - * Menus/Prompts - * $ONELINER$ - * Define a menu item for use with FT_MenuTo() - * $SYNTAX$ - * #include "ftmenuto.ch" - * - * @ , PROMPT ; - * [COLOR ] ; - * [MESSAGE ] ; - * [MSGROW ] ; - * [MSGCOL ] ; - * [MSGCOLOR ] ; - * [TRIGGER ] ; - * [TRIGGERCOLOR ] ; - * [HOME ] ; - * [END ] ; - * [UP ] ; - * [DOWN ] ; - * [LEFT ] ; - * [RIGHT ] ; - * [EXECUTE ] ; - * - * $ARGUMENTS$ - * is the row at which the prompt is to appear. - * - * is the column at which the prompt will appear. - * - * is the menu item string. - * - * is optional and is the color attribute of the prompt. Note - * that two colors are required; one for the standard setting and one - * for the enhanced setting (i.e. the light bar color). See the example - * below if this isn't clear. If is not specified then the - * current SetColor() value is used by default. - * - * is optional and is the message associated with the - * prompt. If not specified, then no message will be displayed. - * - * is optional and is the row at which the message, if any, - * will appear. If not specified, the default is the current setting - * of the SET MESSAGE TO command. - * - * is optional and is the column at which the message, if - * any, will appear. If not specified, the default is either zero or - * centered, depending on the current setting of the CENTER option of - * the SET MESSAGE TO command. - * - * is optional and is the color attribute of the message. - * If not specified, the default is the same as the prompt color. - * - * is optional and is the position within the prompt string - * where the trigger character is located. If not specified, the - * default is one. - * - * is optional and is the color attribute of the trigger - * character. Note that two colors are required; one for the standard - * setting and one for the enhanced setting (i.e. the light bar color). - * See the example below if this isn't clear. If is not - * specified then the default is the same color as the rest of the - * prompt. - * - * is optional and specifies which prompt becomes active - * when the home key is pressed. If not specified, the default is - * the first prompt. - * - * is optional and specifies which prompt becomes active - * when the end key is pressed. If not specified, the default is - * the last prompt. - * - * is optional and specifies which prompt becomes active - * when the up arrow key is pressed. If not specified, the - * default is the previous prompt. The current setting of SET - * WRAP TO is obeyed. - * - * is optional and specifies which prompt becomes - * active when the down arrow key is pressed. If not - * specified, the default is the next prompt. The current - * setting of SET WRAP TO is obeyed. - * - * is optional and specifies which prompt becomes - * active when the right arrow key is pressed. If not - * specified, the default is the next prompt. The current - * setting of SET WRAP TO is obeyed. - * - * is optional and specifies which prompt becomes - * active when the left arrow is pressed. If not specified, - * the default is the previous prompt. The current setting of - * SET WRAP TO is obeyed. - * - * is optional and is a code block to evaluate whenever - * the menu item to which it belongs is selected. - * $DESCRIPTION$ - * Clipper's @...PROMPT and MENU TO commands are fine as far as - * they go. But many times you need more flexibility. As - * you'll no doubt notice if you read the argument list, this - * function is almost completely flexible. You can adjust - * locations and colors for every part of the prompt and its - * associated message. In addition, since you can control the - * effect of the arrow keys, you can allow both horizontal and - * vertical movement, or even disable certain arrow keys if you - * so desire. Support for nested menus is also available, since - * the prompts are stored in stack-based static arrays. - * - * Note that this command can also be called using function-style - * syntax. See the entry for FT_PROMPT() for further details. - * - * This enhanced version of @...PROMPT requires the inclusion of - * the header file ftmenuto.ch in any source file that uses it. - * It is may be used in place of the standard Clipper @...PROMPT - * command. However, in the interests of functionality it is NOT - * 100% compatible. No whining! If compatibility is such a big - * deal then use the standard Clipper commands. - * - * $EXAMPLES$ - * #include "ftmenuto.ch" - * - * // Simple prompt - * @ 1, 1 PROMPT "Menu choice #1" - * - * // Prompt with color - * @ 3, 1 PROMPT "Menu choice #2" COLOR "W+/R,W+/B" - * - * // Prompt with a message - * @ 5, 1 PROMPT "Menu choice #3" MESSAGE "Go to lunch" - * - * // Prompt with pinpoint message control - * @ 7, 1 PROMPT "Menu choice #4" MESSAGE "Drop Dead" ; - * MSGROW 22 MSGCOL 4 MSGCOLOR "GR+/N" - * - * // Prompt with a trigger character ("#" character) - * @ 11, 1 PROMPT "Menu choice #6" TRIGGER 13 - * - * // Prompt with trigger character color control - * @ 13, 1 PROMPT "Menu Choice #7" TRIGGER 13 TRIGGERCOLOR "R+/BG,G+/N" - * - * // Prompt with right and left arrow keys disabled - * @ 15, 1 PROMPT "Menu Choice #8" RIGHT 8 LEFT 8 - * $INCLUDE$ - * ftmenuto.ch - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_Prompt() + $CATEGORY$ + Menus/Prompts + $ONELINER$ + Define a menu item for use with FT_MenuTo() + $SYNTAX$ + #include "ftmenuto.ch" + + @ , PROMPT ; + [COLOR ] ; + [MESSAGE ] ; + [MSGROW ] ; + [MSGCOL ] ; + [MSGCOLOR ] ; + [TRIGGER ] ; + [TRIGGERCOLOR ] ; + [HOME ] ; + [END ] ; + [UP ] ; + [DOWN ] ; + [LEFT ] ; + [RIGHT ] ; + [EXECUTE ] ; + + $ARGUMENTS$ + is the row at which the prompt is to appear. + + is the column at which the prompt will appear. + + is the menu item string. + + is optional and is the color attribute of the prompt. Note + that two colors are required; one for the standard setting and one + for the enhanced setting (i.e. the light bar color). See the example + below if this isn't clear. If is not specified then the + current SetColor() value is used by default. + + is optional and is the message associated with the + prompt. If not specified, then no message will be displayed. + + is optional and is the row at which the message, if any, + will appear. If not specified, the default is the current setting + of the SET MESSAGE TO command. + + is optional and is the column at which the message, if + any, will appear. If not specified, the default is either zero or + centered, depending on the current setting of the CENTER option of + the SET MESSAGE TO command. + + is optional and is the color attribute of the message. + If not specified, the default is the same as the prompt color. + + is optional and is the position within the prompt string + where the trigger character is located. If not specified, the + default is one. + + is optional and is the color attribute of the trigger + character. Note that two colors are required; one for the standard + setting and one for the enhanced setting (i.e. the light bar color). + See the example below if this isn't clear. If is not + specified then the default is the same color as the rest of the + prompt. + + is optional and specifies which prompt becomes active + when the home key is pressed. If not specified, the default is + the first prompt. + + is optional and specifies which prompt becomes active + when the end key is pressed. If not specified, the default is + the last prompt. + + is optional and specifies which prompt becomes active + when the up arrow key is pressed. If not specified, the + default is the previous prompt. The current setting of SET + WRAP TO is obeyed. + + is optional and specifies which prompt becomes + active when the down arrow key is pressed. If not + specified, the default is the next prompt. The current + setting of SET WRAP TO is obeyed. + + is optional and specifies which prompt becomes + active when the right arrow key is pressed. If not + specified, the default is the next prompt. The current + setting of SET WRAP TO is obeyed. + + is optional and specifies which prompt becomes + active when the left arrow is pressed. If not specified, + the default is the previous prompt. The current setting of + SET WRAP TO is obeyed. + + is optional and is a code block to evaluate whenever + the menu item to which it belongs is selected. + $DESCRIPTION$ + Clipper's @...PROMPT and MENU TO commands are fine as far as + they go. But many times you need more flexibility. As + you'll no doubt notice if you read the argument list, this + function is almost completely flexible. You can adjust + locations and colors for every part of the prompt and its + associated message. In addition, since you can control the + effect of the arrow keys, you can allow both horizontal and + vertical movement, or even disable certain arrow keys if you + so desire. Support for nested menus is also available, since + the prompts are stored in stack-based static arrays. + + Note that this command can also be called using function-style + syntax. See the entry for FT_PROMPT() for further details. + + This enhanced version of @...PROMPT requires the inclusion of + the header file ftmenuto.ch in any source file that uses it. + It is may be used in place of the standard Clipper @...PROMPT + command. However, in the interests of functionality it is NOT + 100% compatible. No whining! If compatibility is such a big + deal then use the standard Clipper commands. + + $EXAMPLES$ + #include "ftmenuto.ch" + + // Simple prompt + @ 1, 1 PROMPT "Menu choice #1" + + // Prompt with color + @ 3, 1 PROMPT "Menu choice #2" COLOR "W+/R,W+/B" + + // Prompt with a message + @ 5, 1 PROMPT "Menu choice #3" MESSAGE "Go to lunch" + + // Prompt with pinpoint message control + @ 7, 1 PROMPT "Menu choice #4" MESSAGE "Drop Dead" ; + MSGROW 22 MSGCOL 4 MSGCOLOR "GR+/N" + + // Prompt with a trigger character ("#" character) + @ 11, 1 PROMPT "Menu choice #6" TRIGGER 13 + + // Prompt with trigger character color control + @ 13, 1 PROMPT "Menu Choice #7" TRIGGER 13 TRIGGERCOLOR "R+/BG,G+/N" + + // Prompt with right and left arrow keys disabled + @ 15, 1 PROMPT "Menu Choice #8" RIGHT 8 LEFT 8 + $INCLUDE$ + ftmenuto.ch + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MenuTo() - * $CATEGORY$ - * Menus/Prompts - * $ONELINER$ - * Execute light bar menu using prompts created with @...PROMPT - * $SYNTAX$ - * #include "ftmenuto.ch" - * - * MENU TO [COLD] - * $ARGUMENTS$ - * is the name of the variable to which the result of the menu - * selection should be assigned. - * - * [COLD] is optional and if specified indicates that trigger characters - * should be treated as "cold," i.e. rather than causing the menu item - * to be selected it only causes the light bar to move to that selection. - * $DESCRIPTION$ - * This enhanced version of MENU TO requires the inclusion of the header - * file ftmenuto.ch in any source file that uses it. It may be used in - * place of the standard Clipper MENU TO command. However, in the - * interests of functionality it is NOT 100% compatible (in particular, - * you should make sure that the target memvar exists before executing - * the menu -- the Clipper version will create a PRIVATE memvar for you - * if it does not already exist, but this version does not). No whining! - * If compatibility is such a big deal then use the standard Clipper - * command. - * - * Note that this command can also be called using function-style - * syntax. See the entry for FT_MENUTO() for further details. - * $EXAMPLES$ - * #include "ftmenuto.ch" - * - * // Simple command - * - * MENU TO memvar - * - * $INCLUDE$ - * ftmenuto.ch - * $SEEALSO$ - * FT_Prompt() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MenuTo() + $CATEGORY$ + Menus/Prompts + $ONELINER$ + Execute light bar menu using prompts created with @...PROMPT + $SYNTAX$ + #include "ftmenuto.ch" + + MENU TO [COLD] + $ARGUMENTS$ + is the name of the variable to which the result of the menu + selection should be assigned. + + [COLD] is optional and if specified indicates that trigger characters + should be treated as "cold," i.e. rather than causing the menu item + to be selected it only causes the light bar to move to that selection. + $DESCRIPTION$ + This enhanced version of MENU TO requires the inclusion of the header + file ftmenuto.ch in any source file that uses it. It may be used in + place of the standard Clipper MENU TO command. However, in the + interests of functionality it is NOT 100% compatible (in particular, + you should make sure that the target memvar exists before executing + the menu -- the Clipper version will create a PRIVATE memvar for you + if it does not already exist, but this version does not). No whining! + If compatibility is such a big deal then use the standard Clipper + command. + + Note that this command can also be called using function-style + syntax. See the entry for FT_MENUTO() for further details. + $EXAMPLES$ + #include "ftmenuto.ch" + + // Simple command + + MENU TO memvar + + $INCLUDE$ + ftmenuto.ch + $SEEALSO$ + FT_Prompt() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/metaph.txt b/harbour/contrib/hbnf/doc/en/metaph.txt index 16a8b22249..8ad3304f62 100644 --- a/harbour/contrib/hbnf/doc/en/metaph.txt +++ b/harbour/contrib/hbnf/doc/en/metaph.txt @@ -2,35 +2,35 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_METAPH() - * $CATEGORY$ - * String - * $ONELINER$ - * Convert a character string to MetaPhone format - * $SYNTAX$ - * FT_METAPH( [, ] ) -> cMetaPhone - * $ARGUMENTS$ - * is the character string to convert - * - * is the length of the character string to be returned. - * If not specified the default length is 4 bytes. - * $RETURNS$ - * A phonetically spelled character string - * $DESCRIPTION$ - * This function is a character function use to index and search for - * sound-alike or phonetic matches. It is an alternative to - * the SOUNDEX() function, and addresses some basic pronunciation - * rules, by looking at surrounding letters to determine how parts of - * the string are pronounced. FT_METAPH() will group sound-alikes - * together, and forgive shortcomings in spelling ability. - * $EXAMPLES$ - * USE persons - * INDEX ON FT_METAPH( LastName ) TO lastname - * SEEK FT_METAPH( "Philmore" ) - * ? Found(), LastName // Result: .T. Philmore - * SEEK FT_METAPH( "Fillmore" ) - * ? Found(), LastName // Result: .T. Philmore - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_METAPH() + $CATEGORY$ + String + $ONELINER$ + Convert a character string to MetaPhone format + $SYNTAX$ + FT_METAPH( [, ] ) -> cMetaPhone + $ARGUMENTS$ + is the character string to convert + + is the length of the character string to be returned. + If not specified the default length is 4 bytes. + $RETURNS$ + A phonetically spelled character string + $DESCRIPTION$ + This function is a character function use to index and search for + sound-alike or phonetic matches. It is an alternative to + the SOUNDEX() function, and addresses some basic pronunciation + rules, by looking at surrounding letters to determine how parts of + the string are pronounced. FT_METAPH() will group sound-alikes + together, and forgive shortcomings in spelling ability. + $EXAMPLES$ + USE persons + INDEX ON FT_METAPH( LastName ) TO lastname + SEEK FT_METAPH( "Philmore" ) + ? Found(), LastName // Result: .T. Philmore + SEEK FT_METAPH( "Fillmore" ) + ? Found(), LastName // Result: .T. Philmore + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/miltime.txt b/harbour/contrib/hbnf/doc/en/miltime.txt index 5e0fc5a19d..8c42dfc05c 100644 --- a/harbour/contrib/hbnf/doc/en/miltime.txt +++ b/harbour/contrib/hbnf/doc/en/miltime.txt @@ -2,133 +2,133 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MIL2MIN() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Convert time in military format to number of minute of day. - * $SYNTAX$ - * FT_MIL2MIN( ) -> nMINUTE - * $ARGUMENTS$ - * character string of form hhmm, where 0<=hh<24. - * $RETURNS$ - * numeric value representing minute of day. - * $DESCRIPTION$ - * Converts time in military format to number of minute of the day. - * $EXAMPLES$ - * FT_MIL2MIN( "1729" ) // 1049 - * $SEEALSO$ - * FT_MIN2MIL() FT_CIV2MIL() FT_MIL2CIV() FT_SYS2MIL() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MIL2MIN() + $CATEGORY$ + Date/Time + $ONELINER$ + Convert time in military format to number of minute of day. + $SYNTAX$ + FT_MIL2MIN( ) -> nMINUTE + $ARGUMENTS$ + character string of form hhmm, where 0<=hh<24. + $RETURNS$ + numeric value representing minute of day. + $DESCRIPTION$ + Converts time in military format to number of minute of the day. + $EXAMPLES$ + FT_MIL2MIN( "1729" ) // 1049 + $SEEALSO$ + FT_MIN2MIL() FT_CIV2MIL() FT_MIL2CIV() FT_SYS2MIL() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MIN2MIL() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Convert minute of day to military format time. - * $SYNTAX$ - * FT_MIN2MIL( ) -> cMILTIME - * $ARGUMENTS$ - * numeric integer representing minute of day. - * $RETURNS$ - * character string of form hhmm, where 0<=hh<24. - * $DESCRIPTION$ - * Converts minute of the day to military format time. - * $EXAMPLES$ - * FT_MIN2MIL( 279 ) // 0439 - * $SEEALSO$ - * FT_MIL2MIN() FT_MIL2CIV() FT_CIV2MIL() FT_SYS2MIL() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MIN2MIL() + $CATEGORY$ + Date/Time + $ONELINER$ + Convert minute of day to military format time. + $SYNTAX$ + FT_MIN2MIL( ) -> cMILTIME + $ARGUMENTS$ + numeric integer representing minute of day. + $RETURNS$ + character string of form hhmm, where 0<=hh<24. + $DESCRIPTION$ + Converts minute of the day to military format time. + $EXAMPLES$ + FT_MIN2MIL( 279 ) // 0439 + $SEEALSO$ + FT_MIL2MIN() FT_MIL2CIV() FT_CIV2MIL() FT_SYS2MIL() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MIL2CIV() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Convert time in military format to civilian format. - * $SYNTAX$ - * FT_MIL2CIV( ) -> dMILTIME - * $ARGUMENTS$ - * character string of form hhmm, where 0<=hh<24. - * $RETURNS$ - * character string of form hh:mm (am,pm,n or m), - * where 0 ) -> dMILTIME + $ARGUMENTS$ + character string of form hhmm, where 0<=hh<24. + $RETURNS$ + character string of form hh:mm (am,pm,n or m), + where 0 ) -> cMILTIME - * $ARGUMENTS$ - * character string of form hh:mm (am,pm,n or m), - * where 0 character string of form hhmm, where 0<=hh<24. - * $DESCRIPTION$ - * Converts time from 12-hour civilian format to military. - * $EXAMPLES$ - * FT_CIV2MIL( " 5:40 pm" ) // 1740 - * - * FT_CIV2MIL( " 5:40 am" ) // 0540 - * - * FT_CIV2MIL( "12:00 n" ) // 1200 - * - * FT_CIV2MIL( "12:00 m" ) // 0000 - * - * Caution: leading blanks are irrelevant; p,a,n,m must be preceded by - * one and only one space. - * $SEEALSO$ - * FT_MIL2CIV() FT_SYS2MIL() FT_MIL2MIN() FT_MIN2MIL() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_CIV2MIL() + $CATEGORY$ + Date/Time + $ONELINER$ + Convert usual civilian format time to military time. + $SYNTAX$ + FT_CIV2MIL( ) -> cMILTIME + $ARGUMENTS$ + character string of form hh:mm (am,pm,n or m), + where 0 character string of form hhmm, where 0<=hh<24. + $DESCRIPTION$ + Converts time from 12-hour civilian format to military. + $EXAMPLES$ + FT_CIV2MIL( " 5:40 pm" ) // 1740 + + FT_CIV2MIL( " 5:40 am" ) // 0540 + + FT_CIV2MIL( "12:00 n" ) // 1200 + + FT_CIV2MIL( "12:00 m" ) // 0000 + + Caution: leading blanks are irrelevant; p,a,n,m must be preceded by + one and only one space. + $SEEALSO$ + FT_MIL2CIV() FT_SYS2MIL() FT_MIL2MIN() FT_MIN2MIL() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_SYS2MIL() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Convert system time to military time format. - * $SYNTAX$ - * FT_SYS2MIL() -> cMILTIME - * $ARGUMENTS$ - * none - * $RETURNS$ - * character string of form hhmm, where 0<=hh<24. - * $DESCRIPTION$ - * Return current system time as character string in military format. - * $EXAMPLES$ - * FT_SYS2MIL() // 1623 - * $SEEALSO$ - * FT_MIL2CIV() FT_CIV2MIL() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SYS2MIL() + $CATEGORY$ + Date/Time + $ONELINER$ + Convert system time to military time format. + $SYNTAX$ + FT_SYS2MIL() -> cMILTIME + $ARGUMENTS$ + none + $RETURNS$ + character string of form hhmm, where 0<=hh<24. + $DESCRIPTION$ + Return current system time as character string in military format. + $EXAMPLES$ + FT_SYS2MIL() // 1623 + $SEEALSO$ + FT_MIL2CIV() FT_CIV2MIL() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/min2dhm.txt b/harbour/contrib/hbnf/doc/en/min2dhm.txt index b5cf12808c..1ef921d53c 100644 --- a/harbour/contrib/hbnf/doc/en/min2dhm.txt +++ b/harbour/contrib/hbnf/doc/en/min2dhm.txt @@ -2,25 +2,25 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MIN2DHM() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Convert numeric minutes to days, hours and minutes. - * $SYNTAX$ - * FT_MIN2DHM( ) -> aDHM_ - * $ARGUMENTS$ - * the number of minutes. - * $RETURNS$ - * - * where: - * aDHM_[ 1 ] = cDAYS, aDHM_[ 2 ] = cHours, aDHM_[ 3 ] = cMinutes - * $DESCRIPTION$ - * Converts numeric minutes into a character array containing - * days, hours & minutes. - * $EXAMPLES$ - * aDHM_ := MIN2DHM( 16789 ) // aDHM_[ 1 ] = 11, aDHM_[ 2 ] = 15, aDHM_[ 3 ] = 49 - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MIN2DHM() + $CATEGORY$ + Date/Time + $ONELINER$ + Convert numeric minutes to days, hours and minutes. + $SYNTAX$ + FT_MIN2DHM( ) -> aDHM_ + $ARGUMENTS$ + the number of minutes. + $RETURNS$ + + where: + aDHM_[ 1 ] = cDAYS, aDHM_[ 2 ] = cHours, aDHM_[ 3 ] = cMinutes + $DESCRIPTION$ + Converts numeric minutes into a character array containing + days, hours & minutes. + $EXAMPLES$ + aDHM_ := MIN2DHM( 16789 ) // aDHM_[ 1 ] = 11, aDHM_[ 2 ] = 15, aDHM_[ 3 ] = 49 + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/mkdir.txt b/harbour/contrib/hbnf/doc/en/mkdir.txt index 5016488e6c..2b69dc3ee0 100644 --- a/harbour/contrib/hbnf/doc/en/mkdir.txt +++ b/harbour/contrib/hbnf/doc/en/mkdir.txt @@ -2,34 +2,34 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MKDIR() - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Create a subdirectory - * $SYNTAX$ - * FT_MKDIR( ) -> nResult - * $ARGUMENTS$ - * is the name of the directory to create. - * $RETURNS$ - * 0 if successful - * 3 if Path Not Found - * 5 if Access Denied or directory already exists - * 99 if invalid parameters passed - * $DESCRIPTION$ - * Use this function to create the subdirectories needed by your - * application. It might be especially useful in an installation - * program. - * - * The source code is written to adhere to Turbo Assembler's IDEAL mode. - * To use another assembler, you will need to rearrange the PROC and - * SEGMENT directives, and also the ENDP and ENDS directives (a very - * minor task). - * $EXAMPLES$ - * FT_MKDIR( "C:\clipper" ) - * FT_MKDIR( "\example" ) - * FT_MKDIR( "..\source" ) - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MKDIR() + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Create a subdirectory + $SYNTAX$ + FT_MKDIR( ) -> nResult + $ARGUMENTS$ + is the name of the directory to create. + $RETURNS$ + 0 if successful + 3 if Path Not Found + 5 if Access Denied or directory already exists + 99 if invalid parameters passed + $DESCRIPTION$ + Use this function to create the subdirectories needed by your + application. It might be especially useful in an installation + program. + + The source code is written to adhere to Turbo Assembler's IDEAL mode. + To use another assembler, you will need to rearrange the PROC and + SEGMENT directives, and also the ENDP and ENDS directives (a very + minor task). + $EXAMPLES$ + FT_MKDIR( "C:\clipper" ) + FT_MKDIR( "\example" ) + FT_MKDIR( "..\source" ) + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/month.txt b/harbour/contrib/hbnf/doc/en/month.txt index 6ee9192b08..8742aba8b0 100644 --- a/harbour/contrib/hbnf/doc/en/month.txt +++ b/harbour/contrib/hbnf/doc/en/month.txt @@ -2,60 +2,60 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MONTH() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Return Calendar or Fiscal Month Data - * $SYNTAX$ - * FT_MONTH( [ ], [nMonthNum] ) -> aDateInfo - * $ARGUMENTS$ - * is any valid date in any date format. Defaults - * to current system date if not supplied. - * - * is a number from 1 to 12 signifying a month. - * Defaults to current month if not supplied. - * $RETURNS$ - * A three element array containing the following data: - * - * aDateInfo[ 1 ] - The year and month as a character string "YYYYMM" - * aDateInfo[ 2 ] - The beginning date of the month - * aDateInfo[ 3 ] - The ending date of the month - * $DESCRIPTION$ - * FT_MONTH() returns an array containing data about the month - * containing the given date. - * - * Normally the return data will be based on a year beginning - * on January 1st with weeks beginning on Sunday. - * - * The beginning of year date and/or beginning of week day can be - * changed by using FT_DATECNFG(), which will affect all subsequent - * calls to FT_MONTH() until another call to FT_DATECNFG(). - * - * The beginning of year date and beginning of week day may be reset - * to January 1 and Sunday by calling FT_DATECNFG() with no - * parameters. - * $EXAMPLES$ - * // get info about month containing 9/15/90 - * aDateInfo := FT_MONTH( SToD( "19900915" ) ) - * ? aDateInfo[ 1 ] // 199009 (9th month) - * ? aDateInfo[ 2 ] // 09/01/90 beginning of month 9 - * ? aDateInfo[ 3 ] // 09/30/90 end of week month 9 - * - * // get info about month 5 in year containing 9/15/90 - * aDateInfo := FT_MONTH( SToD( "19900915" ), 5 ) - * ? aDateInfo[ 1 ] // 199005 - * ? aDateInfo[ 2 ] // 05/01/90 beginning of month 5 - * ? aDateInfo[ 3 ] // 05/31/90 end of month 5 - * - * // get info about month 5 in current year (1991) - * aDateInfo := FT_MONTH( , 5 ) - * ? aDateInfo[ 1 ] // 199105 - * ? aDateInfo[ 2 ] // 05/01/91 beginning of month 5 - * ? aDateInfo[ 3 ] // 05/31/91 end of month 5 - * $SEEALSO$ - * FT_DATECNFG() FT_WEEK() FT_QTR() FT_YEAR() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MONTH() + $CATEGORY$ + Date/Time + $ONELINER$ + Return Calendar or Fiscal Month Data + $SYNTAX$ + FT_MONTH( [ ], [nMonthNum] ) -> aDateInfo + $ARGUMENTS$ + is any valid date in any date format. Defaults + to current system date if not supplied. + + is a number from 1 to 12 signifying a month. + Defaults to current month if not supplied. + $RETURNS$ + A three element array containing the following data: + + aDateInfo[ 1 ] - The year and month as a character string "YYYYMM" + aDateInfo[ 2 ] - The beginning date of the month + aDateInfo[ 3 ] - The ending date of the month + $DESCRIPTION$ + FT_MONTH() returns an array containing data about the month + containing the given date. + + Normally the return data will be based on a year beginning + on January 1st with weeks beginning on Sunday. + + The beginning of year date and/or beginning of week day can be + changed by using FT_DATECNFG(), which will affect all subsequent + calls to FT_MONTH() until another call to FT_DATECNFG(). + + The beginning of year date and beginning of week day may be reset + to January 1 and Sunday by calling FT_DATECNFG() with no + parameters. + $EXAMPLES$ + // get info about month containing 9/15/90 + aDateInfo := FT_MONTH( SToD( "19900915" ) ) + ? aDateInfo[ 1 ] // 199009 (9th month) + ? aDateInfo[ 2 ] // 09/01/90 beginning of month 9 + ? aDateInfo[ 3 ] // 09/30/90 end of week month 9 + + // get info about month 5 in year containing 9/15/90 + aDateInfo := FT_MONTH( SToD( "19900915" ), 5 ) + ? aDateInfo[ 1 ] // 199005 + ? aDateInfo[ 2 ] // 05/01/90 beginning of month 5 + ? aDateInfo[ 3 ] // 05/31/90 end of month 5 + + // get info about month 5 in current year (1991) + aDateInfo := FT_MONTH( , 5 ) + ? aDateInfo[ 1 ] // 199105 + ? aDateInfo[ 2 ] // 05/01/91 beginning of month 5 + ? aDateInfo[ 3 ] // 05/31/91 end of month 5 + $SEEALSO$ + FT_DATECNFG() FT_WEEK() FT_QTR() FT_YEAR() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/mouse1.txt b/harbour/contrib/hbnf/doc/en/mouse1.txt index bde1ac0e2f..6aa4dc24cd 100644 --- a/harbour/contrib/hbnf/doc/en/mouse1.txt +++ b/harbour/contrib/hbnf/doc/en/mouse1.txt @@ -2,857 +2,857 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MINIT() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Initialize the mouse driver, vars and return status of mouse - * $SYNTAX$ - * FT_MINIT() -> lMouseStatus - * $ARGUMENTS$ - * NONE - * $RETURNS$ - * An logical representing the mouse status (.F. == mouse not installed) - * $DESCRIPTION$ - * Initializes the mouse drive, associated variables and returns mouse - * status. It checks to see if the mouse has been previously initialized - * and if so it does not reinitialize. The row and column limits of mouse - * movement is set to the maximum for the current video mode. - * Use FT_MSHOWCRS() to display the mouse cursor. - * $EXAMPLES$ - * IF ! FT_MINIT() - * ? "No mouse driver is installed" - * ENDIF - * $SEEALSO$ - * FT_MRESET() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MINIT() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Initialize the mouse driver, vars and return status of mouse + $SYNTAX$ + FT_MINIT() -> lMouseStatus + $ARGUMENTS$ + NONE + $RETURNS$ + An logical representing the mouse status (.F. == mouse not installed) + $DESCRIPTION$ + Initializes the mouse drive, associated variables and returns mouse + status. It checks to see if the mouse has been previously initialized + and if so it does not reinitialize. The row and column limits of mouse + movement is set to the maximum for the current video mode. + Use FT_MSHOWCRS() to display the mouse cursor. + $EXAMPLES$ + IF ! FT_MINIT() + ? "No mouse driver is installed" + ENDIF + $SEEALSO$ + FT_MRESET() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MMICKEYS() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Get mickeys - * $SYNTAX$ - * FT_MMICKEYS( @, @ ) -> NIL - * $ARGUMENTS$ - * is a variable that will receive the vertical mickey count. - * - * is a variable that will receive the horizontal mickey count. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * and must be passed by reference to receive - * the mouse position in Mickeys. - * $EXAMPLES$ - * FT_MMICKEYS( @nX, @nY ) - * ? nX - * ? nY - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MMICKEYS() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Get mickeys + $SYNTAX$ + FT_MMICKEYS( @, @ ) -> NIL + $ARGUMENTS$ + is a variable that will receive the vertical mickey count. + + is a variable that will receive the horizontal mickey count. + $RETURNS$ + NIL + $DESCRIPTION$ + and must be passed by reference to receive + the mouse position in Mickeys. + $EXAMPLES$ + FT_MMICKEYS( @nX, @nY ) + ? nX + ? nY + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MDBLCLK() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Return true if a double click was detected - * $SYNTAX$ - * FT_MDBLCLK( [ [, [, [, [, ; - * [, ] ] ] ] ] ] ) -> lIsDoubleClk - * $ARGUMENTS$ - * is a numeric value. If it is zero FT_MDBLCLK() will not - * check for the first press but rather will simply wait the - * specified period for a single press. This is useful if this - * routine is called from one which in turn responded to a button - * press. If it is not present or not equal to 0, then FT_MDBLCLK() - * will wait for two presses of the specified button. - * - * is the mouse button number - * 0 - Left Button - * 1 - Right Button - * 2 - Middle Button [if applicable] - * - * is the interval to wait for the first click if requested - * and the time to wait for the second. If not present then defaults - * to 0.5 second. - * - * is the row number for the mouse cursor location for a double click - * to be valid. If not present then the current position is taken as - * the valid location. - * - * is the column number for the mouse cursor location for a double - * click to be valid. If not present, then the current position is - * taken as the valid location. - * - * is an optional start time for the waiting period for the first - * click (of either one or two requested). If not given then the - * time is set at entry into this routine. This is useful when this - * routine is called from another routine which was called in - * response to a mouse click but needs to know if a double click - * has occurred - * $RETURNS$ - * .T. if a double click was detected. - * $DESCRIPTION$ - * This is a mouse meta function that checks for the presence - * of a double click. - * $EXAMPLES$ - * IF FT_MISREGION( 10, 10, 11, 20 ) .AND.; - * FT_MDBLCLK( 0, 1,, FT_MGETX(), FT_MGETY() ) // double click, right button - * // at current location with - * // default interval - * - * MnuItem1() - * ENDIF - * $SEEALSO$ - * FT_MBUTPRS() FT_MBUTREL() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MDBLCLK() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Return true if a double click was detected + $SYNTAX$ + FT_MDBLCLK( [ [, [, [, [, ; + [, ] ] ] ] ] ] ) -> lIsDoubleClk + $ARGUMENTS$ + is a numeric value. If it is zero FT_MDBLCLK() will not + check for the first press but rather will simply wait the + specified period for a single press. This is useful if this + routine is called from one which in turn responded to a button + press. If it is not present or not equal to 0, then FT_MDBLCLK() + will wait for two presses of the specified button. + + is the mouse button number + 0 - Left Button + 1 - Right Button + 2 - Middle Button [if applicable] + + is the interval to wait for the first click if requested + and the time to wait for the second. If not present then defaults + to 0.5 second. + + is the row number for the mouse cursor location for a double click + to be valid. If not present then the current position is taken as + the valid location. + + is the column number for the mouse cursor location for a double + click to be valid. If not present, then the current position is + taken as the valid location. + + is an optional start time for the waiting period for the first + click (of either one or two requested). If not given then the + time is set at entry into this routine. This is useful when this + routine is called from another routine which was called in + response to a mouse click but needs to know if a double click + has occurred + $RETURNS$ + .T. if a double click was detected. + $DESCRIPTION$ + This is a mouse meta function that checks for the presence + of a double click. + $EXAMPLES$ + IF FT_MISREGION( 10, 10, 11, 20 ) .AND.; + FT_MDBLCLK( 0, 1,, FT_MGETX(), FT_MGETY() ) // double click, right button + // at current location with + // default interval + + MnuItem1() + ENDIF + $SEEALSO$ + FT_MBUTPRS() FT_MBUTREL() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MCONOFF() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Turn mouse cursur off if in specified region - * $SYNTAX$ - * FT_MCONOFF( , , , ) - * $ARGUMENTS$ - * , are the four corners of the - * screen region in row and column coordinates. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * This function tells the mouse driver to hide the cursor if it is in - * the given region. The driver hides the cursor by decrementing the cursor - * flag. A call to FT_MSHOWCRS is required to turn the cursor back on. - * Calling FT_MSHOWCRS also disables this function. - * - * See FT_MSHOWCRS for a discussion of the cursor display flag. - * $EXAMPLES$ - * FT_MCONOFF( 10, 10, 11, 20 ) - * $SEEALSO$ - * FT_MSHOWCRS() FT_MHIDECRS() FT_MXLIMIT() FT_MYLIMIT() FT_MINREGION() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MCONOFF() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Turn mouse cursur off if in specified region + $SYNTAX$ + FT_MCONOFF( , , , ) + $ARGUMENTS$ + , are the four corners of the + screen region in row and column coordinates. + $RETURNS$ + NIL + $DESCRIPTION$ + This function tells the mouse driver to hide the cursor if it is in + the given region. The driver hides the cursor by decrementing the cursor + flag. A call to FT_MSHOWCRS is required to turn the cursor back on. + Calling FT_MSHOWCRS also disables this function. + + See FT_MSHOWCRS for a discussion of the cursor display flag. + $EXAMPLES$ + FT_MCONOFF( 10, 10, 11, 20 ) + $SEEALSO$ + FT_MSHOWCRS() FT_MHIDECRS() FT_MXLIMIT() FT_MYLIMIT() FT_MINREGION() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MINREGION() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Test if the mouse cursor is in the passed region - * $SYNTAX$ - * FT_MINREGION( , , , ) -> lInRegion - * $ARGUMENTS$ - * , are the four corners of the screen region. - * $RETURNS$ - * .T. if mouse is in specified region. - * $DESCRIPTION$ - * This function will check to see if the mouse cursor is - * within the confines of the specified region. - * $EXAMPLES$ - * IF FT_MINREGION( 10, 10, 11, 20 ) - * nChoice := 1 - * ENDIF - * $SEEALSO$ - * FT_MXLIMIT() FT_MYLIMIT() FT_MINREGION() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MINREGION() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Test if the mouse cursor is in the passed region + $SYNTAX$ + FT_MINREGION( , , , ) -> lInRegion + $ARGUMENTS$ + , are the four corners of the screen region. + $RETURNS$ + .T. if mouse is in specified region. + $DESCRIPTION$ + This function will check to see if the mouse cursor is + within the confines of the specified region. + $EXAMPLES$ + IF FT_MINREGION( 10, 10, 11, 20 ) + nChoice := 1 + ENDIF + $SEEALSO$ + FT_MXLIMIT() FT_MYLIMIT() FT_MINREGION() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MSETSENS() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Set the mouse sensitivity parameters - * $SYNTAX$ - * FT_MSETSENS( , , ) -> NIL - * $ARGUMENTS$ - * is the sensitivity of the mouse on the horizontal axis. This - * value is the integer percentage of highest sensitivity and - * thus has a range of 1 to 100. The default value is 50 and at - * this setting about 3.2 inches of mouse movement will move - * the mouse cursor across the screen. If NIL, the current - * value is used. - * is the relative sensitivity of the mouse on the vertical axis. - * The value is an integer percentage of the highest sensitivity - * and thus has a range of 1 to 100. The default value is 50 and - * requires about 2 inches of mouse movement will move from top - * to bottom of the screen.If NIL, the current value is used. - * is the relative sensitivity of the mouse to doubling the ratio - * of cursor movement to mouse movement. The default - * value is 50. If NIL, the current value is used. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * This function allows one to control the mouse movement sensitivity. The - * first two arguments control the amount of movement necessary to move - * the cursor a given amount. The values are the percentage of full - * sensitivity and the default values after installing the mouse driver - * is 50 which represents approximately 3.2 inches of horizontal - * and 2 inches of vertical mouse movement to cover the entire screen. - * A value of 100 requires about 0.9 inches of horizontal mouse movement to - * cover the screen from one side to the other. - * - * The third argument changes the threshold above which the mouse moves at - * twice the normal speed. The value is a percentage of full sensitivity - * with the default (50) providing doubling at 64 mickeys per second. - * - * NOTE: These values are NOT restored after resetting the mouse driver/ - * hardware. A well behaved application should reset them to the - * original value upon exiting. - * - * NOTE: The above description is counter to all of the documentation - * I have available. However, it does not work the way it is documented - * with Microsoft drivers versions 6.16, 6.24, 7.04 and 8.20. The above - * movement values are documented to be the number of mickeys per 8 - * pixels and the double speed value as the number mickeys per second - * required to double the speed. Each of these values should range from 1 - * to 32K but the driver forces a maximum of 100. Also the documentation - * states that resetting the mouse will reset these values. This is not - * the case. - * - * - * $EXAMPLES$ - * FT_MSETSENS( 75, 75, 50 ) // a little less mouse movement necessary. - * $SEEALSO$ - * FT_MGETSENS() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MSETSENS() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Set the mouse sensitivity parameters + $SYNTAX$ + FT_MSETSENS( , , ) -> NIL + $ARGUMENTS$ + is the sensitivity of the mouse on the horizontal axis. This + value is the integer percentage of highest sensitivity and + thus has a range of 1 to 100. The default value is 50 and at + this setting about 3.2 inches of mouse movement will move + the mouse cursor across the screen. If NIL, the current + value is used. + is the relative sensitivity of the mouse on the vertical axis. + The value is an integer percentage of the highest sensitivity + and thus has a range of 1 to 100. The default value is 50 and + requires about 2 inches of mouse movement will move from top + to bottom of the screen.If NIL, the current value is used. + is the relative sensitivity of the mouse to doubling the ratio + of cursor movement to mouse movement. The default + value is 50. If NIL, the current value is used. + $RETURNS$ + NIL + $DESCRIPTION$ + This function allows one to control the mouse movement sensitivity. The + first two arguments control the amount of movement necessary to move + the cursor a given amount. The values are the percentage of full + sensitivity and the default values after installing the mouse driver + is 50 which represents approximately 3.2 inches of horizontal + and 2 inches of vertical mouse movement to cover the entire screen. + A value of 100 requires about 0.9 inches of horizontal mouse movement to + cover the screen from one side to the other. + + The third argument changes the threshold above which the mouse moves at + twice the normal speed. The value is a percentage of full sensitivity + with the default (50) providing doubling at 64 mickeys per second. + + NOTE: These values are NOT restored after resetting the mouse driver/ + hardware. A well behaved application should reset them to the + original value upon exiting. + + NOTE: The above description is counter to all of the documentation + I have available. However, it does not work the way it is documented + with Microsoft drivers versions 6.16, 6.24, 7.04 and 8.20. The above + movement values are documented to be the number of mickeys per 8 + pixels and the double speed value as the number mickeys per second + required to double the speed. Each of these values should range from 1 + to 32K but the driver forces a maximum of 100. Also the documentation + states that resetting the mouse will reset these values. This is not + the case. + + + $EXAMPLES$ + FT_MSETSENS( 75, 75, 50 ) // a little less mouse movement necessary. + $SEEALSO$ + FT_MGETSENS() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MGETSENS() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Get the mouse sensitivity parameters - * $SYNTAX$ - * FT_MGETSENS( <@nHoriz>, <@nVert>, <@nDouble> ) -> NIL - * $ARGUMENTS$ - * is the percentage of maximum horizontal sensitivity. PASSED - * BY REFERENCE. - * is the percentage of maximum vertical sensitivity. PASSED BY - * REFERENCE. - * is the percentage of maximum sensitivity for doubling the - * mouse cursor's speed on the screen. PASSED BY REFERENCE. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * This function returns the current values of the mouse movement - * sensitivity parameters. The first two arguments control the amount of - * movement necessary to move the cursor a given amount. The third argument - * determines the threshold above which the mouse moves at twice the normal - * speed. For further discussion of these values see FT_MSETSENS() - * $EXAMPLES$ - * FT_MGETSENS( @nHoriz, @nVert, @nDouble ) - * $SEEALSO$ - * FT_MSETSENS() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MGETSENS() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Get the mouse sensitivity parameters + $SYNTAX$ + FT_MGETSENS( <@nHoriz>, <@nVert>, <@nDouble> ) -> NIL + $ARGUMENTS$ + is the percentage of maximum horizontal sensitivity. PASSED + BY REFERENCE. + is the percentage of maximum vertical sensitivity. PASSED BY + REFERENCE. + is the percentage of maximum sensitivity for doubling the + mouse cursor's speed on the screen. PASSED BY REFERENCE. + $RETURNS$ + NIL + $DESCRIPTION$ + This function returns the current values of the mouse movement + sensitivity parameters. The first two arguments control the amount of + movement necessary to move the cursor a given amount. The third argument + determines the threshold above which the mouse moves at twice the normal + speed. For further discussion of these values see FT_MSETSENS() + $EXAMPLES$ + FT_MGETSENS( @nHoriz, @nVert, @nDouble ) + $SEEALSO$ + FT_MSETSENS() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MVERSION() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Get the mouse driver version - * $SYNTAX$ - * FT_MVERSION( <@nMinor>, <@nType>, <@nIRQ> ) -> - * $ARGUMENTS$ - * is the Minor version number. PASSED BY REFERENCE. - * is the Mouse type. PASSED BY REFERENCE. - * 1 = Bus Mouse - * 2 = Serial Mouse - * 3 = InPort Mouse - * 4 = PS/2 Mouse - * 5 = HP Mouse - * is the IRQ number used for the mouse. PASSED BY REFERENCE. - * 0 = PS/2 - * 2,3,4,5 or 7 = IRQ number - * $RETURNS$ - * which is the major version number of the mouse driver. - * $DESCRIPTION$ - * This function returns the current values of the mouse driver version - * number and type. The major version would be 6 and the minor version - * would be 10 if the driver were version 6.10. The mouse type and IRQ - * numbers are also returned. - * - * NOTE: It appears that the values reported when one starts the mouse - * driver actually have the minor version in hexadecimal! Thus on bootup - * my screen showed 6.24 but this routine returned 30 for the minor version - * number! - * $EXAMPLES$ - * nMajor := FT_MVERSION( @nMinor ) - * IF ( nMajor + nMinor / 100 ) < 7.2 - * ? "Sorry mouse driver version too old" - * RETURN - * ENDIF - * $SEEALSO$ - * FT_MSETSENS() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MVERSION() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Get the mouse driver version + $SYNTAX$ + FT_MVERSION( <@nMinor>, <@nType>, <@nIRQ> ) -> + $ARGUMENTS$ + is the Minor version number. PASSED BY REFERENCE. + is the Mouse type. PASSED BY REFERENCE. + 1 = Bus Mouse + 2 = Serial Mouse + 3 = InPort Mouse + 4 = PS/2 Mouse + 5 = HP Mouse + is the IRQ number used for the mouse. PASSED BY REFERENCE. + 0 = PS/2 + 2,3,4,5 or 7 = IRQ number + $RETURNS$ + which is the major version number of the mouse driver. + $DESCRIPTION$ + This function returns the current values of the mouse driver version + number and type. The major version would be 6 and the minor version + would be 10 if the driver were version 6.10. The mouse type and IRQ + numbers are also returned. + + NOTE: It appears that the values reported when one starts the mouse + driver actually have the minor version in hexadecimal! Thus on bootup + my screen showed 6.24 but this routine returned 30 for the minor version + number! + $EXAMPLES$ + nMajor := FT_MVERSION( @nMinor ) + IF ( nMajor + nMinor / 100 ) < 7.2 + ? "Sorry mouse driver version too old" + RETURN + ENDIF + $SEEALSO$ + FT_MSETSENS() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MSETPAGE() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Set the display page for the mouse pointer - * $SYNTAX$ - * FT_MSETPAGE( <@nPage> ) -> NIL - * $ARGUMENTS$ - * is the desired display page. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * This function sets the display page for the mouse cursor. The valid - * values of nPage is dependent upon the display mode. See FT_SETVPG() - * for changing the current video page - * $EXAMPLES$ - * FT_MSETPAGE( 1 ) // Sets the mouse cursor to page 1 - * $SEEALSO$ - * FT_MGETPAGE() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MSETPAGE() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Set the display page for the mouse pointer + $SYNTAX$ + FT_MSETPAGE( <@nPage> ) -> NIL + $ARGUMENTS$ + is the desired display page. + $RETURNS$ + NIL + $DESCRIPTION$ + This function sets the display page for the mouse cursor. The valid + values of nPage is dependent upon the display mode. See FT_SETVPG() + for changing the current video page + $EXAMPLES$ + FT_MSETPAGE( 1 ) // Sets the mouse cursor to page 1 + $SEEALSO$ + FT_MGETPAGE() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MGETPAGE() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Get the display page for the mouse pointer - * $SYNTAX$ - * FT_MGETPAGE() -> - * $ARGUMENTS$ - * None - * $RETURNS$ - * is the display page on which the mouse is currently being - * displayed - * $DESCRIPTION$ - * This function gets the display page for the mouse cursor. The valid - * values of nPage is dependent upon the display mode. See FT_SETVPG() - * for changing the current video page - * $EXAMPLES$ - * nPage := FT_MGETPAGE( ) // Gets the mouse cursor display page - * $SEEALSO$ - * FT_MSETPAGE() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MGETPAGE() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Get the display page for the mouse pointer + $SYNTAX$ + FT_MGETPAGE() -> + $ARGUMENTS$ + None + $RETURNS$ + is the display page on which the mouse is currently being + displayed + $DESCRIPTION$ + This function gets the display page for the mouse cursor. The valid + values of nPage is dependent upon the display mode. See FT_SETVPG() + for changing the current video page + $EXAMPLES$ + nPage := FT_MGETPAGE( ) // Gets the mouse cursor display page + $SEEALSO$ + FT_MSETPAGE() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MRESET() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Reset mouse driver and return status of mouse - * $SYNTAX$ - * FT_MRESET() -> nMouseStatus - * $ARGUMENTS$ - * NONE - * $RETURNS$ - * An integer representing the mouse status (0 == mouse not installed) - * $DESCRIPTION$ - * Resets the mouse driver and returns mouse status. Use FT_MSHOWCRS() - * to display the mouse cursor. The mouse is set to allow it to cover the - * complete screen (as defined by MAXCOL() and MAXROW()). This is necessary - * because at least some versions of the mouse drivers do not operate - * according to the documentation when confronted with a 43 or 50 line - * screen. - * - * Normally, FT_MINIT() should be used to initialize the mouse since it - * will not reinitialize if already done. - * $EXAMPLES$ - * IF Empty( FT_MRESET() ) - * ? "No mouse driver is installed" - * ENDIF - * $SEEALSO$ - * FT_MINIT() FT_MSHOWCRS() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MRESET() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Reset mouse driver and return status of mouse + $SYNTAX$ + FT_MRESET() -> nMouseStatus + $ARGUMENTS$ + NONE + $RETURNS$ + An integer representing the mouse status (0 == mouse not installed) + $DESCRIPTION$ + Resets the mouse driver and returns mouse status. Use FT_MSHOWCRS() + to display the mouse cursor. The mouse is set to allow it to cover the + complete screen (as defined by MAXCOL() and MAXROW()). This is necessary + because at least some versions of the mouse drivers do not operate + according to the documentation when confronted with a 43 or 50 line + screen. + + Normally, FT_MINIT() should be used to initialize the mouse since it + will not reinitialize if already done. + $EXAMPLES$ + IF Empty( FT_MRESET() ) + ? "No mouse driver is installed" + ENDIF + $SEEALSO$ + FT_MINIT() FT_MSHOWCRS() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MCURSOR() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Set the mouse cursor - * $SYNTAX$ - * FT_MCURSOR( [ ] ) -> lCursorState - * $ARGUMENTS$ - * is a logical indicating whether to set the mouse cursor on. - * .T. - set mouse cursor on - * .F. - set mouse cursor off - * If omitted, no change is made to cursor state - * $RETURNS$ - * A logical indicating the previous mouse cursor state. - * $DESCRIPTION$ - * This function works like most Clipper state functions. If no value - * is sent to FT_MCURSOR() it will return the state of the mouse cursor. - * $EXAMPLES$ - * IF ! FT_MCURSOR() - * FT_MCURSOR( .T. ) - * ENDIF - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MCURSOR() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Set the mouse cursor + $SYNTAX$ + FT_MCURSOR( [ ] ) -> lCursorState + $ARGUMENTS$ + is a logical indicating whether to set the mouse cursor on. + .T. - set mouse cursor on + .F. - set mouse cursor off + If omitted, no change is made to cursor state + $RETURNS$ + A logical indicating the previous mouse cursor state. + $DESCRIPTION$ + This function works like most Clipper state functions. If no value + is sent to FT_MCURSOR() it will return the state of the mouse cursor. + $EXAMPLES$ + IF ! FT_MCURSOR() + FT_MCURSOR( .T. ) + ENDIF + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MSHOWCRS() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Increment internal cursor flag and display mouse cursor - * $SYNTAX$ - * FT_MSHOWCRS() -> NIL - * $ARGUMENTS$ - * NONE - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * Displays the mouse cursor. Make sure to turn the mouse cursor off - * when redrawing screens. The mouse cursor dutifully saves the screen - * under it, so if you draw over the mouse cursor it will create a "hole" - * in your screen when you move the mouse cursor. - * - * Note: A call to FT_MHIDECRS() decrements a mouse driver variable - * which indicates whether the cursor is shown. The cursor is visible - * only when the variable = 0. Thus multiple calls to FT_MHIDECRS() - * require an equal number of calls to FT_MSHOWCRS() before the cursor - * will again be visible. Once the variable is 0 calls to FT_MSHOWCRS() - * does not increment the variable above 0. - * $EXAMPLES$ - * IF Empty( FT_MRESET() ) - * FT_MSHOWCRS() - * ENDIF - * $SEEALSO$ - * FT_MHIDECRS() FT_MCONOFF() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MSHOWCRS() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Increment internal cursor flag and display mouse cursor + $SYNTAX$ + FT_MSHOWCRS() -> NIL + $ARGUMENTS$ + NONE + $RETURNS$ + NIL + $DESCRIPTION$ + Displays the mouse cursor. Make sure to turn the mouse cursor off + when redrawing screens. The mouse cursor dutifully saves the screen + under it, so if you draw over the mouse cursor it will create a "hole" + in your screen when you move the mouse cursor. + + Note: A call to FT_MHIDECRS() decrements a mouse driver variable + which indicates whether the cursor is shown. The cursor is visible + only when the variable = 0. Thus multiple calls to FT_MHIDECRS() + require an equal number of calls to FT_MSHOWCRS() before the cursor + will again be visible. Once the variable is 0 calls to FT_MSHOWCRS() + does not increment the variable above 0. + $EXAMPLES$ + IF Empty( FT_MRESET() ) + FT_MSHOWCRS() + ENDIF + $SEEALSO$ + FT_MHIDECRS() FT_MCONOFF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MHIDECRS() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Decrement internal mouse cursor flag and hide mouse cursor - * $SYNTAX$ - * FT_MHIDECRS() -> NIL - * $ARGUMENTS$ - * NONE - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * Hides the mouse cursor. Make sure to turn the mouse cursor off when - * redrawing screens. The mouse cursor dutifully saves the screen - * under it, so if you draw over the mouse cursor it will create a - * "hole" in your screen when you move the mouse cursor. - * - * Note: A call to FT_MHIDECRS() decrements a mouse driver variable - * which indicates whether the cursor is shown. The cursor is visible - * only when the variable = 0. Thus multiple calls to FT_MHIDECRS() - * require an equal number of calls to FT_MSHOWCRS() before the cursor - * will again be visible. Once the variable is 0 calls to FT_MSHOWCRS() - * does not increment the varaible above 0. - * $EXAMPLES$ - * FT_MHIDECRS() - * @ 10, 10 TO 20, 20 - * FT_MSHOWCRS() - * $SEEALSO$ - * FT_MSHOWCRS() FT_MCONOFF() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MHIDECRS() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Decrement internal mouse cursor flag and hide mouse cursor + $SYNTAX$ + FT_MHIDECRS() -> NIL + $ARGUMENTS$ + NONE + $RETURNS$ + NIL + $DESCRIPTION$ + Hides the mouse cursor. Make sure to turn the mouse cursor off when + redrawing screens. The mouse cursor dutifully saves the screen + under it, so if you draw over the mouse cursor it will create a + "hole" in your screen when you move the mouse cursor. + + Note: A call to FT_MHIDECRS() decrements a mouse driver variable + which indicates whether the cursor is shown. The cursor is visible + only when the variable = 0. Thus multiple calls to FT_MHIDECRS() + require an equal number of calls to FT_MSHOWCRS() before the cursor + will again be visible. Once the variable is 0 calls to FT_MSHOWCRS() + does not increment the varaible above 0. + $EXAMPLES$ + FT_MHIDECRS() + @ 10, 10 TO 20, 20 + FT_MSHOWCRS() + $SEEALSO$ + FT_MSHOWCRS() FT_MCONOFF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MGETPOS() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Get mouse cursor position and button status - * $SYNTAX$ - * FT_MGETPOS( @, @ ) -> nButtonStatus - * $ARGUMENTS$ - * is a variable that will receive the mouse X position in virtual - * screen coordinates. It must be passed by reference. - * - * is a variable that will receive the mouse Y position in virtual - * screen coordinates. It must be passed by reference. - * $RETURNS$ - * an integer representing button status - * - * - 0 for no button pressed - * - 1 for left pressed - * - 2 for right pressed - * - 3 for left and right pressed - * - 4 for middle pressed - * - 5 for left and middle pressed - * - 6 for right and middle pressed - * - 7 for all three buttons pressed - * $DESCRIPTION$ - * Loads cursor position into x and y coordinates passed by reference and - * returns the button status. The coordinate system in text mode has - * eight virtual coordinates per character cell. Thus x=16 means that you - * are in the Row 2. The values returned by this routine when in text mode - * and with mouse driver versions 6 and above are multiples of 8. We have - * experience with drivers prior to that version - * $EXAMPLES$ - * LOCAL nX, nY - * LOCAL nButton := FT_MGETPOS( @nX, @nY ) - * ? "Mouse Row :", nX - * ? "Mouse Column :", nY - * ? "Button Status:", nButton - * $SEEALSO$ - * FT_MGETCOORD() FT_MSETPOS() FT_MDEFCRS() FT_MGETX() FT_MGETY() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MGETPOS() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Get mouse cursor position and button status + $SYNTAX$ + FT_MGETPOS( @, @ ) -> nButtonStatus + $ARGUMENTS$ + is a variable that will receive the mouse X position in virtual + screen coordinates. It must be passed by reference. + + is a variable that will receive the mouse Y position in virtual + screen coordinates. It must be passed by reference. + $RETURNS$ + an integer representing button status + + - 0 for no button pressed + - 1 for left pressed + - 2 for right pressed + - 3 for left and right pressed + - 4 for middle pressed + - 5 for left and middle pressed + - 6 for right and middle pressed + - 7 for all three buttons pressed + $DESCRIPTION$ + Loads cursor position into x and y coordinates passed by reference and + returns the button status. The coordinate system in text mode has + eight virtual coordinates per character cell. Thus x=16 means that you + are in the Row 2. The values returned by this routine when in text mode + and with mouse driver versions 6 and above are multiples of 8. We have + experience with drivers prior to that version + $EXAMPLES$ + LOCAL nX, nY + LOCAL nButton := FT_MGETPOS( @nX, @nY ) + ? "Mouse Row :", nX + ? "Mouse Column :", nY + ? "Button Status:", nButton + $SEEALSO$ + FT_MGETCOORD() FT_MSETPOS() FT_MDEFCRS() FT_MGETX() FT_MGETY() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MGETX() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Get mouse cursor row position - * $SYNTAX$ - * FT_MGETX() -> nRowPos - * $ARGUMENTS$ - * NONE - * $RETURNS$ - * which is the row position of mouse in virtual screen - * coordinates. - * $DESCRIPTION$ - * Retrieves mouse's row position in virtual screen coordinates. The - * values returned are multiples of 8 when in text mode and with at least - * Microsoft drivers 6 and above. - * $EXAMPLES$ - * ? FT_MGETX() - * $SEEALSO$ - * FT_MGETCOORD() FT_MDEFCRS() FT_MGETPOS() FT_MGETY() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MGETX() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Get mouse cursor row position + $SYNTAX$ + FT_MGETX() -> nRowPos + $ARGUMENTS$ + NONE + $RETURNS$ + which is the row position of mouse in virtual screen + coordinates. + $DESCRIPTION$ + Retrieves mouse's row position in virtual screen coordinates. The + values returned are multiples of 8 when in text mode and with at least + Microsoft drivers 6 and above. + $EXAMPLES$ + ? FT_MGETX() + $SEEALSO$ + FT_MGETCOORD() FT_MDEFCRS() FT_MGETPOS() FT_MGETY() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MGETY() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Get mouse cursor column position - * $SYNTAX$ - * FT_MGETY() -> nColPos - * $ARGUMENTS$ - * NONE - * $RETURNS$ - * Column position of mouse in virtual screen coordinates - * $DESCRIPTION$ - * Retrieves mouse's column position in virtual screen coordinates. The - * values returned are multiples of 8 when in text mode and with at least - * Microsoft drivers 6 and above. - * $EXAMPLES$ - * ? FT_MGETY() - * $SEEALSO$ - * FT_MGETCOORD() FT_MDEFCRS() FT_MGETPOS() FT_MGETX() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MGETY() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Get mouse cursor column position + $SYNTAX$ + FT_MGETY() -> nColPos + $ARGUMENTS$ + NONE + $RETURNS$ + Column position of mouse in virtual screen coordinates + $DESCRIPTION$ + Retrieves mouse's column position in virtual screen coordinates. The + values returned are multiples of 8 when in text mode and with at least + Microsoft drivers 6 and above. + $EXAMPLES$ + ? FT_MGETY() + $SEEALSO$ + FT_MGETCOORD() FT_MDEFCRS() FT_MGETPOS() FT_MGETX() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MSETPOS() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Position the mouse cursor using virtual screen coordinates - * $SYNTAX$ - * FT_MSETPOS( , ) -> NIL - * $ARGUMENTS$ - * is the desired mouse row. - * - * is the desired mouse column. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * Positions mouse cursor on screen. The virtual coordinate system in text - * mode has eight virtual coordinates per character cell. Thus x=16 means - * that you are in the Row 2. - * $EXAMPLES$ - * FT_MSETPOS( 10, 20 ) // position mouse cursor at row 10, col 20 - * // in virtual screen coordinates - * $SEEALSO$ - * FT_MGETPOS() FT_MGETCOORD() FT_MSETCOORD() FT_MGETX() FT_MGETY() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MSETPOS() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Position the mouse cursor using virtual screen coordinates + $SYNTAX$ + FT_MSETPOS( , ) -> NIL + $ARGUMENTS$ + is the desired mouse row. + + is the desired mouse column. + $RETURNS$ + NIL + $DESCRIPTION$ + Positions mouse cursor on screen. The virtual coordinate system in text + mode has eight virtual coordinates per character cell. Thus x=16 means + that you are in the Row 2. + $EXAMPLES$ + FT_MSETPOS( 10, 20 ) // position mouse cursor at row 10, col 20 + // in virtual screen coordinates + $SEEALSO$ + FT_MGETPOS() FT_MGETCOORD() FT_MSETCOORD() FT_MGETX() FT_MGETY() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MSETCOORD() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Position the mouse cursor using text screen coordinates - * $SYNTAX$ - * FT_MSETPOS( , ) -> NIL - * $ARGUMENTS$ - * is the desired mouse row. - * - * is the desired mouse column. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * Positions mouse cursor on screen using text (normal row and column) - * coordinates. - * $EXAMPLES$ - * FT_MSETCOORD( 10, 20 ) // position mouse cursor at row 10, col 20 - * // in text screen coordinates - * $SEEALSO$ - * FT_MGETPOS() FT_MGETCOORD() FT_MSETPOS() FT_MDEFCRS() FT_MGETX() FT_MGETY() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MSETCOORD() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Position the mouse cursor using text screen coordinates + $SYNTAX$ + FT_MSETPOS( , ) -> NIL + $ARGUMENTS$ + is the desired mouse row. + + is the desired mouse column. + $RETURNS$ + NIL + $DESCRIPTION$ + Positions mouse cursor on screen using text (normal row and column) + coordinates. + $EXAMPLES$ + FT_MSETCOORD( 10, 20 ) // position mouse cursor at row 10, col 20 + // in text screen coordinates + $SEEALSO$ + FT_MGETPOS() FT_MGETCOORD() FT_MSETPOS() FT_MDEFCRS() FT_MGETX() FT_MGETY() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MXLIMIT() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Set vertical bounds of mouse using virtual screen coord. - * $SYNTAX$ - * FT_MXLIMIT( , ) -> NIL - * $ARGUMENTS$ - * is the top row limit. - * - * is the bottom row limit. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * Set maximum vertical bounds of mouse using virtual screen coordinates. - * $EXAMPLES$ - * FT_MXLIMIT( 10, 20 ) - * $SEEALSO$ - * FT_MYLIMIT() FT_MINREGION() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MXLIMIT() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Set vertical bounds of mouse using virtual screen coord. + $SYNTAX$ + FT_MXLIMIT( , ) -> NIL + $ARGUMENTS$ + is the top row limit. + + is the bottom row limit. + $RETURNS$ + NIL + $DESCRIPTION$ + Set maximum vertical bounds of mouse using virtual screen coordinates. + $EXAMPLES$ + FT_MXLIMIT( 10, 20 ) + $SEEALSO$ + FT_MYLIMIT() FT_MINREGION() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MYLIMIT() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Set horiz. bounds of mouse using virtual screen coordinates - * $SYNTAX$ - * FT_MYLIMIT( , ) -> NIL - * $ARGUMENTS$ - * is the left column limit. - * - * is the right column limit. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * Set maximum horizontal bounds of mouse using virtual screen coordinates. - * $EXAMPLES$ - * FT_MYLIMIT( 10, 20 ) - * $SEEALSO$ - * FT_MXLIMIT() FT_MINREGION() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MYLIMIT() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Set horiz. bounds of mouse using virtual screen coordinates + $SYNTAX$ + FT_MYLIMIT( , ) -> NIL + $ARGUMENTS$ + is the left column limit. + + is the right column limit. + $RETURNS$ + NIL + $DESCRIPTION$ + Set maximum horizontal bounds of mouse using virtual screen coordinates. + $EXAMPLES$ + FT_MYLIMIT( 10, 20 ) + $SEEALSO$ + FT_MXLIMIT() FT_MINREGION() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MBUTPRS() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Retrieve button press status - * $SYNTAX$ - * FT_MBUTPRS( [, @nButPrs [, @nX [, @nY] ] ] ) -> nButStatus - * $ARGUMENTS$ - * is the mouse button number: - * - * 0 - Left Button - * 1 - Right Button - * 2 - Middle Button [if applicable] - * - * is the number of times the specified button was pressed - * since the last call to this routine. PASSED BY REFERENCE. - * is the X position of the cursor when the last press occurred. - * PASSED BY REFERENCE. - * is the Y position of the cursor when the last press occurred. - * PASSED BY REFERENCE. - * - * $RETURNS$ - * An integer representing the button status: - * - * 0 - no buttons pressed - * 1 - left button pressed - * 2 - right button pressed - * 3 - left and right pressed - * 4 - middle pressed - * 5 - left and middle pressed - * 6 - middle and right buttons pressed - * 7 - all 3 buttons pressed - * $DESCRIPTION$ - * Retrieves the mouse button status and the position of the cursor when - * a button was last pressed. - * $EXAMPLES$ - * IF Empty( FT_MBUTPRS( 1 ) ) - * ? "No Item selected" - * ENDIF - * $SEEALSO$ - * FT_MBUTREL() FT_MDBLCLK() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MBUTPRS() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Retrieve button press status + $SYNTAX$ + FT_MBUTPRS( [, @nButPrs [, @nX [, @nY] ] ] ) -> nButStatus + $ARGUMENTS$ + is the mouse button number: + + 0 - Left Button + 1 - Right Button + 2 - Middle Button [if applicable] + + is the number of times the specified button was pressed + since the last call to this routine. PASSED BY REFERENCE. + is the X position of the cursor when the last press occurred. + PASSED BY REFERENCE. + is the Y position of the cursor when the last press occurred. + PASSED BY REFERENCE. + + $RETURNS$ + An integer representing the button status: + + 0 - no buttons pressed + 1 - left button pressed + 2 - right button pressed + 3 - left and right pressed + 4 - middle pressed + 5 - left and middle pressed + 6 - middle and right buttons pressed + 7 - all 3 buttons pressed + $DESCRIPTION$ + Retrieves the mouse button status and the position of the cursor when + a button was last pressed. + $EXAMPLES$ + IF Empty( FT_MBUTPRS( 1 ) ) + ? "No Item selected" + ENDIF + $SEEALSO$ + FT_MBUTREL() FT_MDBLCLK() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MBUTREL() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Get mouse button release information - * $SYNTAX$ - * FT_MBUTREL( nButton [, @nButRel [, @nX [, @nY] ] ]) -> nBStat - * $ARGUMENTS$ - * is the mouse button number - * 0 - Left Button - * 1 - Right Button - * 2 - Middle Button [if applicable] - * - * is the number of times the specified button was released - * since the last call to this routine. PASSED BY REFERENCE. - * - * is the X position of the cursor when the last release occurred. - * PASSED BY REFERENCE. - * - * is the Y position of the cursor when the last release occurred. - * PASSED BY REFERENCE. - * $RETURNS$ - * - an integer representing button release status - * 0 - None - * 1 - Left - * 2 - Right - * 3 - Middle - * $DESCRIPTION$ - * This function returns the release status of the mouse buttons and the - * coordinates of the last release. - * $EXAMPLES$ - * IF FT_MBUTREL( 0 ) == 1 - * ? "Left button released" - * ENDIF - * $SEEALSO$ - * FT_MBUTPRS() FT_MDBLCLK() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MBUTREL() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Get mouse button release information + $SYNTAX$ + FT_MBUTREL( nButton [, @nButRel [, @nX [, @nY] ] ]) -> nBStat + $ARGUMENTS$ + is the mouse button number + 0 - Left Button + 1 - Right Button + 2 - Middle Button [if applicable] + + is the number of times the specified button was released + since the last call to this routine. PASSED BY REFERENCE. + + is the X position of the cursor when the last release occurred. + PASSED BY REFERENCE. + + is the Y position of the cursor when the last release occurred. + PASSED BY REFERENCE. + $RETURNS$ + - an integer representing button release status + 0 - None + 1 - Left + 2 - Right + 3 - Middle + $DESCRIPTION$ + This function returns the release status of the mouse buttons and the + coordinates of the last release. + $EXAMPLES$ + IF FT_MBUTREL( 0 ) == 1 + ? "Left button released" + ENDIF + $SEEALSO$ + FT_MBUTPRS() FT_MDBLCLK() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MDEFCRS() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Define the mouse cursor - * $SYNTAX$ - * FT_MDEFCRS( , , ) -> NIL - * $ARGUMENTS$ - * is the cursor type. A value of 0 indicates the software cursor - * (the default) and a value of 1 indicates the hardware cursor. - * - * is the screen mask for the software cursor or the first scan - * line of the hardware cursor. See the description for more - * information. - * - * is the cursor mask for the software cursor of the last scan - * line of the hardware cursor. See the description for more - * information. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * In text mode the mouse cursor can either be a software generated or - * the actual hardware cursor. This routine allows one choose between them. - * The software cursor is the default and its effect on the character it - * covers is determined by the screen mask and the cursor mask. Both of - * these masks are 16 bit values (which in Clipper are passed as standard - * numerical values). The 16 bit masks are arranged in a manner identical - * to the way information is stored for each character cell on the screen. - * The low order 8 bits represent the actual character displayed while the - * high order bits represent the display atributes such as blinking, - * intensity and forground and background colors. The mask is represented in - * the diagram below: - * - * Bit: │15 │14 12│11 │10 8│7 0│ - * Function:│blink │background│intensity│foreground│character│ - * - * Blinking and high intensity are on when the bit is 1. The background and - * foreground indicate which colors are used for each. The software mouse - * cursor uses these two values by taking the mask from the screen cell it - * is on and performing a logical AND on each bit with the screen mask - * value. The result is then logically XOR'ed with the cursor mask value. - * Thus to keep the character the same but invert the foreground and - * background colors the following values would be used: - * - * Bit: │15 │14 12│11 │10 8│7 0│ - * Function:│blink │background│intensity│foreground│character│ - * screen: │ 0 │ 111 │ 0 │ 111 │11111111 │ =30719 - * cursor: │ 0 │ 111 │ 0 │ 111 │00000000 │ =30464 - * - * The hardware cursor is the text cursor provided by the video board. One - * specifies the range of scan lines which are on using and - * . The range of values is dependant upon the type of monitor. - * The first scan line is 0. - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MDEFCRS() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Define the mouse cursor + $SYNTAX$ + FT_MDEFCRS( , , ) -> NIL + $ARGUMENTS$ + is the cursor type. A value of 0 indicates the software cursor + (the default) and a value of 1 indicates the hardware cursor. + + is the screen mask for the software cursor or the first scan + line of the hardware cursor. See the description for more + information. + + is the cursor mask for the software cursor of the last scan + line of the hardware cursor. See the description for more + information. + $RETURNS$ + NIL + $DESCRIPTION$ + In text mode the mouse cursor can either be a software generated or + the actual hardware cursor. This routine allows one choose between them. + The software cursor is the default and its effect on the character it + covers is determined by the screen mask and the cursor mask. Both of + these masks are 16 bit values (which in Clipper are passed as standard + numerical values). The 16 bit masks are arranged in a manner identical + to the way information is stored for each character cell on the screen. + The low order 8 bits represent the actual character displayed while the + high order bits represent the display atributes such as blinking, + intensity and forground and background colors. The mask is represented in + the diagram below: + + Bit: │15 │14 12│11 │10 8│7 0│ + Function:│blink │background│intensity│foreground│character│ + + Blinking and high intensity are on when the bit is 1. The background and + foreground indicate which colors are used for each. The software mouse + cursor uses these two values by taking the mask from the screen cell it + is on and performing a logical AND on each bit with the screen mask + value. The result is then logically XOR'ed with the cursor mask value. + Thus to keep the character the same but invert the foreground and + background colors the following values would be used: + + Bit: │15 │14 12│11 │10 8│7 0│ + Function:│blink │background│intensity│foreground│character│ + screen: │ 0 │ 111 │ 0 │ 111 │11111111 │ =30719 + cursor: │ 0 │ 111 │ 0 │ 111 │00000000 │ =30464 + + The hardware cursor is the text cursor provided by the video board. One + specifies the range of scan lines which are on using and + . The range of values is dependant upon the type of monitor. + The first scan line is 0. + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MGETCOORD() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Get mouse cursor position (text coord.) and button status - * $SYNTAX$ - * FT_MGETPOS( @, @ ) -> nButtonStatus - * $ARGUMENTS$ - * is a variable that will receive the mouse X position in text - * screen coordinates. It must be passed by reference. - * - * is a variable that will receive the mouse Y position in text - * screen coordinates. It must be passed by reference. - * $RETURNS$ - * an integer representing button status - * - * - 0 for no button pressed - * - 1 for left pressed - * - 2 for right pressed - * - 3 for left and right pressed - * - 4 for middle pressed - * - 5 for left and middle pressed - * - 6 for right and middle pressed - * - 7 for all three buttons pressed - * $DESCRIPTION$ - * Loads cursor position into x and y coordinates passed by reference and - * returns the button status. - * $EXAMPLES$ - * LOCAL nX, nY - * LOCAL nButton := FT_MGETCOORD( @nX, @nY ) - * ? "Mouse Row :", nX - * ? "Mouse Column :", nY - * ? "Button Status:", nButton - * $SEEALSO$ - * FT_MGETPOS() FT_MSETPOS() FT_MDEFCRS() FT_MGETX() FT_MGETY() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MGETCOORD() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Get mouse cursor position (text coord.) and button status + $SYNTAX$ + FT_MGETPOS( @, @ ) -> nButtonStatus + $ARGUMENTS$ + is a variable that will receive the mouse X position in text + screen coordinates. It must be passed by reference. + + is a variable that will receive the mouse Y position in text + screen coordinates. It must be passed by reference. + $RETURNS$ + an integer representing button status + + - 0 for no button pressed + - 1 for left pressed + - 2 for right pressed + - 3 for left and right pressed + - 4 for middle pressed + - 5 for left and middle pressed + - 6 for right and middle pressed + - 7 for all three buttons pressed + $DESCRIPTION$ + Loads cursor position into x and y coordinates passed by reference and + returns the button status. + $EXAMPLES$ + LOCAL nX, nY + LOCAL nButton := FT_MGETCOORD( @nX, @nY ) + ? "Mouse Row :", nX + ? "Mouse Column :", nY + ? "Button Status:", nButton + $SEEALSO$ + FT_MGETPOS() FT_MSETPOS() FT_MDEFCRS() FT_MGETX() FT_MGETY() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/n2color.txt b/harbour/contrib/hbnf/doc/en/n2color.txt index 62c53d4a0d..fb9c103126 100644 --- a/harbour/contrib/hbnf/doc/en/n2color.txt +++ b/harbour/contrib/hbnf/doc/en/n2color.txt @@ -2,26 +2,26 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_N2COLOR() - * $CATEGORY$ - * String - * $ONELINER$ - * Returns the string complement of a Clipper color number - * $SYNTAX$ - * FT_COLOR2N( ) -> cColor - * $ARGUMENTS$ - * a number representing a Clipper color - * $RETURNS$ - * The string complement of a number representing a Clipper or a - * null string if the parameter is invalid - * $DESCRIPTION$ - * This function is useful for converting a number to a Clipper color - * string. - * $EXAMPLES$ - * cColor := FT_COLOR2N( 239 ) // returns "*+w/gr" - * $SEEALSO$ - * FT_N2COLOR() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_N2COLOR() + $CATEGORY$ + String + $ONELINER$ + Returns the string complement of a Clipper color number + $SYNTAX$ + FT_COLOR2N( ) -> cColor + $ARGUMENTS$ + a number representing a Clipper color + $RETURNS$ + The string complement of a number representing a Clipper or a + null string if the parameter is invalid + $DESCRIPTION$ + This function is useful for converting a number to a Clipper color + string. + $EXAMPLES$ + cColor := FT_COLOR2N( 239 ) // returns "*+w/gr" + $SEEALSO$ + FT_N2COLOR() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/netpv.txt b/harbour/contrib/hbnf/doc/en/netpv.txt index a2b7b94e3e..0cbaf3d596 100644 --- a/harbour/contrib/hbnf/doc/en/netpv.txt +++ b/harbour/contrib/hbnf/doc/en/netpv.txt @@ -2,45 +2,45 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_NETPV() - * $CATEGORY$ - * Math - * $ONELINER$ - * Calculate net present value - * $SYNTAX$ - * FT_NETPV( , , ; - * [, ] ) -> nNetPV - * $ARGUMENTS$ - * is the amount of cash invested for purposes - * of generating the cash flows. - * - * is the annual interest rate used to discount - * expected cash flows (10.5% = 10.5, not .105). - * - * is an array of the expected cash receipts each year. - * - * is the number of years cash flows are expected - * (optional, Len( aCashFlow ) ). - * $RETURNS$ - * The difference between the initial investment and the discounted - * cash flow in dollars. - * $DESCRIPTION$ - * This function calculates the net present value, the difference - * between the cost of an initial investment and the present value - * of the expected cash flow(s) from the investment. The present - * value of the expected cashflow(s) is calculated at the specified - * interest rate, which is often referred to as the "cost of capital". - * - * This function can be used to evaluate alternative investments. - * The larger the NPV, the more profitable the investment. See - * also the FutureValue and PresentValue for further explanations. - * The formula to calculate the net present value is: - * - * NetPresentValue := SUM( CashFlow[ i ] / ( ( 1 + InterestRate ) ** i ) ) - * FOR i := 1 TO NoOfCashFlows - * $EXAMPLES$ - * nNetPresentValue := FT_NETPV( 10000, 10, { 10000, 15000, 16000, 17000 } ) - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_NETPV() + $CATEGORY$ + Math + $ONELINER$ + Calculate net present value + $SYNTAX$ + FT_NETPV( , , ; + [, ] ) -> nNetPV + $ARGUMENTS$ + is the amount of cash invested for purposes + of generating the cash flows. + + is the annual interest rate used to discount + expected cash flows (10.5% = 10.5, not .105). + + is an array of the expected cash receipts each year. + + is the number of years cash flows are expected + (optional, Len( aCashFlow ) ). + $RETURNS$ + The difference between the initial investment and the discounted + cash flow in dollars. + $DESCRIPTION$ + This function calculates the net present value, the difference + between the cost of an initial investment and the present value + of the expected cash flow(s) from the investment. The present + value of the expected cashflow(s) is calculated at the specified + interest rate, which is often referred to as the "cost of capital". + + This function can be used to evaluate alternative investments. + The larger the NPV, the more profitable the investment. See + also the FutureValue and PresentValue for further explanations. + The formula to calculate the net present value is: + + NetPresentValue := SUM( CashFlow[ i ] / ( ( 1 + InterestRate ) ** i ) ) + FOR i := 1 TO NoOfCashFlows + $EXAMPLES$ + nNetPresentValue := FT_NETPV( 10000, 10, { 10000, 15000, 16000, 17000 } ) + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/nooccur.txt b/harbour/contrib/hbnf/doc/en/nooccur.txt index 0d8aad6c4c..d6d2d61b46 100644 --- a/harbour/contrib/hbnf/doc/en/nooccur.txt +++ b/harbour/contrib/hbnf/doc/en/nooccur.txt @@ -2,37 +2,37 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_NOOCCUR() - * $CATEGORY$ - * String - * $ONELINER$ - * Find the number of times one string occurs in another - * $SYNTAX$ - * FT_NOOCCUR( , ; - * [, ] ) -> - * $ARGUMENTS$ - * is the string to search for - * - * is the string to search - * - * is a boolean variable to force case sensitivity - * (optional, defaults to .F.). - * $RETURNS$ - * The number of times appears in - * $DESCRIPTION$ - * This function finds the number of times a string occurs in a - * second string. - * $EXAMPLES$ - * // Find the number of times "the" appears in cMemoString, case - * // insensitive - * - * nNoOfOccurrences := FT_NOOCCUR( "the", cMemoString ) - * - * // Find the number of times "the" appears in cMemoString, case - * // sensitive - * - * nNoOfOccurrences := FT_NOOCCUR( "the", cMemoString, .T. ) - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_NOOCCUR() + $CATEGORY$ + String + $ONELINER$ + Find the number of times one string occurs in another + $SYNTAX$ + FT_NOOCCUR( , ; + [, ] ) -> + $ARGUMENTS$ + is the string to search for + + is the string to search + + is a boolean variable to force case sensitivity + (optional, defaults to .F.). + $RETURNS$ + The number of times appears in + $DESCRIPTION$ + This function finds the number of times a string occurs in a + second string. + $EXAMPLES$ + // Find the number of times "the" appears in cMemoString, case + // insensitive + + nNoOfOccurrences := FT_NOOCCUR( "the", cMemoString ) + + // Find the number of times "the" appears in cMemoString, case + // sensitive + + nNoOfOccurrences := FT_NOOCCUR( "the", cMemoString, .T. ) + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/ntow.txt b/harbour/contrib/hbnf/doc/en/ntow.txt index c079328d9e..9cdb2520d4 100644 --- a/harbour/contrib/hbnf/doc/en/ntow.txt +++ b/harbour/contrib/hbnf/doc/en/ntow.txt @@ -2,48 +2,48 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_NTOW() - * $CATEGORY$ - * Conversion - * $ONELINER$ - * Translate numeric value to words - * $SYNTAX$ - * FT_NTOW( ) -> cWords - * $ARGUMENTS$ - * An integer to translate - * $RETURNS$ - * A text string representing - * $DESCRIPTION$ - * Translates numeric input to a text string. - * - * FT_NTOW is intended to be used with integers only. Since I don't - * know what your application will be, I can't assume the type of - * fraction you want returned (ninety nine cents, 99/100, .99, etc). - * If you want the fraction in words, just pass it as an integer. - * - * Do not pass a negative number! Handle negative numbers any way - * you need to in your code. (ie: CR, DB, Negative, Minus, etc.) - * - * Also, numeric 0 is returned as a null string. You will need to - * make a decision how to output it (zero dollars, no dollars, etc). - * $EXAMPLES$ - * ? FT_NTOW( 999 ) -> Nine Hundred Ninety Nine - * - * ? FT_NTOW( 1000 ) -> One Thousand - * - * ? FT_NTOW( 23 ) + " Dollars and " + FT_NTOW( 99 ) + " Cents" - * -> Twenty Three Dollars and Ninety Nine Cents - * - * ? FT_NTOW( 23 ) + " Dollars and " + "99/100" - * -> Twenty Three Dollars and 99/100 - * - * x := -23.99 - * cents := Str( ( x - Int( x ) ) * 100, 2, 0 ) + "/100" - * x := Int( x ) - * string := iif( x < 0, "Credit of ", "Debit of " ) - * ? string + FT_NTOW( Abs( x ) ) + " Dollars and " + "99/100" - * -> Credit of Twenty Three Dollars and 99/100 - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_NTOW() + $CATEGORY$ + Conversion + $ONELINER$ + Translate numeric value to words + $SYNTAX$ + FT_NTOW( ) -> cWords + $ARGUMENTS$ + An integer to translate + $RETURNS$ + A text string representing + $DESCRIPTION$ + Translates numeric input to a text string. + + FT_NTOW is intended to be used with integers only. Since I don't + know what your application will be, I can't assume the type of + fraction you want returned (ninety nine cents, 99/100, .99, etc). + If you want the fraction in words, just pass it as an integer. + + Do not pass a negative number! Handle negative numbers any way + you need to in your code. (ie: CR, DB, Negative, Minus, etc.) + + Also, numeric 0 is returned as a null string. You will need to + make a decision how to output it (zero dollars, no dollars, etc). + $EXAMPLES$ + ? FT_NTOW( 999 ) -> Nine Hundred Ninety Nine + + ? FT_NTOW( 1000 ) -> One Thousand + + ? FT_NTOW( 23 ) + " Dollars and " + FT_NTOW( 99 ) + " Cents" + -> Twenty Three Dollars and Ninety Nine Cents + + ? FT_NTOW( 23 ) + " Dollars and " + "99/100" + -> Twenty Three Dollars and 99/100 + + x := -23.99 + cents := Str( ( x - Int( x ) ) * 100, 2, 0 ) + "/100" + x := Int( x ) + string := iif( x < 0, "Credit of ", "Debit of " ) + ? string + FT_NTOW( Abs( x ) ) + " Dollars and " + "99/100" + -> Credit of Twenty Three Dollars and 99/100 + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/numlock.txt b/harbour/contrib/hbnf/doc/en/numlock.txt index a96c3ccc57..08ba23e49b 100644 --- a/harbour/contrib/hbnf/doc/en/numlock.txt +++ b/harbour/contrib/hbnf/doc/en/numlock.txt @@ -2,44 +2,44 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_NUMLOCK() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Return status of NumLock key - * $SYNTAX$ - * FT_NUMLOCK( [ ] ) -> lCurrentSetting - * $ARGUMENTS$ - * is optional and if supplied is the new setting - * for the CapLock key. Specify .T. to turn CapLock on, or .F. to - * turn it off. - * $RETURNS$ - * lValue is .T. if NumLock is set, .F. if it isn't set. The value - * returned represents the setting in effect prior to any changes that - * might by made by . - * $DESCRIPTION$ - * This function is useful if you need to know or set the status of the - * NumLock key for some reason. - * $EXAMPLES$ - * IF FT_NUMLOCK() - * ? "NumLock is active" - * ENDIF - * - * Another one, slightly strange, courtesy of Glenn Scott: - * - * #include "inkey.ch" - * - * FUNCTION numBlink() - * LOCAL lOldNum := ft_numlock() - * - * DO WHILE Inkey( 0.5 ) != K_ESC - * ft_numlock( ! ft_numlock() ) - * ENDDO - * - * RETURN ft_numlock( lOldNum ) - * $SEEALSO$ - * FT_CAPLOCK() FT_CTRL() FT_PRTSCR() FT_SHIFT() FT_ALT() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_NUMLOCK() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Return status of NumLock key + $SYNTAX$ + FT_NUMLOCK( [ ] ) -> lCurrentSetting + $ARGUMENTS$ + is optional and if supplied is the new setting + for the CapLock key. Specify .T. to turn CapLock on, or .F. to + turn it off. + $RETURNS$ + lValue is .T. if NumLock is set, .F. if it isn't set. The value + returned represents the setting in effect prior to any changes that + might by made by . + $DESCRIPTION$ + This function is useful if you need to know or set the status of the + NumLock key for some reason. + $EXAMPLES$ + IF FT_NUMLOCK() + ? "NumLock is active" + ENDIF + + Another one, slightly strange, courtesy of Glenn Scott: + + #include "inkey.ch" + + FUNCTION numBlink() + LOCAL lOldNum := ft_numlock() + + DO WHILE Inkey( 0.5 ) != K_ESC + ft_numlock( ! ft_numlock() ) + ENDDO + + RETURN ft_numlock( lOldNum ) + $SEEALSO$ + FT_CAPLOCK() FT_CTRL() FT_PRTSCR() FT_SHIFT() FT_ALT() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/nwlstat.txt b/harbour/contrib/hbnf/doc/en/nwlstat.txt index adf2687d66..7699dd7a96 100644 --- a/harbour/contrib/hbnf/doc/en/nwlstat.txt +++ b/harbour/contrib/hbnf/doc/en/nwlstat.txt @@ -2,33 +2,33 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_NWLSTAT() - * $CATEGORY$ - * NetWare - * $ONELINER$ - * Return the current Novell NetWare logical station number - * $SYNTAX$ - * FT_NWLSTAT() -> nStatNum - * $ARGUMENTS$ - * None - * $RETURNS$ - * A numeric corresponding to the current logical station number - * assigned by NetWare. - * $DESCRIPTION$ - * In order to find out information about a particular node logged - * in to a NetWare server, you will need the logical - * station number, also known as a "connection number." This - * function will return that number. This will be a number from 1 to 100 - * under NetWare 286, or from 1 to 250 under NetWare 386. This is *not* - * the same as a physical station number. - * - * This function requires FT_INT86(). - * - * This function does NOT test for the existence of the NetWare shell. - * The behavior is undefined if no shell is loaded. - * $EXAMPLES$ - * ? "Logical station: " + Str( FT_NWLSTAT() ) - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_NWLSTAT() + $CATEGORY$ + NetWare + $ONELINER$ + Return the current Novell NetWare logical station number + $SYNTAX$ + FT_NWLSTAT() -> nStatNum + $ARGUMENTS$ + None + $RETURNS$ + A numeric corresponding to the current logical station number + assigned by NetWare. + $DESCRIPTION$ + In order to find out information about a particular node logged + in to a NetWare server, you will need the logical + station number, also known as a "connection number." This + function will return that number. This will be a number from 1 to 100 + under NetWare 286, or from 1 to 250 under NetWare 386. This is *not* + the same as a physical station number. + + This function requires FT_INT86(). + + This function does NOT test for the existence of the NetWare shell. + The behavior is undefined if no shell is loaded. + $EXAMPLES$ + ? "Logical station: " + Str( FT_NWLSTAT() ) + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/nwsem.txt b/harbour/contrib/hbnf/doc/en/nwsem.txt index 566250385a..6822d3925a 100644 --- a/harbour/contrib/hbnf/doc/en/nwsem.txt +++ b/harbour/contrib/hbnf/doc/en/nwsem.txt @@ -2,348 +2,348 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_NWSEMOPEN() - * $CATEGORY$ - * NetWare - * $ONELINER$ - * Open or create a NetWare semaphore - * $SYNTAX$ - * FT_NWSEMOPEN( , , <@nHandle>, <@nOpenCnt> ) -> nRc - * $ARGUMENTS$ - * is the semaphore name, maximum length is 127 characters. - * - * is the initial value for the semaphore. It must start - * as a positive number, to a maximum of 127. - * - * <@nHandle> is the semaphore handle. THIS MUST BE PASSED BY - * REFERENCE! On exit, will contain a numeric value that - * refers to the opened semaphore. You will need it to pass to - * other semaphore functions! PASS IT BY REFERENCE! - * - * <@nOpenCnt> is the number of stations that have opened the - * semaphore. THIS MUST BE PASSED BY REFERENCE! On exit, - * will contain a numeric value. - * $RETURNS$ - * nRc, a numeric result code, as follows: - * - * 0 - success - * 254 - Invalid semaphore name length - * 255 - Invalid semaphore value - * - * will contain the semaphore handle, and - * will contain the number of stations that have opened - * the semaphore. - * $DESCRIPTION$ - * A semaphore is simply a label that indirectly controls network - * activity. There is a semaphore name, which can be up to 127 - * characters, and an associated value, which can range from 0 to - * 127. - * - * A semaphore can be used for many things, but is most often used - * to limit the number of users in an application, and to control - * access to a network resource. - * - * A semaphore essentially allows you to place locks on resources - * other than files. - * - * An application begins the process by calling FT_NWSEMOPEN(). - * If the semaphore doesn't exist, NetWare will create it. - * FT_NWSEMOPEN() returns a handle that is used in other semaphore - * calls. - * - * Applications use FT_NWSEMWAIT() to wait for a semaphore to - * become available. FT_NWSEMWAIT() decrements the semaphore's - * value by 1. If the value > 0, then the application should - * be allowed to access the semaphore's resource. If the value - * goes negative, then the application is placed in a queue. - * How long your app is in the queue is determined by how you - * set the timeout parameter. If you can't get the resource in - * the time you allot, you're let out of the queue and the - * value increments by 1 again. - * - * When an application finishes with a semaphore, it should - * call FT_NWSEMSIG() to increment the value, and then - * FT_NWSEMCLOSE() to close the semaphore. When the semaphore's - * open count goes to 0, NetWare deletes it. - * - * FT_NWSEMEX() can be used to examine the value and open count - * without affecting them. - * - * For an interesting discussion on the operating system aspects - * of semaphores, check "Operating Systems Design and Implementation" - * by A. Tanenbaum, page 60. For more details on NetWare's - * semaphore facilities, refer to Charles Rose's "Programmer's - * Guide to NetWare". The "Programmer's Guide" will make an - * excellent companion guide to the source code for all NetWare - * functions in the Nanforum Toolkit. - * $EXAMPLES$ - * LOCAL nInitVal, nRc, nHandle, nOpenCnt - * - * nInitVal := 2 - * nRc := FT_NWSEMOPEN( "Semaphore Test", nInitVal, ; - * @nHandle, @nOpenCnt ) - * - * IF nRc != 0 - * ? "Error: " + Str( nRc ) - * QUIT - * ENDIF - * $SEEALSO$ - * FT_NWSEMEX() FT_NWSEMWAIT() FT_NWSEMSIG() FT_NWSEMCLOSE() FT_NWSEMLOCK() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_NWSEMOPEN() + $CATEGORY$ + NetWare + $ONELINER$ + Open or create a NetWare semaphore + $SYNTAX$ + FT_NWSEMOPEN( , , <@nHandle>, <@nOpenCnt> ) -> nRc + $ARGUMENTS$ + is the semaphore name, maximum length is 127 characters. + + is the initial value for the semaphore. It must start + as a positive number, to a maximum of 127. + + <@nHandle> is the semaphore handle. THIS MUST BE PASSED BY + REFERENCE! On exit, will contain a numeric value that + refers to the opened semaphore. You will need it to pass to + other semaphore functions! PASS IT BY REFERENCE! + + <@nOpenCnt> is the number of stations that have opened the + semaphore. THIS MUST BE PASSED BY REFERENCE! On exit, + will contain a numeric value. + $RETURNS$ + nRc, a numeric result code, as follows: + + 0 - success + 254 - Invalid semaphore name length + 255 - Invalid semaphore value + + will contain the semaphore handle, and + will contain the number of stations that have opened + the semaphore. + $DESCRIPTION$ + A semaphore is simply a label that indirectly controls network + activity. There is a semaphore name, which can be up to 127 + characters, and an associated value, which can range from 0 to + 127. + + A semaphore can be used for many things, but is most often used + to limit the number of users in an application, and to control + access to a network resource. + + A semaphore essentially allows you to place locks on resources + other than files. + + An application begins the process by calling FT_NWSEMOPEN(). + If the semaphore doesn't exist, NetWare will create it. + FT_NWSEMOPEN() returns a handle that is used in other semaphore + calls. + + Applications use FT_NWSEMWAIT() to wait for a semaphore to + become available. FT_NWSEMWAIT() decrements the semaphore's + value by 1. If the value > 0, then the application should + be allowed to access the semaphore's resource. If the value + goes negative, then the application is placed in a queue. + How long your app is in the queue is determined by how you + set the timeout parameter. If you can't get the resource in + the time you allot, you're let out of the queue and the + value increments by 1 again. + + When an application finishes with a semaphore, it should + call FT_NWSEMSIG() to increment the value, and then + FT_NWSEMCLOSE() to close the semaphore. When the semaphore's + open count goes to 0, NetWare deletes it. + + FT_NWSEMEX() can be used to examine the value and open count + without affecting them. + + For an interesting discussion on the operating system aspects + of semaphores, check "Operating Systems Design and Implementation" + by A. Tanenbaum, page 60. For more details on NetWare's + semaphore facilities, refer to Charles Rose's "Programmer's + Guide to NetWare". The "Programmer's Guide" will make an + excellent companion guide to the source code for all NetWare + functions in the Nanforum Toolkit. + $EXAMPLES$ + LOCAL nInitVal, nRc, nHandle, nOpenCnt + + nInitVal := 2 + nRc := FT_NWSEMOPEN( "Semaphore Test", nInitVal, ; + @nHandle, @nOpenCnt ) + + IF nRc != 0 + ? "Error: " + Str( nRc ) + QUIT + ENDIF + $SEEALSO$ + FT_NWSEMEX() FT_NWSEMWAIT() FT_NWSEMSIG() FT_NWSEMCLOSE() FT_NWSEMLOCK() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_NWSEMEX() - * $CATEGORY$ - * NetWare - * $ONELINER$ - * Examine a NetWare semaphore's value and open count - * $SYNTAX$ - * FT_NWSEMEX( , <@nValue>, <@nOpenCnt> ) -> nRc - * $ARGUMENTS$ - * is the semaphore handle, returned from a previous call - * to FT_NWSEMOPEN(). - * - * <@nValue> will get the current semaphore value. THIS NUMERIC - * ARGUMENT MUST BE PASSED BY REFERENCE! - * - * <@nOpenCnt> will get the current number of workstations - * that have opened the semaphore. THIS NUMERIC ARGUMENT MUST BE - * PASSED BY REFERENCE! - * $RETURNS$ - * nRc, a numeric, as follows: - * - * 0 - success - * 255 - invalid semaphore handle - * - * In addition, nValue will be set to the semaphore's current value, - * and nOpenCnt will be set to the number of stations that have - * opened the semaphore. - * $DESCRIPTION$ - * See the description for FT_NWSEMOPEN(). - * $EXAMPLES$ - * nInitVal := 2 - * nHandle := 0 - * nOpenCnt := 0 - * - * FT_NWSEMOPEN( "Semaphore Test", nInitVal, @nHandle, @nOpenCnt ) - * - * nRc := FT_NWSEMWAIT( nHandle ) - * IF nRc == 254 - * ? "All slots for this resource are currently in use" - * QUIT - * ENDIF - * - * FT_NWSEMEX( nHandle, @nValue, @nOpenCnt ) - * ? "Semaphore test -> Open at [" + ; - * hb_ntos( nOpenCnt ) + ; - * "] stations, value is [" + ; - * hb_ntos( nValue ) + "]" - * $SEEALSO$ - * FT_NWSEMOPEN() FT_NWSEMWAIT() FT_NWSEMSIG() FT_NWSEMCLOSE() FT_NWSEMLOCK() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_NWSEMEX() + $CATEGORY$ + NetWare + $ONELINER$ + Examine a NetWare semaphore's value and open count + $SYNTAX$ + FT_NWSEMEX( , <@nValue>, <@nOpenCnt> ) -> nRc + $ARGUMENTS$ + is the semaphore handle, returned from a previous call + to FT_NWSEMOPEN(). + + <@nValue> will get the current semaphore value. THIS NUMERIC + ARGUMENT MUST BE PASSED BY REFERENCE! + + <@nOpenCnt> will get the current number of workstations + that have opened the semaphore. THIS NUMERIC ARGUMENT MUST BE + PASSED BY REFERENCE! + $RETURNS$ + nRc, a numeric, as follows: + + 0 - success + 255 - invalid semaphore handle + + In addition, nValue will be set to the semaphore's current value, + and nOpenCnt will be set to the number of stations that have + opened the semaphore. + $DESCRIPTION$ + See the description for FT_NWSEMOPEN(). + $EXAMPLES$ + nInitVal := 2 + nHandle := 0 + nOpenCnt := 0 + + FT_NWSEMOPEN( "Semaphore Test", nInitVal, @nHandle, @nOpenCnt ) + + nRc := FT_NWSEMWAIT( nHandle ) + IF nRc == 254 + ? "All slots for this resource are currently in use" + QUIT + ENDIF + + FT_NWSEMEX( nHandle, @nValue, @nOpenCnt ) + ? "Semaphore test -> Open at [" + ; + hb_ntos( nOpenCnt ) + ; + "] stations, value is [" + ; + hb_ntos( nValue ) + "]" + $SEEALSO$ + FT_NWSEMOPEN() FT_NWSEMWAIT() FT_NWSEMSIG() FT_NWSEMCLOSE() FT_NWSEMLOCK() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_NWSEMWAIT() - * $CATEGORY$ - * NetWare - * $ONELINER$ - * Wait on a NetWare semaphore (decrement) - * $SYNTAX$ - * FT_NWSEMWAIT( [, nTimeout ] ) -> nRc - * $ARGUMENTS$ - * is the semaphore handle, returned from a previous call - * to FT_NWSEMOPEN(). - * - * is an optional parameter telling how long you wish to - * wait on this semaphore. This is a numeric indicating the number - * of clock ticks (approx 1/18 sec ) to wait. A zero (the default) - * means "don't wait." - * $RETURNS$ - * nRc, a numeric, as follows: - * - * 0 - success - * 254 - timeout failure - * 255 - invalid semaphore handle - * $DESCRIPTION$ - * See the description for the FT_NWSEMOPEN() function. - * $EXAMPLES$ - * FT_NWSEMOPEN( "Semaphore Test", nInitVal, @nHandle, @nOpenCnt ) - * - * nRc := FT_NWSEMWAIT( nHandle ) - * IF nRc == 254 - * ? "All slots for this resource are currently in use" - * QUIT - * ENDIF - * $SEEALSO$ - * FT_NWSEMOPEN() FT_NWSEMEX() FT_NWSEMSIG() FT_NWSEMCLOSE() FT_NWSEMLOCK() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_NWSEMWAIT() + $CATEGORY$ + NetWare + $ONELINER$ + Wait on a NetWare semaphore (decrement) + $SYNTAX$ + FT_NWSEMWAIT( [, nTimeout ] ) -> nRc + $ARGUMENTS$ + is the semaphore handle, returned from a previous call + to FT_NWSEMOPEN(). + + is an optional parameter telling how long you wish to + wait on this semaphore. This is a numeric indicating the number + of clock ticks (approx 1/18 sec ) to wait. A zero (the default) + means "don't wait." + $RETURNS$ + nRc, a numeric, as follows: + + 0 - success + 254 - timeout failure + 255 - invalid semaphore handle + $DESCRIPTION$ + See the description for the FT_NWSEMOPEN() function. + $EXAMPLES$ + FT_NWSEMOPEN( "Semaphore Test", nInitVal, @nHandle, @nOpenCnt ) + + nRc := FT_NWSEMWAIT( nHandle ) + IF nRc == 254 + ? "All slots for this resource are currently in use" + QUIT + ENDIF + $SEEALSO$ + FT_NWSEMOPEN() FT_NWSEMEX() FT_NWSEMSIG() FT_NWSEMCLOSE() FT_NWSEMLOCK() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_NWSEMSIG() - * $CATEGORY$ - * NetWare - * $ONELINER$ - * Signal a NetWare semaphore (increment) - * $SYNTAX$ - * FT_NWSEMSIG( nHandle ) -> nRc - * $ARGUMENTS$ - * is the semaphore handle, returned from a previous call - * to FT_NWSEMOPEN(). - * $RETURNS$ - * nRc, a numeric, as follows - * - * 0 - success - * 1 - semaphore overflow ( value > 127 ) - * 255 - invalid semaphore handle - * $DESCRIPTION$ - * Use FT_NWSEMSIG() when your app has finished with the resource - * locked by a semaphore. This will increase the value (thus - * making a slot available to another app). - * - * For more information, see the description under FT_NWSEMOPEN(). - * $EXAMPLES$ - * ? "Signal returns: " + Str( FT_NWSEMSIG( nHandle ) ) - * $SEEALSO$ - * FT_NWSEMOPEN() FT_NWSEMEX() FT_NWSEMWAIT() FT_NWSEMCLOSE() FT_NWSEMLOCK() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_NWSEMSIG() + $CATEGORY$ + NetWare + $ONELINER$ + Signal a NetWare semaphore (increment) + $SYNTAX$ + FT_NWSEMSIG( nHandle ) -> nRc + $ARGUMENTS$ + is the semaphore handle, returned from a previous call + to FT_NWSEMOPEN(). + $RETURNS$ + nRc, a numeric, as follows + + 0 - success + 1 - semaphore overflow ( value > 127 ) + 255 - invalid semaphore handle + $DESCRIPTION$ + Use FT_NWSEMSIG() when your app has finished with the resource + locked by a semaphore. This will increase the value (thus + making a slot available to another app). + + For more information, see the description under FT_NWSEMOPEN(). + $EXAMPLES$ + ? "Signal returns: " + Str( FT_NWSEMSIG( nHandle ) ) + $SEEALSO$ + FT_NWSEMOPEN() FT_NWSEMEX() FT_NWSEMWAIT() FT_NWSEMCLOSE() FT_NWSEMLOCK() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_NWSEMCLOSE() - * $CATEGORY$ - * NetWare - * $ONELINER$ - * Close a NetWare semaphore - * $SYNTAX$ - * FT_NWSEMCLOSE( ) -> nRc - * $ARGUMENTS$ - * is the semaphore handle, returned from a previous call - * to FT_NWSEMOPEN(). - * $RETURNS$ - * nRc, a numeric, as follows: - * - * 0 - success - * 255 - invalid semaphore handle - * $DESCRIPTION$ - * Call FT_NWSEMCLOSE() when the app is finished. This decrements - * the open count for the semaphore. If the open count hits zero, - * the semaphore is deleted by NetWare. - * $EXAMPLES$ - * ? "Close returns: " + Str( FT_NWSEMCLOSE( nHandle ) ) - * $SEEALSO$ - * FT_NWSEMOPEN() FT_NWSEMEX() FT_NWSEMWAIT() FT_NWSEMSIG() FT_NWSEMLOCK() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_NWSEMCLOSE() + $CATEGORY$ + NetWare + $ONELINER$ + Close a NetWare semaphore + $SYNTAX$ + FT_NWSEMCLOSE( ) -> nRc + $ARGUMENTS$ + is the semaphore handle, returned from a previous call + to FT_NWSEMOPEN(). + $RETURNS$ + nRc, a numeric, as follows: + + 0 - success + 255 - invalid semaphore handle + $DESCRIPTION$ + Call FT_NWSEMCLOSE() when the app is finished. This decrements + the open count for the semaphore. If the open count hits zero, + the semaphore is deleted by NetWare. + $EXAMPLES$ + ? "Close returns: " + Str( FT_NWSEMCLOSE( nHandle ) ) + $SEEALSO$ + FT_NWSEMOPEN() FT_NWSEMEX() FT_NWSEMWAIT() FT_NWSEMSIG() FT_NWSEMLOCK() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_NWSEMLOCK() - * $CATEGORY$ - * NetWare - * $ONELINER$ - * Perform a semaphore "lock" - * $SYNTAX$ - * FT_NWSEMLOCK ( , <@nHandle> ) -> lRet - * $ARGUMENTS$ - * is the name of a semaphore you want to "lock." - * is the semaphore's handle, if you get the lock. - * THIS MUST BE PASSED BY REFERENCE! - * $RETURNS$ - * lRet == .T. if you get the lock, .T. if you don't. - * If the lock succeeds, will contain the semaphore - * handle. If it fails, the value of is undefined. - * - * $DESCRIPTION$ - * FT_NWSEMLOCK() uses the Nanforum Toolkit's NetWare Semaphore API - * functions in order to provide a general purpose "lock" you can use in - * a NetWare environment. - * - * An interesting byproduct of NetWare's semaphore functions is - * the "open count" which tells you how many connections have this - * semaphore open. This is different from the semaphore's _value_, - * which is set when the semaphore is opened and changed with - * signal() and wait(). - * - * The point of semaphores is that you don't care how many users - * are using the resource; you merely wait on a semaphore until - * the resource becomes available or you give up. When you're done, - * you signal it and off you go. - * - * Back to the open count. FT_NWSEMLOCK() opens the semaphore - * as named in . After it is opened, the open count - * is checked. If it is anything other than 1, that means someone - * else has it (or you failed in your open) so the semaphore is - * closed and the "lock" is refused. If the value is 1, then your - * app is that 1 station so the "lock" is granted. - * - * You can use a semaphore lock to control access to anything - * that Clipper's RLOCK() and FLOCK() can't help you with, such - * as text files written with the low level file i/o functions, - * etc. - * $EXAMPLES$ - * LOCAL nHandle := 0 - * IF FT_NWSEMLOCK( "error.log", @nHandle ) - * // Note, you aren't actually LOCKING this file, you are - * // just locking a semaphore by the same name. As long as - * // all apps that might be using this file are cooperating - * // with the same kind of semaphore lock, you can effectively - * // control access to the file. - * ELSE - * ? "Couldn't lock file." - * ENDIF - * // Processing, then: - * FT_NWSEMUNLOCK( nHandle ) - * - * $SEEALSO$ - * FT_NWSEMOPEN() FT_NWSEMEX() FT_NWSEMWAIT() FT_NWSEMSIG() FT_NWSEMUNLOCK() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_NWSEMLOCK() + $CATEGORY$ + NetWare + $ONELINER$ + Perform a semaphore "lock" + $SYNTAX$ + FT_NWSEMLOCK ( , <@nHandle> ) -> lRet + $ARGUMENTS$ + is the name of a semaphore you want to "lock." + is the semaphore's handle, if you get the lock. + THIS MUST BE PASSED BY REFERENCE! + $RETURNS$ + lRet == .T. if you get the lock, .T. if you don't. + If the lock succeeds, will contain the semaphore + handle. If it fails, the value of is undefined. + + $DESCRIPTION$ + FT_NWSEMLOCK() uses the Nanforum Toolkit's NetWare Semaphore API + functions in order to provide a general purpose "lock" you can use in + a NetWare environment. + + An interesting byproduct of NetWare's semaphore functions is + the "open count" which tells you how many connections have this + semaphore open. This is different from the semaphore's _value_, + which is set when the semaphore is opened and changed with + signal() and wait(). + + The point of semaphores is that you don't care how many users + are using the resource; you merely wait on a semaphore until + the resource becomes available or you give up. When you're done, + you signal it and off you go. + + Back to the open count. FT_NWSEMLOCK() opens the semaphore + as named in . After it is opened, the open count + is checked. If it is anything other than 1, that means someone + else has it (or you failed in your open) so the semaphore is + closed and the "lock" is refused. If the value is 1, then your + app is that 1 station so the "lock" is granted. + + You can use a semaphore lock to control access to anything + that Clipper's RLOCK() and FLOCK() can't help you with, such + as text files written with the low level file i/o functions, + etc. + $EXAMPLES$ + LOCAL nHandle := 0 + IF FT_NWSEMLOCK( "error.log", @nHandle ) + // Note, you aren't actually LOCKING this file, you are + // just locking a semaphore by the same name. As long as + // all apps that might be using this file are cooperating + // with the same kind of semaphore lock, you can effectively + // control access to the file. + ELSE + ? "Couldn't lock file." + ENDIF + // Processing, then: + FT_NWSEMUNLOCK( nHandle ) + + $SEEALSO$ + FT_NWSEMOPEN() FT_NWSEMEX() FT_NWSEMWAIT() FT_NWSEMSIG() FT_NWSEMUNLOCK() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_NWSEMUNLOCK() - * $CATEGORY$ - * NetWare - * $ONELINER$ - * "Unlock" a semaphore locked by FT_NWSEMLOCK() - * $SYNTAX$ - * FT_NWSEMUNLOCK( ) -> lRet - * $ARGUMENTS$ - * is the semaphore handle returned from FT_NWSEMLOCK() - * $RETURNS$ - * lRet == .T. if you successfully unlock the semaphore, .F. if - * you don't. If this call fails, it could be that you're passing - * an invalid semaphore handle. - * $DESCRIPTION$ - * This call unlocks a semaphore prevsiously locked via FT_NWSEMLOCK(). - * It is important that you get a valid semaphore handle from - * FT_NWSEMLOCK() before you use this call. Make sure when you call - * FT_NWSEMLOCK() that you pass a numeric parameter in for the handle - * BY REFERENCE. - * $EXAMPLES$ - * LOCAL nHandle := 0 - * IF FT_NWSEMLOCK( "error.log", @nHandle ) - * // Note, you aren't actually LOCKING this file, you are - * // just locking a semaphore by the same name. As long as - * // all apps that might be using this file are cooperating - * // with the same kind of semaphore lock, you can effectively - * // control access to the file. - * ELSE - * ? "Couldn't lock file." - * ENDIF - * // Processing, then: - * FT_NWSEMUNLOCK( nHandle ) - * - * $SEEALSO$ - * FT_NWSEMOPEN() FT_NWSEMEX() FT_NWSEMWAIT() FT_NWSEMSIG() FT_NWSEMLOCK() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_NWSEMUNLOCK() + $CATEGORY$ + NetWare + $ONELINER$ + "Unlock" a semaphore locked by FT_NWSEMLOCK() + $SYNTAX$ + FT_NWSEMUNLOCK( ) -> lRet + $ARGUMENTS$ + is the semaphore handle returned from FT_NWSEMLOCK() + $RETURNS$ + lRet == .T. if you successfully unlock the semaphore, .F. if + you don't. If this call fails, it could be that you're passing + an invalid semaphore handle. + $DESCRIPTION$ + This call unlocks a semaphore prevsiously locked via FT_NWSEMLOCK(). + It is important that you get a valid semaphore handle from + FT_NWSEMLOCK() before you use this call. Make sure when you call + FT_NWSEMLOCK() that you pass a numeric parameter in for the handle + BY REFERENCE. + $EXAMPLES$ + LOCAL nHandle := 0 + IF FT_NWSEMLOCK( "error.log", @nHandle ) + // Note, you aren't actually LOCKING this file, you are + // just locking a semaphore by the same name. As long as + // all apps that might be using this file are cooperating + // with the same kind of semaphore lock, you can effectively + // control access to the file. + ELSE + ? "Couldn't lock file." + ENDIF + // Processing, then: + FT_NWSEMUNLOCK( nHandle ) + + $SEEALSO$ + FT_NWSEMOPEN() FT_NWSEMEX() FT_NWSEMWAIT() FT_NWSEMSIG() FT_NWSEMLOCK() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/nwuid.txt b/harbour/contrib/hbnf/doc/en/nwuid.txt index 05bbc43188..b364e92326 100644 --- a/harbour/contrib/hbnf/doc/en/nwuid.txt +++ b/harbour/contrib/hbnf/doc/en/nwuid.txt @@ -2,46 +2,46 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_NWUID() - * $CATEGORY$ - * NetWare - * $ONELINER$ - * Return the current Novell NetWare User ID - * $SYNTAX$ - * FT_NWUID( [ ] ) -> cUid - * $ARGUMENTS$ - * is a connection number, or logical station number, - * to find a userid for. Under NetWare 286, this number can be from - * 1 to 100. Under NetWare 386, 1-250. If not supplied, FT_NWUID() - * defaults to the current connection (i.e., the connection running - * the application). - * $RETURNS$ - * A string containing the userid, or "login name." - * The maximum length of this string, as defined by current - * versions of Novell NetWare, is 48 characters. - * $DESCRIPTION$ - * FT_NWUID() returns the current NetWare userid, or "login - * name." This is useful for implementing security or audit - * trail procedures within your programs. - * - * There is no simple way a user can "fool" this function into - * retrieving an incorrect value, provided a NetWare shell is loaded. - * - * This function requires FT_INT86() and FT_NWLSTAT() - * - * This function does NOT test for the existence of the NetWare shell. - * The behavior is undefined if no shell is loaded. You'll usually get - * garbage. This function has not been tested on NetWare 386. - * $EXAMPLES$ - * ? "I am: " + FT_NWUID() - * - * FOR x := 1 TO 100 - * cUid := FT_NWUID( x ) - * IF ! Empty( cUid ) - * ? Str( x, 3 ) + Space( 3 ) + cUid - * ENDIF - * NEXT - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_NWUID() + $CATEGORY$ + NetWare + $ONELINER$ + Return the current Novell NetWare User ID + $SYNTAX$ + FT_NWUID( [ ] ) -> cUid + $ARGUMENTS$ + is a connection number, or logical station number, + to find a userid for. Under NetWare 286, this number can be from + 1 to 100. Under NetWare 386, 1-250. If not supplied, FT_NWUID() + defaults to the current connection (i.e., the connection running + the application). + $RETURNS$ + A string containing the userid, or "login name." + The maximum length of this string, as defined by current + versions of Novell NetWare, is 48 characters. + $DESCRIPTION$ + FT_NWUID() returns the current NetWare userid, or "login + name." This is useful for implementing security or audit + trail procedures within your programs. + + There is no simple way a user can "fool" this function into + retrieving an incorrect value, provided a NetWare shell is loaded. + + This function requires FT_INT86() and FT_NWLSTAT() + + This function does NOT test for the existence of the NetWare shell. + The behavior is undefined if no shell is loaded. You'll usually get + garbage. This function has not been tested on NetWare 386. + $EXAMPLES$ + ? "I am: " + FT_NWUID() + + FOR x := 1 TO 100 + cUid := FT_NWUID( x ) + IF ! Empty( cUid ) + ? Str( x, 3 ) + Space( 3 ) + cUid + ENDIF + NEXT + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/ontick.txt b/harbour/contrib/hbnf/doc/en/ontick.txt index 007e8fa328..7808b23e3f 100644 --- a/harbour/contrib/hbnf/doc/en/ontick.txt +++ b/harbour/contrib/hbnf/doc/en/ontick.txt @@ -2,48 +2,48 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_OnTick() - * $CATEGORY$ - * Event - * $ONELINER$ - * Evaluate a designated code block at a designated interval. - * $SYNTAX$ - * FT_OnTick( bCode, nInterval ) - * $ARGUMENTS$ - * is the code block to evaluate. - * is the number of clock ticks to wait between - * evaluations of the code block. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * This function effectively allows you to run tasks in the background - * by transparently and periodically calling a designated routine. - * - * To halt the execution of the background function, call FT_OnTick() - * with no arguments. - * - * This function makes heavy use of several undocumented internal - * routines. If this fact makes you uncomfortable then don't use - * this function, you quivering sack of cowardly slime. - * $EXAMPLES$ - * // Set up a self-updating on-screen clock - * - * FT_OnTick( "CLOCK", 9 ) - * - * PROCEDURE Clock() - * - * LOCAL nRow := Row() - * LOCAL nCol := Col() - * - * @ 0, 0 SAY Time() - * - * SetPos( nRow, nCol ) - * - * RETURN - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_OnTick() + $CATEGORY$ + Event + $ONELINER$ + Evaluate a designated code block at a designated interval. + $SYNTAX$ + FT_OnTick( bCode, nInterval ) + $ARGUMENTS$ + is the code block to evaluate. + is the number of clock ticks to wait between + evaluations of the code block. + $RETURNS$ + NIL + $DESCRIPTION$ + This function effectively allows you to run tasks in the background + by transparently and periodically calling a designated routine. + + To halt the execution of the background function, call FT_OnTick() + with no arguments. + + This function makes heavy use of several undocumented internal + routines. If this fact makes you uncomfortable then don't use + this function, you quivering sack of cowardly slime. + $EXAMPLES$ + // Set up a self-updating on-screen clock + + FT_OnTick( "CLOCK", 9 ) + + PROCEDURE Clock() + + LOCAL nRow := Row() + LOCAL nCol := Col() + + @ 0, 0 SAY Time() + + SetPos( nRow, nCol ) + + RETURN + + $SEEALSO$ + + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/origin.txt b/harbour/contrib/hbnf/doc/en/origin.txt index 536737e1ee..9d47289c18 100644 --- a/harbour/contrib/hbnf/doc/en/origin.txt +++ b/harbour/contrib/hbnf/doc/en/origin.txt @@ -2,38 +2,38 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ORIGIN() - * $CATEGORY$ - * Environment - * $ONELINER$ - * Report the drive, path and filename of the current program - * $SYNTAX$ - * FT_ORIGIN() -> cString - * $ARGUMENTS$ - * None - * $RETURNS$ - * A string containing the full drive/directory/filename of - * the currently executing file. - * $DESCRIPTION$ - * Often users will install multiple copies of application software, - * especially on networks and in situations where the user is trying - * to get around a copy protection scheme. - * - * This function enables you to learn the name and source location - * of the currently executing file, so that you may take whatever - * action you need to. - * - * Requires DOS v3.xx and above. - * $EXAMPLES$ - * cMyFile := FT_ORIGIN() - * - * IF !( cMyFile == "C:\appdir\myfile.exe" ) - * ? "Incorrect startup file. Please remove/rename and start again" - * QUIT - * ENDIF - * $SEEALSO$ - * FT_WHEREIS() FT_TREE() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ORIGIN() + $CATEGORY$ + Environment + $ONELINER$ + Report the drive, path and filename of the current program + $SYNTAX$ + FT_ORIGIN() -> cString + $ARGUMENTS$ + None + $RETURNS$ + A string containing the full drive/directory/filename of + the currently executing file. + $DESCRIPTION$ + Often users will install multiple copies of application software, + especially on networks and in situations where the user is trying + to get around a copy protection scheme. + + This function enables you to learn the name and source location + of the currently executing file, so that you may take whatever + action you need to. + + Requires DOS v3.xx and above. + $EXAMPLES$ + cMyFile := FT_ORIGIN() + + IF !( cMyFile == "C:\appdir\myfile.exe" ) + ? "Incorrect startup file. Please remove/rename and start again" + QUIT + ENDIF + $SEEALSO$ + FT_WHEREIS() FT_TREE() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/outp.txt b/harbour/contrib/hbnf/doc/en/outp.txt index 3eeea42038..fc43898a51 100644 --- a/harbour/contrib/hbnf/doc/en/outp.txt +++ b/harbour/contrib/hbnf/doc/en/outp.txt @@ -2,34 +2,34 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_OUTP() - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Write a byte to a specified I/O port - * $SYNTAX$ - * FT_OUTP( , ) -> lResult - * $ARGUMENTS$ - * is the port from which to retrieve the byte. - * - * is the value between 0 and 255 to write to the port. - * $RETURNS$ - * .T. if all parameters were valid and the byte was written to - * the port. - * .F. if invalid parameters were passed. - * $DESCRIPTION$ - * It may sometimes be useful to write a byte to a port without having - * to resort to C or assembler. This function allows you to do so. - * - * The source code is written to adhere to Turbo Assembler's IDEAL mode. - * To use another assembler, you will need to rearrange the PROC and - * SEGMENT directives, and also the ENDP and ENDS directives (a very - * minor task). - * $EXAMPLES$ - * lOk := FT_OUTP( 100, 0 ) // send a Chr( 0 ) to port 100 (064h) - * $SEEALSO$ - * FT_INP() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_OUTP() + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Write a byte to a specified I/O port + $SYNTAX$ + FT_OUTP( , ) -> lResult + $ARGUMENTS$ + is the port from which to retrieve the byte. + + is the value between 0 and 255 to write to the port. + $RETURNS$ + .T. if all parameters were valid and the byte was written to + the port. + .F. if invalid parameters were passed. + $DESCRIPTION$ + It may sometimes be useful to write a byte to a port without having + to resort to C or assembler. This function allows you to do so. + + The source code is written to adhere to Turbo Assembler's IDEAL mode. + To use another assembler, you will need to rearrange the PROC and + SEGMENT directives, and also the ENDP and ENDS directives (a very + minor task). + $EXAMPLES$ + lOk := FT_OUTP( 100, 0 ) // send a Chr( 0 ) to port 100 (064h) + $SEEALSO$ + FT_INP() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/page.txt b/harbour/contrib/hbnf/doc/en/page.txt index f4d4a62816..04f28fe029 100644 --- a/harbour/contrib/hbnf/doc/en/page.txt +++ b/harbour/contrib/hbnf/doc/en/page.txt @@ -2,57 +2,57 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_SETVPG() - * $CATEGORY$ - * Video - * $ONELINER$ - * Set the current video page - * $SYNTAX$ - * FT_SETVPG( ) -> NIL - * $ARGUMENTS$ - * is a valid video page. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * Selects the video page. - * - * For more information on graphics programming and video pages, - * consult a reference such as "Programmer's Guide to PC and PS/2 - * Video Systems" (Microsoft Press). - * $EXAMPLES$ - * // The following sets the current video page to 1 - * - * FT_SETVPG( 1 ) - * $SEEALSO$ - * FT_GETVPG() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SETVPG() + $CATEGORY$ + Video + $ONELINER$ + Set the current video page + $SYNTAX$ + FT_SETVPG( ) -> NIL + $ARGUMENTS$ + is a valid video page. + $RETURNS$ + NIL + $DESCRIPTION$ + Selects the video page. + + For more information on graphics programming and video pages, + consult a reference such as "Programmer's Guide to PC and PS/2 + Video Systems" (Microsoft Press). + $EXAMPLES$ + // The following sets the current video page to 1 + + FT_SETVPG( 1 ) + $SEEALSO$ + FT_GETVPG() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_GETVPG() - * $CATEGORY$ - * Video - * $ONELINER$ - * Get the currently selected video page - * $SYNTAX$ - * FT_GETVPG() -> - * $ARGUMENTS$ - * None. - * $RETURNS$ - * The video page, as a numeric. - * $DESCRIPTION$ - * Get the currently selected video page - * - * For more information on graphics programming and video pages, - * consult a reference such as _Programmer's Guide to PC and PS/2 - * Video Systems_ (Microsoft Press). - * - * $EXAMPLES$ - * nPage := FT_GETVPG() - * $SEEALSO$ - * FT_SETVPG() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_GETVPG() + $CATEGORY$ + Video + $ONELINER$ + Get the currently selected video page + $SYNTAX$ + FT_GETVPG() -> + $ARGUMENTS$ + None. + $RETURNS$ + The video page, as a numeric. + $DESCRIPTION$ + Get the currently selected video page + + For more information on graphics programming and video pages, + consult a reference such as _Programmer's Guide to PC and PS/2 + Video Systems_ (Microsoft Press). + + $EXAMPLES$ + nPage := FT_GETVPG() + $SEEALSO$ + FT_SETVPG() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/pchr.txt b/harbour/contrib/hbnf/doc/en/pchr.txt index 4a847b7202..1a5ffd18ce 100644 --- a/harbour/contrib/hbnf/doc/en/pchr.txt +++ b/harbour/contrib/hbnf/doc/en/pchr.txt @@ -2,91 +2,91 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_PChr() - * $CATEGORY$ - * String - * $ONELINER$ - * Convert printer control codes - * $SYNTAX$ - * FT_PChr( ) -> - * $ARGUMENTS$ - * is the representation of the printer control codes in - * text, numeric, hexadecimal, Epson command format, or any combination - * separated by commas. - * $RETURNS$ - * A character string of printer control codes. - * $DESCRIPTION$ - * This function is useful for allowing the user to enter printer - * control codes in text (enclosed in double quotes), numeric, - * hexadecimal, or Epson commands preceded by a slash and returns - * the printer control code equivalent. - * - * NOTES" - * - * - Combinations of text, numbers, hex, and commands must be - * separated by commas ("A",27,&1B,/RESET). - * - Text must be enclosed in double quotes ("x"). - * - Hexadecimal must be preceded by an ampersand (&1B). - * - Epson commands, listed below, must be preceded by a forward - * slash (/RESET). - * - * Epson commands: (slash commands are specific to the Epson) - * - * Job Control: - * - * /RESET or /INIT Reset or initialize the printer - * /BELL or /BEEP Cause the printer's speaker to beep (not HS) - * /CAN Clear print buffers (not MX) - * /SLOW Set low speed mode (not CR, HS, MX) - * /FAST Cancel low speed mode (not CR, HS, MX) - * /ONE Select Unidirectional mode - * /TWO Select Directional mode - * /ON Activate printer - * /OFF Turn off printer - * - * /FF or /EJECT Form Feed - * - * Page Control: - * - * /1/6 Set 6 lines per inch - * /1/8 Set 8 lines per inch - * /SKIP Set Skip perforation ON - * /SKIPOFF Set Skip perforation OFF - * - * Font Selection and Manipulation: - * - * /ITALIC Select italic char. set (only FX86, EX, LX, - * no LQ-1500, SX) - * /GRAPHIC Select graphic char. set (only FX86, EX, LX, - * no LQ-1500, SX) - * /ROMAN Choose Roman font - * /SANS Choose Sans Serif font - * /DRAFT Choose draft - * /NLQ Choose near letter quality - * /PICA Choose 10 chars per inch - * /ELITE Choose 12 chars per inch - * /COND or /SI Choose 15 chars per inch - * /EMPH Turn emphasize on - * /EMPHOFF Turn emphasize off - * /SPANISH Select spanish international char set - * /USA Select USA international char set - * - * $EXAMPLES$ - * cSetUp := "27,116,1" - * SET PRINT ON - * ? FT_PChr( cSetUp ) -> (Chr(27)+Chr(116)+Chr(1)) - * + + ? FT_PChr( '27,"x",0' ) -> (Chr(27)+Chr(120)+Chr(0)) + + + ? FT_PChr( '&1B,"E"' ) -> (Chr(27)+Chr(69)) + + ? FT_PChr( "/ELITE,/NLQ" ) ->(Chr(27)+Chr(77)+Chr(27)+Chr(120)+Chr(1)) + + $SEEALSO$ + + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/peek.txt b/harbour/contrib/hbnf/doc/en/peek.txt index 47a342de11..1b0851b86f 100644 --- a/harbour/contrib/hbnf/doc/en/peek.txt +++ b/harbour/contrib/hbnf/doc/en/peek.txt @@ -2,32 +2,32 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_PEEK() - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Retrieve a byte from a specified memory location. - * $SYNTAX$ - * FT_PEEK( , ) -> nValue - * $ARGUMENTS$ - * is the segment of the desired memory address. - * - * is the offset of the desired memory address. - * $RETURNS$ - * will be a value from 0 to 255 if all parameters were valid and - * the function was able to retrieve the desired byte. - * will be -1 if invalid parameters were passed. - * $DESCRIPTION$ - * Use this function if you have a need to examine a specific memory - * location. The function will return the byte at the specified - * address as a numeric value. If you need this value as a character, - * use the Chr() function to convert it. - * - * This function was written for version 5.1 of MicroSoft C. You may - * have to modify the source code to use another compiler. - * $EXAMPLES$ - * LOCAL nVMode := FT_PEEK( 0, 1097 ) // Get the current video mode - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_PEEK() + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Retrieve a byte from a specified memory location. + $SYNTAX$ + FT_PEEK( , ) -> nValue + $ARGUMENTS$ + is the segment of the desired memory address. + + is the offset of the desired memory address. + $RETURNS$ + will be a value from 0 to 255 if all parameters were valid and + the function was able to retrieve the desired byte. + will be -1 if invalid parameters were passed. + $DESCRIPTION$ + Use this function if you have a need to examine a specific memory + location. The function will return the byte at the specified + address as a numeric value. If you need this value as a character, + use the Chr() function to convert it. + + This function was written for version 5.1 of MicroSoft C. You may + have to modify the source code to use another compiler. + $EXAMPLES$ + LOCAL nVMode := FT_PEEK( 0, 1097 ) // Get the current video mode + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/pegs.txt b/harbour/contrib/hbnf/doc/en/pegs.txt index 8461a3408b..6682753c79 100644 --- a/harbour/contrib/hbnf/doc/en/pegs.txt +++ b/harbour/contrib/hbnf/doc/en/pegs.txt @@ -2,24 +2,24 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_PEGS() - * $CATEGORY$ - * Game - * $ONELINER$ - * FT_PEGS GAME (all work and no play...) - * $SYNTAX$ - * FT_PEGS() -> NIL - * $ARGUMENTS$ - * None - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * This function can be used to alleviate boredom. The object is to - * remove all pegs except one. This is done by jumping over adjacent - * pegs. - * $EXAMPLES$ - * FT_PEGS() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_PEGS() + $CATEGORY$ + Game + $ONELINER$ + FT_PEGS GAME (all work and no play...) + $SYNTAX$ + FT_PEGS() -> NIL + $ARGUMENTS$ + None + $RETURNS$ + NIL + $DESCRIPTION$ + This function can be used to alleviate boredom. The object is to + remove all pegs except one. This is done by jumping over adjacent + pegs. + $EXAMPLES$ + FT_PEGS() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/pending.txt b/harbour/contrib/hbnf/doc/en/pending.txt index 9e04fb39a8..b85de8fd34 100644 --- a/harbour/contrib/hbnf/doc/en/pending.txt +++ b/harbour/contrib/hbnf/doc/en/pending.txt @@ -2,52 +2,52 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_PENDING() - * $CATEGORY$ - * Menus/Prompts - * $ONELINER$ - * Display same-line pending messages after a wait. - * $SYNTAX$ - * FT_PENDING ( , [ ], [ ], ; - * [ ], [ ] ) -> NIL - * $ARGUMENTS$ - * is the message string to display. - * - * is an optional screen row for message display, default row 24. - * - * is an optional screen col for message display, default col 0. - * - * is an optional wait (sec) between messages, default 5 sec. - * - * is an optional color string for displayed messages, default - * is white text over red background. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * A good way to display information messages during the running - * of an application is to send them all to the SAME line on the - * screen where users are expected to look for them. In order to - * give users a chance to read the current message before the next one - * is displayed we may need to insert a delay after each message. - * - * FT_PENDING() function displays messages by keeping track of - * the time of the last message and providing a delay ONLY if the next - * pending message is issued much too soon after the current one. - * - * $EXAMPLES$ - * FT_PENDING( "Message one",20,0,3,"W+/G" ) // Displays "Message one." - * // sets row to 20, col to 0. - * // wait to 3 and color to - * // bright white over green. - * FT_PENDING( "Message two" ) // Displays "Message two", after 5 sec. - * FT_PENDING( "Message three" ) // Displays "Message three", after 5 sec. - * - * - * Note that default row, col, wait time and color need to be set only - * once in the very first call to FT_PENDING() and only if the internal - * default values are not appropriate. - * - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_PENDING() + $CATEGORY$ + Menus/Prompts + $ONELINER$ + Display same-line pending messages after a wait. + $SYNTAX$ + FT_PENDING ( , [ ], [ ], ; + [ ], [ ] ) -> NIL + $ARGUMENTS$ + is the message string to display. + + is an optional screen row for message display, default row 24. + + is an optional screen col for message display, default col 0. + + is an optional wait (sec) between messages, default 5 sec. + + is an optional color string for displayed messages, default + is white text over red background. + $RETURNS$ + NIL + $DESCRIPTION$ + A good way to display information messages during the running + of an application is to send them all to the SAME line on the + screen where users are expected to look for them. In order to + give users a chance to read the current message before the next one + is displayed we may need to insert a delay after each message. + + FT_PENDING() function displays messages by keeping track of + the time of the last message and providing a delay ONLY if the next + pending message is issued much too soon after the current one. + + $EXAMPLES$ + FT_PENDING( "Message one",20,0,3,"W+/G" ) // Displays "Message one." + // sets row to 20, col to 0. + // wait to 3 and color to + // bright white over green. + FT_PENDING( "Message two" ) // Displays "Message two", after 5 sec. + FT_PENDING( "Message three" ) // Displays "Message three", after 5 sec. + + + Note that default row, col, wait time and color need to be set only + once in the very first call to FT_PENDING() and only if the internal + default values are not appropriate. + + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/pickday.txt b/harbour/contrib/hbnf/doc/en/pickday.txt index fab7e76938..9543ff66f0 100644 --- a/harbour/contrib/hbnf/doc/en/pickday.txt +++ b/harbour/contrib/hbnf/doc/en/pickday.txt @@ -2,22 +2,22 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_PICKDAY() - * $CATEGORY$ - * Menus/Prompts - * $ONELINER$ - * Picklist of days of week - * $SYNTAX$ - * FT_PICKDAY() -> cDayOfWeek - * $ARGUMENTS$ - * None - * $RETURNS$ - * Character string containing day of week - * $DESCRIPTION$ - * This function is ideal if you need the user to select a day. - * $EXAMPLES$ - * mday := FT_PICKDAY() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_PICKDAY() + $CATEGORY$ + Menus/Prompts + $ONELINER$ + Picklist of days of week + $SYNTAX$ + FT_PICKDAY() -> cDayOfWeek + $ARGUMENTS$ + None + $RETURNS$ + Character string containing day of week + $DESCRIPTION$ + This function is ideal if you need the user to select a day. + $EXAMPLES$ + mday := FT_PICKDAY() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/poke.txt b/harbour/contrib/hbnf/doc/en/poke.txt index 1ea0bc394e..8b093efde5 100644 --- a/harbour/contrib/hbnf/doc/en/poke.txt +++ b/harbour/contrib/hbnf/doc/en/poke.txt @@ -2,35 +2,35 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_POKE() - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Write a byte to a specified memory location - * $SYNTAX$ - * FT_POKE( , , ) -> lResult - * $ARGUMENTS$ - * is the segment of the desired memory address. - * - * is the offset of the desired memory address. - * - * is the value to write to the desired memory address. - * $RETURNS$ - * will be .T. if all parameters were valid and the function was - * able to write the desired byte. - * will be .F. if invalid parameters were passed. - * $DESCRIPTION$ - * Use this function if you have a need to change the value at a specific - * memory location. The function will write the specified byte to the - * specified address. The value must be passed as a numeric; if the byte - * you wish to use is stored as a character, use the Asc() function - * to convert it. - * - * This function was written for version 5.1 of MicroSoft C. You may - * have to modify the source code to use another compiler. - * $EXAMPLES$ - * FT_POKE( 0, 1047, 64 ) // Turn CapsLock on - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_POKE() + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Write a byte to a specified memory location + $SYNTAX$ + FT_POKE( , , ) -> lResult + $ARGUMENTS$ + is the segment of the desired memory address. + + is the offset of the desired memory address. + + is the value to write to the desired memory address. + $RETURNS$ + will be .T. if all parameters were valid and the function was + able to write the desired byte. + will be .F. if invalid parameters were passed. + $DESCRIPTION$ + Use this function if you have a need to change the value at a specific + memory location. The function will write the specified byte to the + specified address. The value must be passed as a numeric; if the byte + you wish to use is stored as a character, use the Asc() function + to convert it. + + This function was written for version 5.1 of MicroSoft C. You may + have to modify the source code to use another compiler. + $EXAMPLES$ + FT_POKE( 0, 1047, 64 ) // Turn CapsLock on + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/popadder.txt b/harbour/contrib/hbnf/doc/en/popadder.txt index f96ff37c0e..734e46d705 100644 --- a/harbour/contrib/hbnf/doc/en/popadder.txt +++ b/harbour/contrib/hbnf/doc/en/popadder.txt @@ -2,82 +2,82 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_Adder() - * $CATEGORY$ - * Menus/Prompts - * $ONELINER$ - * Pop up a simple calculator - * $SYNTAX$ - * FT_Adder() - * $ARGUMENTS$ - * None - * $RETURNS$ - * NIL .... but optionally places Total of calculation in active - * Get variable using oGet:VARPUT() - * $DESCRIPTION$ - * PopAdder() gives you an adding machine inside your Clipper 5.2 - * application. It has the basic functions add, subtract, multiply, - * and divide. You may move it from one side of the screen to the - * other. It even displays a scrollable tape, if you want it. - * - * - * There are a few HOT Keys while using the Adder: - * - * ecimals - change # of decimals - * ove - the Adder from right display to left - * ape - turn the Tape Display On or Off - * croll - the tape display - * ---+-- 1st Clear entry - * +-- 2nd Clear ADDER - * - Quit - * - return a to the active get - * - * - * A couple of notes about the adder: - * - * - * 1.) It was designed to be used on an Enhanced keyboard with - * separate key. is used to clear the adder. - * However, it will still work on a Standard keyboard. - * - * 2.) You do not have to display the tape. You may turn it on - * at any time by pressing . You may SCROLL back through - * the tape once there are more than 16 entries in the - * adder, by pressing . - * - * 3.) To Quit the Adder just press . To return your Total - * to the application press . The adder will place the - * Total in the active GET variable using oGet:VarPut(). The - * adder will only return a Total to a numerical GET! - * - * 4.) There are many support functions that you might find - * interesting. They are part of my personal library, but - * are necessary to the operation of the adder. - * You might want to pull these out to reduce the overall - * size of the adder. Many are worth at least a little - * time studying. - * - * 5.) To make FT_Adder a Hot key from inside your application - * at the beginning of your application add the line: - * - * SET KEY K_ALT_A TO FT_Adder - * - * This will make a key "Hot" and permit you to - * Pop - Up the adder from anywhere in the application. - * - * 6.) If you use FT_INKEY(), you can even have active hotkeys - * in an INKEY(). - * - * - * - * - * $EXAMPLES$ - * - * $SEEALSO$ - * - * $INCLUDE$ - * inkey.ch, setcurs.ch, achoice.ch - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_Adder() + $CATEGORY$ + Menus/Prompts + $ONELINER$ + Pop up a simple calculator + $SYNTAX$ + FT_Adder() + $ARGUMENTS$ + None + $RETURNS$ + NIL .... but optionally places Total of calculation in active + Get variable using oGet:VARPUT() + $DESCRIPTION$ + PopAdder() gives you an adding machine inside your Clipper 5.2 + application. It has the basic functions add, subtract, multiply, + and divide. You may move it from one side of the screen to the + other. It even displays a scrollable tape, if you want it. + + + There are a few HOT Keys while using the Adder: + + ecimals - change # of decimals + ove - the Adder from right display to left + ape - turn the Tape Display On or Off + croll - the tape display + ---+-- 1st Clear entry + +-- 2nd Clear ADDER + - Quit + - return a to the active get + + + A couple of notes about the adder: + + + 1.) It was designed to be used on an Enhanced keyboard with + separate key. is used to clear the adder. + However, it will still work on a Standard keyboard. + + 2.) You do not have to display the tape. You may turn it on + at any time by pressing . You may SCROLL back through + the tape once there are more than 16 entries in the + adder, by pressing . + + 3.) To Quit the Adder just press . To return your Total + to the application press . The adder will place the + Total in the active GET variable using oGet:VarPut(). The + adder will only return a Total to a numerical GET! + + 4.) There are many support functions that you might find + interesting. They are part of my personal library, but + are necessary to the operation of the adder. + You might want to pull these out to reduce the overall + size of the adder. Many are worth at least a little + time studying. + + 5.) To make FT_Adder a Hot key from inside your application + at the beginning of your application add the line: + + SET KEY K_ALT_A TO FT_Adder + + This will make a key "Hot" and permit you to + Pop - Up the adder from anywhere in the application. + + 6.) If you use FT_INKEY(), you can even have active hotkeys + in an INKEY(). + + + + + $EXAMPLES$ + + $SEEALSO$ + + $INCLUDE$ + inkey.ch, setcurs.ch, achoice.ch + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/proper.txt b/harbour/contrib/hbnf/doc/en/proper.txt index 8204dc78e0..590cff8c68 100644 --- a/harbour/contrib/hbnf/doc/en/proper.txt +++ b/harbour/contrib/hbnf/doc/en/proper.txt @@ -2,38 +2,38 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_PROPER() - * $CATEGORY$ - * String - * $ONELINER$ - * Convert a string to proper-name case - * $SYNTAX$ - * FT_PROPER( ) -> cProperName - * $ARGUMENTS$ - * is the string to be converted. - * $RETURNS$ - * A string of the same length as , only converted to - * proper name case (upper/lower case). - * $DESCRIPTION$ - * FT_PROPER() uses a brute-force algorithm to convert a string - * to propername case. First, it capitalizes the first letter of - * all words starting after a blank, dash, or apostrophe. This - * catches most names, including special cases such as names - * beginning with O' (O'Malley, O'Reilly) and hyphenated names - * (such as Susan Chia-Mei Lo). - * - * Next, it does a specific adjustment for words beginning in "Mc" - * It finds the first 'Mc' and capitalizes the next character after - * it. It does this for all occurrences of Mc. - * - * The original FT_PROPER() was written in Clipper by Glenn Scott - * and Mark Zechiel; it was re-written in C (and thus, optimized - * and enhanced) by Robert DiFalco. - * $EXAMPLES$ - * PROCEDURE Main( cStr ) - * OutStd( FT_PROPER( cStr ) + hb_eol() ) - * RETURN - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_PROPER() + $CATEGORY$ + String + $ONELINER$ + Convert a string to proper-name case + $SYNTAX$ + FT_PROPER( ) -> cProperName + $ARGUMENTS$ + is the string to be converted. + $RETURNS$ + A string of the same length as , only converted to + proper name case (upper/lower case). + $DESCRIPTION$ + FT_PROPER() uses a brute-force algorithm to convert a string + to propername case. First, it capitalizes the first letter of + all words starting after a blank, dash, or apostrophe. This + catches most names, including special cases such as names + beginning with O' (O'Malley, O'Reilly) and hyphenated names + (such as Susan Chia-Mei Lo). + + Next, it does a specific adjustment for words beginning in "Mc" + It finds the first 'Mc' and capitalizes the next character after + it. It does this for all occurrences of Mc. + + The original FT_PROPER() was written in Clipper by Glenn Scott + and Mark Zechiel; it was re-written in C (and thus, optimized + and enhanced) by Robert DiFalco. + $EXAMPLES$ + PROCEDURE Main( cStr ) + OutStd( FT_PROPER( cStr ) + hb_eol() ) + RETURN + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/prtesc.txt b/harbour/contrib/hbnf/doc/en/prtesc.txt index 329ae3cc53..8099c3b905 100644 --- a/harbour/contrib/hbnf/doc/en/prtesc.txt +++ b/harbour/contrib/hbnf/doc/en/prtesc.txt @@ -2,32 +2,32 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ESCCODE() - * $CATEGORY$ - * Conversion - * $ONELINER$ - * Convert Lotus style escape codes - * $SYNTAX$ - * FT_ESCCODE( ) -> - * $ARGUMENTS$ - * is the ASCII representation of the printer control - * codes in Lotus 123 format (e.g. "\027E" for Chr(27)+"E") - * - * "\nnn" will be converted to Chr(nnn) - * "\\" will be converted to "\" - * $RETURNS$ - * The binary version of an ASCII coded printer setup string. - * $DESCRIPTION$ - * This function is useful for allowing the user to enter printer - * control codes in Lotus-style ASCII format, and then having - * this function convert that code to the format that the printer - * needs to receive. - * $EXAMPLES$ - * cSetup = "\015" // default = Epson compressed print - * UserInput( @cSetup ) // Let user modify setup code - * SET DEVICE TO PRINT // get ready to print - * ?? FT_ESCCODE( cSetup ) // Output the converted code - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ESCCODE() + $CATEGORY$ + Conversion + $ONELINER$ + Convert Lotus style escape codes + $SYNTAX$ + FT_ESCCODE( ) -> + $ARGUMENTS$ + is the ASCII representation of the printer control + codes in Lotus 123 format (e.g. "\027E" for Chr(27)+"E") + + "\nnn" will be converted to Chr(nnn) + "\\" will be converted to "\" + $RETURNS$ + The binary version of an ASCII coded printer setup string. + $DESCRIPTION$ + This function is useful for allowing the user to enter printer + control codes in Lotus-style ASCII format, and then having + this function convert that code to the format that the printer + needs to receive. + $EXAMPLES$ + cSetup = "\015" // default = Epson compressed print + UserInput( @cSetup ) // Let user modify setup code + SET DEVICE TO PRINT // get ready to print + ?? FT_ESCCODE( cSetup ) // Output the converted code + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/prtscr.txt b/harbour/contrib/hbnf/doc/en/prtscr.txt index d3d0cbf5af..3a70af64e5 100644 --- a/harbour/contrib/hbnf/doc/en/prtscr.txt +++ b/harbour/contrib/hbnf/doc/en/prtscr.txt @@ -2,30 +2,30 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_PRTSCR() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Enable or disable the Print Screen key - * $SYNTAX$ - * FT_PRTSCR( [ ] ) -> lCurStat - * $ARGUMENTS$ - * set to .T. will enable the Print Screen key, - * .F. will disable it. If omitted, leaves status as is. - * $RETURNS$ - * The current state: .T. if enabled, .F. if disabled. - * $DESCRIPTION$ - * This function is valuable if you have a need to disable the - * printscreen key. It works by fooling the BIOS into thinking that - * a printscreen is already in progress. The BIOS will then refuse - * to invoke the printscreen handler. - * $EXAMPLES$ - * FT_PRTSCR( .F. ) // Disable the printscreen key - * FT_PRTSCR( .T. ) // Enable the printscreen key - * MemVar := FT_PRTSCR() // Get the current status - * $SEEALSO$ - * FT_CAPLOCK() FT_CTRL() FT_NUMLOCK() FT_SHIFT() FT_ALT() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_PRTSCR() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Enable or disable the Print Screen key + $SYNTAX$ + FT_PRTSCR( [ ] ) -> lCurStat + $ARGUMENTS$ + set to .T. will enable the Print Screen key, + .F. will disable it. If omitted, leaves status as is. + $RETURNS$ + The current state: .T. if enabled, .F. if disabled. + $DESCRIPTION$ + This function is valuable if you have a need to disable the + printscreen key. It works by fooling the BIOS into thinking that + a printscreen is already in progress. The BIOS will then refuse + to invoke the printscreen handler. + $EXAMPLES$ + FT_PRTSCR( .F. ) // Disable the printscreen key + FT_PRTSCR( .T. ) // Enable the printscreen key + MemVar := FT_PRTSCR() // Get the current status + $SEEALSO$ + FT_CAPLOCK() FT_CTRL() FT_NUMLOCK() FT_SHIFT() FT_ALT() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/putkey.txt b/harbour/contrib/hbnf/doc/en/putkey.txt index 2a22cd7d33..54ec869a0f 100644 --- a/harbour/contrib/hbnf/doc/en/putkey.txt +++ b/harbour/contrib/hbnf/doc/en/putkey.txt @@ -2,47 +2,47 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_PUTKEY() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Stuff a keystroke into the keyboard buffer - * $SYNTAX$ - * FT_PUTKEY( ) -> lResult - * $ARGUMENTS$ - * is the INKEY() value of the keystroke to be stuffed. - * $RETURNS$ - * .T. if the keystroke was put into the keyboard buffer. - * .F. if nKeyValue was invalid or the buffer was full. - * $DESCRIPTION$ - * This function is similar to the KEYBOARD command, with a few - * exceptions. First, this function does not clear the keyboard buffer - * before inserting the keystroke. In addition, since it uses the - * Inkey() value, you can stuff any key, including function keys, into - * the keyboard buffer. However, this also means that unlike the KEYBOARD - * command, you can only stuff one keystroke at a time. - * - * You can easily create a User-Defined Command that makes this function - * even more like the KEYBOARD command. For example, - * - * #command KEYSTROKE => FT_PUTKEY( ) - * - * will create a command called KEYSTROKE that could be used as a - * companion command to KEYBOARD. The only difference is that it would - * insert a single keystroke instead of a string. - * - * Be aware that this function makes use of Clipper's internal event - * handler. If you don't like using internals, then don't use this - * function, you sniveling coward. - * - * This function is written to adhere to Turbo Assembler's IDEAL mode. - * To use another assembler, rearrange the SEGMENT and PROC directives - * and make any other necessary changes to the source code. - * $EXAMPLES$ - * FT_PUTKEY( -9 ) // Stuff the F10 key - * FT_PUTKEY( 276 ) // Stuff the Alt T key - * KEYSTROKE 28 // Stuff the F1 key using a User-Defined Command - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_PUTKEY() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Stuff a keystroke into the keyboard buffer + $SYNTAX$ + FT_PUTKEY( ) -> lResult + $ARGUMENTS$ + is the INKEY() value of the keystroke to be stuffed. + $RETURNS$ + .T. if the keystroke was put into the keyboard buffer. + .F. if nKeyValue was invalid or the buffer was full. + $DESCRIPTION$ + This function is similar to the KEYBOARD command, with a few + exceptions. First, this function does not clear the keyboard buffer + before inserting the keystroke. In addition, since it uses the + Inkey() value, you can stuff any key, including function keys, into + the keyboard buffer. However, this also means that unlike the KEYBOARD + command, you can only stuff one keystroke at a time. + + You can easily create a User-Defined Command that makes this function + even more like the KEYBOARD command. For example, + + #command KEYSTROKE => FT_PUTKEY( ) + + will create a command called KEYSTROKE that could be used as a + companion command to KEYBOARD. The only difference is that it would + insert a single keystroke instead of a string. + + Be aware that this function makes use of Clipper's internal event + handler. If you don't like using internals, then don't use this + function, you sniveling coward. + + This function is written to adhere to Turbo Assembler's IDEAL mode. + To use another assembler, rearrange the SEGMENT and PROC directives + and make any other necessary changes to the source code. + $EXAMPLES$ + FT_PUTKEY( -9 ) // Stuff the F10 key + FT_PUTKEY( 276 ) // Stuff the Alt T key + KEYSTROKE 28 // Stuff the F1 key using a User-Defined Command + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/pvid.txt b/harbour/contrib/hbnf/doc/en/pvid.txt index 36afa68f5b..4144e026d2 100644 --- a/harbour/contrib/hbnf/doc/en/pvid.txt +++ b/harbour/contrib/hbnf/doc/en/pvid.txt @@ -2,59 +2,59 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_PUSHVID() - * $CATEGORY$ - * Video - * $ONELINER$ - * Save current video states on internal stack. - * $SYNTAX$ - * FT_PushVid() -> - * $ARGUMENTS$ - * None - * $RETURNS$ - * The current size of the internal stack (i.e. the number of times - * FT_PushVid() has been called). - * $DESCRIPTION$ - * Menus, picklists, browses, and other video-intensive items often - * require you to save certain video states -- screen image, cursor - * position, and so forth. Constantly saving and restoring these items - * can get very tedious. This function attempts to alleviate this - * problem. When called, it saves the cursor position, color setting, - * screen image, cursor style, blink setting, scoreboard setting, snow - * setting, and maximum row and column to a series of static arrays. All - * that is needed to restore the saved settings is a call to FT_PopVid(). - * $EXAMPLES$ - * FT_PushVid() // Save the current video states - * $SEEALSO$ - * FT_PopVid() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_PUSHVID() + $CATEGORY$ + Video + $ONELINER$ + Save current video states on internal stack. + $SYNTAX$ + FT_PushVid() -> + $ARGUMENTS$ + None + $RETURNS$ + The current size of the internal stack (i.e. the number of times + FT_PushVid() has been called). + $DESCRIPTION$ + Menus, picklists, browses, and other video-intensive items often + require you to save certain video states -- screen image, cursor + position, and so forth. Constantly saving and restoring these items + can get very tedious. This function attempts to alleviate this + problem. When called, it saves the cursor position, color setting, + screen image, cursor style, blink setting, scoreboard setting, snow + setting, and maximum row and column to a series of static arrays. All + that is needed to restore the saved settings is a call to FT_PopVid(). + $EXAMPLES$ + FT_PushVid() // Save the current video states + $SEEALSO$ + FT_PopVid() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_POPVID() - * $CATEGORY$ - * Video - * $ONELINER$ - * Restore previously saved video states. - * $SYNTAX$ - * FT_PopVid() -> - * $ARGUMENTS$ - * None - * $RETURNS$ - * The number of items remaining in the internal stack. - * $DESCRIPTION$ - * This is the complementary function to FT_PushVid(). At some time - * after saving the video states it will probably be necessary to restore - * them. This is done by restoring the settings from the last call to - * FT_PushVid(). The number of items on the internal stack is then - * reduced by one. Note that the use of stack logic means that items on - * the stack are retrieved in Last In First Out order. - * $EXAMPLES$ - * FT_PopVid() // Restore video states - * $SEEALSO$ - * FT_PushVid() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_POPVID() + $CATEGORY$ + Video + $ONELINER$ + Restore previously saved video states. + $SYNTAX$ + FT_PopVid() -> + $ARGUMENTS$ + None + $RETURNS$ + The number of items remaining in the internal stack. + $DESCRIPTION$ + This is the complementary function to FT_PushVid(). At some time + after saving the video states it will probably be necessary to restore + them. This is done by restoring the settings from the last call to + FT_PushVid(). The number of items on the internal stack is then + reduced by one. Note that the use of stack logic means that items on + the stack are retrieved in Last In First Out order. + $EXAMPLES$ + FT_PopVid() // Restore video states + $SEEALSO$ + FT_PushVid() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/qtr.txt b/harbour/contrib/hbnf/doc/en/qtr.txt index 720cf5253c..238713a30a 100644 --- a/harbour/contrib/hbnf/doc/en/qtr.txt +++ b/harbour/contrib/hbnf/doc/en/qtr.txt @@ -2,60 +2,60 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_QTR() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Return Calendar or Fiscal Quarter Data. - * $SYNTAX$ - * FT_QTR( [ ], [ ] ) -> aDateInfo - * $ARGUMENTS$ - * is any valid date in any date format. Defaults - * to current system date if not supplied. - * - * is a number from 1 to 4 signifying a quarter. - * Defaults to current quarter if not supplied. - * $RETURNS$ - * A three element array containing the following data: - * - * aDateInfo[ 1 ] - The year and quarter as a character string "YYYYQQ" - * aDateInfo[ 2 ] - The beginning date of the quarter - * aDateInfo[ 3 ] - The ending date of the quarter - * $DESCRIPTION$ - * FT_QTR() returns an array containing data about the quarter - * containing the given date. - * - * Normally the return data will be based on a year beginning - * on January 1st with weeks beginning on Sunday. - * - * The beginning of year date and/or beginning of week day can be - * changed by using FT_DATECNFG(), which will affect all subsequent - * calls to FT_QTR() until another call to FT_DATECNFG(). - * - * The beginning of year date and beginning of week day may be reset - * to January 1 and Sunday by calling FT_DATECNFG() with no - * parameters. - * $EXAMPLES$ - * // get info about quarter containing 9/15/90 - * aDateInfo := FT_QTR( SToD( "19900915" ) ) - * ? aDateInfo[ 1 ] // 199003 (3rd quarter) - * ? aDateInfo[ 2 ] // 07/01/90 beginning of quarter 3 - * ? aDateInfo[ 3 ] // 09/30/90 end of week quarter 3 - * - * // get info about quarter 2 in year containing 9/15/90 - * aDateInfo := FT_QTR( SToD( "19900915" ), 2 ) - * ? aDateInfo[ 1 ] // 199002 - * ? aDateInfo[ 2 ] // 04/01/90 beginning of quarter 2 - * ? aDateInfo[ 3 ] // 06/30/90 end of quarter 2 - * - * // get info about quarter 2 in current year (1991) - * aDateInfo := FT_QTR( , 2 ) - * ? aDateInfo[ 1 ] // 199102 - * ? aDateInfo[ 2 ] // 04/01/91 beginning of quarter 2 - * ? aDateInfo[ 3 ] // 06/30/91 end of quarter 2 - * $SEEALSO$ - * FT_DATECNFG() FT_WEEK() FT_MONTH() FT_YEAR() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_QTR() + $CATEGORY$ + Date/Time + $ONELINER$ + Return Calendar or Fiscal Quarter Data. + $SYNTAX$ + FT_QTR( [ ], [ ] ) -> aDateInfo + $ARGUMENTS$ + is any valid date in any date format. Defaults + to current system date if not supplied. + + is a number from 1 to 4 signifying a quarter. + Defaults to current quarter if not supplied. + $RETURNS$ + A three element array containing the following data: + + aDateInfo[ 1 ] - The year and quarter as a character string "YYYYQQ" + aDateInfo[ 2 ] - The beginning date of the quarter + aDateInfo[ 3 ] - The ending date of the quarter + $DESCRIPTION$ + FT_QTR() returns an array containing data about the quarter + containing the given date. + + Normally the return data will be based on a year beginning + on January 1st with weeks beginning on Sunday. + + The beginning of year date and/or beginning of week day can be + changed by using FT_DATECNFG(), which will affect all subsequent + calls to FT_QTR() until another call to FT_DATECNFG(). + + The beginning of year date and beginning of week day may be reset + to January 1 and Sunday by calling FT_DATECNFG() with no + parameters. + $EXAMPLES$ + // get info about quarter containing 9/15/90 + aDateInfo := FT_QTR( SToD( "19900915" ) ) + ? aDateInfo[ 1 ] // 199003 (3rd quarter) + ? aDateInfo[ 2 ] // 07/01/90 beginning of quarter 3 + ? aDateInfo[ 3 ] // 09/30/90 end of week quarter 3 + + // get info about quarter 2 in year containing 9/15/90 + aDateInfo := FT_QTR( SToD( "19900915" ), 2 ) + ? aDateInfo[ 1 ] // 199002 + ? aDateInfo[ 2 ] // 04/01/90 beginning of quarter 2 + ? aDateInfo[ 3 ] // 06/30/90 end of quarter 2 + + // get info about quarter 2 in current year (1991) + aDateInfo := FT_QTR( , 2 ) + ? aDateInfo[ 1 ] // 199102 + ? aDateInfo[ 2 ] // 04/01/91 beginning of quarter 2 + ? aDateInfo[ 3 ] // 06/30/91 end of quarter 2 + $SEEALSO$ + FT_DATECNFG() FT_WEEK() FT_MONTH() FT_YEAR() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/rand1.txt b/harbour/contrib/hbnf/doc/en/rand1.txt index 9a33053a10..f10a2012bb 100644 --- a/harbour/contrib/hbnf/doc/en/rand1.txt +++ b/harbour/contrib/hbnf/doc/en/rand1.txt @@ -2,31 +2,31 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_RAND1() - * $CATEGORY$ - * Math - * $ONELINER$ - * Generate a random number - * $SYNTAX$ - * FT_RAND1( ) -> nRand - * $ARGUMENTS$ - * Maximum limit of value to be produced. - * $RETURNS$ - * nRand is a random number between 0 (inclusive) and (exclusive). - * $DESCRIPTION$ - * Generates a non-integer random number based on the Linear - * Congruential Method. - * - * If you need a random number between 1 and inclusive, INT() - * the result and add 1. - * - * If you need a random number between 0 and inclusive, - * then you should ROUND() the result. - * $EXAMPLES$ - * nResult := Int( FT_RAND1( 100 ) ) + 1 // 1 <= nResult <= 100 - * nResult := Round( FT_RAND1( 100 ), 0 ) // 0 <= nResult <= 100 - * nResult := FT_RAND1( 1 ) // 0 <= nResult < 1 - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_RAND1() + $CATEGORY$ + Math + $ONELINER$ + Generate a random number + $SYNTAX$ + FT_RAND1( ) -> nRand + $ARGUMENTS$ + Maximum limit of value to be produced. + $RETURNS$ + nRand is a random number between 0 (inclusive) and (exclusive). + $DESCRIPTION$ + Generates a non-integer random number based on the Linear + Congruential Method. + + If you need a random number between 1 and inclusive, INT() + the result and add 1. + + If you need a random number between 0 and inclusive, + then you should ROUND() the result. + $EXAMPLES$ + nResult := Int( FT_RAND1( 100 ) ) + 1 // 1 <= nResult <= 100 + nResult := Round( FT_RAND1( 100 ), 0 ) // 0 <= nResult <= 100 + nResult := FT_RAND1( 1 ) // 0 <= nResult < 1 + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/reboot.txt b/harbour/contrib/hbnf/doc/en/reboot.txt index 998cc7c73f..86eadb7940 100644 --- a/harbour/contrib/hbnf/doc/en/reboot.txt +++ b/harbour/contrib/hbnf/doc/en/reboot.txt @@ -2,36 +2,36 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_REBOOT() - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Force a warm or cold boot - * $SYNTAX$ - * FT_REBOOT( ) -> NIL - * $ARGUMENTS$ - * is used to indicate the type of reboot. A value of zero - * will cause a cold boot, while any other value will cause a warm boot. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * This function is valuable if you need to reboot the PC for some - * reason; e.g. an installation routine that modifies CONFIG.SYS or - * AUTOEXEC.BAT. - * - * The source code is written to adhere to Turbo Assembler's IDEAL mode. - * To use another assembler, you will need to rearrange the PROC and - * SEGMENT directives, and also the ENDP and ENDS directives (a very - * minor task). - * $EXAMPLES$ - * #define COLD 0 - * #define WARM 1 - * - * // Issue a warm boot - * - * FT_Reboot( WARM ) - * - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_REBOOT() + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Force a warm or cold boot + $SYNTAX$ + FT_REBOOT( ) -> NIL + $ARGUMENTS$ + is used to indicate the type of reboot. A value of zero + will cause a cold boot, while any other value will cause a warm boot. + $RETURNS$ + NIL + $DESCRIPTION$ + This function is valuable if you need to reboot the PC for some + reason; e.g. an installation routine that modifies CONFIG.SYS or + AUTOEXEC.BAT. + + The source code is written to adhere to Turbo Assembler's IDEAL mode. + To use another assembler, you will need to rearrange the PROC and + SEGMENT directives, and also the ENDP and ENDS directives (a very + minor task). + $EXAMPLES$ + #define COLD 0 + #define WARM 1 + + // Issue a warm boot + + FT_Reboot( WARM ) + + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/restsets.txt b/harbour/contrib/hbnf/doc/en/restsets.txt index 3335f79f76..d92deef9ed 100644 --- a/harbour/contrib/hbnf/doc/en/restsets.txt +++ b/harbour/contrib/hbnf/doc/en/restsets.txt @@ -2,29 +2,29 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_RESTSETS() - * $CATEGORY$ - * Environment - * $ONELINER$ - * Restore status of all SET command settings - * $SYNTAX$ - * FT_RESTSETS( [ ] ) -> NIL - * $ARGUMENTS$ - * aOldSets is an array of SET settings created by FT_SAVESETS() - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * This function "restores" the SET Settings, i.e., it sets them to the - * values in the array aOldSets. The following SETs are not currently - * supported: FILTER, FORMAT, FUNCTION, INDEX, KEYS, MODE, ORDER, - * PROCEDURE, RELATION, TYPEAHEAD - * $EXAMPLES$ - * FT_RESTSETS(aOldSets) - * $INCLUDE$ - * set.ch - * $SEEALSO$ - * FT_SAVESETS() FT_SETCENTURY() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_RESTSETS() + $CATEGORY$ + Environment + $ONELINER$ + Restore status of all SET command settings + $SYNTAX$ + FT_RESTSETS( [ ] ) -> NIL + $ARGUMENTS$ + aOldSets is an array of SET settings created by FT_SAVESETS() + $RETURNS$ + NIL + $DESCRIPTION$ + This function "restores" the SET Settings, i.e., it sets them to the + values in the array aOldSets. The following SETs are not currently + supported: FILTER, FORMAT, FUNCTION, INDEX, KEYS, MODE, ORDER, + PROCEDURE, RELATION, TYPEAHEAD + $EXAMPLES$ + FT_RESTSETS(aOldSets) + $INCLUDE$ + set.ch + $SEEALSO$ + FT_SAVESETS() FT_SETCENTURY() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/rmdir.txt b/harbour/contrib/hbnf/doc/en/rmdir.txt index 44c44d9e44..5cd3df21e5 100644 --- a/harbour/contrib/hbnf/doc/en/rmdir.txt +++ b/harbour/contrib/hbnf/doc/en/rmdir.txt @@ -2,34 +2,34 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_RMDIR() - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Delete a subdirectory - * $SYNTAX$ - * FT_RMDIR( ) -> nResult - * $ARGUMENTS$ - * is the name of the directory to delete. - * $RETURNS$ - * 0 if successful - * 3 if Path Not Found - * 5 if Access Denied (directory not empty) - * 16 if attempt to delete current directory. - * 99 if invalid parameters passed - * $DESCRIPTION$ - * This function is useful if you need to remove a subdirectory for - * some reason. - * - * The source code is written to adhere to Turbo Assembler's IDEAL mode. - * To use another assembler, you will need to rearrange the PROC and - * SEGMENT directives, and also the ENDP and ENDS directives (a very - * minor task). - * $EXAMPLES$ - * FT_RMDIR( "C:\clipper" ) - * FT_RMDIR( "\example" ) - * FT_RMDIR( "..\source" ) - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_RMDIR() + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Delete a subdirectory + $SYNTAX$ + FT_RMDIR( ) -> nResult + $ARGUMENTS$ + is the name of the directory to delete. + $RETURNS$ + 0 if successful + 3 if Path Not Found + 5 if Access Denied (directory not empty) + 16 if attempt to delete current directory. + 99 if invalid parameters passed + $DESCRIPTION$ + This function is useful if you need to remove a subdirectory for + some reason. + + The source code is written to adhere to Turbo Assembler's IDEAL mode. + To use another assembler, you will need to rearrange the PROC and + SEGMENT directives, and also the ENDP and ENDS directives (a very + minor task). + $EXAMPLES$ + FT_RMDIR( "C:\clipper" ) + FT_RMDIR( "\example" ) + FT_RMDIR( "..\source" ) + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/round.txt b/harbour/contrib/hbnf/doc/en/round.txt index 57e87b7718..2ab9bbc842 100644 --- a/harbour/contrib/hbnf/doc/en/round.txt +++ b/harbour/contrib/hbnf/doc/en/round.txt @@ -2,65 +2,65 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ROUND() - * $CATEGORY$ - * Math - * $ONELINER$ - * Rounds a number to a specific place - * $SYNTAX$ - * FT_ROUND( [, ; - * [, [, ; - * [, ] ] ] ] ) -> nNumber - * $ARGUMENTS$ - * is the number to round - * - * is the fraction to round to or the number of places, - * default is 2. - * - * is the type of rounding desired - * - * "D" for Decimal (3 for thousandth, 1/1000) (default) - * "F" for Fraction (3 for thirds, 1/3) - * "W" for Whole numbers (3 for thousand, 1000) - * - * is the direction to round the number toward - * - * "U" to round Up 1.31 -> 1.4 - * -1.31 -> -1.4 - * "D" to round Down 1.36 -> 1.3 - * -1.36 -> -1.3 - * "N" to round Normal 1.5 -> 2 - * -1.5 -> -2 - * 1.49 -> 1 - * -1.49 -> -1 - * - * is the amount that is considered acceptable - * to be within, i.e., if you're within this amount of the number - * you don't need to round - * $RETURNS$ - * The number, rounded as specified. - * $DESCRIPTION$ - * This function will allow you to round a number. The following can - * be specified: - * a. Direction (up, down or normal - normal is 4/5 convention) - * b. Type (whole, decimal, fraction) - * c. Amount (100's, 5 decimals, 16th, etc.) - * $EXAMPLES$ - * // round normal to 2 decimal places - * nDollars := FT_ROUND( nDollars ) - * - * // round normal to 6 decimal places - * nIntRate := FT_ROUND( nIntRate, 6 ) - * - * // round to nearest thousands - * nPrice := FT_ROUND( nPrice, 3, NEAREST_WHOLE_NUMBER ) - * - * // round Up to nearest third - * nAmount := FT_ROUND( nAmount, 3, NEAREST_FRACTION, ROUND_UP ) - * - * // round down to 3 decimals Within .005 - * nAvg := FT_ROUND( nAvg, 3, , ROUND_DOWN, .005 ) - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ROUND() + $CATEGORY$ + Math + $ONELINER$ + Rounds a number to a specific place + $SYNTAX$ + FT_ROUND( [, ; + [, [, ; + [, ] ] ] ] ) -> nNumber + $ARGUMENTS$ + is the number to round + + is the fraction to round to or the number of places, + default is 2. + + is the type of rounding desired + + "D" for Decimal (3 for thousandth, 1/1000) (default) + "F" for Fraction (3 for thirds, 1/3) + "W" for Whole numbers (3 for thousand, 1000) + + is the direction to round the number toward + + "U" to round Up 1.31 -> 1.4 + -1.31 -> -1.4 + "D" to round Down 1.36 -> 1.3 + -1.36 -> -1.3 + "N" to round Normal 1.5 -> 2 + -1.5 -> -2 + 1.49 -> 1 + -1.49 -> -1 + + is the amount that is considered acceptable + to be within, i.e., if you're within this amount of the number + you don't need to round + $RETURNS$ + The number, rounded as specified. + $DESCRIPTION$ + This function will allow you to round a number. The following can + be specified: + a. Direction (up, down or normal - normal is 4/5 convention) + b. Type (whole, decimal, fraction) + c. Amount (100's, 5 decimals, 16th, etc.) + $EXAMPLES$ + // round normal to 2 decimal places + nDollars := FT_ROUND( nDollars ) + + // round normal to 6 decimal places + nIntRate := FT_ROUND( nIntRate, 6 ) + + // round to nearest thousands + nPrice := FT_ROUND( nPrice, 3, NEAREST_WHOLE_NUMBER ) + + // round Up to nearest third + nAmount := FT_ROUND( nAmount, 3, NEAREST_FRACTION, ROUND_UP ) + + // round down to 3 decimals Within .005 + nAvg := FT_ROUND( nAvg, 3, , ROUND_DOWN, .005 ) + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/savearr.txt b/harbour/contrib/hbnf/doc/en/savearr.txt index 30ad7b8624..b9f7af36ba 100644 --- a/harbour/contrib/hbnf/doc/en/savearr.txt +++ b/harbour/contrib/hbnf/doc/en/savearr.txt @@ -2,104 +2,104 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_SAVEARR() - * $CATEGORY$ - * Array - * $ONELINER$ - * Save Clipper array to a disc file. - * $SYNTAX$ - * FT_SAVEARR( , , ) -> lRet - * $ARGUMENTS$ - * is any Clipper array except those containing - * compiled code blocks. - * - * is a DOS file name. - * - * will return any DOS file error. - * - * All arguments are required. - * - * $RETURNS$ - * .F. if there was a DOS file error or the array contained - * code blocks, otherwise returns .T. - * $DESCRIPTION$ - * FT_SAVEARR() saves any Clipper array, except those - * containing compiled code blocks, to a disc file. The - * array can be restored from the disc file using - * FT_RESTARR(). - * - * [10/1/92 Librarian note: - * - * This function does not appear to work with multi-dimensional - * arrays. If you'd care to modify it to support this feature, - * please do and send it to Glenn Scott 71620,1521.] - * - * - * $EXAMPLES$ - * aArray := { { "Invoice 1", SToD( "19910415" ), 1234.32, .T. },; - * { "Invoice 2", Date(), 234.98, .F. },; - * { "Invoice 3", Date() + 1, 0, .T. } } - * nErrorCode := 0 - * FT_SAVEARR( aArray, "invoice.dat", @nErrorCode ) - * IF nErrorCode == 0 - * aSave := FT_RESTARR( "invoice.dat", @nErrorCode ) - * IF nErrorCode != 0 - * ? "Error restoring array" - * ENDIF - * ELSE - * ? "Error writing array" - * ENDIF - * - * $SEEALSO$ - * FT_RESTARR() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SAVEARR() + $CATEGORY$ + Array + $ONELINER$ + Save Clipper array to a disc file. + $SYNTAX$ + FT_SAVEARR( , , ) -> lRet + $ARGUMENTS$ + is any Clipper array except those containing + compiled code blocks. + + is a DOS file name. + + will return any DOS file error. + + All arguments are required. + + $RETURNS$ + .F. if there was a DOS file error or the array contained + code blocks, otherwise returns .T. + $DESCRIPTION$ + FT_SAVEARR() saves any Clipper array, except those + containing compiled code blocks, to a disc file. The + array can be restored from the disc file using + FT_RESTARR(). + + [10/1/92 Librarian note: + + This function does not appear to work with multi-dimensional + arrays. If you'd care to modify it to support this feature, + please do and send it to Glenn Scott 71620,1521.] + + + $EXAMPLES$ + aArray := { { "Invoice 1", SToD( "19910415" ), 1234.32, .T. },; + { "Invoice 2", Date(), 234.98, .F. },; + { "Invoice 3", Date() + 1, 0, .T. } } + nErrorCode := 0 + FT_SAVEARR( aArray, "invoice.dat", @nErrorCode ) + IF nErrorCode == 0 + aSave := FT_RESTARR( "invoice.dat", @nErrorCode ) + IF nErrorCode != 0 + ? "Error restoring array" + ENDIF + ELSE + ? "Error writing array" + ENDIF + + $SEEALSO$ + FT_RESTARR() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_RESTARR() - * $CATEGORY$ - * Array - * $ONELINER$ - * Restore a Clipper array from a disc file - * $SYNTAX$ - * FT_RESTARR( , ) -> aArray - * $ARGUMENTS$ - * is a DOS file name. - * - * will return any DOS file error. - * - * All arguments are required. - * $RETURNS$ - * Return an array variable. - * $DESCRIPTION$ - * FT_RESTARR() restores an array which was saved to - * a disc file using FT_SAVEARR(). - * - * [10/1/92 Librarian note: - * - * This function does not appear to work with multi-dimensional - * arrays. If you'd care to modify it to support this feature, - * please do and send it to Glenn Scott 71620,1521.] - * - * $EXAMPLES$ - * aArray := { { "Invoice 1", SToD( "19910415" ), 1234.32, .T. },; - * { "Invoice 2", Date(), 234.98, .F. },; - * { "Invoice 3", Date() + 1, 0, .T. } } - * nErrorCode := 0 - * FT_SAVEARR( aArray, "invoice.dat", @nErrorCode ) - * IF nErrorCode == 0 - * aSave := FT_RESTARR( "invoice.dat", @nErrorCode ) - * IF nErrorCode != 0 - * ? "Error restoring array" - * ENDIF - * ELSE - * ? "Error writing array" - * ENDIF - * - * $SEEALSO$ - * FT_SAVEARR() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_RESTARR() + $CATEGORY$ + Array + $ONELINER$ + Restore a Clipper array from a disc file + $SYNTAX$ + FT_RESTARR( , ) -> aArray + $ARGUMENTS$ + is a DOS file name. + + will return any DOS file error. + + All arguments are required. + $RETURNS$ + Return an array variable. + $DESCRIPTION$ + FT_RESTARR() restores an array which was saved to + a disc file using FT_SAVEARR(). + + [10/1/92 Librarian note: + + This function does not appear to work with multi-dimensional + arrays. If you'd care to modify it to support this feature, + please do and send it to Glenn Scott 71620,1521.] + + $EXAMPLES$ + aArray := { { "Invoice 1", SToD( "19910415" ), 1234.32, .T. },; + { "Invoice 2", Date(), 234.98, .F. },; + { "Invoice 3", Date() + 1, 0, .T. } } + nErrorCode := 0 + FT_SAVEARR( aArray, "invoice.dat", @nErrorCode ) + IF nErrorCode == 0 + aSave := FT_RESTARR( "invoice.dat", @nErrorCode ) + IF nErrorCode != 0 + ? "Error restoring array" + ENDIF + ELSE + ? "Error writing array" + ENDIF + + $SEEALSO$ + FT_SAVEARR() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/savesets.txt b/harbour/contrib/hbnf/doc/en/savesets.txt index f953329139..034606dc5b 100644 --- a/harbour/contrib/hbnf/doc/en/savesets.txt +++ b/harbour/contrib/hbnf/doc/en/savesets.txt @@ -2,29 +2,29 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_SAVESETS() - * $CATEGORY$ - * Environment - * $ONELINER$ - * Save the status of all the SET command settings - * $SYNTAX$ - * FT_SAVESETS() -> aOldSets - * $ARGUMENTS$ - * None - * $RETURNS$ - * An array containing the values of the supported SETs. - * $DESCRIPTION$ - * This function saves the SET Settings, i.e., it copies them into an - * array, aOldSets. The following SETs are not currently supported: - * FILTER, FORMAT, FUNCTION, INDEX, KEYS, MODE, ORDER, PROCEDURE, - * RELATION, TYPEAHEAD - * $EXAMPLES$ - * aOldSets := FT_SAVESETS() - * $INCLUDE$ - * set.ch - * $SEEALSO$ - * FT_RESTSETS() FT_SETCENTURY() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SAVESETS() + $CATEGORY$ + Environment + $ONELINER$ + Save the status of all the SET command settings + $SYNTAX$ + FT_SAVESETS() -> aOldSets + $ARGUMENTS$ + None + $RETURNS$ + An array containing the values of the supported SETs. + $DESCRIPTION$ + This function saves the SET Settings, i.e., it copies them into an + array, aOldSets. The following SETs are not currently supported: + FILTER, FORMAT, FUNCTION, INDEX, KEYS, MODE, ORDER, PROCEDURE, + RELATION, TYPEAHEAD + $EXAMPLES$ + aOldSets := FT_SAVESETS() + $INCLUDE$ + set.ch + $SEEALSO$ + FT_RESTSETS() FT_SETCENTURY() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/scancode.txt b/harbour/contrib/hbnf/doc/en/scancode.txt index b9d04d3402..499c325450 100644 --- a/harbour/contrib/hbnf/doc/en/scancode.txt +++ b/harbour/contrib/hbnf/doc/en/scancode.txt @@ -2,49 +2,49 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_SCANCODE() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Wait for keypress and return keyboard scan code - * $SYNTAX$ - * FT_SCANCODE() -> cCode - * $ARGUMENTS$ - * None - * $RETURNS$ - * A two-character string, corresponding to the keyboard scan code. - * $DESCRIPTION$ - * FT_SCANCODE() enables you to distinguish the different scancodes - * of similar keys (such as Grey minus versus regular minus), thus - * increasing the number of keys your input routine can recognize. - * - * It works like INKEY(), in that it waits for a key to be pressed. - * The scan code consists of two bytes, which are returned as a - * two-character string. - * - * For example, calling FT_SCANCODE() and pressing the Grey-minus - * key will return a two character string: - * - * Chr( 45 ) + Chr( 74 ) - * - * LASTKEY() is not updated by FT_SCANCODE(), so don't try to - * test LASTKEY() to see what was pressed during an FT_SCANCODE() - * call. Simply assign the return value to a variable and test - * that (see the test driver below). - * - * * This was adapted from a short C routine posted by John Kaster on - * NANFORUM. It was written in Clipper to help demonstrate the - * FT_INT86 function of the Nanforum Toolkit. - * - * This program requires FT_INT86(). - * $EXAMPLES$ - * cKey := FT_SCANCODE() - * - * [grey-] returns: Chr( 45 ) + Chr( 74 ) - * [-] returns: Chr( 45 ) + Chr( 12 ) - * [grey+] returns: Chr( 43 ) + Chr( 78 ) - * [+] returns: Chr( 43 ) + Chr( 13 ) - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SCANCODE() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Wait for keypress and return keyboard scan code + $SYNTAX$ + FT_SCANCODE() -> cCode + $ARGUMENTS$ + None + $RETURNS$ + A two-character string, corresponding to the keyboard scan code. + $DESCRIPTION$ + FT_SCANCODE() enables you to distinguish the different scancodes + of similar keys (such as Grey minus versus regular minus), thus + increasing the number of keys your input routine can recognize. + + It works like INKEY(), in that it waits for a key to be pressed. + The scan code consists of two bytes, which are returned as a + two-character string. + + For example, calling FT_SCANCODE() and pressing the Grey-minus + key will return a two character string: + + Chr( 45 ) + Chr( 74 ) + + LASTKEY() is not updated by FT_SCANCODE(), so don't try to + test LASTKEY() to see what was pressed during an FT_SCANCODE() + call. Simply assign the return value to a variable and test + that (see the test driver below). + + * This was adapted from a short C routine posted by John Kaster on + NANFORUM. It was written in Clipper to help demonstrate the + FT_INT86 function of the Nanforum Toolkit. + + This program requires FT_INT86(). + $EXAMPLES$ + cKey := FT_SCANCODE() + + [grey-] returns: Chr( 45 ) + Chr( 74 ) + [-] returns: Chr( 45 ) + Chr( 12 ) + [grey+] returns: Chr( 43 ) + Chr( 78 ) + [+] returns: Chr( 43 ) + Chr( 13 ) + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/scregion.txt b/harbour/contrib/hbnf/doc/en/scregion.txt index 75cf8e3c0f..7be231fded 100644 --- a/harbour/contrib/hbnf/doc/en/scregion.txt +++ b/harbour/contrib/hbnf/doc/en/scregion.txt @@ -2,157 +2,157 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_SAVRGN() - * $CATEGORY$ - * Video - * $ONELINER$ - * Save a screen region for later display - * $SYNTAX$ - * FT_SAVRGN( , , , ) -> cScreen - * $ARGUMENTS$ - * , , , and define the portion of the - * screen to save. Allowable values are 0 through 255. - * $RETURNS$ - * FT_SAVRGN() returns the saved screen region and its coordinates - * as a character string. - * $DESCRIPTION$ - * FT_SAVRGN() is similar to Clipper's SAVESCREEN(), but it saves the - * screen coordinates as well as the display information. The saved - * area can be restored by passing the returned string to FT_RSTRGN(). - * - * Note that the strings returned from FT_SAVRGN() and Clipper's - * SAVESCREEN() are not interchangeable. A screen region saved with - * with FT_SAVRGN() must be restored using FT_RSTRGN(). - * - * FT_SAVRGN() calls Clipper's SAVESCREEN(). Refer to the Clipper - * documentation for more information regarding this function. - * $EXAMPLES$ - * The following example uses FT_SAVRGN() and FT_RSTRGN() to save - * and restore a portion of the screen. - * - * @ 00, 00, 24, 79 BOX "111111111" // fill the screen with 1's - * cScreen = FT_SAVRGN(10, 10, 20, 30) // save a region - * @ 00, 00, 24, 79 BOX "222222222" // fill the screen with 2's - * FT_RSTRGN(cScreen) // restore the 1's region - * $SEEALSO$ - * FT_RSTRGN() FT_RGNSTACK() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SAVRGN() + $CATEGORY$ + Video + $ONELINER$ + Save a screen region for later display + $SYNTAX$ + FT_SAVRGN( , , , ) -> cScreen + $ARGUMENTS$ + , , , and define the portion of the + screen to save. Allowable values are 0 through 255. + $RETURNS$ + FT_SAVRGN() returns the saved screen region and its coordinates + as a character string. + $DESCRIPTION$ + FT_SAVRGN() is similar to Clipper's SAVESCREEN(), but it saves the + screen coordinates as well as the display information. The saved + area can be restored by passing the returned string to FT_RSTRGN(). + + Note that the strings returned from FT_SAVRGN() and Clipper's + SAVESCREEN() are not interchangeable. A screen region saved with + with FT_SAVRGN() must be restored using FT_RSTRGN(). + + FT_SAVRGN() calls Clipper's SAVESCREEN(). Refer to the Clipper + documentation for more information regarding this function. + $EXAMPLES$ + The following example uses FT_SAVRGN() and FT_RSTRGN() to save + and restore a portion of the screen. + + @ 00, 00, 24, 79 BOX "111111111" // fill the screen with 1's + cScreen = FT_SAVRGN(10, 10, 20, 30) // save a region + @ 00, 00, 24, 79 BOX "222222222" // fill the screen with 2's + FT_RSTRGN(cScreen) // restore the 1's region + $SEEALSO$ + FT_RSTRGN() FT_RGNSTACK() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_RSTRGN() - * $CATEGORY$ - * Video - * $ONELINER$ - * Restore region of the screen saved with FT_SAVRGN() - * $SYNTAX$ - * FT_RSTRGN( , [ ], [ ] ) -> NIL - * $ARGUMENTS$ - * is a screen region previously returned from FT_SAVRGN(). - * - * and are optional parameters that define a new location - * for the upper left corner of the screen area contained in . - * Allowable values are 0 through 255. - * $RETURNS$ - * FT_RSTRGN() returns NIL. - * $DESCRIPTION$ - * FT_RSTRGN() restores a screen region previously saved with - * FT_SAVRGN(). Calling FT_RSTRGN() with as the only - * parameter will restore the saved region to its original location. - * and may be used to define a new location for the - * upper left corner of the saved region. - * - * and are dependent upon each other. You may not - * specify one without the other. - * - * FT_RSTRGN() calls Clipper's RESTSCREEN(). Refer to the Clipper - * documentation for more information regarding this function. - * $EXAMPLES$ - * The following example uses FT_RSTRGN() to restore a saved portion - * of the screen to different locations. - * - * @ 00, 00, 24, 79 BOX "111111111" // fill the screen with 1's - * cScreen = FT_SAVRGN(10, 10, 20, 30) // save a region - * @ 00, 00, 24, 79 BOX "222222222" // fill the screen with 2's - * FT_RSTRGN(cScreen) // restore the 1's region - * @ 00, 00, 24, 79 BOX "222222222" // fill the screen with 2's - * FT_RSTRGN(cScreen, 15, 15) // restore to a different location - * @ 00, 00, 24, 79 BOX "222222222" // fill the screen with 2's - * FT_RSTRGN(cScreen, 20, 60) // restore to a different location - * $SEEALSO$ - * FT_SAVRGN() FT_RGNSTACK() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_RSTRGN() + $CATEGORY$ + Video + $ONELINER$ + Restore region of the screen saved with FT_SAVRGN() + $SYNTAX$ + FT_RSTRGN( , [ ], [ ] ) -> NIL + $ARGUMENTS$ + is a screen region previously returned from FT_SAVRGN(). + + and are optional parameters that define a new location + for the upper left corner of the screen area contained in . + Allowable values are 0 through 255. + $RETURNS$ + FT_RSTRGN() returns NIL. + $DESCRIPTION$ + FT_RSTRGN() restores a screen region previously saved with + FT_SAVRGN(). Calling FT_RSTRGN() with as the only + parameter will restore the saved region to its original location. + and may be used to define a new location for the + upper left corner of the saved region. + + and are dependent upon each other. You may not + specify one without the other. + + FT_RSTRGN() calls Clipper's RESTSCREEN(). Refer to the Clipper + documentation for more information regarding this function. + $EXAMPLES$ + The following example uses FT_RSTRGN() to restore a saved portion + of the screen to different locations. + + @ 00, 00, 24, 79 BOX "111111111" // fill the screen with 1's + cScreen = FT_SAVRGN(10, 10, 20, 30) // save a region + @ 00, 00, 24, 79 BOX "222222222" // fill the screen with 2's + FT_RSTRGN(cScreen) // restore the 1's region + @ 00, 00, 24, 79 BOX "222222222" // fill the screen with 2's + FT_RSTRGN(cScreen, 15, 15) // restore to a different location + @ 00, 00, 24, 79 BOX "222222222" // fill the screen with 2's + FT_RSTRGN(cScreen, 20, 60) // restore to a different location + $SEEALSO$ + FT_SAVRGN() FT_RGNSTACK() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_RGNSTACK() - * $CATEGORY$ - * Video - * $ONELINER$ - * Push or pop a saved screen region on or off the stack - * $SYNTAX$ - * FT_RGNSTACK( , [ ], [ ], [ ], - * [ ] ) -> NIL - * $ARGUMENTS$ - * determines what action FT_RGNSTACK() will take. The - * allowable values for this parameter are "push", "pop", and "pop all". - * If the function is called with any other string as the first parameter - * no action is performed. - * - * with a value of "push" will push a saved screen region onto - * the stack. A value of "pop" will restore the most recently pushed - * screen region. "pop all" tells the function to restore all screen - * images which are currently on the stack. - * - * The use of , , , and depends on the - * parameter. If is "push", the next four parameters - * define the screen region to save. If is "pop" or "pop all" - * the following four parameters are ignored. - * $RETURNS$ - * FT_RGNSTACK() returns NIL. - * $DESCRIPTION$ - * FT_RGNSTACK() allows multiple screens to be saved and restored from - * a stack. The stack is implemented with Clipper static array that is - * visible only to FT_RGNSTACK(). - * - * The purpose of FT_RGNSTACK() is to allow multiple screen regions to be - * managed without the need to remember the original coordinates or to - * create variables for each one. - * - * When called with "push", FT_RGNSTACK() places the saved screen area - * at the end of the static array. The array size is incremented by one - * to accommodate the new screen area. - * - * When called with "pop", the function restores the screen image stored - * in the last element of the array, and the array size is decremented by - * one. If "pop all" is specified, all the saved screens are restored - * until the array is empty. - * - * FT_RGNSTACK() calls FT_SAVRGN() and FT_RSTRGN(). Refer to the - * documentation for these two functions for more information. - * $EXAMPLES$ - * The following example uses FT_RGNSTACK() to save and restore various - * sections of the screen. - * - * @ 00, 00, 24, 79 BOX "111111111" // fill the screen with 1's - * FT_RGNSTACK( "push", 10, 05, 15, 15 ) // push a region - * @ 00, 00, 24, 79 BOX "222222222" // fill the screen with 2's - * FT_RGNSTACK( "push", 10, 20, 15, 30 ) // push a region - * @ 00, 00, 24, 79 BOX "333333333" // fill the screen with 3's - * FT_RGNSTACK( "push", 10, 35, 15, 45 ) // push a region - * @ 00, 00, 24, 79 BOX "444444444" // fill the screen with 4's - * FT_RGNSTACK( "push", 10, 50, 15, 60 ) // push a region - * @ 00, 00, 24, 79 BOX "555555555" // fill the screen with 5's - * FT_RGNSTACK( "push", 10, 65, 15, 75 ) // push a region - * CLEAR - * FT_RGNSTACK( "pop" ) // restore the 5's region - * FT_RGNSTACK( "pop" ) // restore the 4's region - * FT_RGNSTACK( "pop all" ) // restore the 3's, 2's and 1's regions - * $SEEALSO$ - * FT_SAVRGN() FT_RSTRGN() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_RGNSTACK() + $CATEGORY$ + Video + $ONELINER$ + Push or pop a saved screen region on or off the stack + $SYNTAX$ + FT_RGNSTACK( , [ ], [ ], [ ], + [ ] ) -> NIL + $ARGUMENTS$ + determines what action FT_RGNSTACK() will take. The + allowable values for this parameter are "push", "pop", and "pop all". + If the function is called with any other string as the first parameter + no action is performed. + + with a value of "push" will push a saved screen region onto + the stack. A value of "pop" will restore the most recently pushed + screen region. "pop all" tells the function to restore all screen + images which are currently on the stack. + + The use of , , , and depends on the + parameter. If is "push", the next four parameters + define the screen region to save. If is "pop" or "pop all" + the following four parameters are ignored. + $RETURNS$ + FT_RGNSTACK() returns NIL. + $DESCRIPTION$ + FT_RGNSTACK() allows multiple screens to be saved and restored from + a stack. The stack is implemented with Clipper static array that is + visible only to FT_RGNSTACK(). + + The purpose of FT_RGNSTACK() is to allow multiple screen regions to be + managed without the need to remember the original coordinates or to + create variables for each one. + + When called with "push", FT_RGNSTACK() places the saved screen area + at the end of the static array. The array size is incremented by one + to accommodate the new screen area. + + When called with "pop", the function restores the screen image stored + in the last element of the array, and the array size is decremented by + one. If "pop all" is specified, all the saved screens are restored + until the array is empty. + + FT_RGNSTACK() calls FT_SAVRGN() and FT_RSTRGN(). Refer to the + documentation for these two functions for more information. + $EXAMPLES$ + The following example uses FT_RGNSTACK() to save and restore various + sections of the screen. + + @ 00, 00, 24, 79 BOX "111111111" // fill the screen with 1's + FT_RGNSTACK( "push", 10, 05, 15, 15 ) // push a region + @ 00, 00, 24, 79 BOX "222222222" // fill the screen with 2's + FT_RGNSTACK( "push", 10, 20, 15, 30 ) // push a region + @ 00, 00, 24, 79 BOX "333333333" // fill the screen with 3's + FT_RGNSTACK( "push", 10, 35, 15, 45 ) // push a region + @ 00, 00, 24, 79 BOX "444444444" // fill the screen with 4's + FT_RGNSTACK( "push", 10, 50, 15, 60 ) // push a region + @ 00, 00, 24, 79 BOX "555555555" // fill the screen with 5's + FT_RGNSTACK( "push", 10, 65, 15, 75 ) // push a region + CLEAR + FT_RGNSTACK( "pop" ) // restore the 5's region + FT_RGNSTACK( "pop" ) // restore the 4's region + FT_RGNSTACK( "pop all" ) // restore the 3's, 2's and 1's regions + $SEEALSO$ + FT_SAVRGN() FT_RSTRGN() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/setdate.txt b/harbour/contrib/hbnf/doc/en/setdate.txt index 7fcf1e6904..8f1a9c8ecc 100644 --- a/harbour/contrib/hbnf/doc/en/setdate.txt +++ b/harbour/contrib/hbnf/doc/en/setdate.txt @@ -2,43 +2,43 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_SETDATE() - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Set the DOS system date - * $SYNTAX$ - * FT_SETDATE( ) -> - * $ARGUMENTS$ - * is a Clipper date variable that you want to set the current - * DOS system date to. - * - * It is up to you to send in a valid date. The - * year must be within the range 1980 through 2099. If DOS - * thinks the date is not valid, it won't change the date. - * - * $RETURNS$ - * is simply the result of FT_INT86(), passed back - * to your program. - * - * $DESCRIPTION$ - * FT_SETDATE() uses NANFOR.LIB's FT_INT86() function to invoke - * the DOS Set Date service (Interrupt 33, service 43). - * - * $EXAMPLES$ - * The following program takes a date from the command line and sets - * the DOS system date: - * - * PROCEDURE Main( cDate ) - * - * cDate := iif( cDate == NIL, DToS( Date() ), cDate ) - * ? "Setting date to: " + cDate + "... " - * FT_SETDATE( SToD( cDate ) ) - * ? "Today is now: " + DToC( Date() ) - * - * RETURN - * - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SETDATE() + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Set the DOS system date + $SYNTAX$ + FT_SETDATE( ) -> + $ARGUMENTS$ + is a Clipper date variable that you want to set the current + DOS system date to. + + It is up to you to send in a valid date. The + year must be within the range 1980 through 2099. If DOS + thinks the date is not valid, it won't change the date. + + $RETURNS$ + is simply the result of FT_INT86(), passed back + to your program. + + $DESCRIPTION$ + FT_SETDATE() uses NANFOR.LIB's FT_INT86() function to invoke + the DOS Set Date service (Interrupt 33, service 43). + + $EXAMPLES$ + The following program takes a date from the command line and sets + the DOS system date: + + PROCEDURE Main( cDate ) + + cDate := iif( cDate == NIL, DToS( Date() ), cDate ) + ? "Setting date to: " + cDate + "... " + FT_SETDATE( SToD( cDate ) ) + ? "Today is now: " + DToC( Date() ) + + RETURN + + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/setkeys.txt b/harbour/contrib/hbnf/doc/en/setkeys.txt index fe9a49bd86..69ac8fd6a4 100644 --- a/harbour/contrib/hbnf/doc/en/setkeys.txt +++ b/harbour/contrib/hbnf/doc/en/setkeys.txt @@ -2,39 +2,39 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_LASTKEY() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Force LastKey() to return a programmer-defined value. - * $SYNTAX$ - * FT_LastKey( ) -> NIL - * $ARGUMENTS$ - * is the Inkey() value of the desired key. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * It is occasionally useful to force LastKey() to return a known value. - * This is easily accomplishing by using the KEYBOARD command, but this - * has undesireable side effects (the keyboard buffer is cleared, and - * the keystroke is processed whether you needed it to be or not). This - * function accomplishes the same task but without the side effects. It - * does so by directly modifying the memory location where Clipper stores - * the LastKey() value. - * - * Some highly unorthodox programming techniques, not to mention rather - * strange use of Clipper internals, was necessary to make this function - * work. If this makes you uncomfortable, then don't use this function, - * you worthless crybaby. - * $EXAMPLES$ - * hb_keyPut( K_ESC ) - * - * ? LastKey() // returns 27 - * - * FT_LastKey( K_F1 ) - * - * ? LastKey() // now returns 28 - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_LASTKEY() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Force LastKey() to return a programmer-defined value. + $SYNTAX$ + FT_LastKey( ) -> NIL + $ARGUMENTS$ + is the Inkey() value of the desired key. + $RETURNS$ + NIL + $DESCRIPTION$ + It is occasionally useful to force LastKey() to return a known value. + This is easily accomplishing by using the KEYBOARD command, but this + has undesireable side effects (the keyboard buffer is cleared, and + the keystroke is processed whether you needed it to be or not). This + function accomplishes the same task but without the side effects. It + does so by directly modifying the memory location where Clipper stores + the LastKey() value. + + Some highly unorthodox programming techniques, not to mention rather + strange use of Clipper internals, was necessary to make this function + work. If this makes you uncomfortable, then don't use this function, + you worthless crybaby. + $EXAMPLES$ + hb_keyPut( K_ESC ) + + ? LastKey() // returns 27 + + FT_LastKey( K_F1 ) + + ? LastKey() // now returns 28 + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/setlastk.txt b/harbour/contrib/hbnf/doc/en/setlastk.txt index fe9a49bd86..69ac8fd6a4 100644 --- a/harbour/contrib/hbnf/doc/en/setlastk.txt +++ b/harbour/contrib/hbnf/doc/en/setlastk.txt @@ -2,39 +2,39 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_LASTKEY() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Force LastKey() to return a programmer-defined value. - * $SYNTAX$ - * FT_LastKey( ) -> NIL - * $ARGUMENTS$ - * is the Inkey() value of the desired key. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * It is occasionally useful to force LastKey() to return a known value. - * This is easily accomplishing by using the KEYBOARD command, but this - * has undesireable side effects (the keyboard buffer is cleared, and - * the keystroke is processed whether you needed it to be or not). This - * function accomplishes the same task but without the side effects. It - * does so by directly modifying the memory location where Clipper stores - * the LastKey() value. - * - * Some highly unorthodox programming techniques, not to mention rather - * strange use of Clipper internals, was necessary to make this function - * work. If this makes you uncomfortable, then don't use this function, - * you worthless crybaby. - * $EXAMPLES$ - * hb_keyPut( K_ESC ) - * - * ? LastKey() // returns 27 - * - * FT_LastKey( K_F1 ) - * - * ? LastKey() // now returns 28 - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_LASTKEY() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Force LastKey() to return a programmer-defined value. + $SYNTAX$ + FT_LastKey( ) -> NIL + $ARGUMENTS$ + is the Inkey() value of the desired key. + $RETURNS$ + NIL + $DESCRIPTION$ + It is occasionally useful to force LastKey() to return a known value. + This is easily accomplishing by using the KEYBOARD command, but this + has undesireable side effects (the keyboard buffer is cleared, and + the keystroke is processed whether you needed it to be or not). This + function accomplishes the same task but without the side effects. It + does so by directly modifying the memory location where Clipper stores + the LastKey() value. + + Some highly unorthodox programming techniques, not to mention rather + strange use of Clipper internals, was necessary to make this function + work. If this makes you uncomfortable, then don't use this function, + you worthless crybaby. + $EXAMPLES$ + hb_keyPut( K_ESC ) + + ? LastKey() // returns 27 + + FT_LastKey( K_F1 ) + + ? LastKey() // now returns 28 + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/settime.txt b/harbour/contrib/hbnf/doc/en/settime.txt index 57ba2968f5..2896985bf9 100644 --- a/harbour/contrib/hbnf/doc/en/settime.txt +++ b/harbour/contrib/hbnf/doc/en/settime.txt @@ -2,41 +2,41 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_SETTIME() - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Set the DOS system time - * $SYNTAX$ - * FT_SETTIME( ) -> - * $ARGUMENTS$ - * is a string in the form that you want to set - * the current DOS system time to. - * - * Use 24-hour time. It is up to you to send in a valid time. If - * DOS doesn't think it is valid, it won't reset the time anyway. - * $RETURNS$ - * is simply the result of FT_INT86(), passed back - * to your program. - * - * $DESCRIPTION$ - * FT_SETTIME() uses NANFOR.LIB's FT_INT86() function to invoke - * the DOS Set Time service (Interrupt 33, service 45). - * - * $EXAMPLES$ - * The following program takes a time string from the command line and sets - * the DOS system time: - * - * PROCEDURE Main( cTime ) - * - * cTime := iif( cTime == NIL, Time(), cTime ) - * ? "Setting time to: " + cTime + "... " - * FT_SETTIME( cTime ) - * ? "Time is now: " + Time() - * - * RETURN - * - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SETTIME() + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Set the DOS system time + $SYNTAX$ + FT_SETTIME( ) -> + $ARGUMENTS$ + is a string in the form that you want to set + the current DOS system time to. + + Use 24-hour time. It is up to you to send in a valid time. If + DOS doesn't think it is valid, it won't reset the time anyway. + $RETURNS$ + is simply the result of FT_INT86(), passed back + to your program. + + $DESCRIPTION$ + FT_SETTIME() uses NANFOR.LIB's FT_INT86() function to invoke + the DOS Set Time service (Interrupt 33, service 45). + + $EXAMPLES$ + The following program takes a time string from the command line and sets + the DOS system time: + + PROCEDURE Main( cTime ) + + cTime := iif( cTime == NIL, Time(), cTime ) + ? "Setting time to: " + cTime + "... " + FT_SETTIME( cTime ) + ? "Time is now: " + Time() + + RETURN + + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/shadow.txt b/harbour/contrib/hbnf/doc/en/shadow.txt index 445c971c04..cdfaeb79f6 100644 --- a/harbour/contrib/hbnf/doc/en/shadow.txt +++ b/harbour/contrib/hbnf/doc/en/shadow.txt @@ -2,34 +2,33 @@ * $Id$ */ -/* - * $DOC$ - * $FUNCNAME$ - * FT_SHADOW() - * $CATEGORY$ - * Video - * $ONELINER$ - * Draw a non-destructive shadow on the screen - * $SYNTAX$ - * FT_SHADOW( , , , [ ,] ) -> NIL - * $ARGUMENTS$ - * is the top row of the shadow area. - * is the upper left column of the shadow area. - * is the bottom row of the shadow area. - * is the lower right column of the shadow area. - * is optional and is the screen attribute to use for drawing - * the shadow. If not specified, the default is 8. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * This function allows you to implement the popular "shadow effect." It - * draws a shadow using the specified screen coordinates. The shadow - * is drawn along the bottom and right side of the specified region. - * - * The source code is written to TASM IDEAL mode. - * $EXAMPLES$ - * FT_Shadow( 10, 10, 15, 50, 8 ) // draw a dim shadow - * - * FT_Shadow( 10, 10, 15, 40, 47 ) // draw a green shadow - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SHADOW() + $CATEGORY$ + Video + $ONELINER$ + Draw a non-destructive shadow on the screen + $SYNTAX$ + FT_SHADOW( , , , [ ,] ) -> NIL + $ARGUMENTS$ + is the top row of the shadow area. + is the upper left column of the shadow area. + is the bottom row of the shadow area. + is the lower right column of the shadow area. + is optional and is the screen attribute to use for drawing + the shadow. If not specified, the default is 8. + $RETURNS$ + NIL + $DESCRIPTION$ + This function allows you to implement the popular "shadow effect." It + draws a shadow using the specified screen coordinates. The shadow + is drawn along the bottom and right side of the specified region. + + The source code is written to TASM IDEAL mode. + $EXAMPLES$ + FT_Shadow( 10, 10, 15, 50, 8 ) // draw a dim shadow + + FT_Shadow( 10, 10, 15, 40, 47 ) // draw a green shadow + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/shift.txt b/harbour/contrib/hbnf/doc/en/shift.txt index c631477c59..9191fe44e4 100644 --- a/harbour/contrib/hbnf/doc/en/shift.txt +++ b/harbour/contrib/hbnf/doc/en/shift.txt @@ -2,29 +2,29 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_SHIFT() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Determine status of shift key - * $SYNTAX$ - * FT_SHIFT() -> lValue - * $ARGUMENTS$ - * None - * $RETURNS$ - * .T. if a shift key is pressed, .F. if otherwise. - * $DESCRIPTION$ - * This function is useful for times you need to know whether or not the - * shift key is pressed, such as during a MemoEdit(). - * $EXAMPLES$ - * IF FT_SHIFT() - * @ 24, 0 say "Shift" - * ELSE - * @ 24, 0 say " " - * ENDIF - * $SEEALSO$ - * FT_CAPLOCK() FT_CTRL() FT_NUMLOCK() FT_PRTSCR() FT_ALT() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SHIFT() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Determine status of shift key + $SYNTAX$ + FT_SHIFT() -> lValue + $ARGUMENTS$ + None + $RETURNS$ + .T. if a shift key is pressed, .F. if otherwise. + $DESCRIPTION$ + This function is useful for times you need to know whether or not the + shift key is pressed, such as during a MemoEdit(). + $EXAMPLES$ + IF FT_SHIFT() + @ 24, 0 say "Shift" + ELSE + @ 24, 0 say " " + ENDIF + $SEEALSO$ + FT_CAPLOCK() FT_CTRL() FT_NUMLOCK() FT_PRTSCR() FT_ALT() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/sinkey.txt b/harbour/contrib/hbnf/doc/en/sinkey.txt index 37e01c91cb..42a89a4b32 100644 --- a/harbour/contrib/hbnf/doc/en/sinkey.txt +++ b/harbour/contrib/hbnf/doc/en/sinkey.txt @@ -2,34 +2,34 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_SINKEY() - * $CATEGORY$ - * Keyboard/Mouse - * $ONELINER$ - * Replacement for INKEY() that tests for SET KEY procedures - * $SYNTAX$ - * FT_SINKEY( [ ] ) -> nKey - * $ARGUMENTS$ - * is the number of seconds to wait. If zero, - * FT_SINKEY() will wait indefinitely for a keypress. If not - * passed, FT_SINKEY() does not wait for a keypress. If NIL, - * it is treated the same as 0. - * $RETURNS$ - * The INKEY() value of the key pressed. - * $DESCRIPTION$ - * FT_SINKEY() is similar to the function provided by Nantucket in - * keyboard.prg, with one significant difference: you can pass NIL - * to INKEY(), which will be treated as a zero (i.e., wait indefinitely - * for keypress). Therefore, it is necessary to differentiate between - * an explicit NIL and one that is a result of a formal parameter NOT - * being received. - * - * FT_SINKEY() differs from the standard INKEY() in that it will - * respond to any keys set with SET KEY TO or SetKey(). - * $EXAMPLES$ - * SetKey( K_F1, {| n, l, r | Help( n, l, r ) } ) - * nKey := FT_SINKEY( 0 ) // Help() will be called if F1 pressed - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SINKEY() + $CATEGORY$ + Keyboard/Mouse + $ONELINER$ + Replacement for INKEY() that tests for SET KEY procedures + $SYNTAX$ + FT_SINKEY( [ ] ) -> nKey + $ARGUMENTS$ + is the number of seconds to wait. If zero, + FT_SINKEY() will wait indefinitely for a keypress. If not + passed, FT_SINKEY() does not wait for a keypress. If NIL, + it is treated the same as 0. + $RETURNS$ + The INKEY() value of the key pressed. + $DESCRIPTION$ + FT_SINKEY() is similar to the function provided by Nantucket in + keyboard.prg, with one significant difference: you can pass NIL + to INKEY(), which will be treated as a zero (i.e., wait indefinitely + for keypress). Therefore, it is necessary to differentiate between + an explicit NIL and one that is a result of a formal parameter NOT + being received. + + FT_SINKEY() differs from the standard INKEY() in that it will + respond to any keys set with SET KEY TO or SetKey(). + $EXAMPLES$ + SetKey( K_F1, {| n, l, r | Help( n, l, r ) } ) + nKey := FT_SINKEY( 0 ) // Help() will be called if F1 pressed + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/sleep.txt b/harbour/contrib/hbnf/doc/en/sleep.txt index 4e3a815cb1..620c7dc4e2 100644 --- a/harbour/contrib/hbnf/doc/en/sleep.txt +++ b/harbour/contrib/hbnf/doc/en/sleep.txt @@ -2,50 +2,50 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_SLEEP - * $CATEGORY$ - * Menus/Prompts - * $ONELINER$ - * Wait for a specified amount of time - * $SYNTAX$ - * FT_SLEEP( , [] ) -> nil - * $ARGUMENTS$ - * is the number of seconds to pause - * - * is an optional clock value (from a call to SECONDS()) - * from which the seconds are to elapse. Useful - * for setting a minimum time between the start of events - * which could take a variable amount of time due to the - * execution of intervening code. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * This routine will wait a specified period of time. It provides - * resolution based upon the execution of the SECONDS() function. - * It does not use an input state such as INKEY(). The specified time - * is the minimum time sleeping and will usually be slightly longer. - * - * The second optional argument allows one to begin timing an event - * prior to executing some operation. This is useful when, for example, - * you input a key or mouse click and wish to do something but still want - * to note if the user double entered (mouse or key) within a certain time - * which in turn may have meaning within your program's context. - * - * The routine correctly handles passing through midnight but will not - * work for more than 24 hours. - * $EXAMPLES$ - * Example 1: - * FT_SLEEP( 10.0 ) // Sleep for 10.0 seconds - * Example 2: - * nTime := SECONDS() // usually after some interupt from mouse or - * // keyboard - * - * ... intervening code ... - * - * FT_SLEEP( 0.5, nTime ) // Sleep until the sytem clock is - * // nTime+0.5 seconds. - * - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SLEEP + $CATEGORY$ + Menus/Prompts + $ONELINER$ + Wait for a specified amount of time + $SYNTAX$ + FT_SLEEP( , [] ) -> nil + $ARGUMENTS$ + is the number of seconds to pause + + is an optional clock value (from a call to SECONDS()) + from which the seconds are to elapse. Useful + for setting a minimum time between the start of events + which could take a variable amount of time due to the + execution of intervening code. + $RETURNS$ + NIL + $DESCRIPTION$ + This routine will wait a specified period of time. It provides + resolution based upon the execution of the SECONDS() function. + It does not use an input state such as INKEY(). The specified time + is the minimum time sleeping and will usually be slightly longer. + + The second optional argument allows one to begin timing an event + prior to executing some operation. This is useful when, for example, + you input a key or mouse click and wish to do something but still want + to note if the user double entered (mouse or key) within a certain time + which in turn may have meaning within your program's context. + + The routine correctly handles passing through midnight but will not + work for more than 24 hours. + $EXAMPLES$ + Example 1: + FT_SLEEP( 10.0 ) // Sleep for 10.0 seconds + Example 2: + nTime := SECONDS() // usually after some interupt from mouse or + // keyboard + + ... intervening code ... + + FT_SLEEP( 0.5, nTime ) // Sleep until the sytem clock is + // nTime+0.5 seconds. + + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/sqzn.txt b/harbour/contrib/hbnf/doc/en/sqzn.txt index e3bc5304c8..7cbcf5d6ec 100644 --- a/harbour/contrib/hbnf/doc/en/sqzn.txt +++ b/harbour/contrib/hbnf/doc/en/sqzn.txt @@ -2,71 +2,71 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_SQZN() - * $CATEGORY$ - * Conversion - * $ONELINER$ - * Compress a numeric value into a character string - * $SYNTAX$ - * FT_SQZN( [, [, ] ] ) -> cCompressed - * $ARGUMENTS$ - * nValue - The numeric value to be compressed - * nSize - Optional size of numeric field, defaults to 10 - * nDecimals - Optional number of decimal places, defaults to 0 - * $RETURNS$ - * cCompressed - Compressed string, 50% the size of nSize - * $DESCRIPTION$ - * The FT_SQZN function allows a numeric value to be compressed when - * stored in the database. The compression is 50% the storage space - * of the original number. The companion function, FT_UNSQZN returns - * the original number from the compressed string. - * - * $EXAMPLES$ - * REPLACE TRANS->cust_id WITH FT_SQZN( mcust_id, 8 ),; - * TRANS->amount WITH FT_SQZN( mamount, 12, 2 ) - * - * $SEEALSO$ - * FT_UNSQZN() - * $INCLUDE$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SQZN() + $CATEGORY$ + Conversion + $ONELINER$ + Compress a numeric value into a character string + $SYNTAX$ + FT_SQZN( [, [, ] ] ) -> cCompressed + $ARGUMENTS$ + nValue - The numeric value to be compressed + nSize - Optional size of numeric field, defaults to 10 + nDecimals - Optional number of decimal places, defaults to 0 + $RETURNS$ + cCompressed - Compressed string, 50% the size of nSize + $DESCRIPTION$ + The FT_SQZN function allows a numeric value to be compressed when + stored in the database. The compression is 50% the storage space + of the original number. The companion function, FT_UNSQZN returns + the original number from the compressed string. + + $EXAMPLES$ + REPLACE TRANS->cust_id WITH FT_SQZN( mcust_id, 8 ),; + TRANS->amount WITH FT_SQZN( mamount, 12, 2 ) + + $SEEALSO$ + FT_UNSQZN() + $INCLUDE$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_UNSQZN() - * $CATEGORY$ - * Conversion - * $ONELINER$ - * Uncompress a numeric compressed by FT_SQZN() - * $SYNTAX$ - * FT_UNSQZN( , [, ] ) -> nValue - * $ARGUMENTS$ - * - Compressed string, obtained from FT_SQZN() - * - * - Size of numeric field - * - * - Optional number of decimal places - * $RETURNS$ - * nValue - Uncompressed numeric value - * $DESCRIPTION$ - * The FT_UNSQZN function returns the numeric value from the compressed - * string. The compression is 50% the storage space of the original - * number. The original number must have been compressed using the - * FT_SQZN() function. - * - * This function, along with FT_SQZN() can be used to reduce disk storage - * requirements for numeric fields in a database file. - * - * $EXAMPLES$ - * mcust_id := FT_UNSQZN( TRANS->cust_id, 8 ),; - * mamount := FT_UNSQZN( TRANS->amount, 12, 2 ) - * - * $SEEALSO$ - * FT_SQZN() - * $INCLUDE$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_UNSQZN() + $CATEGORY$ + Conversion + $ONELINER$ + Uncompress a numeric compressed by FT_SQZN() + $SYNTAX$ + FT_UNSQZN( , [, ] ) -> nValue + $ARGUMENTS$ + - Compressed string, obtained from FT_SQZN() + + - Size of numeric field + + - Optional number of decimal places + $RETURNS$ + nValue - Uncompressed numeric value + $DESCRIPTION$ + The FT_UNSQZN function returns the numeric value from the compressed + string. The compression is 50% the storage space of the original + number. The original number must have been compressed using the + FT_SQZN() function. + + This function, along with FT_SQZN() can be used to reduce disk storage + requirements for numeric fields in a database file. + + $EXAMPLES$ + mcust_id := FT_UNSQZN( TRANS->cust_id, 8 ),; + mamount := FT_UNSQZN( TRANS->amount, 12, 2 ) + + $SEEALSO$ + FT_SQZN() + $INCLUDE$ + + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/stod.txt b/harbour/contrib/hbnf/doc/en/stod.txt index e7def305b3..d421ba2653 100644 --- a/harbour/contrib/hbnf/doc/en/stod.txt +++ b/harbour/contrib/hbnf/doc/en/stod.txt @@ -2,25 +2,25 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_SToD() - * $CATEGORY$ - * Conversion - * $ONELINER$ - * Convert a date string to a Clipper date data type - * $SYNTAX$ - * FT_SToD( ) -> dDateType - * $ARGUMENTS$ - * is a Clipper string in the format "CCYYMMDD". - * $RETURNS$ - * A Clipper date type. - * $DESCRIPTION$ - * This function allows the programmer to hard code a date into the - * program without knowing what the current date type is. This - * function is the converse of the Clipper DTOS() function. - * $EXAMPLES$ - * LOCAL dMyDate - * dMyDate := FT_SToD( "19901127" ) - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SToD() + $CATEGORY$ + Conversion + $ONELINER$ + Convert a date string to a Clipper date data type + $SYNTAX$ + FT_SToD( ) -> dDateType + $ARGUMENTS$ + is a Clipper string in the format "CCYYMMDD". + $RETURNS$ + A Clipper date type. + $DESCRIPTION$ + This function allows the programmer to hard code a date into the + program without knowing what the current date type is. This + function is the converse of the Clipper DTOS() function. + $EXAMPLES$ + LOCAL dMyDate + dMyDate := FT_SToD( "19901127" ) + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/sysmem.txt b/harbour/contrib/hbnf/doc/en/sysmem.txt index 991a260e3f..8f30b9ce8d 100644 --- a/harbour/contrib/hbnf/doc/en/sysmem.txt +++ b/harbour/contrib/hbnf/doc/en/sysmem.txt @@ -2,28 +2,28 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_SYSMEM() - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Determine the amount of conventional memory installed - * $SYNTAX$ - * FT_SYSMEM() -> nMemSize - * $ARGUMENTS$ - * None - * $RETURNS$ - * A numeric corresponding to the number of K memory. - * $DESCRIPTION$ - * FT_SYSMEM() simply reports the amount of conventional memory - * (up to 640K) installed. - * - * FT_SYSMEM() uses DOS interrupt 12h to get this information. - * For information, refer to Peter Norton's _Programmer's Guide - * to the IBM PC_ (Brady). - * - * $EXAMPLES$ - * ? "Conventional memory installed: " + Str( FT_SYSMEM() ) + "K" - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SYSMEM() + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Determine the amount of conventional memory installed + $SYNTAX$ + FT_SYSMEM() -> nMemSize + $ARGUMENTS$ + None + $RETURNS$ + A numeric corresponding to the number of K memory. + $DESCRIPTION$ + FT_SYSMEM() simply reports the amount of conventional memory + (up to 640K) installed. + + FT_SYSMEM() uses DOS interrupt 12h to get this information. + For information, refer to Peter Norton's _Programmer's Guide + to the IBM PC_ (Brady). + + $EXAMPLES$ + ? "Conventional memory installed: " + Str( FT_SYSMEM() ) + "K" + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/tbwhile.txt b/harbour/contrib/hbnf/doc/en/tbwhile.txt index f9611330bf..72998cd406 100644 --- a/harbour/contrib/hbnf/doc/en/tbwhile.txt +++ b/harbour/contrib/hbnf/doc/en/tbwhile.txt @@ -2,89 +2,89 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_BRWSWHL() - * $CATEGORY$ - * Menus/Prompts - * $ONELINER$ - * Browse an indexed database limited to a while condition - * $SYNTAX$ - * FT_BRWSWHL( , , , ; - * [ ], [ ], [ ], ; - * [ ], [ ], [ ], ; - * [ ], [ ] -> nRecno - * $ARGUMENTS$ - * is array of field blocks of fields you want to display. - * Example to set up last name and first name in array: - * aFields := {} - * AAdd( aFields, { "Last Name" , {|| Names->Last } } ) - * AAdd( aFields, { "First Name", {|| Names->First } } ) - * - * is the limiting WHILE condition as a block. - * Example 1: {|| Names->Last == "JONES" } - * Example 2: {|| Names->Last == "JONES" .AND. Names->First == "A" } - * - * is the key to find top condition of WHILE. - * cLast := "JONES " - * cFirst := "A" - * Example 1: cKey := cLast - * Example 2: cKey := cLast + cFirst - * - * is number of fields to freeze in TBrowse. Defaults - * to 0 if not passed. - * - * is a logical indicating whether or not you want to - * save the screen from the calling program. Defaults to .T. if - * not passed. - * - * is a list of colors for the TBrowse columns. - * The 1st color is used as SAY/TBrowse Background and the - * 3rd and 4th colors are used as part of column:defColor := {3, 4} - * - * Thus if you pass a cColorList, you MUST pass at least 4 colors. - * Defaults to "N/W, N/BG, B/W, B/BG, B/W, B/BG, R/W, B/R" if not passed. - * - * is the color of the TBrowse box shadow. Defaults - * to "N/N" if not passed. - * - * , , , are the coordinates of - * the area to display the TBrowse in. Defaults to 2, 2, - * MAXROW() - 2, MAXCOL() - 2 with shadowed box, i.e. full screen. - * $RETURNS$ - * nRecno is the number of the record selected by the key. - * 0 is returned if there are either no records matching the WHILE - * condition or an is pressed instead of an - * $DESCRIPTION$ - * This is a demonstration of TBrowse with a WHILE condition for an - * indexed database. - * $EXAMPLES$ - * * This example will only show those people with last name of "JONES" - * * in the TBNames.dbf which contains at least the fields: - * * Last, First, City AND is indexed on Last + First. - * LOCAL nRecSel := 0 - * LOCAL aFields := {} - * LOCAL bWhile := {|| TBNames->Last = "JONES" } - * LOCAL cKey := "JONES" - * LOCAL nFreeze := 1 - * LOCAL lSaveScrn := .T. - * LOCAL cColorList := "N/W, N/BG, B/W, B/BG, B/W, B/BG, R/W, B/R" - * LOCAL cColorShad := "N/N" - * - * USE TBNames INDEX TBNames NEW // indexed on Last + First - * - * * Pass Heading as character and Field as Block including Alias - * * To eliminate the need to use FIELDWBLOCK() function in FT_BRWSWHL() - * AAdd( aFields, { "Last Name" , {|| TBNames->Last } } ) - * AAdd( aFields, { "First Name", {|| TBNames->First } } ) - * AAdd( aFields, { "City" , {|| TBNames->City } } ) - * - * IF FT_BRWSWHL( aFields, bWhile, cKey, nFreeze, lSaveScrn, ; - * cColorList, cColorShad, 3, 6, MaxRow() - 2, MaxCol() - 6 ) == 0 - * ? "Sorry, NO Records Were Selected" - * ELSE - * ? "You Selected: " + TBNames->Last + " " + ; - * TBNames->First + " " + TBNames->City - * ENDIF - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_BRWSWHL() + $CATEGORY$ + Menus/Prompts + $ONELINER$ + Browse an indexed database limited to a while condition + $SYNTAX$ + FT_BRWSWHL( , , , ; + [ ], [ ], [ ], ; + [ ], [ ], [ ], ; + [ ], [ ] -> nRecno + $ARGUMENTS$ + is array of field blocks of fields you want to display. + Example to set up last name and first name in array: + aFields := {} + AAdd( aFields, { "Last Name" , {|| Names->Last } } ) + AAdd( aFields, { "First Name", {|| Names->First } } ) + + is the limiting WHILE condition as a block. + Example 1: {|| Names->Last == "JONES" } + Example 2: {|| Names->Last == "JONES" .AND. Names->First == "A" } + + is the key to find top condition of WHILE. + cLast := "JONES " + cFirst := "A" + Example 1: cKey := cLast + Example 2: cKey := cLast + cFirst + + is number of fields to freeze in TBrowse. Defaults + to 0 if not passed. + + is a logical indicating whether or not you want to + save the screen from the calling program. Defaults to .T. if + not passed. + + is a list of colors for the TBrowse columns. + The 1st color is used as SAY/TBrowse Background and the + 3rd and 4th colors are used as part of column:defColor := {3, 4} + + Thus if you pass a cColorList, you MUST pass at least 4 colors. + Defaults to "N/W, N/BG, B/W, B/BG, B/W, B/BG, R/W, B/R" if not passed. + + is the color of the TBrowse box shadow. Defaults + to "N/N" if not passed. + + , , , are the coordinates of + the area to display the TBrowse in. Defaults to 2, 2, + MAXROW() - 2, MAXCOL() - 2 with shadowed box, i.e. full screen. + $RETURNS$ + nRecno is the number of the record selected by the key. + 0 is returned if there are either no records matching the WHILE + condition or an is pressed instead of an + $DESCRIPTION$ + This is a demonstration of TBrowse with a WHILE condition for an + indexed database. + $EXAMPLES$ + * This example will only show those people with last name of "JONES" + * in the TBNames.dbf which contains at least the fields: + * Last, First, City AND is indexed on Last + First. + LOCAL nRecSel := 0 + LOCAL aFields := {} + LOCAL bWhile := {|| TBNames->Last = "JONES" } + LOCAL cKey := "JONES" + LOCAL nFreeze := 1 + LOCAL lSaveScrn := .T. + LOCAL cColorList := "N/W, N/BG, B/W, B/BG, B/W, B/BG, R/W, B/R" + LOCAL cColorShad := "N/N" + + USE TBNames INDEX TBNames NEW // indexed on Last + First + + * Pass Heading as character and Field as Block including Alias + * To eliminate the need to use FIELDWBLOCK() function in FT_BRWSWHL() + AAdd( aFields, { "Last Name" , {|| TBNames->Last } } ) + AAdd( aFields, { "First Name", {|| TBNames->First } } ) + AAdd( aFields, { "City" , {|| TBNames->City } } ) + + IF FT_BRWSWHL( aFields, bWhile, cKey, nFreeze, lSaveScrn, ; + cColorList, cColorShad, 3, 6, MaxRow() - 2, MaxCol() - 6 ) == 0 + ? "Sorry, NO Records Were Selected" + ELSE + ? "You Selected: " + TBNames->Last + " " + ; + TBNames->First + " " + TBNames->City + ENDIF + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/tempfile.txt b/harbour/contrib/hbnf/doc/en/tempfile.txt index ecc3ff5627..d14ee8af4f 100644 --- a/harbour/contrib/hbnf/doc/en/tempfile.txt +++ b/harbour/contrib/hbnf/doc/en/tempfile.txt @@ -2,48 +2,48 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_TEMPFIL() - * $CATEGORY$ - * DOS/BIOS - * $ONELINER$ - * Create a file with a unique name - * $SYNTAX$ - * FT_TEMPFIL( [ ] [, ] ) -> cFileSpec - * $ARGUMENTS$ - * is the directory where you want to create the temporary - * file. If you omit this argument, the root of the current drive - * is assumed ("\"). - * - * If is .T., then the file will be created with the hidden - * attribute set. The default is .F. - * $RETURNS$ - * should be your path, including the name of the newly - * created unique file. Use this with FOPEN(), etc. - * - * If a DOS error occurred when trying to create the file, a - * null string will be returned. - * - * $DESCRIPTION$ - * This function uses DOS Interrupt 21, service 5Ah (Create temporary - * file) to create a unique filename in a directory you specify. - * There will be no extension. After the file is created, you may - * then fopen() it and do any i/o you need (see the test driver - * in the source code). - * - * This function requires FT_INT86(). - * $EXAMPLES$ - * Create a unique file in the root of the current drive: - * - * myFile := FT_TEMPFIL() - * - * Create a unique file in the current directory and hide it: - * - * myFile := FT_TEMPFIL( "." + hb_ps(), .T. ) - * - * Create a unique file on another drive, but do not hide it: - * - * myFile := FT_TEMPFIL( "E:\nanfor\src\" ) - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_TEMPFIL() + $CATEGORY$ + DOS/BIOS + $ONELINER$ + Create a file with a unique name + $SYNTAX$ + FT_TEMPFIL( [ ] [, ] ) -> cFileSpec + $ARGUMENTS$ + is the directory where you want to create the temporary + file. If you omit this argument, the root of the current drive + is assumed ("\"). + + If is .T., then the file will be created with the hidden + attribute set. The default is .F. + $RETURNS$ + should be your path, including the name of the newly + created unique file. Use this with FOPEN(), etc. + + If a DOS error occurred when trying to create the file, a + null string will be returned. + + $DESCRIPTION$ + This function uses DOS Interrupt 21, service 5Ah (Create temporary + file) to create a unique filename in a directory you specify. + There will be no extension. After the file is created, you may + then fopen() it and do any i/o you need (see the test driver + in the source code). + + This function requires FT_INT86(). + $EXAMPLES$ + Create a unique file in the root of the current drive: + + myFile := FT_TEMPFIL() + + Create a unique file in the current directory and hide it: + + myFile := FT_TEMPFIL( "." + hb_ps(), .T. ) + + Create a unique file on another drive, but do not hide it: + + myFile := FT_TEMPFIL( "E:\nanfor\src\" ) + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/vertmenu.txt b/harbour/contrib/hbnf/doc/en/vertmenu.txt index 91520546f5..9a5f5f562b 100644 --- a/harbour/contrib/hbnf/doc/en/vertmenu.txt +++ b/harbour/contrib/hbnf/doc/en/vertmenu.txt @@ -2,46 +2,46 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_MENU2() - * $CATEGORY$ - * Menus/Prompts - * $ONELINER$ - * Vertical lightbar menu - * $SYNTAX$ - * FT_MENU2( [, ] ) -> NIL - * $ARGUMENTS$ - * is an array of menu options, messages, and action - * blocks. - * - * Each element in this array is a nested array with the structure: - * - * element[ x, 1 ] = menu option - * element[ x, 2 ] = message to be displayed when option is highlighted - * element[ x, 3 ] = code block to be executed when option is selected - * - * is a string containing colors for the prompts, in the same - * format as that returned by Set( _SET_COLOR ). If not supplied, - * colors default to the current color setting. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * This function greatly simplifies the process of displaying light-bar - * menus. All prompts are padded out with spaces so they are the same - * length, a box is drawn around the prompts, the box is automatically - * centered on the screen, and the underlying screen is restored after - * a menu selection has been made. - * - * Additionally, because you can tie action blocks to each menu - * option, you can save on a lot of DO CASE or IF..ELSEIF code in your - * main program. See the test code for a succinct demonstration. - * $EXAMPLES$ - * LOCAL mainmenu := ; - * { { "Data Entry", "Enter data", {|| FT_MENU2( datamenu ) } }, ; - * { "Reports", "Hard copy", {|| FT_MENU2( repmenu ) } }, ; - * { "Maintenance", "Reindex files", {|| FT_MENU2( maintmenu ) } }, ; - * { "Quit", "See ya later" } } - * FT_MENU2( mainmenu ) - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_MENU2() + $CATEGORY$ + Menus/Prompts + $ONELINER$ + Vertical lightbar menu + $SYNTAX$ + FT_MENU2( [, ] ) -> NIL + $ARGUMENTS$ + is an array of menu options, messages, and action + blocks. + + Each element in this array is a nested array with the structure: + + element[ x, 1 ] = menu option + element[ x, 2 ] = message to be displayed when option is highlighted + element[ x, 3 ] = code block to be executed when option is selected + + is a string containing colors for the prompts, in the same + format as that returned by Set( _SET_COLOR ). If not supplied, + colors default to the current color setting. + $RETURNS$ + NIL + $DESCRIPTION$ + This function greatly simplifies the process of displaying light-bar + menus. All prompts are padded out with spaces so they are the same + length, a box is drawn around the prompts, the box is automatically + centered on the screen, and the underlying screen is restored after + a menu selection has been made. + + Additionally, because you can tie action blocks to each menu + option, you can save on a lot of DO CASE or IF..ELSEIF code in your + main program. See the test code for a succinct demonstration. + $EXAMPLES$ + LOCAL mainmenu := ; + { { "Data Entry", "Enter data", {|| FT_MENU2( datamenu ) } }, ; + { "Reports", "Hard copy", {|| FT_MENU2( repmenu ) } }, ; + { "Maintenance", "Reindex files", {|| FT_MENU2( maintmenu ) } }, ; + { "Quit", "See ya later" } } + FT_MENU2( mainmenu ) + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/vidcur.txt b/harbour/contrib/hbnf/doc/en/vidcur.txt index 582f7e1e82..d1711c1453 100644 --- a/harbour/contrib/hbnf/doc/en/vidcur.txt +++ b/harbour/contrib/hbnf/doc/en/vidcur.txt @@ -2,75 +2,75 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_SETVCUR() - * $CATEGORY$ - * Video - * $ONELINER$ - * Set the cursor position on a specified video page - * $SYNTAX$ - * FT_SETVCUR( [ ], [ ], [ ] ) -> NIL - * $ARGUMENTS$ - * is the video page (defaults to current page, determined - * by FT_GETVPG() - * - * is the row coordinate (defaults to 0 ) - * - * is the column coordinate (defaults to 0 ) - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * FT_SETVCUR() sets the cursor position on a specific video page. - * It uses FT_INT86() to invoke interrupt 10h, function 2. - * - * For more information on graphics programming, cursors, and video - * pages, refer to Richard Wilton's _Programmer's Guide to PC and - * PS/2 Video Systems_ (Microsoft Press). - * - * $EXAMPLES$ - * // Set the position to row 5, column 10 on video page 1: - * - * FT_SETVCUR( 1, 5, 10 ) - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SETVCUR() + $CATEGORY$ + Video + $ONELINER$ + Set the cursor position on a specified video page + $SYNTAX$ + FT_SETVCUR( [ ], [ ], [ ] ) -> NIL + $ARGUMENTS$ + is the video page (defaults to current page, determined + by FT_GETVPG() + + is the row coordinate (defaults to 0 ) + + is the column coordinate (defaults to 0 ) + $RETURNS$ + NIL + $DESCRIPTION$ + FT_SETVCUR() sets the cursor position on a specific video page. + It uses FT_INT86() to invoke interrupt 10h, function 2. + + For more information on graphics programming, cursors, and video + pages, refer to Richard Wilton's _Programmer's Guide to PC and + PS/2 Video Systems_ (Microsoft Press). + + $EXAMPLES$ + // Set the position to row 5, column 10 on video page 1: + + FT_SETVCUR( 1, 5, 10 ) + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_GETVCUR() - * $CATEGORY$ - * Video - * $ONELINER$ - * Return info about the cursor on a specified video page - * $SYNTAX$ - * FT_GETVCUR( [] ) -> - * $ARGUMENTS$ - * is the video page to get the cursor information for. - * Defaults to the current page, as returned by FT_GETVPG(). - * $RETURNS$ - * A four-element array (), set up as follows: - * - * aCurInfo[ 1 ] = Top line of cursor - * aCurInfo[ 2 ] = Bottom line of cursor - * aCurInfo[ 3 ] = Character row - * aCurInfo[ 4 ] = Character column - * - * $DESCRIPTION$ - * FT_GETVCUR() uses FT_INT86() to invoke interrupt 10h, function - * 3, to return the character cursor location for the specified - * video page. - * - * The top line and bottom line of cursor are set depending on - * the current cursor mode, and are only meaningful in alphanumeric - * video modes. - * - * For more information on graphics programming, cursors, and - * cursor modes, refer to Richard Wilton's _Programmer's Guide to - * PC and PS/2 Video Systems_ (Microsoft Press). - * - * $EXAMPLES$ - * aCurInfo := getVCur( 1 ) // Get info on cursor pos in page 1 - * ? "Row: " + Str( aCurInfo[ 3 ] ) + " Col: " + Str( aCurInfo[ 4 ] ) - * - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_GETVCUR() + $CATEGORY$ + Video + $ONELINER$ + Return info about the cursor on a specified video page + $SYNTAX$ + FT_GETVCUR( [] ) -> + $ARGUMENTS$ + is the video page to get the cursor information for. + Defaults to the current page, as returned by FT_GETVPG(). + $RETURNS$ + A four-element array (), set up as follows: + + aCurInfo[ 1 ] = Top line of cursor + aCurInfo[ 2 ] = Bottom line of cursor + aCurInfo[ 3 ] = Character row + aCurInfo[ 4 ] = Character column + + $DESCRIPTION$ + FT_GETVCUR() uses FT_INT86() to invoke interrupt 10h, function + 3, to return the character cursor location for the specified + video page. + + The top line and bottom line of cursor are set depending on + the current cursor mode, and are only meaningful in alphanumeric + video modes. + + For more information on graphics programming, cursors, and + cursor modes, refer to Richard Wilton's _Programmer's Guide to + PC and PS/2 Video Systems_ (Microsoft Press). + + $EXAMPLES$ + aCurInfo := getVCur( 1 ) // Get info on cursor pos in page 1 + ? "Row: " + Str( aCurInfo[ 3 ] ) + " Col: " + Str( aCurInfo[ 4 ] ) + + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/video1.txt b/harbour/contrib/hbnf/doc/en/video1.txt index e8325fbdbc..05481362ba 100644 --- a/harbour/contrib/hbnf/doc/en/video1.txt +++ b/harbour/contrib/hbnf/doc/en/video1.txt @@ -2,198 +2,198 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_VIDSTR() - * $CATEGORY$ - * Video - * $ONELINER$ - * Display string on screen in specified attribute - * $SYNTAX$ - * FT_VIDSTR( , , [, ] ) -> NIL - * $ARGUMENTS$ - * and are the screen coordinates. - * - * is the string to be printed on the screen. - * - * is an integer representing the color attribute. - * The formula is: - * - * nFore + ( nBack * 16 ) - * - * FT_VIDSTR() will display the string in the current color if - * is not passed. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * This is a high speed function to display a string of any ASCII - * characters on screen in a specified color attribute. This function - * is useful for constructing screens with a lot of text or repetitive - * screen prints where speed is important. - * $EXAMPLES$ - * FT_VIDSTR( 10, 20, "Enter Name :", 165 ) - * - * This example will print the specified text at coordinates 10, 20 - * in bright white on top of Magenta. - * - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_VIDSTR() + $CATEGORY$ + Video + $ONELINER$ + Display string on screen in specified attribute + $SYNTAX$ + FT_VIDSTR( , , [, ] ) -> NIL + $ARGUMENTS$ + and are the screen coordinates. + + is the string to be printed on the screen. + + is an integer representing the color attribute. + The formula is: + + nFore + ( nBack * 16 ) + + FT_VIDSTR() will display the string in the current color if + is not passed. + $RETURNS$ + NIL + $DESCRIPTION$ + This is a high speed function to display a string of any ASCII + characters on screen in a specified color attribute. This function + is useful for constructing screens with a lot of text or repetitive + screen prints where speed is important. + $EXAMPLES$ + FT_VIDSTR( 10, 20, "Enter Name :", 165 ) + + This example will print the specified text at coordinates 10, 20 + in bright white on top of Magenta. + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_WRTChr() - * $CATEGORY$ - * Video - * $ONELINER$ - * Display character on screen - * $SYNTAX$ - * FT_WRTChr( , , , ) -> NIL - * $ARGUMENTS$ - * and are the screen coordinates. - * - * is the single character to print on the screen. - * - * is an integer representing the color attribute. - * The formula is: - * - * nFore + ( nBack * 16 ) - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * This is a high speed function to display a single ASCII character - * on screen in a specified color attribute. This function is useful - * for constructing screens with a lot of text or repetitive screen prints - * where speed is important. It is faster and requires less memory than - * FT_VIDSTR(). A working example is contained in clrtable.prg. - * $EXAMPLES$ - * FOR nX = 1 to MaxRow() - * FOR nY = 1 to MaxCol() - * FT_WRTChr( nX, nY, "∙", ( nX - 1 ) + ( nY * 16 ) ) - * NEXT - * NEXT - * - * This example will write the ASCII character 249 to every location - * on screen in every possible color combination. It will recognize - * the status of SetBlink(). It uses direct video writes for speed. - * - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_WRTChr() + $CATEGORY$ + Video + $ONELINER$ + Display character on screen + $SYNTAX$ + FT_WRTChr( , , , ) -> NIL + $ARGUMENTS$ + and are the screen coordinates. + + is the single character to print on the screen. + + is an integer representing the color attribute. + The formula is: + + nFore + ( nBack * 16 ) + $RETURNS$ + NIL + $DESCRIPTION$ + This is a high speed function to display a single ASCII character + on screen in a specified color attribute. This function is useful + for constructing screens with a lot of text or repetitive screen prints + where speed is important. It is faster and requires less memory than + FT_VIDSTR(). A working example is contained in clrtable.prg. + $EXAMPLES$ + FOR nX = 1 to MaxRow() + FOR nY = 1 to MaxCol() + FT_WRTChr( nX, nY, "∙", ( nX - 1 ) + ( nY * 16 ) ) + NEXT + NEXT + + This example will write the ASCII character 249 to every location + on screen in every possible color combination. It will recognize + the status of SetBlink(). It uses direct video writes for speed. + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_CLS() - * $CATEGORY$ - * Video - * $ONELINER$ - * Clear screen - * $SYNTAX$ - * FT_CLS( , , , , ) -> NIL - * $ARGUMENTS$ - * , , and are the screen coordinates - * to clear. - * - * is an integer representing the color attribute. - * The formula is: - * - * nFore + ( nBack * 16 ) - * - * The default is black. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * This is a high speed function to clear the screen at the given - * coordinates with the given color attribute. This does not change - * Clipper's color settings. It uses direct video writes for speed. - * - * $EXAMPLES$ - * FT_CLS( 0, 0, MaxRow(), MaxCol(), 165 ) - * - * This example will clear the entire screen with the colors - * bright white on magenta. - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_CLS() + $CATEGORY$ + Video + $ONELINER$ + Clear screen + $SYNTAX$ + FT_CLS( , , , , ) -> NIL + $ARGUMENTS$ + , , and are the screen coordinates + to clear. + + is an integer representing the color attribute. + The formula is: + + nFore + ( nBack * 16 ) + + The default is black. + $RETURNS$ + NIL + $DESCRIPTION$ + This is a high speed function to clear the screen at the given + coordinates with the given color attribute. This does not change + Clipper's color settings. It uses direct video writes for speed. + + $EXAMPLES$ + FT_CLS( 0, 0, MaxRow(), MaxCol(), 165 ) + + This example will clear the entire screen with the colors + bright white on magenta. + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_SETATTR() - * $CATEGORY$ - * Video - * $ONELINER$ - * Change color attributes of screen region - * $SYNTAX$ - * FT_SETATTR( , , , , ) -> NIL - * $ARGUMENTS$ - * , , , and are the coordinates of the - * screen region. - * - * is an integer representing the new color attribute. - * The formula is: - * - * nFore + ( nBack * 16 ) - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * This is a high speed function to change the colors of a specified - * region of the screen without disturbing any text. Uses direct - * video writes. - * $EXAMPLES$ - * FT_SETATTR( 0, 0, MaxRow(), MaxCol(), 95 ) - * - * This example will change the entire screen's colors to bright white on - * magenta without changing or overwriting any text on the screen. - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SETATTR() + $CATEGORY$ + Video + $ONELINER$ + Change color attributes of screen region + $SYNTAX$ + FT_SETATTR( , , , , ) -> NIL + $ARGUMENTS$ + , , , and are the coordinates of the + screen region. + + is an integer representing the new color attribute. + The formula is: + + nFore + ( nBack * 16 ) + $RETURNS$ + NIL + $DESCRIPTION$ + This is a high speed function to change the colors of a specified + region of the screen without disturbing any text. Uses direct + video writes. + $EXAMPLES$ + FT_SETATTR( 0, 0, MaxRow(), MaxCol(), 95 ) + + This example will change the entire screen's colors to bright white on + magenta without changing or overwriting any text on the screen. + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_REVATTR() - * $CATEGORY$ - * Video - * $ONELINER$ - * Reverse colors of specified screen coordinates - * $SYNTAX$ - * FT_REVATTR( , , , ) -> NIL - * $ARGUMENTS$ - * , , , and are the coordinates of the - * screen region. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * This is a high speed function to reverse the color of a specified - * screen region without disturbing any text on the screen. This - * function will correctly reverse the color attributes in a region - * containing multiple color combinations. - * $EXAMPLES$ - * FT_REVATTR( 0, 0, MaxRow(), MaxCol() ) - * - * This example will change the entire screen's colors to their reverse - * attributes without changing or overwriting any text. - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_REVATTR() + $CATEGORY$ + Video + $ONELINER$ + Reverse colors of specified screen coordinates + $SYNTAX$ + FT_REVATTR( , , , ) -> NIL + $ARGUMENTS$ + , , , and are the coordinates of the + screen region. + $RETURNS$ + NIL + $DESCRIPTION$ + This is a high speed function to reverse the color of a specified + screen region without disturbing any text on the screen. This + function will correctly reverse the color attributes in a region + containing multiple color combinations. + $EXAMPLES$ + FT_REVATTR( 0, 0, MaxRow(), MaxCol() ) + + This example will change the entire screen's colors to their reverse + attributes without changing or overwriting any text. + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_REVCHR() - * $CATEGORY$ - * Video - * $ONELINER$ - * Reverse the color of a single character on the screen - * $SYNTAX$ - * FT_REVCHR( , ) -> NIL - * $ARGUMENTS$ - * , are the screen coordinates of the character. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * This is a high speed function to reverse the color of a single - * character on the screen without changing the character itself. - * This function is the same as FT_REVATTR() except that it changes - * only one character on screen and hence is faster and uses less memory. - * $EXAMPLES$ - * FT_REVCHR( 10, 20 ) - * - * This example will change the text and background at 10, 20 to it's - * reverse color attributes without changing or overwriting the - * character itself. - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_REVCHR() + $CATEGORY$ + Video + $ONELINER$ + Reverse the color of a single character on the screen + $SYNTAX$ + FT_REVCHR( , ) -> NIL + $ARGUMENTS$ + , are the screen coordinates of the character. + $RETURNS$ + NIL + $DESCRIPTION$ + This is a high speed function to reverse the color of a single + character on the screen without changing the character itself. + This function is the same as FT_REVATTR() except that it changes + only one character on screen and hence is faster and uses less memory. + $EXAMPLES$ + FT_REVCHR( 10, 20 ) + + This example will change the text and background at 10, 20 to it's + reverse color attributes without changing or overwriting the + character itself. + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/vidmode.txt b/harbour/contrib/hbnf/doc/en/vidmode.txt index 913f9e921f..38d0e1a61a 100644 --- a/harbour/contrib/hbnf/doc/en/vidmode.txt +++ b/harbour/contrib/hbnf/doc/en/vidmode.txt @@ -2,58 +2,58 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_SETMODE() - * $CATEGORY$ - * Video - * $ONELINER$ - * Set the video mode - * $SYNTAX$ - * FT_SETMODE( ) -> NIL - * $ARGUMENTS$ - * is one of the DOS video modes. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * Use this function to put your display adapter into a video mode. - * Uses DOS interrupt 10h to set the mode. For a table of modes - * available on various graphics adapters, refer to a book such - * as Wilton's "Programmer's Guide to PC & PS/2 Video Systems" - * (Microsoft Press) - * $EXAMPLES$ - * PROCEDURE Main( cMode ) - * FT_SETMODE( Val( cMode ) ) - * ? "Video mode is: " + Str( FT_GETMODE() ) - * RETURN - * $SEEALSO$ - * FT_ADAPTER() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_SETMODE() + $CATEGORY$ + Video + $ONELINER$ + Set the video mode + $SYNTAX$ + FT_SETMODE( ) -> NIL + $ARGUMENTS$ + is one of the DOS video modes. + $RETURNS$ + NIL + $DESCRIPTION$ + Use this function to put your display adapter into a video mode. + Uses DOS interrupt 10h to set the mode. For a table of modes + available on various graphics adapters, refer to a book such + as Wilton's "Programmer's Guide to PC & PS/2 Video Systems" + (Microsoft Press) + $EXAMPLES$ + PROCEDURE Main( cMode ) + FT_SETMODE( Val( cMode ) ) + ? "Video mode is: " + Str( FT_GETMODE() ) + RETURN + $SEEALSO$ + FT_ADAPTER() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_GETMODE() - * $CATEGORY$ - * Video - * $ONELINER$ - * Get the video mode - * $SYNTAX$ - * FT_GETMODE() -> nVMode - * $ARGUMENTS$ - * None. - * $RETURNS$ - * The video mode, as a numeric. - * $DESCRIPTION$ - * Use this function to find out what mode your display adapter is in. - * Uses DOS interrupt 10h to get the mode. For a table of modes - * available on various graphics adapters, refer to a book such - * as Wilton's "Programmer's Guide to PC & PS/2 Video Systems" - * (Microsoft Press) - * $EXAMPLES$ - * PROCEDURE Main( cMode ) - * FT_SETMODE( Val( cMode ) ) - * ? "Video mode is: " + Str( FT_GETMODE() ) - * RETURN - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_GETMODE() + $CATEGORY$ + Video + $ONELINER$ + Get the video mode + $SYNTAX$ + FT_GETMODE() -> nVMode + $ARGUMENTS$ + None. + $RETURNS$ + The video mode, as a numeric. + $DESCRIPTION$ + Use this function to find out what mode your display adapter is in. + Uses DOS interrupt 10h to get the mode. For a table of modes + available on various graphics adapters, refer to a book such + as Wilton's "Programmer's Guide to PC & PS/2 Video Systems" + (Microsoft Press) + $EXAMPLES$ + PROCEDURE Main( cMode ) + FT_SETMODE( Val( cMode ) ) + ? "Video mode is: " + Str( FT_GETMODE() ) + RETURN + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/wda.txt b/harbour/contrib/hbnf/doc/en/wda.txt index ba19199803..b6441f8372 100644 --- a/harbour/contrib/hbnf/doc/en/wda.txt +++ b/harbour/contrib/hbnf/doc/en/wda.txt @@ -2,45 +2,45 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_ADDWKDY() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Return true number of days to add given number of workdays - * $SYNTAX$ - * FT_ADDWKDY( , ) -> nTrueDays - * $ARGUMENTS$ - * = date to start adding from - * = number of workdays to add - * $RETURNS$ - * = Number of actual days to add to in - * order to add the required - * $DESCRIPTION$ - * Let's say you are given the problem: - * - * "All invoices are due 10 working days from the date they - * are printed. Please display the due date on the invoice." - * - * When is the due date? Assuming you are printing the invoices - * today, your answer is: - * - * dDueDate := DATE() + ft_addWkDay( Date(), 10 ) - * - * A work day is defined as Monday through Friday. Unfortunately - * this routine does _not_ account for holidays. - * - * This documentation was written by Glenn Scott so if it's wrong, - * blame him. - * - * $EXAMPLES$ - * // Postdate 5 working days from the first of January - * dPost := SToD( "19910101" ) - * dPost += FT_ADDWKDY( dPost, 5 ) // returns 7 true days - * ? dPost // 01/08/91 - * - * $SEEALSO$ - * FT_WORKDAYS() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_ADDWKDY() + $CATEGORY$ + Date/Time + $ONELINER$ + Return true number of days to add given number of workdays + $SYNTAX$ + FT_ADDWKDY( , ) -> nTrueDays + $ARGUMENTS$ + = date to start adding from + = number of workdays to add + $RETURNS$ + = Number of actual days to add to in + order to add the required + $DESCRIPTION$ + Let's say you are given the problem: + + "All invoices are due 10 working days from the date they + are printed. Please display the due date on the invoice." + + When is the due date? Assuming you are printing the invoices + today, your answer is: + + dDueDate := DATE() + ft_addWkDay( Date(), 10 ) + + A work day is defined as Monday through Friday. Unfortunately + this routine does _not_ account for holidays. + + This documentation was written by Glenn Scott so if it's wrong, + blame him. + + $EXAMPLES$ + // Postdate 5 working days from the first of January + dPost := SToD( "19910101" ) + dPost += FT_ADDWKDY( dPost, 5 ) // returns 7 true days + ? dPost // 01/08/91 + + $SEEALSO$ + FT_WORKDAYS() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/week.txt b/harbour/contrib/hbnf/doc/en/week.txt index 1bc0f5067e..85b6dfe610 100644 --- a/harbour/contrib/hbnf/doc/en/week.txt +++ b/harbour/contrib/hbnf/doc/en/week.txt @@ -2,60 +2,60 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_WEEK() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Return calendar or fiscal week data - * $SYNTAX$ - * FT_WEEK( [ ], [ ] ) -> aDateinfo - * $ARGUMENTS$ - * is any valid date in any date format. Defaults - * to current system date if not supplied. - * - * is a number from 1 to 53 signifying a week. - * Defaults to current week if not supplied. - * $RETURNS$ - * A three element array containing the following data: - * - * aDateInfo[ 1 ] - The year and week as a character string "YYYYWW" - * aDateInfo[ 2 ] - The beginning date of the week - * aDateInfo[ 3 ] - The ending date of the week - * $DESCRIPTION$ - * FT_WEEK() returns an array containing data about the week - * containing the given date. - * - * Normally the return data will be based on a year beginning - * on January 1st with weeks beginning on Sunday. - * - * The beginning of year date and/or beginning of week day can be - * changed by using FT_DATECNFG(), which will affect all subsequent - * calls to FT_WEEK() until another call to FT_DATECNFG(). - * - * The beginning of year date and beginning of week day may be reset - * to January 1 and Sunday by calling FT_DATECNFG() with no - * parameters. - * $EXAMPLES$ - * // get info about week containing 9/15/90 - * aDateInfo := FT_WEEK( SToD( "19900915" ) ) - * ? aDateInfo[ 1 ] // 199037 (37th week) - * ? aDateInfo[ 2 ] // 09/09/90 beginning of week 37 - * ? aDateInfo[ 3 ] // 09/15/90 end of week 37 - * - * // get info about week 25 in year containing 9/15/90 - * aDateInfo := FT_WEEK( SToD( "19900915" ), 25 ) - * ? aDateInfo[ 1 ] // 199025 - * ? aDateInfo[ 2 ] // 06/17/90 beginning of week 25 - * ? aDateInfo[ 3 ] // 06/23/90 end of week 25 - * - * // get info about week 25 in current year( 1991 ) - * aDateInfo := FT_WEEK( , 25 ) - * ? aDateInfo[ 1 ] // 199025 - * ? aDateInfo[ 2 ] // 06/16/91 beginning of week 25 - * ? aDateInfo[ 3 ] // 06/22/91 end of week 25 - * $SEEALSO$ - * FT_DATECNFG() FT_MONTH() FT_QTR() FT_YEAR() FT_DAYTOBOW() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_WEEK() + $CATEGORY$ + Date/Time + $ONELINER$ + Return calendar or fiscal week data + $SYNTAX$ + FT_WEEK( [ ], [ ] ) -> aDateinfo + $ARGUMENTS$ + is any valid date in any date format. Defaults + to current system date if not supplied. + + is a number from 1 to 53 signifying a week. + Defaults to current week if not supplied. + $RETURNS$ + A three element array containing the following data: + + aDateInfo[ 1 ] - The year and week as a character string "YYYYWW" + aDateInfo[ 2 ] - The beginning date of the week + aDateInfo[ 3 ] - The ending date of the week + $DESCRIPTION$ + FT_WEEK() returns an array containing data about the week + containing the given date. + + Normally the return data will be based on a year beginning + on January 1st with weeks beginning on Sunday. + + The beginning of year date and/or beginning of week day can be + changed by using FT_DATECNFG(), which will affect all subsequent + calls to FT_WEEK() until another call to FT_DATECNFG(). + + The beginning of year date and beginning of week day may be reset + to January 1 and Sunday by calling FT_DATECNFG() with no + parameters. + $EXAMPLES$ + // get info about week containing 9/15/90 + aDateInfo := FT_WEEK( SToD( "19900915" ) ) + ? aDateInfo[ 1 ] // 199037 (37th week) + ? aDateInfo[ 2 ] // 09/09/90 beginning of week 37 + ? aDateInfo[ 3 ] // 09/15/90 end of week 37 + + // get info about week 25 in year containing 9/15/90 + aDateInfo := FT_WEEK( SToD( "19900915" ), 25 ) + ? aDateInfo[ 1 ] // 199025 + ? aDateInfo[ 2 ] // 06/17/90 beginning of week 25 + ? aDateInfo[ 3 ] // 06/23/90 end of week 25 + + // get info about week 25 in current year( 1991 ) + aDateInfo := FT_WEEK( , 25 ) + ? aDateInfo[ 1 ] // 199025 + ? aDateInfo[ 2 ] // 06/16/91 beginning of week 25 + ? aDateInfo[ 3 ] // 06/22/91 end of week 25 + $SEEALSO$ + FT_DATECNFG() FT_MONTH() FT_QTR() FT_YEAR() FT_DAYTOBOW() + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/workdays.txt b/harbour/contrib/hbnf/doc/en/workdays.txt index 985a0680fc..8b6b39e4e0 100644 --- a/harbour/contrib/hbnf/doc/en/workdays.txt +++ b/harbour/contrib/hbnf/doc/en/workdays.txt @@ -2,33 +2,33 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_WORKDAYS() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Return number of work days between two dates - * $SYNTAX$ - * FT_WORKDAYS( [ ], [ ] ) -> nDays - * $ARGUMENTS$ - * is the beginning value for the date range. - * - * is the ending value for the date range. - * - * $RETURNS$ - * The number of work days (Monday through Friday) between two dates. - * - * $DESCRIPTION$ - * FT_WORKDAYS() returns a number indicating the number of work days - * between two dates. Work days are considered Monday through Friday. - * (The five day work week none of us Clipper programmers have.) - * - * $EXAMPLES$ - * ? FT_WorkDays( SToD( "19910516" ), SToD( "19910520" ) ) // 3 (Th - Mo) - * ? FT_WorkDays( SToD( "19910518" ), SToD( "19910519" ) ) // 0 (Sa - Su) - * ? FT_WorkDays( SToD( "19910517" ), SToD( "19910517" ) ) // 1 (Fr - Fr) - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_WORKDAYS() + $CATEGORY$ + Date/Time + $ONELINER$ + Return number of work days between two dates + $SYNTAX$ + FT_WORKDAYS( [ ], [ ] ) -> nDays + $ARGUMENTS$ + is the beginning value for the date range. + + is the ending value for the date range. + + $RETURNS$ + The number of work days (Monday through Friday) between two dates. + + $DESCRIPTION$ + FT_WORKDAYS() returns a number indicating the number of work days + between two dates. Work days are considered Monday through Friday. + (The five day work week none of us Clipper programmers have.) + + $EXAMPLES$ + ? FT_WorkDays( SToD( "19910516" ), SToD( "19910520" ) ) // 3 (Th - Mo) + ? FT_WorkDays( SToD( "19910518" ), SToD( "19910519" ) ) // 0 (Sa - Su) + ? FT_WorkDays( SToD( "19910517" ), SToD( "19910517" ) ) // 1 (Fr - Fr) + $SEEALSO$ + + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/woy.txt b/harbour/contrib/hbnf/doc/en/woy.txt index 0b4e7e86f3..5807f49b64 100644 --- a/harbour/contrib/hbnf/doc/en/woy.txt +++ b/harbour/contrib/hbnf/doc/en/woy.txt @@ -2,86 +2,86 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_WOY() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Find number of week within year - * $SYNTAX$ - * FT_WOY( ) -> - * $ARGUMENTS$ - * is a date in the form "mm/dd/yy" or "mm/dd/yyyy" - * $RETURNS$ - * Return numeric position of week within the year or NIL if - * parameter does not conform. - * $DESCRIPTION$ - * Considers a full week as starting on Sunday, ending on Saturday. - * First week of year (week 1) may start on any day, and thus - * contain any number of days. - * Final week of year (week 53) may contain any number of days. - * Handles dates with CENTURY ON|OFF, to allow for 21st century. - * Date validation must be external to this function. - * $EXAMPLES$ - * These code fragments find the week number, given a date. - * - * // literal character date - * dDate := SToD( "19910101" ) - * nWkNum := FT_WOY( dDate ) // result: 1 - * - * // presume DOS date to be 01/06/91 - * nWkNum := FT_WOY( Date() ) // result: 2 - * - * // date input - * dDate := SToD( "" ) - * @ 4, 10 GET cDate // input 1991/07/04 - * READ - * nWkNum := FT_WOY( dDate ) // result: 27 - * - * // last day of year - * nWkNum := FT_WOY( SToD( "19911231" ) ) // result: 53 - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_WOY() + $CATEGORY$ + Date/Time + $ONELINER$ + Find number of week within year + $SYNTAX$ + FT_WOY( ) -> + $ARGUMENTS$ + is a date in the form "mm/dd/yy" or "mm/dd/yyyy" + $RETURNS$ + Return numeric position of week within the year or NIL if + parameter does not conform. + $DESCRIPTION$ + Considers a full week as starting on Sunday, ending on Saturday. + First week of year (week 1) may start on any day, and thus + contain any number of days. + Final week of year (week 53) may contain any number of days. + Handles dates with CENTURY ON|OFF, to allow for 21st century. + Date validation must be external to this function. + $EXAMPLES$ + These code fragments find the week number, given a date. + + // literal character date + dDate := SToD( "19910101" ) + nWkNum := FT_WOY( dDate ) // result: 1 + + // presume DOS date to be 01/06/91 + nWkNum := FT_WOY( Date() ) // result: 2 + + // date input + dDate := SToD( "" ) + @ 4, 10 GET cDate // input 1991/07/04 + READ + nWkNum := FT_WOY( dDate ) // result: 27 + + // last day of year + nWkNum := FT_WOY( SToD( "19911231" ) ) // result: 53 + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_DOY() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Find number of day within year - * $SYNTAX$ - * FT_DOY( ) -> - * $ARGUMENTS$ - * is a date in the form "mm/dd/yy" or "mm/dd/yyyy" - * $RETURNS$ - * Return numeric position of day within the year. - * Return NIL if parameter does not conform. - * $DESCRIPTION$ - * Finds the day number, considering 01/01 as day 1 - * Handles dates with CENTURY ON|OFF, to allow for 21st century. - * Date validation must be external to this function. - * $EXAMPLES$ - * These code fragments find the day number, given a date. - * - * // literal character date - * dDate := SToD( "19910101" ) - * nDayNum := FT_DOY( dDate ) // result: 1 - * - * // presume DOS date to be 01/06/91 - * nDayNum := FT_DOY( Date() ) // result: 6 - * - * // date input - * dDate := SToD( "" ) - * @ 4, 10 GET cDate // input 1991/07/04 - * READ - * nDayNum := FT_DOY( dDate ) // result: 185 - * - * // last day of year - * nDayNum := FT_DOY( SToD( "19911231" ) ) // result: 365 - * - * For a demonstration of this function, compile and link the - * program woy.prg in the Nanforum Toolkit source code. - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_DOY() + $CATEGORY$ + Date/Time + $ONELINER$ + Find number of day within year + $SYNTAX$ + FT_DOY( ) -> + $ARGUMENTS$ + is a date in the form "mm/dd/yy" or "mm/dd/yyyy" + $RETURNS$ + Return numeric position of day within the year. + Return NIL if parameter does not conform. + $DESCRIPTION$ + Finds the day number, considering 01/01 as day 1 + Handles dates with CENTURY ON|OFF, to allow for 21st century. + Date validation must be external to this function. + $EXAMPLES$ + These code fragments find the day number, given a date. + + // literal character date + dDate := SToD( "19910101" ) + nDayNum := FT_DOY( dDate ) // result: 1 + + // presume DOS date to be 01/06/91 + nDayNum := FT_DOY( Date() ) // result: 6 + + // date input + dDate := SToD( "" ) + @ 4, 10 GET cDate // input 1991/07/04 + READ + nDayNum := FT_DOY( dDate ) // result: 185 + + // last day of year + nDayNum := FT_DOY( SToD( "19911231" ) ) // result: 365 + + For a demonstration of this function, compile and link the + program woy.prg in the Nanforum Toolkit source code. + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/xbox.txt b/harbour/contrib/hbnf/doc/en/xbox.txt index a6369b0941..f604452ade 100644 --- a/harbour/contrib/hbnf/doc/en/xbox.txt +++ b/harbour/contrib/hbnf/doc/en/xbox.txt @@ -2,78 +2,78 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_XBOX() - * $CATEGORY$ - * Menus/Prompts - * $ONELINER$ - * Display a self-sizing message box and message - * $SYNTAX$ - * FT_XBOX( [ ], [ ], [ ], ; - * [ ], [ ], [ ], ; - * [ ], , , , ; - * , , , , ) -> NIL - * $ARGUMENTS$ - * is a character indicating the type of text justification. - * "L" or "l" will cause the text to be left-justified in the box. - * Centered text is the default. - * - * is a character which determines if the function will wait - * for a keypress after displaying the box. "W" or "w" will cause the - * function to wait for a keypress before returning control to the - * calling routine. Not waiting is the default - * - * is a character which determines whether a single or double - * border will be displayed. "D" or "d" will cause a double border to - * be displayed. A single border is the default. - * - * is a character string denoting the border color. 'N/W' is - * the default if this parameter is not a string. - * - * is a character string denoting the text color. 'W/N' is - * the default if this parameter is not a string. - * - * is a number denoting the starting row. If '99' is passed, - * the box is centered vertically. If necessary, nStartRow is decreased - * so the entire box can be displayed. - * - * is a number denoting the starting column. If '99' is passed, - * the box is centered horizontally. If necessary, nStartCol is decreased - * so the entire box can be displayed. - * - * thru are 1 to 8 character strings to be displayed. - * They are truncated to fit on the screen if necessary. - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * FT_XBOX() allows the programmer to display a message box on the screen - * without needing to calculate the dimensions of the box. Only the upper - * left corner needs to be defined. The function will calculate the lower - * right corner based on the number and length of strings passed. - * - * A maximum of eight strings can be displayed. If a string is too long - * to fit on the screen it is truncated. - * - * The first seven parameters are optional. The default settings are: - * Lines of text are centered. - * Control is returned to the calling routine immediately. - * A single line border is painted. - * The border is black on white. - * The text is white on black. - * The box is centered both vertically and horizontally. - * $EXAMPLES$ - * The following displays a two-line box with default settings: - * - * FT_XBOX( ,,,,,,, "This is a test", "of the XBOX() function" ) - * - * The following uses all optional parameters and displays a three-line - * box. The box is left-justified with a double border. It has a yellow - * on red border and white on blue text. The function will wait for a - * keypress before returning control to the calling routine. - * - * FT_XBOX( "L", "W", "D", "GR+/R", "W/B", 5, 10, "It is so nice",; - * "to not have to do the messy chore",; - * "of calculating the box size!" ) - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_XBOX() + $CATEGORY$ + Menus/Prompts + $ONELINER$ + Display a self-sizing message box and message + $SYNTAX$ + FT_XBOX( [ ], [ ], [ ], ; + [ ], [ ], [ ], ; + [ ], , , , ; + , , , , ) -> NIL + $ARGUMENTS$ + is a character indicating the type of text justification. + "L" or "l" will cause the text to be left-justified in the box. + Centered text is the default. + + is a character which determines if the function will wait + for a keypress after displaying the box. "W" or "w" will cause the + function to wait for a keypress before returning control to the + calling routine. Not waiting is the default + + is a character which determines whether a single or double + border will be displayed. "D" or "d" will cause a double border to + be displayed. A single border is the default. + + is a character string denoting the border color. 'N/W' is + the default if this parameter is not a string. + + is a character string denoting the text color. 'W/N' is + the default if this parameter is not a string. + + is a number denoting the starting row. If '99' is passed, + the box is centered vertically. If necessary, nStartRow is decreased + so the entire box can be displayed. + + is a number denoting the starting column. If '99' is passed, + the box is centered horizontally. If necessary, nStartCol is decreased + so the entire box can be displayed. + + thru are 1 to 8 character strings to be displayed. + They are truncated to fit on the screen if necessary. + $RETURNS$ + NIL + $DESCRIPTION$ + FT_XBOX() allows the programmer to display a message box on the screen + without needing to calculate the dimensions of the box. Only the upper + left corner needs to be defined. The function will calculate the lower + right corner based on the number and length of strings passed. + + A maximum of eight strings can be displayed. If a string is too long + to fit on the screen it is truncated. + + The first seven parameters are optional. The default settings are: + Lines of text are centered. + Control is returned to the calling routine immediately. + A single line border is painted. + The border is black on white. + The text is white on black. + The box is centered both vertically and horizontally. + $EXAMPLES$ + The following displays a two-line box with default settings: + + FT_XBOX( ,,,,,,, "This is a test", "of the XBOX() function" ) + + The following uses all optional parameters and displays a three-line + box. The box is left-justified with a double border. It has a yellow + on red border and white on blue text. The function will wait for a + keypress before returning control to the calling routine. + + FT_XBOX( "L", "W", "D", "GR+/R", "W/B", 5, 10, "It is so nice",; + "to not have to do the messy chore",; + "of calculating the box size!" ) + $END$ */ diff --git a/harbour/contrib/hbnf/doc/en/year.txt b/harbour/contrib/hbnf/doc/en/year.txt index d17732977f..9914f7953b 100644 --- a/harbour/contrib/hbnf/doc/en/year.txt +++ b/harbour/contrib/hbnf/doc/en/year.txt @@ -2,51 +2,51 @@ * $Id$ */ -/* $DOC$ - * $FUNCNAME$ - * FT_YEAR() - * $CATEGORY$ - * Date/Time - * $ONELINER$ - * Return calendar or fiscal year data - * $SYNTAX$ - * FT_YEAR( [ ] ) -> aDateInfo - * $ARGUMENTS$ - * is any valid date in any date format. Defaults - * to current system date if not supplied. - * $RETURNS$ - * A three element array containing the following data: - * - * aDateInfo[ 1 ] - The year as a character string "YYYY" - * aDateInfo[ 2 ] - The beginning date of the year - * aDateInfo[ 3 ] - The ending date of the year - * $DESCRIPTION$ - * FT_YEAR() returns an array containing data about the year - * containing the given date. - * - * Normally the return data will be based on a year beginning - * on January 1st. - * - * The beginning of year date can be changed by using FT_DATECNFG(), - * which will affect all subsequent calls to FT_YEAR() until another - * call to FT_DATECNFG(). - * - * The beginning of year date may be reset to January 1 by calling - * FT_DATECNFG() with no parameters. - * $EXAMPLES$ - * // Get info about year containing 9/15/90, assuming default - * // beginning of year is January 1st. - * aDateInfo := FT_YEAR( SToD( "19900915" ) ) - * ? aDateInfo[ 1 ] // 1990 - * ? aDateInfo[ 2 ] // 01/01/90 beginning of year - * ? aDateInfo[ 3 ] // 12/31/90 end of year - * - * // get info about current year (1991). - * aDateInfo := FT_YEAR() - * ? aDateInfo[ 1 ] // 1991 - * ? aDateInfo[ 2 ] // 01/01/91 beginning of year - * ? aDateInfo[ 3 ] // 12/31/91 end of year - * $SEEALSO$ - * FT_DATECNFG() FT_WEEK() FT_MONTH() FT_QTR() - * $END$ +/* $DOC$ + $FUNCNAME$ + FT_YEAR() + $CATEGORY$ + Date/Time + $ONELINER$ + Return calendar or fiscal year data + $SYNTAX$ + FT_YEAR( [ ] ) -> aDateInfo + $ARGUMENTS$ + is any valid date in any date format. Defaults + to current system date if not supplied. + $RETURNS$ + A three element array containing the following data: + + aDateInfo[ 1 ] - The year as a character string "YYYY" + aDateInfo[ 2 ] - The beginning date of the year + aDateInfo[ 3 ] - The ending date of the year + $DESCRIPTION$ + FT_YEAR() returns an array containing data about the year + containing the given date. + + Normally the return data will be based on a year beginning + on January 1st. + + The beginning of year date can be changed by using FT_DATECNFG(), + which will affect all subsequent calls to FT_YEAR() until another + call to FT_DATECNFG(). + + The beginning of year date may be reset to January 1 by calling + FT_DATECNFG() with no parameters. + $EXAMPLES$ + // Get info about year containing 9/15/90, assuming default + // beginning of year is January 1st. + aDateInfo := FT_YEAR( SToD( "19900915" ) ) + ? aDateInfo[ 1 ] // 1990 + ? aDateInfo[ 2 ] // 01/01/90 beginning of year + ? aDateInfo[ 3 ] // 12/31/90 end of year + + // get info about current year (1991). + aDateInfo := FT_YEAR() + ? aDateInfo[ 1 ] // 1991 + ? aDateInfo[ 2 ] // 01/01/91 beginning of year + ? aDateInfo[ 3 ] // 12/31/91 end of year + $SEEALSO$ + FT_DATECNFG() FT_WEEK() FT_MONTH() FT_QTR() + $END$ */ diff --git a/harbour/contrib/hbziparc/doc/en/hbziparc.txt b/harbour/contrib/hbziparc/doc/en/hbziparc.txt index c7b469a550..65d58bedfa 100644 --- a/harbour/contrib/hbziparc/doc/en/hbziparc.txt +++ b/harbour/contrib/hbziparc/doc/en/hbziparc.txt @@ -3,576 +3,572 @@ */ /* $DOC$ - * $FUNCNAME$ - * hb_SetZipComment() - * $CATEGORY$ - * Zip Functions - * $ONELINER$ - * Set an Zip archive Comment - * $SYNTAX$ - * hb_SetZipComment( ) --> NIL - * $ARGUMENTS$ - * Comment to add to the zip archive - * $RETURNS$ - * this function always return NIL - * $DESCRIPTION$ - * This function stored an global comment to an zip archive. - * It should be called before any of the compression functions. - * $EXAMPLES$ - * hb_SetZipComment( "This is an Test" ) - * hb_ZipFile( "test.zip", { "ios.ini", "win.ini" } ) - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is a Harbour extension - * $PLATFORMS$ - * All - * $FILES$ - * Library is hbziparc - * $END$ + $FUNCNAME$ + hb_SetZipComment() + $CATEGORY$ + Zip Functions + $ONELINER$ + Set an Zip archive Comment + $SYNTAX$ + hb_SetZipComment( ) --> NIL + $ARGUMENTS$ + Comment to add to the zip archive + $RETURNS$ + this function always return NIL + $DESCRIPTION$ + This function stored an global comment to an zip archive. + It should be called before any of the compression functions. + $EXAMPLES$ + hb_SetZipComment( "This is an Test" ) + hb_ZipFile( "test.zip", { "ios.ini", "win.ini" } ) + $STATUS$ + R + $COMPLIANCE$ + This function is a Harbour extension + $PLATFORMS$ + All + $FILES$ + Library is hbziparc + $END$ */ /* $DOC$ - * $FUNCNAME$ - * hb_GetZipComment() - * $CATEGORY$ - * Zip Functions - * $ONELINER$ - * Return the comment of an zip file - * $SYNTAX$ - * hb_GetZipComment( ) --> - * $ARGUMENTS$ - * File to get the comment from - * $RETURNS$ - * The comment that was stored in - * $DESCRIPTION$ - * This function receives a valid zip file name as parameter, - * and returns the global comment stored within. - * $EXAMPLES$ - * ? "The comment in test.zip is ", hb_GetZipComment( "test.zip" ) - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is a Harbour extension - * $PLATFORMS$ - * All - * $FILES$ - * Library is hbziparc - * $END$ + $FUNCNAME$ + hb_GetZipComment() + $CATEGORY$ + Zip Functions + $ONELINER$ + Return the comment of an zip file + $SYNTAX$ + hb_GetZipComment( ) --> + $ARGUMENTS$ + File to get the comment from + $RETURNS$ + The comment that was stored in + $DESCRIPTION$ + This function receives a valid zip file name as parameter, + and returns the global comment stored within. + $EXAMPLES$ + ? "The comment in test.zip is ", hb_GetZipComment( "test.zip" ) + $STATUS$ + R + $COMPLIANCE$ + This function is a Harbour extension + $PLATFORMS$ + All + $FILES$ + Library is hbziparc + $END$ */ /* $DOC$ - * $FUNCNAME$ - * hb_ZipTestPK() - * $CATEGORY$ - * Zip Functions - * $ONELINER$ - * Test pkSpanned zip files - * $SYNTAX$ - * hb_ZipTestPK( ) --> - * $ARGUMENTS$ - * File to be tested. - * $RETURNS$ - * A code that tells if the current disk is the last of a - * pkSpanned disk set. - * $DESCRIPTION$ - * This function tests if the disk inserted is the last disk of an backup - * set or not. - * It will return the follow return code when an error is found - * - * - * Error code Meaning - * 114 Incorrect Disk - * 103 No Call back was set with hb_ZipTestPK() - *
- * - * Call this function to determine if the disk inserted is the correct - * one before any other function. - * $EXAMPLES$ - * IF hb_ZipTestPK( "test22.zip" ) == 114 - * ? "Invalid Diskette" - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is a Harbour extension - * $PLATFORMS$ - * All - * $FILES$ - * Library is hbziparc - * $END$ + $FUNCNAME$ + hb_ZipTestPK() + $CATEGORY$ + Zip Functions + $ONELINER$ + Test pkSpanned zip files + $SYNTAX$ + hb_ZipTestPK( ) --> + $ARGUMENTS$ + File to be tested. + $RETURNS$ + A code that tells if the current disk is the last of a + pkSpanned disk set. + $DESCRIPTION$ + This function tests if the disk inserted is the last disk of an backup + set or not. + It will return the follow return code when an error is found + + + Error code Meaning + 114 Incorrect Disk + 103 No Call back was set with hb_ZipTestPK() +
+ + Call this function to determine if the disk inserted is the correct + one before any other function. + $EXAMPLES$ + IF hb_ZipTestPK( "test22.zip" ) == 114 + ? "Invalid Diskette" + ENDIF + $STATUS$ + R + $COMPLIANCE$ + This function is a Harbour extension + $PLATFORMS$ + All + $FILES$ + Library is hbziparc + $END$ */ /* $DOC$ - * $FUNCNAME$ - * hb_SetDiskZip() - * $CATEGORY$ - * Zip Functions - * $ONELINER$ - * Set an codeblock for disk changes - * $SYNTAX$ - * hb_SetDiskZip( ) --> .T. - * $ARGUMENTS$ - * an Code block that contains an function that will be performed - * when the need of changing disk are need. - * $RETURNS$ - * It always returns True - * $DESCRIPTION$ - * This function will set an codeblock that will be evaluated every time - * that an changedisk event is necessary. receives nDisk as a - * code block param that corresponds to the diskette number to be processed. - * - * Set this function before opening archives that are in removable media. - * This block will be released, when the caller finish it job. - * $EXAMPLES$ - * hb_SetDiskZip( {| nDisk | Alert( "Please insert disk no " + Str( nDisk, 3 ) ) } ) - * $COMPLIANCE$ - * This function is a Harbour extension - * $PLATFORMS$ - * All - * $FILES$ - * Library is hbziparc - * $END$ + $FUNCNAME$ + hb_SetDiskZip() + $CATEGORY$ + Zip Functions + $ONELINER$ + Set an codeblock for disk changes + $SYNTAX$ + hb_SetDiskZip( ) --> .T. + $ARGUMENTS$ + an Code block that contains an function that will be performed + when the need of changing disk are need. + $RETURNS$ + It always returns True + $DESCRIPTION$ + This function will set an codeblock that will be evaluated every time + that an changedisk event is necessary. receives nDisk as a + code block param that corresponds to the diskette number to be processed. + + Set this function before opening archives that are in removable media. + This block will be released, when the caller finish it job. + $EXAMPLES$ + hb_SetDiskZip( {| nDisk | Alert( "Please insert disk no " + Str( nDisk, 3 ) ) } ) + $COMPLIANCE$ + This function is a Harbour extension + $PLATFORMS$ + All + $FILES$ + Library is hbziparc + $END$ */ /* $DOC$ - * $FUNCNAME$ - * hb_SetBuffer() - * $CATEGORY$ - * Zip Functions - * $ONELINER$ - * - * $SYNTAX$ - * hb_SetBuffer( [], [], [] ) --> NIL - * $ARGUMENTS$ - * The size of the write buffer. - * - * The size of the extract buffer. - * - * The size of the read buffer. - * $RETURNS$ - * This function always returns NIL. - * $DESCRIPTION$ - * This function set the size of the internal buffers for write/extract/read - * operation. - * - * If the size of the buffer is smaller then the default, the function - * will automatically use the default values, which are 65535/16384/32768 - * respectively. - * - * This function be called before any of the compression/decompression - * functions. - * $EXAMPLES$ - * hb_SetBuffer( 100000, 115214, 65242 ) - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is a Harbour extension - * $PLATFORMS$ - * All - * $FILES$ - * Library is hbziparc - * $END$ - */ - -/* - * $DOC$ - * $FUNCNAME$ - * hb_ZipFileByTDSpan() - * $CATEGORY$ - * Zip Functions - * $ONELINER$ - * Create a zip file - * $SYNTAX$ - * hb_ZipFileByTDSpan( , | , , - * , , , , , , - * ) --> lCompress - * $ARGUMENTS$ - * Name of the zip file - * - * Name of a file to Compress, Drive and/or path - * can be used - * _or_ - * An array containing files to compress, Drive and/or path - * can be used - * - * Compression level ranging from 0 to 9 - * - * Code block to execute while compressing - * - * Toggle to overwrite the file if exists - * - * Password to encrypt the files - * - * Size of the archive, in bytes. Default is 1457664 bytes - * - * Toggle to store the path or not - * - * Toggle to store the Drive letter and path or not - * - * Code block for File Progress - * $RETURNS$ - * .T. if file was create, otherwise .F. - * $DESCRIPTION$ - * This function creates a zip file named . If the extension - * is omitted, .zip will be assumed. If the second parameter is a - * character string, this file will be added to the zip file. If the - * second parameter is an array, all file names contained in - * will be compressed. - * - * If is used, it determines the compression type where 0 means - * no compression and 9 means best compression. - * - * If is used, every time the file is opened to compress it - * will evaluate bBlock. Parameters of bBlock are cFile and nPos. - * - * If is used, it toggles to overwrite or not the existing - * file. Default is to overwrite the file, otherwise if is - * false the new files are added to the . - * - * If is used, it tells thats the path should also be stored - * with the file name. Default is false. - * - * If is used, it tells thats the Drive and path should also - * be stored with the file name. Default is false. - * - * If is used, an Code block is evaluated, showing the total - * of that file has being processed. - * The codeblock must be defined as follow {| nPos, nTotal | GaugeUpdate( aGauge1, nPos / nTotal ) } - * $EXAMPLES$ - * PROCEDURE Main() - * - * IF hb_ZipFileByTDSpan( "test.zip", "test.prg" ) - * ? "File was successfully created" - * ENDIF - * - * IF hb_ZipFileByTDSpan( "test1.zip", { "test.prg", "test.hbp" } ) - * ? "File was successfully created" - * ENDIF - * - * IF hb_ZipFileByTDSpan( "test2.zip", { "test.prg", "test.hbp" }, 9, {| nPos, cFile | QOut( cFile ) }, "hello",, 521421 ) - * ? "File was successfully created" - * ENDIF - * - * aFiles := { "test.prg", "test.hbp" } - * nLen := Len( aFiles ) - * aGauge := GaugeNew( 5, 5, 7, 40, "W/B", "W+/B", "." ) - * GaugeDisplay( aGauge ) - * hb_ZipFileByTDSpan( "test33.zip", aFiles, 9, {| cFile, nPos | GaugeUpdate( aGauge, nPos / nLen) },, "hello",, 6585452 ) - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is a Harbour extension - * $PLATFORMS$ - * All - * $FILES$ - * Library is hbziparc - * $END$ - */ - -/* - * $DOC$ - * $FUNCNAME$ - * hb_ZipFileByPKSpan() - * $CATEGORY$ - * Zip Functions - * $ONELINER$ - * Create a zip file on removable media - * $SYNTAX$ - * hb_ZipFileByPKSpan( , | , , - * , , , , , - * ) --> lCompress - * $ARGUMENTS$ - * Name of the zip file - * - * Name of a file to Compress, Drive and/or path - * can be used - * _or_ - * An array containing files to compress, Drive and/or path - * can be used - * - * Compression level ranging from 0 to 9 - * - * Code block to execute while compressing - * - * Toggle to overwrite the file if exists - * - * Password to encrypt the files - * - * Toggle to store the path or not - * - * Toggle to store the Drive letter and path or not - * - * Code block for File Progress - * $RETURNS$ - * .T. if file was create, otherwise .F. - * $DESCRIPTION$ - * This function creates a zip file named . If the extension - * is omitted, .zip will be assumed. If the second parameter is a - * character string, this file will be added to the zip file. If the - * second parameter is an array, all file names contained in - * will be compressed. Also, the use of this function is for creating - * backup in removable media like an floppy drive/zip drive. - * - * If is used, it determines the compression type where 0 means - * no compression and 9 means best compression. - * - * If is used, every time the file is opened to compress it - * will evaluate bBlock. Parameters of bBlock are cFile and nPos. - * - * If is used , it toggles to overwrite or not the existing - * file. Default is to overwrite the file, otherwise if is false - * the new files are added to the . - * - * If is used, all files that are added to the archive are encrypted - * with the password. - * - * If is used, it tells thats the path should also be stored with - * the file name. Default is false. - * - * If is used, it tells thats the Drive and path should also be stored - * with the file name. Default is false. - * - * If is used, an Code block is evaluated, showing the total - * of that file has being processed. - * The codeblock must be defined as follow {| nPos, nTotal | GaugeUpdate( aGauge1, nPos / nTotal ) } - * - * Before calling this function, Set an Changedisk codeblock by calling - * the hb_SetDiskZip(). - * $EXAMPLES$ - * PROCEDURE Main() - * - * hb_SetDiskZip( {| nDisk | Alert( "Please insert disk no " + Str( nDisk, 3 ) ) } ) - * - * IF hb_ZipFileByPKSpan( "test.zip", "test.prg" ) - * ? "File was successfully created" - * ENDIF - * - * IF hb_ZipFileByPKSpan( "test1.zip", { "test.prg", "test.hbp" } ) - * ? "File was successfully created" - * ENDIF - * - * IF hb_ZipFileByPKSpan( "test2.zip", { "test.prg", "test.hbp" }, 9, {| nPos, cFile | QOut( cFile ) } ) - * ? "File was successfully created" - * ENDIF - * - * aFiles := { "test.prg", "test.hbp" } - * nLen := Len( aFiles ) - * aGauge := GaugeNew( 5, 5, 7, 40, "W/B", "W+/B", "." ) - * GaugeDisplay( aGauge ) - * hb_ZipFileByPKSpan( "test33.zip", aFiles, 9, {| cFile, nPos | GaugeUpdate( aGauge, nPos / nLen ) },, "hello" ) - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is a Harbour extension - * $PLATFORMS$ - * All - * $FILES$ - * Library is hbziparc - * $END$ - */ - -/* - * $DOC$ - * $FUNCNAME$ - * hb_ZipFile() - * $CATEGORY$ - * Zip Functions - * $ONELINER$ - * Create a zip file - * $SYNTAX$ - * hb_ZipFile( , | , , - * , , , , , - * ) --> lCompress - * $ARGUMENTS$ - * Name of the zip file to create - * - * Name of a file to Compress, Drive and/or path - * can be used - * _or_ - * An array containing files to compress, Drive and/or path - * can be used - * - * Compression level ranging from 0 to 9 - * - * Code block to execute while compressing - * - * Toggle to overwrite the file if exists - * - * Password to encrypt the files - * - * Toggle to store the path or not - * - * Toggle to store the Drive letter and path or not - * - * Code block for File Progress - * $RETURNS$ - * .T. if file was create, otherwise .F. - * $DESCRIPTION$ - * This function creates a zip file named . If the extension - * is omitted, .zip will be assumed. If the second parameter is a - * character string, this file will be added to the zip file. If the - * second parameter is an array, all file names contained in - * will be compressed. - * - * If is used, it determines the compression type where 0 means - * no compression and 9 means best compression. - * - * If is used, every time the file is opened to compress it - * will evaluate bBlock. Parameters of bBlock are cFile and nPos. - * - * If is used, it toggles to overwrite or not the existing - * file. Default is to overwrite the file,otherwise if is false - * the new files are added to the . - * - * If is used, all files that are added to the archive are encrypted - * with the password. - * - * If is used, it tells the path should also be stored with - * the file name. Default is false. - * - * If is used, it tells thats the Drive and path should also be stored - * with the file name. Default is false. - * - * If is used, an Code block is evaluated, showing the total - * of that file has being processed. - * The codeblock must be defined as follow {| nPos, nTotal | GaugeUpdate( aGauge1, nPos / nTotal ) } - * - * $EXAMPLES$ - * PROCEDURE Main() - * - * IF hb_ZipFile( "test.zip", "test.prg" ) - * ? "File was successfully created" - * ENDIF - * - * IF hb_ZipFile( "test1.zip", { "test.prg", "test.hbp" } ) - * ? "File was successfully created" - * ENDIF - * - * IF hb_ZipFile( "test2.zip", { "test.prg", "test.hbp" }, 9, {| cFile, nPos | QOut( cFile ) } ) - * ? "File was successfully created" - * ENDIF - * - * aFiles := { "test.prg", "test.hbp" } - * nLen := Len( aFiles ) - * aGauge := GaugeNew( 5, 5, 7, 40, "W/B", "W+/B" , "." ) - * GaugeDisplay( aGauge ) - * hb_ZipFile( "test33.zip", aFiles, 9, {| cFile, nPos | GaugeUpdate( aGauge, nPos / nLen ) },, "hello" ) - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is a Harbour extension - * $PLATFORMS$ - * All - * $FILES$ - * Library is hbziparc - * $END$ - */ - -/* - * $DOC$ - * $FUNCNAME$ - * hb_UnzipFile() - * $CATEGORY$ - * Zip Functions - * $ONELINER$ - * Unzip a compressed file - * $SYNTAX$ - * hb_UnzipFILE( , , , , , - * | , ) --> lCompress - * $ARGUMENTS$ - * Name of the zip file to extract - * - * Code block to execute while extracting - * - * Toggle to create directory if needed - * - * Password to use to extract files - * - * Path to extract the files to - mandatory - * - * | A File or Array of files to extract - mandatory - * - * Code block for File Progress - * $RETURNS$ - * .T. if all file was successfully restored, otherwise .F. - * $DESCRIPTION$ - * This function restores all files contained inside the . - * If the extension is omitted, .zip will be assumed. If a file already - * exists, it will be overwritten. - * - * If is used, every time the file is opened to compress it - * will evaluate bBlock. Parameters of bBlock are cFile and nPos. - * - * The is a mandatory parameter. Set to ".\" to extract to the - * current directory - * - * If or are not provided, no files will be extracted! - * Make sure you provide the file or files you want extracted - * - * If is used, an Code block is evaluated, showing the total - * of that file has being processed. - * The codeblock must be defined as follow {| nPos, nTotal | GaugeUpdate( aGauge1, nPos / nTotal ) } - * $EXAMPLES$ - * PROCEDURE Main() - * - * LOCAL aExtract := hb_GetFilesInZip( "test.zip" ) // extract all files in zip - * - * IF hb_UnzipFile( "test.zip",,,, "." + hb_ps(), aExtract ) - * ? "File was successfully extracted" - * ENDIF - * - * aExtract := hb_GetFilesInZip( "test2.zip" ) // extract all files in zip - * IF hb_UnzipFile( "test2.zip", {| cFile | QOut( cFile ) },,, "." + hb_ps(), aExtract ) - * ? "File was successfully extracted" - * ENDIF - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is a Harbour extension - * $PLATFORMS$ - * All - * $FILES$ - * Library is hbziparc - * $END$ + $FUNCNAME$ + hb_SetBuffer() + $CATEGORY$ + Zip Functions + $ONELINER$ + + $SYNTAX$ + hb_SetBuffer( [], [], [] ) --> NIL + $ARGUMENTS$ + The size of the write buffer. + + The size of the extract buffer. + + The size of the read buffer. + $RETURNS$ + This function always returns NIL. + $DESCRIPTION$ + This function set the size of the internal buffers for write/extract/read + operation. + + If the size of the buffer is smaller then the default, the function + will automatically use the default values, which are 65535/16384/32768 + respectively. + + This function be called before any of the compression/decompression + functions. + $EXAMPLES$ + hb_SetBuffer( 100000, 115214, 65242 ) + $STATUS$ + R + $COMPLIANCE$ + This function is a Harbour extension + $PLATFORMS$ + All + $FILES$ + Library is hbziparc + $END$ */ /* $DOC$ - * $FUNCNAME$ - * hb_ZipDeleteFiles() - * $CATEGORY$ - * Zip Functions - * $ONELINER$ - * Delete files from an zip archive - * $SYNTAX$ - * hb_ZipDeleteFiles( , | | ) --> - * $ARGUMENTS$ - * The name of the zip files from where the files will be deleted - * - * An File to be removed - * _or_ - * An Array of Files to be removed - * _or_ - * The Position of the file to be removed - * $RETURNS$ - * If the files are deleted, it will return .T.; otherwise - * it will return .F. in the following cases: Spanned Archives; the file(s) - * could not be found in the zip file. - * $DESCRIPTION$ - * This function removes files from an Zip archive. - * $EXAMPLES$ - * ? "has the file zipnew.i been deleted ", iif( hb_ZipDeleteFiles( "test23.zip", "zipnew.i" ), "Yes", "No" ) - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is a Harbour extension - * $PLATFORMS$ - * All - * $FILES$ - * Library is hbziparc - * $END$ + $FUNCNAME$ + hb_ZipFileByTDSpan() + $CATEGORY$ + Zip Functions + $ONELINER$ + Create a zip file + $SYNTAX$ + hb_ZipFileByTDSpan( , | , , + , , , , , , + ) --> lCompress + $ARGUMENTS$ + Name of the zip file + + Name of a file to Compress, Drive and/or path + can be used + _or_ + An array containing files to compress, Drive and/or path + can be used + + Compression level ranging from 0 to 9 + + Code block to execute while compressing + + Toggle to overwrite the file if exists + + Password to encrypt the files + + Size of the archive, in bytes. Default is 1457664 bytes + + Toggle to store the path or not + + Toggle to store the Drive letter and path or not + + Code block for File Progress + $RETURNS$ + .T. if file was create, otherwise .F. + $DESCRIPTION$ + This function creates a zip file named . If the extension + is omitted, .zip will be assumed. If the second parameter is a + character string, this file will be added to the zip file. If the + second parameter is an array, all file names contained in + will be compressed. + + If is used, it determines the compression type where 0 means + no compression and 9 means best compression. + + If is used, every time the file is opened to compress it + will evaluate bBlock. Parameters of bBlock are cFile and nPos. + + If is used, it toggles to overwrite or not the existing + file. Default is to overwrite the file, otherwise if is + false the new files are added to the . + + If is used, it tells thats the path should also be stored + with the file name. Default is false. + + If is used, it tells thats the Drive and path should also + be stored with the file name. Default is false. + + If is used, an Code block is evaluated, showing the total + of that file has being processed. + The codeblock must be defined as follow {| nPos, nTotal | GaugeUpdate( aGauge1, nPos / nTotal ) } + $EXAMPLES$ + PROCEDURE Main() + + IF hb_ZipFileByTDSpan( "test.zip", "test.prg" ) + ? "File was successfully created" + ENDIF + + IF hb_ZipFileByTDSpan( "test1.zip", { "test.prg", "test.hbp" } ) + ? "File was successfully created" + ENDIF + + IF hb_ZipFileByTDSpan( "test2.zip", { "test.prg", "test.hbp" }, 9, {| nPos, cFile | QOut( cFile ) }, "hello",, 521421 ) + ? "File was successfully created" + ENDIF + + aFiles := { "test.prg", "test.hbp" } + nLen := Len( aFiles ) + aGauge := GaugeNew( 5, 5, 7, 40, "W/B", "W+/B", "." ) + GaugeDisplay( aGauge ) + hb_ZipFileByTDSpan( "test33.zip", aFiles, 9, {| cFile, nPos | GaugeUpdate( aGauge, nPos / nLen) },, "hello",, 6585452 ) + RETURN + $STATUS$ + R + $COMPLIANCE$ + This function is a Harbour extension + $PLATFORMS$ + All + $FILES$ + Library is hbziparc + $END$ + */ + +/* $DOC$ + $FUNCNAME$ + hb_ZipFileByPKSpan() + $CATEGORY$ + Zip Functions + $ONELINER$ + Create a zip file on removable media + $SYNTAX$ + hb_ZipFileByPKSpan( , | , , + , , , , , + ) --> lCompress + $ARGUMENTS$ + Name of the zip file + + Name of a file to Compress, Drive and/or path + can be used + _or_ + An array containing files to compress, Drive and/or path + can be used + + Compression level ranging from 0 to 9 + + Code block to execute while compressing + + Toggle to overwrite the file if exists + + Password to encrypt the files + + Toggle to store the path or not + + Toggle to store the Drive letter and path or not + + Code block for File Progress + $RETURNS$ + .T. if file was create, otherwise .F. + $DESCRIPTION$ + This function creates a zip file named . If the extension + is omitted, .zip will be assumed. If the second parameter is a + character string, this file will be added to the zip file. If the + second parameter is an array, all file names contained in + will be compressed. Also, the use of this function is for creating + backup in removable media like an floppy drive/zip drive. + + If is used, it determines the compression type where 0 means + no compression and 9 means best compression. + + If is used, every time the file is opened to compress it + will evaluate bBlock. Parameters of bBlock are cFile and nPos. + + If is used , it toggles to overwrite or not the existing + file. Default is to overwrite the file, otherwise if is false + the new files are added to the . + + If is used, all files that are added to the archive are encrypted + with the password. + + If is used, it tells thats the path should also be stored with + the file name. Default is false. + + If is used, it tells thats the Drive and path should also be stored + with the file name. Default is false. + + If is used, an Code block is evaluated, showing the total + of that file has being processed. + The codeblock must be defined as follow {| nPos, nTotal | GaugeUpdate( aGauge1, nPos / nTotal ) } + + Before calling this function, Set an Changedisk codeblock by calling + the hb_SetDiskZip(). + $EXAMPLES$ + PROCEDURE Main() + + hb_SetDiskZip( {| nDisk | Alert( "Please insert disk no " + Str( nDisk, 3 ) ) } ) + + IF hb_ZipFileByPKSpan( "test.zip", "test.prg" ) + ? "File was successfully created" + ENDIF + + IF hb_ZipFileByPKSpan( "test1.zip", { "test.prg", "test.hbp" } ) + ? "File was successfully created" + ENDIF + + IF hb_ZipFileByPKSpan( "test2.zip", { "test.prg", "test.hbp" }, 9, {| nPos, cFile | QOut( cFile ) } ) + ? "File was successfully created" + ENDIF + + aFiles := { "test.prg", "test.hbp" } + nLen := Len( aFiles ) + aGauge := GaugeNew( 5, 5, 7, 40, "W/B", "W+/B", "." ) + GaugeDisplay( aGauge ) + hb_ZipFileByPKSpan( "test33.zip", aFiles, 9, {| cFile, nPos | GaugeUpdate( aGauge, nPos / nLen ) },, "hello" ) + RETURN + $STATUS$ + R + $COMPLIANCE$ + This function is a Harbour extension + $PLATFORMS$ + All + $FILES$ + Library is hbziparc + $END$ + */ + +/* $DOC$ + $FUNCNAME$ + hb_ZipFile() + $CATEGORY$ + Zip Functions + $ONELINER$ + Create a zip file + $SYNTAX$ + hb_ZipFile( , | , , + , , , , , + ) --> lCompress + $ARGUMENTS$ + Name of the zip file to create + + Name of a file to Compress, Drive and/or path + can be used + _or_ + An array containing files to compress, Drive and/or path + can be used + + Compression level ranging from 0 to 9 + + Code block to execute while compressing + + Toggle to overwrite the file if exists + + Password to encrypt the files + + Toggle to store the path or not + + Toggle to store the Drive letter and path or not + + Code block for File Progress + $RETURNS$ + .T. if file was create, otherwise .F. + $DESCRIPTION$ + This function creates a zip file named . If the extension + is omitted, .zip will be assumed. If the second parameter is a + character string, this file will be added to the zip file. If the + second parameter is an array, all file names contained in + will be compressed. + + If is used, it determines the compression type where 0 means + no compression and 9 means best compression. + + If is used, every time the file is opened to compress it + will evaluate bBlock. Parameters of bBlock are cFile and nPos. + + If is used, it toggles to overwrite or not the existing + file. Default is to overwrite the file,otherwise if is false + the new files are added to the . + + If is used, all files that are added to the archive are encrypted + with the password. + + If is used, it tells the path should also be stored with + the file name. Default is false. + + If is used, it tells thats the Drive and path should also be stored + with the file name. Default is false. + + If is used, an Code block is evaluated, showing the total + of that file has being processed. + The codeblock must be defined as follow {| nPos, nTotal | GaugeUpdate( aGauge1, nPos / nTotal ) } + + $EXAMPLES$ + PROCEDURE Main() + + IF hb_ZipFile( "test.zip", "test.prg" ) + ? "File was successfully created" + ENDIF + + IF hb_ZipFile( "test1.zip", { "test.prg", "test.hbp" } ) + ? "File was successfully created" + ENDIF + + IF hb_ZipFile( "test2.zip", { "test.prg", "test.hbp" }, 9, {| cFile, nPos | QOut( cFile ) } ) + ? "File was successfully created" + ENDIF + + aFiles := { "test.prg", "test.hbp" } + nLen := Len( aFiles ) + aGauge := GaugeNew( 5, 5, 7, 40, "W/B", "W+/B" , "." ) + GaugeDisplay( aGauge ) + hb_ZipFile( "test33.zip", aFiles, 9, {| cFile, nPos | GaugeUpdate( aGauge, nPos / nLen ) },, "hello" ) + RETURN + $STATUS$ + R + $COMPLIANCE$ + This function is a Harbour extension + $PLATFORMS$ + All + $FILES$ + Library is hbziparc + $END$ + */ + +/* $DOC$ + $FUNCNAME$ + hb_UnzipFile() + $CATEGORY$ + Zip Functions + $ONELINER$ + Unzip a compressed file + $SYNTAX$ + hb_UnzipFILE( , , , , , + | , ) --> lCompress + $ARGUMENTS$ + Name of the zip file to extract + + Code block to execute while extracting + + Toggle to create directory if needed + + Password to use to extract files + + Path to extract the files to - mandatory + + | A File or Array of files to extract - mandatory + + Code block for File Progress + $RETURNS$ + .T. if all file was successfully restored, otherwise .F. + $DESCRIPTION$ + This function restores all files contained inside the . + If the extension is omitted, .zip will be assumed. If a file already + exists, it will be overwritten. + + If is used, every time the file is opened to compress it + will evaluate bBlock. Parameters of bBlock are cFile and nPos. + + The is a mandatory parameter. Set to ".\" to extract to the + current directory + + If or are not provided, no files will be extracted! + Make sure you provide the file or files you want extracted + + If is used, an Code block is evaluated, showing the total + of that file has being processed. + The codeblock must be defined as follow {| nPos, nTotal | GaugeUpdate( aGauge1, nPos / nTotal ) } + $EXAMPLES$ + PROCEDURE Main() + + LOCAL aExtract := hb_GetFilesInZip( "test.zip" ) // extract all files in zip + + IF hb_UnzipFile( "test.zip",,,, "." + hb_ps(), aExtract ) + ? "File was successfully extracted" + ENDIF + + aExtract := hb_GetFilesInZip( "test2.zip" ) // extract all files in zip + IF hb_UnzipFile( "test2.zip", {| cFile | QOut( cFile ) },,, "." + hb_ps(), aExtract ) + ? "File was successfully extracted" + ENDIF + RETURN + $STATUS$ + R + $COMPLIANCE$ + This function is a Harbour extension + $PLATFORMS$ + All + $FILES$ + Library is hbziparc + $END$ + */ + +/* $DOC$ + $FUNCNAME$ + hb_ZipDeleteFiles() + $CATEGORY$ + Zip Functions + $ONELINER$ + Delete files from an zip archive + $SYNTAX$ + hb_ZipDeleteFiles( , | | ) --> + $ARGUMENTS$ + The name of the zip files from where the files will be deleted + + An File to be removed + _or_ + An Array of Files to be removed + _or_ + The Position of the file to be removed + $RETURNS$ + If the files are deleted, it will return .T.; otherwise + it will return .F. in the following cases: Spanned Archives; the file(s) + could not be found in the zip file. + $DESCRIPTION$ + This function removes files from an Zip archive. + $EXAMPLES$ + ? "has the file zipnew.i been deleted ", iif( hb_ZipDeleteFiles( "test23.zip", "zipnew.i" ), "Yes", "No" ) + $STATUS$ + R + $COMPLIANCE$ + This function is a Harbour extension + $PLATFORMS$ + All + $FILES$ + Library is hbziparc + $END$ */ diff --git a/harbour/contrib/rddads/doc/en/adsfuncs.txt b/harbour/contrib/rddads/doc/en/adsfuncs.txt index 86c23b50da..bc64ad91f0 100644 --- a/harbour/contrib/rddads/doc/en/adsfuncs.txt +++ b/harbour/contrib/rddads/doc/en/adsfuncs.txt @@ -2,1487 +2,1501 @@ * $Id$ */ -/* - * The following are Copyright of the individual authors. - * www - http://harbour-project.org - * - * Copyright 2000 Extended Systems, Inc. - * Documentation for Advantage Database Server and Local Server - * - * Copyright 2000 Brian Hays - * Documentation for Harbour-specific features - * - * See COPYING for licensing terms. - * +/* $DOC$ + $FUNCNAME$ + ADSBlob2File() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Write a Binary (memo) field's contents to a file + $SYNTAX$ + ADSBlob2File(cFileName, cFieldName) --> lSuccess + $ARGUMENTS$ + File to create. If it already exists, it will be + overwritten on success and destroyed on error. + + Field in the current workarea that contains binary data. + + $RETURNS$ + True if the file is successfully written. + $DESCRIPTION$ + See ace.hlp for full details about the Advantage Database Server. + ADSBlob2File() is a wrapper for AdsBinaryToFile. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + ADSFile2Blob() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSBlob2File() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Write a Binary (memo) field's contents to a file - * $SYNTAX$ - * ADSBlob2File(cFileName, cFieldName) --> lSuccess - * $ARGUMENTS$ - * File to create. If it already exists, it will be - * overwritten on success and destroyed on error. - * - * Field in the current workarea that contains binary data. - * - * $RETURNS$ - * True if the file is successfully written. - * $DESCRIPTION$ - * See ace.hlp for full details about the Advantage Database Server. - * ADSBlob2File() is a wrapper for AdsBinaryToFile. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * ADSFile2Blob() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSFile2Blob() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Save a Binary file to a field + $SYNTAX$ + ADSFile2Blob(cFileName, cFieldName, ) --> lSuccess + $ARGUMENTS$ + File to read. Can be in UNC format. A common example is an image file. + + Field in the current workarea to contain the binary data. + + Either ADS_BINARY (the default) or ADS_IMAGE. + 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). + $RETURNS$ + True if the file is successfully written. + $DESCRIPTION$ + See ace.hlp for full details about the Advantage Database Server. + ADSFile2Blob() is a wrapper for AdsFileToBinary. + Use of this function is illegal in an ADS transaction. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + ADSBlob2File() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSFile2Blob() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Save a Binary file to a field - * $SYNTAX$ - * ADSFile2Blob(cFileName, cFieldName, ) --> lSuccess - * $ARGUMENTS$ - * File to read. Can be in UNC format. A common example is an image file. - * - * Field in the current workarea to contain the binary data. - * - * Either ADS_BINARY (the default) or ADS_IMAGE. - * 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). - * $RETURNS$ - * True if the file is successfully written. - * $DESCRIPTION$ - * See ace.hlp for full details about the Advantage Database Server. - * ADSFile2Blob() is a wrapper for AdsFileToBinary. - * Use of this function is illegal in an ADS transaction. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * ADSBlob2File() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSClearAOF() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Clears an Advantage Optimized Filter in the current workarea. + $SYNTAX$ + ADSClearAOF() + $ARGUMENTS$ + None + $RETURNS$ + NIL + $DESCRIPTION$ + See ace.hlp for full details about the Advantage Database Server. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + ADSCustomizeAOF(),ADSEvalAOF(),ADSGetAOF(),ADSGetAOFoptLevel(),ADSIsRecordInAOF(),ADSRefreshAOF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSClearAOF() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Clears an Advantage Optimized Filter in the current workarea. - * $SYNTAX$ - * ADSClearAOF() - * $ARGUMENTS$ - * None - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * See ace.hlp for full details about the Advantage Database Server. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * ADSCustomizeAOF(),ADSEvalAOF(),ADSGetAOF(),ADSGetAOFoptLevel(),ADSIsRecordInAOF(),ADSRefreshAOF() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSCustomizeAOF() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Add or remove records from an existing AOF + $SYNTAX$ + ADSCustomizeAOF( [] [, ] ) --> nSuccess + $ARGUMENTS$ + 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. + + The type of operation: + + + ADS_AOF_ADD_RECORD Add the record to the AOF (set the bit). This is the default operation. + ADS_AOF_REMOVE_RECORD Remove the record from the AOF (clear the bit). + ADS_AOF_TOGGLE_RECORD Switch the record into or out of the AOF. +
+ $RETURNS$ + ADS error code, or 0 for success. + $DESCRIPTION$ + 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 SET FILTER TO or adsSetAOF(). But by using ADSCustomizeAOF() 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. + + The maximum number of records that can be customized in a single call is + 16,383, so must not be longer than this. + + Calls to AdsCustomizeAOF must be made after an application has created a + filter with a call to AdsSetAOF. To create a completely empty record set + (to which records can be added with calls to AdsCustomizeAOF), use ".F." as + the filter expression given to AdsSetAOF. To create a completely full + record set (from which records can be removed), use ".T." as the filter + expression. + + WARNING: Always start with a FULLY optimized AOF! + If an application must use a filter expression that is not fully optimized + as the starting point for customization, the ADS_RESOLVE_IMMEDIATE option + should be used with the call to AdsSetAOF. Otherwise, the dynamic filter + resolution that occurs on the server will automatically remove records that + have been added through the AdsCustomizeAOF calls. The + filter expressions ".T." and ".F." both result in fully optimized AOFs + regardless of available indexes. + + See ace.hlp for full details about the Advantage Database Server. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + ADSClearAOF(),ADSEvalAOF(),ADSGetAOF(),ADSGetAOFoptLevel(),ADSIsRecordInAOF(),ADSRefreshAOF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSCustomizeAOF() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Add or remove records from an existing AOF - * $SYNTAX$ - * ADSCustomizeAOF( [] [, ] ) --> nSuccess - * $ARGUMENTS$ - * 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. - * - * The type of operation: - - * - * ADS_AOF_ADD_RECORD Add the record to the AOF (set the bit). This is the default operation. - * ADS_AOF_REMOVE_RECORD Remove the record from the AOF (clear the bit). - * ADS_AOF_TOGGLE_RECORD Switch the record into or out of the AOF. - *
- * $RETURNS$ - * ADS error code, or 0 for success. - * $DESCRIPTION$ - * 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 SET FILTER TO or adsSetAOF(). But by using ADSCustomizeAOF() 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. - - * The maximum number of records that can be customized in a single call is - * 16,383, so must not be longer than this. - - * Calls to AdsCustomizeAOF must be made after an application has created a - * filter with a call to AdsSetAOF. To create a completely empty record set - * (to which records can be added with calls to AdsCustomizeAOF), use ".F." as - * the filter expression given to AdsSetAOF. To create a completely full - * record set (from which records can be removed), use ".T." as the filter - * expression. - - * WARNING: Always start with a FULLY optimized AOF! - * If an application must use a filter expression that is not fully optimized - * as the starting point for customization, the ADS_RESOLVE_IMMEDIATE option - * should be used with the call to AdsSetAOF. Otherwise, the dynamic filter - * resolution that occurs on the server will automatically remove records that - * have been added through the AdsCustomizeAOF calls. The - * filter expressions ".T." and ".F." both result in fully optimized AOFs - * regardless of available indexes. - - * See ace.hlp for full details about the Advantage Database Server. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * ADSClearAOF(),ADSEvalAOF(),ADSGetAOF(),ADSGetAOFoptLevel(),ADSIsRecordInAOF(),ADSRefreshAOF() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSEvalAOF() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Evaluate a filter expression to determine its optimization level + $SYNTAX$ + ADSEvalAOF() --> nOptimizationLevel + $ARGUMENTS$ + Expression to test. + $RETURNS$ + + Values are defined in ads.ch: + ADS_OPTIMIZED_FULL, ADS_OPTIMIZED_PART, ADS_OPTIMIZED_NONE. + IMPORTANT NOTE: These values are NOT the same as those returned + by dbOrderInfo(). + $DESCRIPTION$ + See ace.hlp for full details about the Advantage Database Server. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + ADSClearAOF(),ADSGetAOF(),ADSGetAOFoptLevel(),ADSIsRecordInAOF(),ADSRefreshAOF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSEvalAOF() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Evaluate a filter expression to determine its optimization level - * $SYNTAX$ - * ADSEvalAOF() --> nOptimizationLevel - * $ARGUMENTS$ - * Expression to test. - * $RETURNS$ - * - * Values are defined in ads.ch: - * ADS_OPTIMIZED_FULL, ADS_OPTIMIZED_PART, ADS_OPTIMIZED_NONE. - * IMPORTANT NOTE: These values are NOT the same as those returned - * by dbOrderInfo(). - * $DESCRIPTION$ - * See ace.hlp for full details about the Advantage Database Server. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * ADSClearAOF(),ADSGetAOF(),ADSGetAOFoptLevel(),ADSIsRecordInAOF(),ADSRefreshAOF() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSGetAOFoptLevel() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Returns optimization level of the current AOF filter + $SYNTAX$ + ADSGetAOFoptLevel() --> nOptimizationLevel + $ARGUMENTS$ + None + $RETURNS$ + + Values are defined in ads.ch: + ADS_OPTIMIZED_FULL, ADS_OPTIMIZED_PART, ADS_OPTIMIZED_NONE. + $DESCRIPTION$ + See ace.hlp for full details about the Advantage Database Server. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + ADSClearAOF(),ADSGetAOF(),ADSIsRecordInAOF(),ADSRefreshAOF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSGetAOFoptLevel() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Returns optimization level of the current AOF filter - * $SYNTAX$ - * ADSGetAOFoptLevel() --> nOptimizationLevel - * $ARGUMENTS$ - * None - * $RETURNS$ - * - * Values are defined in ads.ch: - * ADS_OPTIMIZED_FULL, ADS_OPTIMIZED_PART, ADS_OPTIMIZED_NONE. - * $DESCRIPTION$ - * See ace.hlp for full details about the Advantage Database Server. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * ADSClearAOF(),ADSGetAOF(),ADSIsRecordInAOF(),ADSRefreshAOF() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSGetAOF() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Retrieve the filter expression used in the call to AdsSetAOF + $SYNTAX$ + ADSGetAOF() --> cFilter + $ARGUMENTS$ + None + $RETURNS$ + The filter expression used in the call to AdsSetAOF. + $DESCRIPTION$ + See ace.hlp for full details about the Advantage Database Server. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + ADSClearAOF(),ADSGetAOFoptLevel(),ADSIsRecordInAOF(),ADSRefreshAOF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSGetAOF() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Retrieve the filter expression used in the call to AdsSetAOF - * $SYNTAX$ - * ADSGetAOF() --> cFilter - * $ARGUMENTS$ - * None - * $RETURNS$ - * The filter expression used in the call to AdsSetAOF. - * $DESCRIPTION$ - * See ace.hlp for full details about the Advantage Database Server. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * ADSClearAOF(),ADSGetAOFoptLevel(),ADSIsRecordInAOF(),ADSRefreshAOF() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSGetAOFnoOpt() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Return the non-optimized portion of the current filter expression + $SYNTAX$ + ADSGetAOFnoOpt() --> cFilterFragment + $ARGUMENTS$ + None + $RETURNS$ + If an AOF filter expression is not fully optimizable, + the non-optimizable part of the expression can be retrieved with this function. + $DESCRIPTION$ + See ace.hlp for full details about the Advantage Database Server. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + ADSClearAOF(),ADSIsRecordInAOF(),ADSRefreshAOF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSGetAOFnoOpt() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Return the non-optimized portion of the current filter expression - * $SYNTAX$ - * ADSGetAOFnoOpt() --> cFilterFragment - * $ARGUMENTS$ - * None - * $RETURNS$ - * If an AOF filter expression is not fully optimizable, - * the non-optimizable part of the expression can be retrieved with this function. - * $DESCRIPTION$ - * See ace.hlp for full details about the Advantage Database Server. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * ADSClearAOF(),ADSIsRecordInAOF(),ADSRefreshAOF() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSRefreshAOF() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Update the filter snapshot + $SYNTAX$ + ADSRefreshAOF() + $ARGUMENTS$ + None + $RETURNS$ + NIL + $DESCRIPTION$ + See ace.hlp 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. ADSRefreshAOF() + re-evaluates the data to include or exclude changed records. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + ADSClearAOF(),ADSIsRecordInAOF(),ADSSetAOF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSRefreshAOF() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Update the filter snapshot - * $SYNTAX$ - * ADSRefreshAOF() - * $ARGUMENTS$ - * None - * $RETURNS$ - * NIL - * $DESCRIPTION$ - * See ace.hlp 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. ADSRefreshAOF() - * re-evaluates the data to include or exclude changed records. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * ADSClearAOF(),ADSIsRecordInAOF(),ADSSetAOF() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSSetAOF() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Create an Advantage Optimized Filter + $SYNTAX$ + ADSSetAOF( [, ] ) --> lSuccess + $ARGUMENTS$ + Filter expression to set. + + Option to indicate how the filter should be resolved + in the event that the expression cannot be fully optimized. + Options are defined in ads.ch: + ADS_RESOLVE_IMMEDIATE, ADS_RESOLVE_DYNAMIC. + $RETURNS$ + True if AOF is created. + $DESCRIPTION$ + See ace.hlp for full details about the Advantage Database Server. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + ADSClearAOF(),ADSIsRecordInAOF(),ADSRefreshAOF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSSetAOF() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Create an Advantage Optimized Filter - * $SYNTAX$ - * ADSSetAOF( [, ] ) --> lSuccess - * $ARGUMENTS$ - * Filter expression to set. - - * Option to indicate how the filter should be resolved - * in the event that the expression cannot be fully optimized. - * Options are defined in ads.ch: - * ADS_RESOLVE_IMMEDIATE, ADS_RESOLVE_DYNAMIC. - * $RETURNS$ - * True if AOF is created. - * $DESCRIPTION$ - * See ace.hlp for full details about the Advantage Database Server. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * ADSClearAOF(),ADSIsRecordInAOF(),ADSRefreshAOF() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSIsRecordInAOF() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Determine if a record is in the current AOF + $SYNTAX$ + ADSIsRecordInAOF( [] ) --> lSatisfiesFilter + $ARGUMENTS$ + Record number to test. Default is current record. + $RETURNS$ + True if the record satisfies the filter criteria. + $DESCRIPTION$ + See ace.hlp for full details about the Advantage Database Server. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + ADSClearAOF(),ADSRefreshAOF() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSIsRecordInAOF() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Determine if a record is in the current AOF - * $SYNTAX$ - * ADSIsRecordInAOF( [] ) --> lSatisfiesFilter - * $ARGUMENTS$ - * Record number to test. Default is current record. - * $RETURNS$ - * True if the record satisfies the filter criteria. - * $DESCRIPTION$ - * See ace.hlp for full details about the Advantage Database Server. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * ADSClearAOF(),ADSRefreshAOF() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSGetRelKeyPos() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Estimated key position of current record within the current index + $SYNTAX$ + ADSGetRelKeyPos() --> nKeyPos + $ARGUMENTS$ + None. Only accesses the current index, if any. + $RETURNS$ + A value between 0.0 and 1.0, inclusive. + $DESCRIPTION$ + 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. + + This is the recommended function for positioning a scrollbar + or other "coarse" position interface. + See ace.hlp for full details about the Advantage Database Server. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + ADSKeyNo(),ADSKeyCount(),ADSSetRelKeyPos() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSGetRelKeyPos() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Estimated key position of current record within the current index - * $SYNTAX$ - * ADSGetRelKeyPos() --> nKeyPos - * $ARGUMENTS$ - * None. Only accesses the current index, if any. - * $RETURNS$ - * A value between 0.0 and 1.0, inclusive. - * $DESCRIPTION$ - * 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. - * - * This is the recommended function for positioning a scrollbar - * or other "coarse" position interface. - * See ace.hlp for full details about the Advantage Database Server. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * ADSKeyNo(),ADSKeyCount(),ADSSetRelKeyPos() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSSetRelKeyPos() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + GoTo the given estimated key position within the current index + $SYNTAX$ + ADSSetSelKeyPos( ) --> nError + $ARGUMENTS$ + Relative key position between 0.0 and 1.0, inclusive. + $RETURNS$ + The return/error value of the ADS API call. + $DESCRIPTION$ + This function moves the record pointer to the estimated relative position + within the current index order, respecting any scope setting. + It also works with no active index to go to the relative position of the + current record number. + + This is the recommended function for re-positioning in reaction to + a dragged scrollbar thumb or other "coarse" navigation interface. + See ace.hlp for full details about the Advantage Database Server. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + ADSKeyNo(),ADSKeyCount(),ADSGetRelKeyPos() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSSetRelKeyPos() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * GoTo the given estimated key position within the current index - * $SYNTAX$ - * ADSSetSelKeyPos( ) --> nError - * $ARGUMENTS$ - * Relative key position between 0.0 and 1.0, inclusive. - * $RETURNS$ - * The return/error value of the ADS API call. - * $DESCRIPTION$ - * This function moves the record pointer to the estimated relative position - * within the current index order, respecting any scope setting. - * It also works with no active index to go to the relative position of the - * current record number. - * - * This is the recommended function for re-positioning in reaction to - * a dragged scrollbar thumb or other "coarse" navigation interface. - * See ace.hlp for full details about the Advantage Database Server. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * ADSKeyNo(),ADSKeyCount(),ADSGetRelKeyPos() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSKeyCount() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Retrieve the number of keys in a specified index + $SYNTAX$ + ADSKeyCount([], , []) --> nKeyCount + $ARGUMENTS$ + Numeric order number OR index tag name. Default is current index. + + 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 + is passed as a third parameter. + + Indicates if filters and/or scopes are to be respected if set. + + Options are defined in ads.ch: + + + ADS_RESPECTFILTERS Respect filters and scopes + ADS_IGNOREFILTERS Ignore filters and scopes + ADS_RESPECTSCOPES Respect scopes only +
+ $RETURNS$ + The number of keys within the current index. + $DESCRIPTION$ + See ace.hlp for full details about the Advantage Database Server. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + ADSKeyNo(),ADSGetRelKeyPos() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSKeyCount() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Retrieve the number of keys in a specified index - * $SYNTAX$ - * ADSKeyCount([], , []) --> nKeyCount - * $ARGUMENTS$ - * Numeric order number OR index tag name. Default is current index. - * - * 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 - * is passed as a third parameter. - * - * Indicates if filters and/or scopes are to be respected if set. - - * Options are defined in ads.ch: - * - - * ADS_RESPECTFILTERS Respect filters and scopes - * ADS_IGNOREFILTERS Ignore filters and scopes - * ADS_RESPECTSCOPES Respect scopes only -
- * $RETURNS$ - * The number of keys within the current index. - * $DESCRIPTION$ - * See ace.hlp for full details about the Advantage Database Server. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * ADSKeyNo(),ADSGetRelKeyPos() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSKeyNo() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Get the logical key number of the current record in the given index + $SYNTAX$ + ADSKeyNo([], , []) --> nKeyNo + $ARGUMENTS$ + Numeric order number OR index tag name. Default is current index. + + 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 + is passed as a third parameter. + + Indicates if filters and/or scopes are to be respected if set. + + + Options are defined in ads.ch: + ADS_RESPECTFILTERS Respect filters and scopes + ADS_IGNOREFILTERS Ignore filters and scopes + ADS_RESPECTSCOPES Respect scopes only +
+ $RETURNS$ + The logical key number of the current record in the given index. + $DESCRIPTION$ + See ace.hlp for full details about the Advantage Database Server. + Wrapper for AdsGetKeyNum. + This function may be slow on a large database with + ADS_RESPECTFILTERS set because it walks through the keys to get the + current position. Compare to ADSGetRelKeyPos(). + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + ADSKeyCount(),ADSGetRelKeyPos() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSKeyNo() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Get the logical key number of the current record in the given index - * $SYNTAX$ - * ADSKeyNo([], , []) --> nKeyNo - * $ARGUMENTS$ - * Numeric order number OR index tag name. Default is current index. - * - * 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 - * is passed as a third parameter. - * - * Indicates if filters and/or scopes are to be respected if set. - * - * - * Options are defined in ads.ch: - * ADS_RESPECTFILTERS Respect filters and scopes - * ADS_IGNOREFILTERS Ignore filters and scopes - * ADS_RESPECTSCOPES Respect scopes only - *
- * $RETURNS$ - * The logical key number of the current record in the given index. - * $DESCRIPTION$ - * See ace.hlp for full details about the Advantage Database Server. - * Wrapper for AdsGetKeyNum. - * This function may be slow on a large database with - * ADS_RESPECTFILTERS set because it walks through the keys to get the - * current position. Compare to ADSGetRelKeyPos(). - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * ADSKeyCount(),ADSGetRelKeyPos() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSLocking() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Turns on/off the Advantage proprietary locking mode + $SYNTAX$ + ADSLocking( ) --> lPriorSetting + $ARGUMENTS$ + .T. to use the Advantage proprietary locking mode + (this is the default setting if a remote server is used) + or pass .F. to use "compatibility" locking. + + $RETURNS$ + .T. if prior setting was for the proprietary mode. + $DESCRIPTION$ + See ace.hlp 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). + + 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 ADSLocking( .F. ). + + ADSLocking() 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. + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + ADSRightsCheck() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSLocking() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Turns on/off the Advantage proprietary locking mode - * $SYNTAX$ - * ADSLocking( ) --> lPriorSetting - * $ARGUMENTS$ - * .T. to use the Advantage proprietary locking mode - * (this is the default setting if a remote server is used) - * or pass .F. to use "compatibility" locking. - * - * $RETURNS$ - * .T. if prior setting was for the proprietary mode. - * $DESCRIPTION$ - * See ace.hlp 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). - - * 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 ADSLocking( .F. ). - - * ADSLocking() 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. - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * ADSRightsCheck() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSRightsCheck() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Sets the "rights checking" setting for opening files + $SYNTAX$ + ADSRightsCheck( ) --> lPriorSetting + $ARGUMENTS$ + .T. to check rights upon opening data files (the default), + or .F. to ignore rights + + $RETURNS$ + + $DESCRIPTION$ + See ace.hlp for full details about the Advantage Database Server. + ADSRightsCheck() is a Get/Set function for the "rights checking" mode. + If the setting is .T. when a file is opened, then the Advantage + Database Server will use the rights of the connected user when + opening the file. If the user does not have rights to the + directory or server, then the open call will fail. + + If the setting is .F., then the ADS will + ignore the connected user's rights and open the file + regardless. This lets you allow only + Advantage-based applications to access specific data. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + ADSLocking() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSRightsCheck() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Sets the "rights checking" setting for opening files - * $SYNTAX$ - * ADSRightsCheck( ) --> lPriorSetting - * $ARGUMENTS$ - * .T. to check rights upon opening data files (the default), - * or .F. to ignore rights - * - * $RETURNS$ - * - * $DESCRIPTION$ - * See ace.hlp for full details about the Advantage Database Server. - * ADSRightsCheck() is a Get/Set function for the "rights checking" mode. - * If the setting is .T. when a file is opened, then the Advantage - * Database Server will use the rights of the connected user when - * opening the file. If the user does not have rights to the - * directory or server, then the open call will fail. - - * If the setting is .F., then the ADS will - * ignore the connected user's rights and open the file - * regardless. This lets you allow only - * Advantage-based applications to access specific data. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * ADSLocking() - * $END$ +/* $DOC$ + $FUNCNAME$ + AdsRegCallBack() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + For Progress displays: Sets a codeblock to be called during indexing + $SYNTAX$ + AdsRegCallBack( bEval ) --> nil + $ARGUMENTS$ + The codeblock that is eval'ed every 2 seconds during + indexing. A numeric value of the "percent completed" is passed + to the codeblock by the ADS server. The codeblock should return + a logical value: .T. to abort or .F. to not stop indexing. + + $RETURNS$ + + $DESCRIPTION$ + See ace.hlp for full details on AdsRegisterProgressCallback. + ace32.dll does not support the EVAL/EVERY 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 this. + $EXAMPLES$ + #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 + + FUNCTION outputstuff( nPercent ) /* The "callback" function */ + ? "output stuff", nPercent + RETURN Inkey() == K_ESC + /* If press ESC, returns .T. to abort. */ + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows, Linux + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + AdsClrCallBack() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * AdsRegCallBack() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * For Progress displays: Sets a codeblock to be called during indexing - * $SYNTAX$ - * AdsRegCallBack( bEval ) --> nil - * $ARGUMENTS$ - * The codeblock that is eval'ed every 2 seconds during - * indexing. A numeric value of the "percent completed" is passed - * to the codeblock by the ADS server. The codeblock should return - * a logical value: .T. to abort or .F. to not stop indexing. - * - * $RETURNS$ - * - * $DESCRIPTION$ - * See ace.hlp for full details on AdsRegisterProgressCallback. - * ace32.dll does not support the EVAL/EVERY 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 this. - * $EXAMPLES$ - * #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 - * - * FUNCTION outputstuff( nPercent ) /* The "callback" function */ - * ? "output stuff", nPercent - * RETURN Inkey() == K_ESC - * /* If press ESC, returns .T. to abort. */ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * AdsClrCallBack() - * $END$ +/* $DOC$ + $FUNCNAME$ + AdsClrCallBack() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Clears the callback set by AdsRegCallBack(). + $SYNTAX$ + AdsClrCallBack() --> nil + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + See AdsRegCallBack(). + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows, Linux + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + AdsRegCallBack() + $END$ */ - -/* $DOC$ - * $FUNCNAME$ - * AdsClrCallBack() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Clears the callback set by AdsRegCallBack(). - * $SYNTAX$ - * AdsClrCallBack() --> nil - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * See AdsRegCallBack(). - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * AdsRegCallBack() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSSetDefault() * + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Get/Set function for ADS's DEFAULT setting. + $SYNTAX$ + ADSSetDefault( [] ) --> cPriorSetting + $ARGUMENTS$ + Sets new value if passed. + + $RETURNS$ + + $DESCRIPTION$ + This function is NOT recommended! It allows direct access to the + ADS internal equivalent to SET DEFAULT TO. But this setting is + automatically maintained by Harbour's Set() function and the + SET DEFAULT TO command, so normal programming will not use this. + It exists primarily for testing purposes. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows, Linux + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + + $END$ */ - -/* $DOC$ - * $FUNCNAME$ - * ADSSetDefault() * - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Get/Set function for ADS's DEFAULT setting. - * $SYNTAX$ - * ADSSetDefault( [] ) --> cPriorSetting - * $ARGUMENTS$ - * Sets new value if passed. - * - * $RETURNS$ - * - * $DESCRIPTION$ - * This function is NOT recommended! It allows direct access to the - * ADS internal equivalent to SET DEFAULT TO. But this setting is - * automatically maintained by Harbour's Set() function and the - * SET DEFAULT TO command, so normal programming will not use this. - * It exists primarily for testing purposes. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSSetDeleted() * + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Get/Set function for ADS's ShowDeleted() setting. + $SYNTAX$ + ADSSetDeleted( [] ) --> lPriorSetting + $ARGUMENTS$ + Sets new value if passed. The value is parallel + to Harbour usage, so pass .F. to see deleted records or .T. + to hide them. (This is inverted from ADS's AdsShowDeleted() + syntax.) + + $RETURNS$ + + $DESCRIPTION$ + This function is NOT recommended! It allows direct access to the + ADS internal equivalent to SET DELETED. But this setting is + automatically maintained by Harbour's Set() function and the + SET DELETED ON/OFF command, so normal programming will not use this. + It exists primarily for testing purposes. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows, Linux + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + + $END$ */ - -/* $DOC$ - * $FUNCNAME$ - * ADSSetDeleted() * - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Get/Set function for ADS's ShowDeleted() setting. - * $SYNTAX$ - * ADSSetDeleted( [] ) --> lPriorSetting - * $ARGUMENTS$ - * Sets new value if passed. The value is parallel - * to Harbour usage, so pass .F. to see deleted records or .T. - * to hide them. (This is inverted from ADS's AdsShowDeleted() - * syntax.) - * - * $RETURNS$ - * - * $DESCRIPTION$ - * This function is NOT recommended! It allows direct access to the - * ADS internal equivalent to SET DELETED. But this setting is - * automatically maintained by Harbour's Set() function and the - * SET DELETED ON/OFF command, so normal programming will not use this. - * It exists primarily for testing purposes. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * $END$ +/* $DOC$ + $FUNCNAME$ + AdsSetSearchPath() * + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Get/Set function for ADS's AdsSetSearchPath() setting. + $SYNTAX$ + AdsSetSearchPath( [] ) --> cPriorSetting + $ARGUMENTS$ + Sets new value if passed. + + $RETURNS$ + + $DESCRIPTION$ + This function is NOT recommended! It allows direct access to the + ADS AdsSetSearchPath() setting. But this setting is + automatically maintained by Harbour's Set() function and the + SET PATH command, so normal programming will not use this. + It exists primarily for testing purposes. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows, Linux + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + + $END$ */ - -/* $DOC$ - * $FUNCNAME$ - * AdsSetSearchPath() * - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Get/Set function for ADS's AdsSetSearchPath() setting. - * $SYNTAX$ - * AdsSetSearchPath( [] ) --> cPriorSetting - * $ARGUMENTS$ - * Sets new value if passed. - * - * $RETURNS$ - * - * $DESCRIPTION$ - * This function is NOT recommended! It allows direct access to the - * ADS AdsSetSearchPath() setting. But this setting is - * automatically maintained by Harbour's Set() function and the - * SET PATH command, so normal programming will not use this. - * It exists primarily for testing purposes. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * $END$ +/* $DOC$ + $FUNCNAME$ + AdsSetExact() * + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Get/Set function for ADS's AdsSetExact() setting. + $SYNTAX$ + AdsSetExact( [] ) --> lPriorSetting + $ARGUMENTS$ + Sets new value if passed. + + $RETURNS$ + + $DESCRIPTION$ + This function is NOT recommended! It allows direct access to the + ADS internal equivalent to SET EXACT. But this setting is + automatically maintained by Harbour's Set() function and the + SET EXACT ON/OFF command, so normal programming will not use this. + It exists primarily for testing purposes. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows, Linux + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + + $END$ */ - -/* $DOC$ - * $FUNCNAME$ - * AdsSetExact() * - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Get/Set function for ADS's AdsSetExact() setting. - * $SYNTAX$ - * AdsSetExact( [] ) --> lPriorSetting - * $ARGUMENTS$ - * Sets new value if passed. - - * $RETURNS$ - * - * $DESCRIPTION$ - * This function is NOT recommended! It allows direct access to the - * ADS internal equivalent to SET EXACT. But this setting is - * automatically maintained by Harbour's Set() function and the - * SET EXACT ON/OFF command, so normal programming will not use this. - * It exists primarily for testing purposes. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSSetCharType() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Sets the type of character data expected when opening tables. + $SYNTAX$ + ADSSetCharType( , [lOEM] ) --> nPriorSetting + $ARGUMENTS$ + Type of character data in the table. + From ADS docs: + Options are ADS_ANSI and ADS_OEM. This indicates the type of + character data to be stored in the table. For compatibility with + DOS-based CA-Cl*pper applications, ADS_OEM should be specified. + When usTableType is ADS_ADT, this parameter is ignored and ANSI + is always used. + This parameter used for console mode applications, when + character data stored in OEM charset. If lOEM is passed as .T., + rddads doesn't convert character data into ANSI charset. + + $RETURNS$ + + $DESCRIPTION$ + See ace.hlp for full details about the Advantage Database Server. + This sets the usCharType parameter used when ADS opens a table. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows, Linux + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + AdsRightsCheck(),AdsLocking(), ADSSetFileType() + $END$ */ - -/* $DOC$ - * $FUNCNAME$ - * ADSSetCharType() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Sets the type of character data expected when opening tables. - * $SYNTAX$ - * ADSSetCharType( , [lOEM] ) --> nPriorSetting - * $ARGUMENTS$ - * Type of character data in the table. - * From ADS docs: - * Options are ADS_ANSI and ADS_OEM. This indicates the type of - * character data to be stored in the table. For compatibility with - * DOS-based CA-Cl*pper applications, ADS_OEM should be specified. - * When usTableType is ADS_ADT, this parameter is ignored and ANSI - * is always used. - * This parameter used for console mode applications, when - * character data stored in OEM charset. If lOEM is passed as .T., - * rddads doesn't convert character data into ANSI charset. - * - * $RETURNS$ - * - * $DESCRIPTION$ - * See ace.hlp for full details about the Advantage Database Server. - * This sets the usCharType parameter used when ADS opens a table. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * AdsRightsCheck(),AdsLocking(), ADSSetFileType() - * $END$ +/* $DOC$ + $FUNCNAME$ + AdsIsIndexed() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Fast determination for if current workarea has a selected index + $SYNTAX$ + AdsIsIndexed() --> lActiveIndex + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + Equivalent to empty(ordSetFocus())<\b>, but faster. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows, Linux + $FILES$ + Library is RddAds + $SEEALSO$ + + $END$ */ - -/* $DOC$ - * $FUNCNAME$ - * AdsIsIndexed() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Fast determination for if current workarea has a selected index - * $SYNTAX$ - * AdsIsIndexed() --> lActiveIndex - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * Equivalent to empty(ordSetFocus())<\b>, but faster. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * Library is RddAds - * $SEEALSO$ - * $END$ +/* $DOC$ + $FUNCNAME$ + AdsTestRecLocks() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Turn On or Off a "debug mode" for trapping missed record locks. + $SYNTAX$ + AdsTestRecLocks( ) --> lPriorSetting + $ARGUMENTS$ + New setting. Default is FALSE. + $RETURNS$ + Prior Setting. + $DESCRIPTION$ + AdsTestRecLocks() is a Get/Set function for a "record lock checking" mode. + ADS has Implicit Record locking that can mask programming errors. + Implicit locking can occur the first time a value is written to a + field with no lock in effect. The lock can potentially remain in + effect indefinitely if the record pointer is not moved, causing + bugs later in program execution that are hard to find. + In Harbour internal RDDs, a runtime error occurs if an attempt is made + to write to a shared file without a proper lock. + + AdsTestRecLocks( .T. ) will turn on a debugging mode to mimic this behavior + and throw an error instead of allowing an implicit lock. Each time a field + is set, we see if the file is open exclusively or locked, and whether + the record has been explicitly locked already. If not, we throw + an error so the developer can catch the missing lock condition. + For performance reasons, Release code should leave this OFF. + Although the call to AdsIsRecordLocked is documented as a client + call, not a server request, and should be fast, it will be + called for EACH FIELD as it is assigned a value. + + See ace.hlp for full details about the Advantage Database Server. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows, Linux + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * AdsTestRecLocks() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Turn On or Off a "debug mode" for trapping missed record locks. - * $SYNTAX$ - * AdsTestRecLocks( ) --> lPriorSetting - * $ARGUMENTS$ - * New setting. Default is FALSE. - * $RETURNS$ - * Prior Setting. - * $DESCRIPTION$ - * AdsTestRecLocks() is a Get/Set function for a "record lock checking" mode. - * ADS has Implicit Record locking that can mask programming errors. - * Implicit locking can occur the first time a value is written to a - * field with no lock in effect. The lock can potentially remain in - * effect indefinitely if the record pointer is not moved, causing - * bugs later in program execution that are hard to find. - * In Harbour internal RDDs, a runtime error occurs if an attempt is made - * to write to a shared file without a proper lock. - - * AdsTestRecLocks( .T. ) will turn on a debugging mode to mimic this behavior - * and throw an error instead of allowing an implicit lock. Each time a field - * is set, we see if the file is open exclusively or locked, and whether - * the record has been explicitly locked already. If not, we throw - * an error so the developer can catch the missing lock condition. - * For performance reasons, Release code should leave this OFF. - * Although the call to AdsIsRecordLocked is documented as a client - * call, not a server request, and should be fast, it will be - * called for EACH FIELD as it is assigned a value. - - * See ace.hlp for full details about the Advantage Database Server. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * $END$ +/* $DOC$ + $FUNCNAME$ + AdsGetLastError() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Returns any error code generated by the most recent ADS API call + $SYNTAX$ + AdsGetLastError() --> nErrorCode + $ARGUMENTS$ + None. + $RETURNS$ + The error code generated by the most recent ADS API call. Zero for success. + $DESCRIPTION$ + See ace.hlp for full details about the Advantage Database Server. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows, Linux + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + + $END$ */ - -/* $DOC$ - * $FUNCNAME$ - * AdsGetLastError() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Returns any error code generated by the most recent ADS API call - * $SYNTAX$ - * AdsGetLastError() --> nErrorCode - * $ARGUMENTS$ - * None. - * $RETURNS$ - * The error code generated by the most recent ADS API call. Zero for success. - * $DESCRIPTION$ - * See ace.hlp for full details about the Advantage Database Server. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * $END$ +/* $DOC$ + $FUNCNAME$ + AdsIsExprValid() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Determine if the ADS server can parse an expression + $SYNTAX$ + AdsIsExprValid( ) --> lSuccess + $ARGUMENTS$ + Any hopefully valid expression; often a filter string + $RETURNS$ + .T. if the expression is understood by ADS. + $DESCRIPTION$ + ADS has its own limitations for the logical or string expressions + used in indexes, filters, scopes, etc. Unlike internal RDDs like DBFNTX, + the server is independent of the applications code, so it cannot understand + references to PUBLIC variables or User-Defined Functions (UDFs). + (See ace.hlp under Advantage Expression Engine for a list of functions + allowed by ADS.) + Call AdsIsExprValid() to determine if the server can process the expression. + + For illustration, consider filter expressions. + Since Harbour attempts to be as compatible with Clipper as possible, + you CAN set a filter that ADS DOES NOT 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. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows, Linux + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * AdsIsExprValid() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Determine if the ADS server can parse an expression - * $SYNTAX$ - * AdsIsExprValid( ) --> lSuccess - * $ARGUMENTS$ - * Any hopefully valid expression; often a filter string - * $RETURNS$ - * .T. if the expression is understood by ADS. - * $DESCRIPTION$ - * ADS has its own limitations for the logical or string expressions - * used in indexes, filters, scopes, etc. Unlike internal RDDs like DBFNTX, - * the server is independent of the applications code, so it cannot understand - * references to PUBLIC variables or User-Defined Functions (UDFs). - * (See ace.hlp under Advantage Expression Engine for a list of functions - * allowed by ADS.) - * Call AdsIsExprValid() to determine if the server can process the expression. - - * For illustration, consider filter expressions. - * Since Harbour attempts to be as compatible with Clipper as possible, - * you CAN set a filter that ADS DOES NOT 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. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * $END$ +/* $DOC$ + $FUNCNAME$ + AdsGetConnectionType() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Returns the type of Server used by the given connection handle. + $SYNTAX$ + AdsGetConnectionType( [] ) --> nConnectionType + $ARGUMENTS$ + A connection handle retrieved via AdsConnect() + or AdsConnect60(). If omitted, the RDD's current connection + handle is used, but this only exists if AdsConnect() or AdsConnect60() + were previously called. + + $RETURNS$ + The type of Advantage Server that the connection uses, either + ADS_REMOTE_SERVER, ADS_AIS_SERVER, or ADS_LOCAL_SERVER. + $DESCRIPTION$ + 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 Internect 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 AdsGetTableConType(). + See ace.hlp for full details. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows, Linux + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + AdsGetTableConType(),AdsConnect(),AdsConnect60() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * AdsGetConnectionType() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Returns the type of Server used by the given connection handle. - * $SYNTAX$ - * AdsGetConnectionType( [] ) --> nConnectionType - * $ARGUMENTS$ - * A connection handle retrieved via AdsConnect() - * or AdsConnect60(). If omitted, the RDD's current connection - * handle is used, but this only exists if AdsConnect() or AdsConnect60() - * were previously called. - * - * $RETURNS$ - * The type of Advantage Server that the connection uses, either - * ADS_REMOTE_SERVER, ADS_AIS_SERVER, or ADS_LOCAL_SERVER. - * $DESCRIPTION$ - * 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 Internect 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 AdsGetTableConType(). - * See ace.hlp for full details. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * AdsGetTableConType(),AdsConnect(),AdsConnect60() - * $END$ +/* $DOC$ + $FUNCNAME$ + AdsGetTableConType() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Returns the type of Server used by current workarea. + $SYNTAX$ + AdsGetTableConType() --> nConnectionType + $ARGUMENTS$ + None. + + $RETURNS$ + The type of Advantage Server that the current workarea uses, either + ADS_REMOTE_SERVER, ADS_AIS_SERVER, or ADS_LOCAL_SERVER. + Returns zero if the current workarea does not have an Advantage table opened. + $DESCRIPTION$ + 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 Internect connection. + This function identifies the type of server used in the current workarea. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows, Linux + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + AdsGetConnectionType(),AdsConnect(),AdsConnect60() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * AdsGetTableConType() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Returns the type of Server used by current workarea. - * $SYNTAX$ - * AdsGetTableConType() --> nConnectionType - * $ARGUMENTS$ - * None. - * - * $RETURNS$ - * The type of Advantage Server that the current workarea uses, either - * ADS_REMOTE_SERVER, ADS_AIS_SERVER, or ADS_LOCAL_SERVER. - * Returns zero if the current workarea does not have an Advantage table opened. - * $DESCRIPTION$ - * 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 Internect connection. - * This function identifies the type of server used in the current workarea. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * AdsGetConnectionType(),AdsConnect(),AdsConnect60() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSDDADDTABLE() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Add a new table to a Data dictionary + $SYNTAX$ + ADSDDADDTABLE( , , ) --> lSuccess + $ARGUMENTS$ + Name of the table inside the data dictionary + Name of the adt or dbf file name + Optional name of the index file + $RETURNS$ + -> .T. if file was added, otherwise .F. + $DESCRIPTION$ + See ace.hlp for full details about the Advantage Database Server. + AdsDDAddTable() adds a new table to an ADS data dictionary. + To add the table you must be connected as ADSSYS user using the AdsConnect60() function + $EXAMPLES$ + 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") + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows, Linux + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + ADSCONNECT60(),ADSUSEDICTIONARY() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSDDADDTABLE() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Add a new table to a Data dictionary - * $SYNTAX$ - * ADSDDADDTABLE( , , ) --> lSuccess - * $ARGUMENTS$ - * Name of the table inside the data dictionary - * Name of the adt or dbf file name - * Optional name of the index file - * $RETURNS$ - * -> .T. if file was added, otherwise .F. - * $DESCRIPTION$ - * See ace.hlp for full details about the Advantage Database Server. - * AdsDDAddTable() adds a new table to an ADS data dictionary. - * To add the table you must be connected as ADSSYS user using the AdsConnect60() function - * $EXAMPLES$ - * 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") - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * ADSCONNECT60(),ADSUSEDICTIONARY() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSUSEDICTIONARY()* + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + This function has been REMOVED. It specified usage of a datadictionary connection + $SYNTAX$ + None + $ARGUMENTS$ + None + $RETURNS$ + None + $DESCRIPTION$ + This function no longer exists. See the Data Dictionary topic + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows, Linux + $FILES$ + + $SEEALSO$ + ADSCONNECT60() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSUSEDICTIONARY()* - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * This function has been REMOVED. It specified usage of a datadictionary connection - * $SYNTAX$ - * None - * $ARGUMENTS$ - * None - * $RETURNS$ - * None - * $DESCRIPTION$ - * This function no longer exists. See the Data Dictionary topic - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * $SEEALSO$ - * ADSCONNECT60() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSCONNECT60() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Connect to a local/remote/internet server + $SYNTAX$ + ADSCONNECT60(, , [], [], []) -> lSuccess + $ARGUMENTS$ + Name of data dictionary to connect to. + The server type to connect (LOCAL, REMOTE, AIS or all together) + Optional Name of the user connecting to the server + Optional password for the user Name + The optional connection options + + $RETURNS$ + True if connected, otherwise False. + $DESCRIPTION$ + Adsconnect60() makes the connection to an advantage database server. + See ace.hlp for full details about the Advantage Database Server. + $EXAMPLES$ + IF adsConnect60( "harbour.add", 7/* All types of connection*/, "ADSSYS", "",) + // Add one user + AdsDDCreateUser(, "Luiz", "papael", "This is luiz User") + ENDIF + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows, Linux + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + ADSDDADDTABLE() + $END$ */ - -/* $DOC$ - * $FUNCNAME$ - * ADSCONNECT60() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Connect to a local/remote/internet server - * $SYNTAX$ - * ADSCONNECT60(, , [], [], []) -> lSuccess - * $ARGUMENTS$ - * Name of data dictionary to connect to. - * The server type to connect (LOCAL, REMOTE, AIS or all together) - * Optional Name of the user connecting to the server - * Optional password for the user Name - * The optional connection options - * - * $RETURNS$ - * True if connected, otherwise False. - * $DESCRIPTION$ - * Adsconnect60() makes the connection to an advantage database server. - * See ace.hlp for full details about the Advantage Database Server. - * $EXAMPLES$ - * IF adsConnect60( "harbour.add", 7/* All types of connection*/, "ADSSYS", "",) - * // Add one user - * AdsDDCreateUser(, "Luiz", "papael", "This is luiz User") - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * ADSDDADDTABLE() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSCACHEOPENTABLES() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Provides caching of open tables + $SYNTAX$ + ADSCACHEOPENTABLES() -> nRetVal + $ARGUMENTS$ + Number of tables to cache. + + $RETURNS$ + ??? + $DESCRIPTION$ + AdsCacheOpenTables allows table closes to be cached in order for + subsequent opens to occur faster. A call to AdsCloseTable with + the table cache greater than zero results in the table appearing + closed to an application, but still open on the Advantage server. + AdsCacheOpenTables is a global setting that affects the behavior + of the entire application. The default number of open tables that + are cached is 0. + $EXAMPLES$ + AdsCacheOpenTables( 25 ) + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows, Linux + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + AdsCacheOpenCursors() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSCACHEOPENTABLES() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Provides caching of open tables - * $SYNTAX$ - * ADSCACHEOPENTABLES() -> nRetVal - * $ARGUMENTS$ - * Number of tables to cache. - * - * $RETURNS$ - * ??? - * $DESCRIPTION$ - * AdsCacheOpenTables allows table closes to be cached in order for - * subsequent opens to occur faster. A call to AdsCloseTable with - * the table cache greater than zero results in the table appearing - * closed to an application, but still open on the Advantage server. - * AdsCacheOpenTables is a global setting that affects the behavior - * of the entire application. The default number of open tables that - * are cached is 0. - * $EXAMPLES$ - * AdsCacheOpenTables( 25 ) - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * AdsCacheOpenCursors() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSCACHEOPENCURSORS() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Provides caching of open cursors + $SYNTAX$ + ADSCACHEOPENCURSORS() -> nRetVal + $ARGUMENTS$ + Number of cursors to cache. + + $RETURNS$ + ??? + $DESCRIPTION$ + AdsCacheOpenCursors allows cursor closes to be cached in + order for subsequent SELECTS to occur faster. A call to + AdsCloseTable with the cursor cache greater than zero results + in the cursor appearing closed to an application, but still + open on the Advantage server. + AdsCacheOpenCursors is a global setting that affects the + behavior of the entire application. The default number of + open cursors that are cached is 25. + $EXAMPLES$ + AdsCacheOpenCursors( 0 ) + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows, Linux + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + AdsCacheOpenTables() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSCACHEOPENCURSORS() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Provides caching of open cursors - * $SYNTAX$ - * ADSCACHEOPENCURSORS() -> nRetVal - * $ARGUMENTS$ - * Number of cursors to cache. - * - * $RETURNS$ - * ??? - * $DESCRIPTION$ - * AdsCacheOpenCursors allows cursor closes to be cached in - * order for subsequent SELECTS to occur faster. A call to - * AdsCloseTable with the cursor cache greater than zero results - * in the cursor appearing closed to an application, but still - * open on the Advantage server. - * AdsCacheOpenCursors is a global setting that affects the - * behavior of the entire application. The default number of - * open cursors that are cached is 25. - * $EXAMPLES$ - * AdsCacheOpenCursors( 0 ) - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * AdsCacheOpenTables() - * $END$ +/* $DOC$ + $FUNCNAME$ + ADSCLOSECACHEDTABLES() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + Close all cached tables on the given connection + $SYNTAX$ + ADSCLOSECACHEDTABLES([]) -> nRetVal + $ARGUMENTS$ + A connection handle retrieved via AdsConnect() + or AdsConnect60(). If omitted, the RDD's current connection + handle is used, but this only exists if AdsConnect() or AdsConnect60() + were previously called. + $RETURNS$ + ??? + $DESCRIPTION$ + AdsCloseCachedTables 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. + $EXAMPLES$ + AdsCloseCachedTables() + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Ads 7.x and above, Windows, Linux + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + AdsCacheOpenTables(), AdsCacheOpenCursors() + $END$ */ -/* $DOC$ - * $FUNCNAME$ - * ADSCLOSECACHEDTABLES() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * Close all cached tables on the given connection - * $SYNTAX$ - * ADSCLOSECACHEDTABLES([]) -> nRetVal - * $ARGUMENTS$ - * A connection handle retrieved via AdsConnect() - * or AdsConnect60(). If omitted, the RDD's current connection - * handle is used, but this only exists if AdsConnect() or AdsConnect60() - * were previously called. - * $RETURNS$ - * ??? - * $DESCRIPTION$ - * AdsCloseCachedTables 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. - * $EXAMPLES$ - * AdsCloseCachedTables() - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Ads 7.x and above, Windows, Linux - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * AdsCacheOpenTables(), AdsCacheOpenCursors() - * $END$ +/* $DOC$ + $FUNCNAME$ + xxx() + $CATEGORY$ + Advantage Database RDD + $ONELINER$ + xxx + $SYNTAX$ + xxx( ) --> lPriorSetting + $ARGUMENTS$ + xxx + xxx + + $RETURNS$ + + $DESCRIPTION$ + See ace.hlp for full details about the Advantage Database Server. + ADSRightsCheck() is a Get/Set function for the "rights checking" mode. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + Harbour extension + $PLATFORMS$ + Windows, Linux + $FILES$ + Library is RddAds + Header is ads.ch + $SEEALSO$ + xxx() + $END$ */ - - -/* $DOC$ - * $FUNCNAME$ - * xxx() - * $CATEGORY$ - * Advantage Database RDD - * $ONELINER$ - * xxx - * $SYNTAX$ - * xxx( ) --> lPriorSetting - * $ARGUMENTS$ - * xxx - * xxx - * - * $RETURNS$ - * - * $DESCRIPTION$ - * See ace.hlp for full details about the Advantage Database Server. - * ADSRightsCheck() is a Get/Set function for the "rights checking" mode. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension - * $PLATFORMS$ - * Windows, Linux - * $FILES$ - * Library is RddAds - * Header is ads.ch - * $SEEALSO$ - * xxx() - * $END$ - */ - -/* TO-DO: - -v6: - AdsAddUserToGroup - -AdsAddCustomKey -AdsDeleteCustomKey -AdsGetTableAlias -AdsConnect -AdsDisconnect -AdsCloseAllTables -AdsWriteAllRecords -AdsRefreshRecord -AdsCopyTable -AdsConvertTable -AdsGetNumIndexes - -ADSDecryptRecord -ADSDecryptTable -ADSDisableEncryption -ADSEnableEncryption -ADSEncryptRecord -ADSEncryptTable -ADSIsEncryptionEnabled -ADSIsRecordEncrypted -ADSIsTableEncrypted - -*/ diff --git a/harbour/contrib/rddads/doc/en/readme.txt b/harbour/contrib/rddads/doc/en/readme.txt index 3305b1fae9..407c741a2b 100644 --- a/harbour/contrib/rddads/doc/en/readme.txt +++ b/harbour/contrib/rddads/doc/en/readme.txt @@ -2,167 +2,166 @@ * $Id$ */ -/* - * $DOC$ - * $FUNCNAME$ - * ADS Overview - * $CATEGORY$ - * Document - * $ONELINER$ - * Advantage Database Server RDD - * $DESCRIPTION$ - * RDDADS is an RDD for the Advantage Database Server, an xBase data - * server by Extended Systems . - * The RDD was written by Alexander Kresin - * Additional code and documentation was added by - * Brian Hays . - * - * 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. - * - * For using this RDD you need to have all required dynamic libraries - * installed on your system. - * - * For building executables don't forget to include rddads.hbc in your - * hbmk2 project. - * - * You also need to include in your prg file following lines: - * - * REQUEST ADS - * rddRegister( "ADS", 1 ) - * rddsetdefault( "ADS" ) - * - * By default RDDADS is tuned for remote server and cdx indexes. To - * change this you may use these commands defined in ads.ch: - * - * SET SERVER LOCAL - * SET SERVER REMOTE - * - * SET FILETYPE TO NTX - * SET FILETYPE TO ADT - * SET FILETYPE TO CDX - * - * or functions AdsSetServerType(), AdsSetFileType(). - * See the header file ads.ch for details. - * - * Note that the default local server is useable for - * file sharing on a small network. The default DLL is limited to - * 5 users, but an unlimited version is available from Extended Systems. - * - * MAX OPEN TABLES: The server (even local) has its own setting for - * Max Tables allowed open. For the Local Server, it can be set in - * adslocal.cfg. The default is only 50! - * For the Windows Remote Servers, use the Configuration Utility, or - * increase the setting for the TABLES configuration value in the Advantage - * Database Server configuration registry key using the Registry Editor. - * For NetWare, edit the configuration file ads.cfg. - * - * See ace.hlp under adslocal.cfg, or the Advantage Error Guide for - * error 7005. - * - * SPEED AND PERFORMANCE ISSUES - * - * 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 - * ADSGetRelKeyPos() and ADSSetRelKeyPos() instead of key counting functions. - * - * 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 - * - * Set( _SET_OPTIMIZE, .T. ) - * - * or its command equivalent. RDDADS will use an AOF whenever - * dbSetFilter is called *if it can*. - * - * 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 - * - * ? AdsIsExprValid( cFilter ) - * - * 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 eval'ing the - * codeblock and testing each record). The only way to speed it up is to - * fix the filter so ADS understands it. - * - * You can also use dbOrderInfo(DBOI_OPTLEVEL) to see if the current - * filter is optimized or not. COMIX users can use: - * - * FUNCTION rlOptLevel() - * RETURN dbOrderInfo(DBOI_OPTLEVEL) - * - * 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). - * - * $COMPLIANCE$ - * Every attempt has been made to make the RDD compliant with the - * standard dbfcdx RDD at the .prg level. - * One important difference is the handling of structural indexes. - * ACE will always automatically open an index with the same - * name as the data file. There is no way to turn this feature off. - * - * You can use the Set() function call as well as the equivalent - * commands for SET DEFAULT TO, DATEFORMAT, DELETE, and EPOCH. - * Harbour automatically makes the call to ADS to change its internal - * setting to match Harbour's. - * - * INDEXING and Progress Displays: - * Remote server does not support the EVAL/EVERY 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 adsRegCallback( bEval ). - * It lets you set a codeblock that is eval'ed every 2 seconds. - * A numeric value of the "percent completed" is passed to the - * codeblock by the ADS server. - * - * - * #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 - * - * FUNCTION outputstuff( nPercent ) /* The "callback" function */ - * ? "output stuff", nPercent - * RETURN Inkey() == K_ESC - * /* If press ESC, returns .T. to abort. */ - *
- * - * For programmers who are already familiar with the ACE engine, - * Harbour's compatibility with dbfcdx means there are some differences - * between the RDDADS in Harbour and the parallel ACE documentation: - * - * 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. - * - * 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. - * - * One problem with this scenario is that index key counting - * functions that are supposed to give an accurate count respecting - * the filter (e.g. dbOrderInfo(DBOI_KEYCOUNT) will return the values the - * Server knows about, so the counts may be inaccurate. - * - * 3) When setting a relation, the expression must be one that can be - * evaluated by the Advantage Expression Engine. UDFs will fail. - * - * $END$ +/* $DOC$ + $FUNCNAME$ + ADS Overview + $CATEGORY$ + Document + $ONELINER$ + Advantage Database Server RDD + $DESCRIPTION$ + RDDADS is an RDD for the Advantage Database Server, an xBase data + server by Extended Systems . + The RDD was written by Alexander Kresin + Additional code and documentation was added by + Brian Hays . + + 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. + + For using this RDD you need to have all required dynamic libraries + installed on your system. + + For building executables don't forget to include rddads.hbc in your + hbmk2 project. + + You also need to include in your prg file following lines: + + REQUEST ADS + rddRegister( "ADS", 1 ) + rddsetdefault( "ADS" ) + + By default RDDADS is tuned for remote server and cdx indexes. To + change this you may use these commands defined in ads.ch: + + SET SERVER LOCAL + SET SERVER REMOTE + + SET FILETYPE TO NTX + SET FILETYPE TO ADT + SET FILETYPE TO CDX + + or functions AdsSetServerType(), AdsSetFileType(). + See the header file ads.ch for details. + + Note that the default local server is useable for + file sharing on a small network. The default DLL is limited to + 5 users, but an unlimited version is available from Extended Systems. + + MAX OPEN TABLES: The server (even local) has its own setting for + Max Tables allowed open. For the Local Server, it can be set in + adslocal.cfg. The default is only 50! + For the Windows Remote Servers, use the Configuration Utility, or + increase the setting for the TABLES configuration value in the Advantage + Database Server configuration registry key using the Registry Editor. + For NetWare, edit the configuration file ads.cfg. + + See ace.hlp under adslocal.cfg, or the Advantage Error Guide for + error 7005. + + SPEED AND PERFORMANCE ISSUES + + 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 + ADSGetRelKeyPos() and ADSSetRelKeyPos() instead of key counting functions. + + 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 + + Set( _SET_OPTIMIZE, .T. ) + + or its command equivalent. RDDADS will use an AOF whenever + dbSetFilter is called *if it can*. + + 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 + + ? AdsIsExprValid( cFilter ) + + 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 eval'ing the + codeblock and testing each record). The only way to speed it up is to + fix the filter so ADS understands it. + + You can also use dbOrderInfo(DBOI_OPTLEVEL) to see if the current + filter is optimized or not. COMIX users can use: + + FUNCTION rlOptLevel() + RETURN dbOrderInfo(DBOI_OPTLEVEL) + + 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). + + $COMPLIANCE$ + Every attempt has been made to make the RDD compliant with the + standard dbfcdx RDD at the .prg level. + One important difference is the handling of structural indexes. + ACE will always automatically open an index with the same + name as the data file. There is no way to turn this feature off. + + You can use the Set() function call as well as the equivalent + commands for SET DEFAULT TO, DATEFORMAT, DELETE, and EPOCH. + Harbour automatically makes the call to ADS to change its internal + setting to match Harbour's. + + INDEXING and Progress Displays: + Remote server does not support the EVAL/EVERY 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 adsRegCallback( bEval ). + It lets you set a codeblock that is eval'ed every 2 seconds. + A numeric value of the "percent completed" is passed to the + codeblock by the ADS server. + + + #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 + + FUNCTION outputstuff( nPercent ) /* The "callback" function */ + ? "output stuff", nPercent + RETURN Inkey() == K_ESC + /* If press ESC, returns .T. to abort. */ +
+ + For programmers who are already familiar with the ACE engine, + Harbour's compatibility with dbfcdx means there are some differences + between the RDDADS in Harbour and the parallel ACE documentation: + + 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. + + 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. + + One problem with this scenario is that index key counting + functions that are supposed to give an accurate count respecting + the filter (e.g. dbOrderInfo(DBOI_KEYCOUNT) will return the values the + Server knows about, so the counts may be inaccurate. + + 3) When setting a relation, the expression must be one that can be + evaluated by the Advantage Expression Engine. UDFs will fail. + + $END$ */ diff --git a/harbour/doc/en/1stread.txt b/harbour/doc/en/1stread.txt index ff46def294..94b816f7ab 100644 --- a/harbour/doc/en/1stread.txt +++ b/harbour/doc/en/1stread.txt @@ -50,51 +50,51 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Document - * $NAME$ - * 1st document to read - * $CATEGORY$ - * Document - * $SUBCATEGORY$ - * - * $ONELINER$ - * A starters guide to Harbour - * $DESCRIPTION$ - * Welcome to Harbour - * ================== - * - * Clipper is a trademark of Computer Associates and will often be - * referred to as CA-Cl*pper within Harbour documents. Regardless of this - * variant, Clipper is recognized as Computer Associates' trademark. - * - * Harbour is a free software compiler for the xBase superset language often - * referred to as Clipper (the language that is implemented by the compiler - * Clipper). The goal of the Harbour project is to produce a cross platform - * CA-Cl*pper compatible compiler. - * - * The Harbour web site is at . If you - * have any problems with this copy of Harbour please visit our web site and - * ensure that you are using the latest release. - * - * If you have any questions about Harbour please be sure to read the FAQ - * . Also, please be sure to read the - * documentation that comes with Harbour, you should find it in the same - * directory in which you found this file. - * - * If you are reading this file as part of a source distribution of harbour you - * probably want to start by reading dirstruc.txt because this is your map to - * the harbour source directories. - * - * Harbour is a superset of Clipper and is backwards compatible with nearly - * 100% of all Clipper 5.2x or 5.3 code. Most Clipper S'87 code will also - * compile and run fine, but may require some modifications to run well. - * $PLATFORMS$ - * All - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Document + $NAME$ + 1st document to read + $CATEGORY$ + Document + $SUBCATEGORY$ + + $ONELINER$ + A starters guide to Harbour + $DESCRIPTION$ + Welcome to Harbour + ================== + + Clipper is a trademark of Computer Associates and will often be + referred to as CA-Cl*pper within Harbour documents. Regardless of this + variant, Clipper is recognized as Computer Associates' trademark. + + Harbour is a free software compiler for the xBase superset language often + referred to as Clipper (the language that is implemented by the compiler + Clipper). The goal of the Harbour project is to produce a cross platform + CA-Cl*pper compatible compiler. + + The Harbour web site is at . If you + have any problems with this copy of Harbour please visit our web site and + ensure that you are using the latest release. + + If you have any questions about Harbour please be sure to read the FAQ + . Also, please be sure to read the + documentation that comes with Harbour, you should find it in the same + directory in which you found this file. + + If you are reading this file as part of a source distribution of harbour you + probably want to start by reading dirstruc.txt because this is your map to + the harbour source directories. + + Harbour is a superset of Clipper and is backwards compatible with nearly + 100% of all Clipper 5.2x or 5.3 code. Most Clipper S'87 code will also + compile and run fine, but may require some modifications to run well. + $PLATFORMS$ + All + $FILES$ + + $SEEALSO$ + + $END$ */ diff --git a/harbour/doc/en/array.txt b/harbour/doc/en/array.txt index 659beeceed..6646985f37 100644 --- a/harbour/doc/en/array.txt +++ b/harbour/doc/en/array.txt @@ -17,590 +17,590 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ARRAY() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Array - * $ONELINER$ - * Create an uninitialized array of specified length - * $SYNTAX$ - * ARRAY( [, ...] ) --> aArray - * $ARGUMENTS$ - * is the number of elements in the specified dimension. - * $RETURNS$ - * an array of specified dimensions. - * $DESCRIPTION$ - * This function returns an uninitialized array with the length of - * . - * - * Nested arrays are uninitialized within the same array - * pointer reference if additional parameters are specified. - * - * Establishing a memory variable with the same name as the array may - * destroy the original array and release the entire contents of the - * array. This depends, of course, on the data storage type of either - * the array or the variable with the same name as the array. - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL aArray := Array( 10 ) - * LOCAL x - * FOR x := 1 TO Len( aArray ) - * aArray[ x ] := Array( x ) - * NEXT - * // Result is: { { NIL }, { NIL, NIL }, ... } - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C(array) - * $FILES$ - * Library is vm - * $SEEALSO$ - * AADD(),ADEL(),AFILL(),AINS() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ARRAY() + $CATEGORY$ + API + $SUBCATEGORY$ + Array + $ONELINER$ + Create an uninitialized array of specified length + $SYNTAX$ + ARRAY( [, ...] ) --> aArray + $ARGUMENTS$ + is the number of elements in the specified dimension. + $RETURNS$ + an array of specified dimensions. + $DESCRIPTION$ + This function returns an uninitialized array with the length of + . + + Nested arrays are uninitialized within the same array + pointer reference if additional parameters are specified. + + Establishing a memory variable with the same name as the array may + destroy the original array and release the entire contents of the + array. This depends, of course, on the data storage type of either + the array or the variable with the same name as the array. + $EXAMPLES$ + PROCEDURE Main() + LOCAL aArray := Array( 10 ) + LOCAL x + FOR x := 1 TO Len( aArray ) + aArray[ x ] := Array( x ) + NEXT + // Result is: { { NIL }, { NIL, NIL }, ... } + RETURN + $STATUS$ + R + $COMPLIANCE$ + C(array) + $FILES$ + Library is vm + $SEEALSO$ + AADD(),ADEL(),AFILL(),AINS() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * AADD() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Array - * $ONELINER$ - * Dynamically add an element to an array - * $SYNTAX$ - * AADD([, ]) --> Value - * $ARGUMENTS$ - * The name of an array - * - * Element to add to array - * $RETURNS$ - * if specified , will return , otherwise this - * function returns a NIL value. - * $DESCRIPTION$ - * This function dynamically increases the length of the array named - * by one element and stores the value of to that - * newly created element. - * - * may be an array reference pointer, which in turn may be - * stored to an array's subscript position. - * $EXAMPLES$ - * LOCAL aArray := {} - * LOCAL x - * AAdd( aArray, 10 ) - * FOR x := 1 TO 10 - * AAdd( aArray, x ) - * NEXT - * // Result is: { 10, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 } - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is vm - * $SEEALSO$ - * AINS(),ASIZE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + AADD() + $CATEGORY$ + API + $SUBCATEGORY$ + Array + $ONELINER$ + Dynamically add an element to an array + $SYNTAX$ + AADD([, ]) --> Value + $ARGUMENTS$ + The name of an array + + Element to add to array + $RETURNS$ + if specified , will return , otherwise this + function returns a NIL value. + $DESCRIPTION$ + This function dynamically increases the length of the array named + by one element and stores the value of to that + newly created element. + + may be an array reference pointer, which in turn may be + stored to an array's subscript position. + $EXAMPLES$ + LOCAL aArray := {} + LOCAL x + AAdd( aArray, 10 ) + FOR x := 1 TO 10 + AAdd( aArray, x ) + NEXT + // Result is: { 10, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 } + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is vm + $SEEALSO$ + AINS(),ASIZE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ASIZE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Array - * $ONELINER$ - * Adjust the size of an array - * $SYNTAX$ - * ASIZE(, ) --> aTarget - * $ARGUMENTS$ - * Name of array to be dynamically altered - * - * Numeric value representing the new size of - * $RETURNS$ - * an array pointer reference to . - * $DESCRIPTION$ - * This function will dynamically increase or decrease the size of - * by adjusting the length of the array to subscript - * positions. - * - * If the length of the array is shortened, those former - * subscript positions are lost. If the length of the array is - * lengthened a NIL value is assigned to the new subscript position. - * $EXAMPLES$ - * LOCAL aArray := { 1 } // Result: aArray is { 1 } - * ASize( aArray, 3 ) // Result: aArray is { 1, NIL, NIL } - * ASize( aArray, 1 ) // Result: aArray is { 1 } - * $STATUS$ - * R - * $COMPLIANCE$ - * If HB_COMPAT_C53 is defined, the function generates an Error, - * else it will return the array itself. - * $FILES$ - * Library is vm - * $SEEALSO$ - * AADD(),ADEL(),AFILL(),AINS() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ASIZE() + $CATEGORY$ + API + $SUBCATEGORY$ + Array + $ONELINER$ + Adjust the size of an array + $SYNTAX$ + ASIZE(, ) --> aTarget + $ARGUMENTS$ + Name of array to be dynamically altered + + Numeric value representing the new size of + $RETURNS$ + an array pointer reference to . + $DESCRIPTION$ + This function will dynamically increase or decrease the size of + by adjusting the length of the array to subscript + positions. + + If the length of the array is shortened, those former + subscript positions are lost. If the length of the array is + lengthened a NIL value is assigned to the new subscript position. + $EXAMPLES$ + LOCAL aArray := { 1 } // Result: aArray is { 1 } + ASize( aArray, 3 ) // Result: aArray is { 1, NIL, NIL } + ASize( aArray, 1 ) // Result: aArray is { 1 } + $STATUS$ + R + $COMPLIANCE$ + If HB_COMPAT_C53 is defined, the function generates an Error, + else it will return the array itself. + $FILES$ + Library is vm + $SEEALSO$ + AADD(),ADEL(),AFILL(),AINS() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ATAIL() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Array - * $ONELINER$ - * Returns the rightmost element of an array - * $SYNTAX$ - * ATAIL( ) --> Element - * $ARGUMENTS$ - * is the array. - * $RETURNS$ - * the expression of the last element in the array. - * $DESCRIPTION$ - * This function return the value of the last element in the array - * named . This function does not alter the size of the - * array or any of the subscript values. - * $EXAMPLES$ - * LOCAL aArray := { "Harbour", "is", "Supreme", "Power" } - * ? ATail( aArray ) // Result is "Power" - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is vm - * $SEEALSO$ - * LEN(),ARRAY(),ASIZE(),AADD() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ATAIL() + $CATEGORY$ + API + $SUBCATEGORY$ + Array + $ONELINER$ + Returns the rightmost element of an array + $SYNTAX$ + ATAIL( ) --> Element + $ARGUMENTS$ + is the array. + $RETURNS$ + the expression of the last element in the array. + $DESCRIPTION$ + This function return the value of the last element in the array + named . This function does not alter the size of the + array or any of the subscript values. + $EXAMPLES$ + LOCAL aArray := { "Harbour", "is", "Supreme", "Power" } + ? ATail( aArray ) // Result is "Power" + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is vm + $SEEALSO$ + LEN(),ARRAY(),ASIZE(),AADD() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * AINS() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Array - * $ONELINER$ - * Insert a NIL value at an array subscript position. - * $SYNTAX$ - * AINS( , ) --> aTarget - * $ARGUMENTS$ - * Array name. - * - * Subscript position in - * $RETURNS$ - * an array pointer reference. - * $DESCRIPTION$ - * This function inserts a NIL value in the array named - * at the th position. - * - * All array elements starting with the th position will be - * shifted down one subscript position in the array list and the - * last item in the array will be removed completely. In other words, - * if an array element were to be inserted at the fifth subscript - * position, the element previously in the fifth position would now - * be located at the sixth position. The length of the array - * will remain unchanged. - * $EXAMPLES$ - * LOCAL aArray := { "Harbour", "is", "Power!", "!!!" } - * AIns( aArray, 4 ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is vm - * $SEEALSO$ - * AADD(),ACOPY(),ADEL(),AEVAL(),AFILL(),ASIZE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + AINS() + $CATEGORY$ + API + $SUBCATEGORY$ + Array + $ONELINER$ + Insert a NIL value at an array subscript position. + $SYNTAX$ + AINS( , ) --> aTarget + $ARGUMENTS$ + Array name. + + Subscript position in + $RETURNS$ + an array pointer reference. + $DESCRIPTION$ + This function inserts a NIL value in the array named + at the th position. + + All array elements starting with the th position will be + shifted down one subscript position in the array list and the + last item in the array will be removed completely. In other words, + if an array element were to be inserted at the fifth subscript + position, the element previously in the fifth position would now + be located at the sixth position. The length of the array + will remain unchanged. + $EXAMPLES$ + LOCAL aArray := { "Harbour", "is", "Power!", "!!!" } + AIns( aArray, 4 ) + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is vm + $SEEALSO$ + AADD(),ACOPY(),ADEL(),AEVAL(),AFILL(),ASIZE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ADEL() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Array - * $ONELINER$ - * Delete an element form an array. - * $SYNTAX$ - * ADEL(, ) --> aTarget - * $ARGUMENTS$ - * Name of array from which an element is to be removed. - * - * Subscript of the element to be removed. - * $RETURNS$ - * an array pointer reference. - * $DESCRIPTION$ - * This function deletes the element found at subscript position - * in the array . All elements in the array below the - * given subscript position will move up one position in the - * array. In other words, what was formerly the sixth subscript position - * will become the fifth subscript position. The length of the array - * will remain unchanged,as the last element in the array will - * become a NIL data type. - * $EXAMPLES$ - * LOCAL aArray := { "Harbour", "is", "Power" } - * ADel( aArray, 2 ) // Result: aArray is { "Harbour", "Power" } - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is vm - * $SEEALSO$ - * ACOPY(),AINS(),AFILL() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ADEL() + $CATEGORY$ + API + $SUBCATEGORY$ + Array + $ONELINER$ + Delete an element form an array. + $SYNTAX$ + ADEL(, ) --> aTarget + $ARGUMENTS$ + Name of array from which an element is to be removed. + + Subscript of the element to be removed. + $RETURNS$ + an array pointer reference. + $DESCRIPTION$ + This function deletes the element found at subscript position + in the array . All elements in the array below the + given subscript position will move up one position in the + array. In other words, what was formerly the sixth subscript position + will become the fifth subscript position. The length of the array + will remain unchanged,as the last element in the array will + become a NIL data type. + $EXAMPLES$ + LOCAL aArray := { "Harbour", "is", "Power" } + ADel( aArray, 2 ) // Result: aArray is { "Harbour", "Power" } + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is vm + $SEEALSO$ + ACOPY(),AINS(),AFILL() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * AFILL() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Array - * $ONELINER$ - * Fill an array with a specified value - * $SYNTAX$ - * AFILL( , , [], [] ) --> aTarget - * $ARGUMENTS$ - * Name of array to be filled. - * - * Expression to be globally filled in - * - * Subscript starting position - * - * Number of subscript to be filled - * $RETURNS$ - * an array pointer. - * $DESCRIPTION$ - * This function will fill each element of an array named with - * the value . If specified, denotes the beginning - * element to be filled and the array elements will continue to be - * filled for positions. If Not specified, the value of - * will be 1, and the value of will be the value - * of LEN(); thus, all subscript positions in the array - * will be filled with the value of . - * - * This function will work on only a single dimension of . - * If there are array pointer references within a subscript , - * those values will be lost, since this function will overwrite those - * values with new values. - * $EXAMPLES$ - * LOCAL aTest := { NIL, 0, 1, 2 } - * AFill( aTest, 5 ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is vm - * $SEEALSO$ - * AADD(),AEVAL(),DBSTRUCT(),DIRECTORY() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + AFILL() + $CATEGORY$ + API + $SUBCATEGORY$ + Array + $ONELINER$ + Fill an array with a specified value + $SYNTAX$ + AFILL( , , [], [] ) --> aTarget + $ARGUMENTS$ + Name of array to be filled. + + Expression to be globally filled in + + Subscript starting position + + Number of subscript to be filled + $RETURNS$ + an array pointer. + $DESCRIPTION$ + This function will fill each element of an array named with + the value . If specified, denotes the beginning + element to be filled and the array elements will continue to be + filled for positions. If Not specified, the value of + will be 1, and the value of will be the value + of LEN(); thus, all subscript positions in the array + will be filled with the value of . + + This function will work on only a single dimension of . + If there are array pointer references within a subscript , + those values will be lost, since this function will overwrite those + values with new values. + $EXAMPLES$ + LOCAL aTest := { NIL, 0, 1, 2 } + AFill( aTest, 5 ) + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is vm + $SEEALSO$ + AADD(),AEVAL(),DBSTRUCT(),DIRECTORY() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ASCAN() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Array - * $ONELINER$ - * Scan array elements for a specified condition - * $SYNTAX$ - * ASCAN( , , [], [] ) --> nStoppedAt - * $ARGUMENTS$ - * Array to be scanned. - * - * Expression to search for in - * - * Beginning subscript position at which to start the search. - * - * Number of elements to scan with . - * $RETURNS$ - * A numeric value of subscript position where - * was found, or 0 if is not found. - * $DESCRIPTION$ - * This function scan the content of array named for the - * value of . The return value is the position in the array - * in which was found. If it was not found, the - * return value will be 0. - * - * If specified, the beginning subscript position at which to start - * scanning may be set with the value passed as . The default - * is 1. - * - * If specified, the number of array elements to scan may be set with - * the value passed as . The default is the number of elements - * in the array . - * - * If is a code block, the operation of the function is - * slightly different. Each array subscript pointer reference is - * passed to the code block to be evaluated. The scanning routine - * will continue until the value obtained from the code block is a - * logical true (.T.) or until the end of the array has been reached. - * $EXAMPLES$ - * LOCAL aDir := Directory( "*.prg" ) - * AScan( aDir,,, {| x, y | x[ 1 ] := "test.prg" } ) - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is not CA-Cl*pper compatible. CA-Cl*pper ASCAN() is affected by the SET EXACT ON/OFF Condition - * $FILES$ - * Library is vm - * $SEEALSO$ - * AEVAL() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ASCAN() + $CATEGORY$ + API + $SUBCATEGORY$ + Array + $ONELINER$ + Scan array elements for a specified condition + $SYNTAX$ + ASCAN( , , [], [] ) --> nStoppedAt + $ARGUMENTS$ + Array to be scanned. + + Expression to search for in + + Beginning subscript position at which to start the search. + + Number of elements to scan with . + $RETURNS$ + A numeric value of subscript position where + was found, or 0 if is not found. + $DESCRIPTION$ + This function scan the content of array named for the + value of . The return value is the position in the array + in which was found. If it was not found, the + return value will be 0. + + If specified, the beginning subscript position at which to start + scanning may be set with the value passed as . The default + is 1. + + If specified, the number of array elements to scan may be set with + the value passed as . The default is the number of elements + in the array . + + If is a code block, the operation of the function is + slightly different. Each array subscript pointer reference is + passed to the code block to be evaluated. The scanning routine + will continue until the value obtained from the code block is a + logical true (.T.) or until the end of the array has been reached. + $EXAMPLES$ + LOCAL aDir := Directory( "*.prg" ) + AScan( aDir,,, {| x, y | x[ 1 ] := "test.prg" } ) + $STATUS$ + R + $COMPLIANCE$ + This function is not CA-Cl*pper compatible. CA-Cl*pper ASCAN() is affected by the SET EXACT ON/OFF Condition + $FILES$ + Library is vm + $SEEALSO$ + AEVAL() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * AEVAL() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Array - * $ONELINER$ - * Evaluates the subscript element of an array - * $SYNTAX$ - * AEVAL(, , [], []) --> aArray - * $ARGUMENTS$ - * Is the array to be evaluated. - * - * Is a code block to evaluate for each element processed. - * - * The beginning array element index to evaluate. - * - * The number of elements to process. - * $RETURNS$ - * an array pointer reference. - * $DESCRIPTION$ - * This function will evaluate and process the subscript elements - * in . A code block passed as defines the operation - * to be executed on each element of the array. All elements in - * will be evaluated unless specified by a beginning subscript position - * in for elements. - * - * Two parameters are passed to the code block . The individual - * elements in an array are the first parameter and the subscript position - * is the second. - * - * AEVAL() does not replace a FOR...NEXT loop for processing arrays. If - * an array is an autonomous unit, AEVAL() is appropriate. If the array - * is to be altered or if elements are to be reevaluated, a FOR...NEXT - * loop is more appropriate. - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is vm - * $SEEALSO$ - * EVAL(),DBEVAL() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + AEVAL() + $CATEGORY$ + API + $SUBCATEGORY$ + Array + $ONELINER$ + Evaluates the subscript element of an array + $SYNTAX$ + AEVAL(, , [], []) --> aArray + $ARGUMENTS$ + Is the array to be evaluated. + + Is a code block to evaluate for each element processed. + + The beginning array element index to evaluate. + + The number of elements to process. + $RETURNS$ + an array pointer reference. + $DESCRIPTION$ + This function will evaluate and process the subscript elements + in . A code block passed as defines the operation + to be executed on each element of the array. All elements in + will be evaluated unless specified by a beginning subscript position + in for elements. + + Two parameters are passed to the code block . The individual + elements in an array are the first parameter and the subscript position + is the second. + + AEVAL() does not replace a FOR...NEXT loop for processing arrays. If + an array is an autonomous unit, AEVAL() is appropriate. If the array + is to be altered or if elements are to be reevaluated, a FOR...NEXT + loop is more appropriate. + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is vm + $SEEALSO$ + EVAL(),DBEVAL() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ACOPY() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Array - * $ONELINER$ - * Copy elements from one array to another - * $SYNTAX$ - * ACOPY( , , [], [], [] ) --> aTarget - * $ARGUMENTS$ - * is the array to copy elements from. - * - * is the array to copy elements to. - * - * is the beginning subscript position to copy from - * - * the number of subscript elements to copy from . - * - * the starting subscript position in to copy - * elements to. - * $RETURNS$ - * an array pointer reference - * $DESCRIPTION$ - * This function copies array elements from to . - * - * is the beginning element to be copied from ; - * the default is 1. - * - * is the number of elements to be copied from ; - * the default is the entire array. - * - * is the subscript number in the target array,, - * to which array elements are to be copied; the default is 1 - * - * This function will copy all data types in to . - * - * If an array element in is a pointer reference to another - * array, that array pointer will be copied to ; not all - * subdimensions will be copied from one array to the next. This must - * be accomplished via the ACLONE() function. - * - * Note: - * If array is larger then , array elements will - * start copying at and continue copying until the end - * of array is reached. The ACOPY() function doesn't append - * subscript positions to the target array, the size of the target - * array remains constant. - * $EXAMPLES$ - * LOCAL nCount := 2, nStart := 1, aOne, aTwo - * aOne := { "HARBOUR", " is ", "POWER"} - * aTwo := { "CLIPPER", " was ", "POWER"} - * ACopy( aOne, aTwo, nStart, nCount ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is vm - * $SEEALSO$ - * ACLONE(),ADEL(),AEVAL(),AFILL(),AINS(),ASORT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ACOPY() + $CATEGORY$ + API + $SUBCATEGORY$ + Array + $ONELINER$ + Copy elements from one array to another + $SYNTAX$ + ACOPY( , , [], [], [] ) --> aTarget + $ARGUMENTS$ + is the array to copy elements from. + + is the array to copy elements to. + + is the beginning subscript position to copy from + + the number of subscript elements to copy from . + + the starting subscript position in to copy + elements to. + $RETURNS$ + an array pointer reference + $DESCRIPTION$ + This function copies array elements from to . + + is the beginning element to be copied from ; + the default is 1. + + is the number of elements to be copied from ; + the default is the entire array. + + is the subscript number in the target array,, + to which array elements are to be copied; the default is 1 + + This function will copy all data types in to . + + If an array element in is a pointer reference to another + array, that array pointer will be copied to ; not all + subdimensions will be copied from one array to the next. This must + be accomplished via the ACLONE() function. + + Note: + If array is larger then , array elements will + start copying at and continue copying until the end + of array is reached. The ACOPY() function doesn't append + subscript positions to the target array, the size of the target + array remains constant. + $EXAMPLES$ + LOCAL nCount := 2, nStart := 1, aOne, aTwo + aOne := { "HARBOUR", " is ", "POWER"} + aTwo := { "CLIPPER", " was ", "POWER"} + ACopy( aOne, aTwo, nStart, nCount ) + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is vm + $SEEALSO$ + ACLONE(),ADEL(),AEVAL(),AFILL(),AINS(),ASORT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ACLONE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Array - * $ONELINER$ - * Duplicate a multidimensional array - * $SYNTAX$ - * ACLONE() --> aDuplicate - * $ARGUMENTS$ - * Name of the array to be cloned. - * $RETURNS$ - * A new array pointer reference complete with nested - * array values. - * $DESCRIPTION$ - * This function makes a complete copy of the array expressed as - * and return a cloned set of array values. This provides - * a complete set of arrays values for all dimensions within the - * original array - * $EXAMPLES$ - * LOCAL aOne, aTwo - * aOne := { "Harbour"," is ","POWER" } - * aTwo := AClone( aOne ) // Result: aTwo is {"Harbour"," is ","POWER"} - * aOne[ 1 ] := "The Harbour Compiler" - * // Result: - * // aOne is { "The Harbour Compiler", " is ", "POWER" } - * // aTwo is { "Harbour"," is ","POWER" } - * $STATUS$ - * R - * $COMPLIANCE$ - * CA-Cl*pper will return NIL if the parameter is not an array. - * $FILES$ - * Library is vm - * $SEEALSO$ - * ACOPY(),ADEL(),AINS(),ASIZE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ACLONE() + $CATEGORY$ + API + $SUBCATEGORY$ + Array + $ONELINER$ + Duplicate a multidimensional array + $SYNTAX$ + ACLONE() --> aDuplicate + $ARGUMENTS$ + Name of the array to be cloned. + $RETURNS$ + A new array pointer reference complete with nested + array values. + $DESCRIPTION$ + This function makes a complete copy of the array expressed as + and return a cloned set of array values. This provides + a complete set of arrays values for all dimensions within the + original array + $EXAMPLES$ + LOCAL aOne, aTwo + aOne := { "Harbour"," is ","POWER" } + aTwo := AClone( aOne ) // Result: aTwo is {"Harbour"," is ","POWER"} + aOne[ 1 ] := "The Harbour Compiler" + // Result: + // aOne is { "The Harbour Compiler", " is ", "POWER" } + // aTwo is { "Harbour"," is ","POWER" } + $STATUS$ + R + $COMPLIANCE$ + CA-Cl*pper will return NIL if the parameter is not an array. + $FILES$ + Library is vm + $SEEALSO$ + ACOPY(),ADEL(),AINS(),ASIZE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ASORT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Array - * $ONELINER$ - * Sort an array - * $SYNTAX$ - * ASORT( , [], [], [] ) --> aArray - * $ARGUMENTS$ - * Array to be sorted. - * - * The first element to start the sort from, default is 1. - * - * Number of elements starting from to sort, default - * is all elements. - * - * Code block for sorting order, default is ascending order - * {| x, y | x < y }. The code block should accept two parameters and - * must return .T. if the sort is in order, .F. if not. - * $RETURNS$ - * reference to the now sorted or NIL if the - * passed is not an array. - * $DESCRIPTION$ - * ASORT() sort all or part of a given array. If is omitted, - * the function expect to be one dimensional array containing - * single data type (one of: Character, Date, Logical, Numeric) and sort - * this array in ascending order: Character are sorted by their ASCII - * value, Dates are sorted chronologically, Logical put .F. values before - * .T., Numeric are sorted by their value. - * - * If is specified, it is used to handle the sorting order. With - * each time the block is evaluate, two array elements are passed to the - * code block, and must return a logical value that state if - * those elements are in order (.T.) or not (.F.). Using this block you - * can sort multidimensional array, descending orders or even (but why - * would you want to do that) sort array that contain different data - * type. - * $EXAMPLES$ - * // sort numeric values in ascending order - * ASort( { 3, 1, 4, 42, 5, 9 } ) // result: { 1, 3, 4, 5, 9, 42 } - * - * // sort character strings in descending lexical order - * aKeys := { "Ctrl", "Alt", "Delete" } - * bSort := {| x, y | Upper( x ) > Upper( y ) } - * ASort( aKeys,,, bSort ) // result: { "Delete", "Ctrl", "Alt" } - * - * // sort two-dimensional array according to 2nd element of each pair - * aPair := { { "Sun", 8 }, { "Mon", 1 }, { "Tue", 57 }, { "Wed", -6 } } - * ASort( aPair,,, {| x, y | x[ 2 ] < y[ 2 ] } ) - * // result: { { "Wed", -6 }, { "Mon", 1 }, { "Sun", 8 }, { "Tue", 57 } } - * $STATUS$ - * R - * $COMPLIANCE$ - * C(arrayblock) - * $FILES$ - * Library is vm - * $SEEALSO$ - * ASCAN(),EVAL(),SORT - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ASORT() + $CATEGORY$ + API + $SUBCATEGORY$ + Array + $ONELINER$ + Sort an array + $SYNTAX$ + ASORT( , [], [], [] ) --> aArray + $ARGUMENTS$ + Array to be sorted. + + The first element to start the sort from, default is 1. + + Number of elements starting from to sort, default + is all elements. + + Code block for sorting order, default is ascending order + {| x, y | x < y }. The code block should accept two parameters and + must return .T. if the sort is in order, .F. if not. + $RETURNS$ + reference to the now sorted or NIL if the + passed is not an array. + $DESCRIPTION$ + ASORT() sort all or part of a given array. If is omitted, + the function expect to be one dimensional array containing + single data type (one of: Character, Date, Logical, Numeric) and sort + this array in ascending order: Character are sorted by their ASCII + value, Dates are sorted chronologically, Logical put .F. values before + .T., Numeric are sorted by their value. + + If is specified, it is used to handle the sorting order. With + each time the block is evaluate, two array elements are passed to the + code block, and must return a logical value that state if + those elements are in order (.T.) or not (.F.). Using this block you + can sort multidimensional array, descending orders or even (but why + would you want to do that) sort array that contain different data + type. + $EXAMPLES$ + // sort numeric values in ascending order + ASort( { 3, 1, 4, 42, 5, 9 } ) // result: { 1, 3, 4, 5, 9, 42 } + + // sort character strings in descending lexical order + aKeys := { "Ctrl", "Alt", "Delete" } + bSort := {| x, y | Upper( x ) > Upper( y ) } + ASort( aKeys,,, bSort ) // result: { "Delete", "Ctrl", "Alt" } + + // sort two-dimensional array according to 2nd element of each pair + aPair := { { "Sun", 8 }, { "Mon", 1 }, { "Tue", 57 }, { "Wed", -6 } } + ASort( aPair,,, {| x, y | x[ 2 ] < y[ 2 ] } ) + // result: { { "Wed", -6 }, { "Mon", 1 }, { "Sun", 8 }, { "Tue", 57 } } + $STATUS$ + R + $COMPLIANCE$ + C(arrayblock) + $FILES$ + Library is vm + $SEEALSO$ + ASCAN(),EVAL(),SORT + $END$ */ diff --git a/harbour/doc/en/binnum.txt b/harbour/doc/en/binnum.txt index b90e5f107c..12001127d8 100644 --- a/harbour/doc/en/binnum.txt +++ b/harbour/doc/en/binnum.txt @@ -14,471 +14,471 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * BIN2W() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Conversion - * $ONELINER$ - * Convert unsigned short encoded bytes into Harbour numeric - * $SYNTAX$ - * BIN2W( ) --> nNumber - * $ARGUMENTS$ - * is a character string that contain 16 bit encoded unsigned - * short integer (least significant byte first). The first two bytes - * are taken into account, the rest if any are ignored. - * $RETURNS$ - * BIN2W() return numeric integer (or 0 if is not a string). - * $DESCRIPTION$ - * BIN2W() is one of the low level binary conversion functions, those - * functions convert between Harbour numeric and a character - * representation of numeric value. BIN2W() take two bytes of encoded - * 16 bit unsigned short integer and convert it into standard Harbour - * numeric value. - * - * You might ask what is the need for such functions, well, first of - * all it allow you to read/write information from/to a binary file - * (like extracting information from DBF header), it is also a useful - * way to share information from source other than Harbour (C for - * instance). - * - * BIN2W() is the opposite of W2BIN() - * $EXAMPLES$ - * // Show header length of a DBF - * #include "fileio.ch" - * PROCEDURE Main() - * LOCAL nHandle, cBuffer := Space( 2 ) - * nHandle := FOpen( "test.dbf" ) - * IF nHandle != F_ERROR - * FSeek( nHandle, 8 ) - * FRead( nHandle, @cBuffer, hb_BLen( cBuffer ) ) - * ? "Length of DBF header in bytes:", Bin2W( cBuffer ) - * FClose( nHandle ) - * ELSE - * ? "Can not open file" - * ENDIF - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * BIN2I(),BIN2L(),BIN2U(),I2BIN(),L2BIN(),W2BIN(),WORD(),U2BIN(),FREAD() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + BIN2W() + $CATEGORY$ + API + $SUBCATEGORY$ + Conversion + $ONELINER$ + Convert unsigned short encoded bytes into Harbour numeric + $SYNTAX$ + BIN2W( ) --> nNumber + $ARGUMENTS$ + is a character string that contain 16 bit encoded unsigned + short integer (least significant byte first). The first two bytes + are taken into account, the rest if any are ignored. + $RETURNS$ + BIN2W() return numeric integer (or 0 if is not a string). + $DESCRIPTION$ + BIN2W() is one of the low level binary conversion functions, those + functions convert between Harbour numeric and a character + representation of numeric value. BIN2W() take two bytes of encoded + 16 bit unsigned short integer and convert it into standard Harbour + numeric value. + + You might ask what is the need for such functions, well, first of + all it allow you to read/write information from/to a binary file + (like extracting information from DBF header), it is also a useful + way to share information from source other than Harbour (C for + instance). + + BIN2W() is the opposite of W2BIN() + $EXAMPLES$ + // Show header length of a DBF + #include "fileio.ch" + PROCEDURE Main() + LOCAL nHandle, cBuffer := Space( 2 ) + nHandle := FOpen( "test.dbf" ) + IF nHandle != F_ERROR + FSeek( nHandle, 8 ) + FRead( nHandle, @cBuffer, hb_BLen( cBuffer ) ) + ? "Length of DBF header in bytes:", Bin2W( cBuffer ) + FClose( nHandle ) + ELSE + ? "Can not open file" + ENDIF + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + BIN2I(),BIN2L(),BIN2U(),I2BIN(),L2BIN(),W2BIN(),WORD(),U2BIN(),FREAD() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * BIN2I() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Conversion - * $ONELINER$ - * Convert signed short encoded bytes into Harbour numeric - * $SYNTAX$ - * BIN2I( ) --> nNumber - * $ARGUMENTS$ - * is a character string that contain 16 bit encoded signed - * short integer (least significant byte first). The first two bytes - * are taken into account, the rest if any are ignored. - * $RETURNS$ - * BIN2I() return numeric integer (or 0 if is not a string). - * $DESCRIPTION$ - * BIN2I() is one of the low level binary conversion functions, those - * functions convert between Harbour numeric and a character - * representation of numeric value. BIN2I() take two bytes of encoded - * 16 bit signed short integer and convert it into standard Harbour - * numeric value. - * - * You might ask what is the need for such functions, well, first of - * all it allow you to read/write information from/to a binary file - * (like extracting information from DBF header), it is also a useful - * way to share information from source other than Harbour (C for - * instance). - * - * BIN2I() is the opposite of I2BIN() - * $EXAMPLES$ - * // Show DBF last update date - * #include "fileio.ch" - * PROCEDURE Main() - * LOCAL nHandle, cYear, cMonth, cDay - * nHandle := FOpen( "test.dbf" ) - * IF nHandle != F_ERROR - * FSeek( nHandle, 1 ) - * cYear := cMonth := cDay := " " - * FRead( nHandle, @cYear , hb_BLen( cYear ) ) - * FRead( nHandle, @cMonth, hb_BLen( cMonth ) ) - * FRead( nHandle, @cDay , hb_BLen( cDay ) ) - * ? "Last update:", Bin2I( cYear ), Bin2I( cMonth ), Bin2I( cDay ) - * FClose( nHandle ) - * ELSE - * ? "Can not open file" - * ENDIF - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * BIN2L(),BIN2U(),BIN2W(),I2BIN(),L2BIN(),W2BIN(),WORD(),U2BIN(),FREAD() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + BIN2I() + $CATEGORY$ + API + $SUBCATEGORY$ + Conversion + $ONELINER$ + Convert signed short encoded bytes into Harbour numeric + $SYNTAX$ + BIN2I( ) --> nNumber + $ARGUMENTS$ + is a character string that contain 16 bit encoded signed + short integer (least significant byte first). The first two bytes + are taken into account, the rest if any are ignored. + $RETURNS$ + BIN2I() return numeric integer (or 0 if is not a string). + $DESCRIPTION$ + BIN2I() is one of the low level binary conversion functions, those + functions convert between Harbour numeric and a character + representation of numeric value. BIN2I() take two bytes of encoded + 16 bit signed short integer and convert it into standard Harbour + numeric value. + + You might ask what is the need for such functions, well, first of + all it allow you to read/write information from/to a binary file + (like extracting information from DBF header), it is also a useful + way to share information from source other than Harbour (C for + instance). + + BIN2I() is the opposite of I2BIN() + $EXAMPLES$ + // Show DBF last update date + #include "fileio.ch" + PROCEDURE Main() + LOCAL nHandle, cYear, cMonth, cDay + nHandle := FOpen( "test.dbf" ) + IF nHandle != F_ERROR + FSeek( nHandle, 1 ) + cYear := cMonth := cDay := " " + FRead( nHandle, @cYear , hb_BLen( cYear ) ) + FRead( nHandle, @cMonth, hb_BLen( cMonth ) ) + FRead( nHandle, @cDay , hb_BLen( cDay ) ) + ? "Last update:", Bin2I( cYear ), Bin2I( cMonth ), Bin2I( cDay ) + FClose( nHandle ) + ELSE + ? "Can not open file" + ENDIF + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + BIN2L(),BIN2U(),BIN2W(),I2BIN(),L2BIN(),W2BIN(),WORD(),U2BIN(),FREAD() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * BIN2L() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Conversion - * $ONELINER$ - * Convert signed long encoded bytes into Harbour numeric - * $SYNTAX$ - * BIN2L( ) --> nNumber - * $ARGUMENTS$ - * is a character string that contain 32 bit encoded signed - * long integer (least significant byte first). The first four bytes - * are taken into account, the rest if any are ignored. - * $RETURNS$ - * BIN2L() return numeric integer (or 0 if is not a string). - * $DESCRIPTION$ - * BIN2L() is one of the low level binary conversion functions, those - * functions convert between Harbour numeric and a character - * representation of numeric value. BIN2L() take four bytes of encoded - * 32 bit signed long integer and convert it into standard Harbour - * numeric value. - * - * You might ask what is the need for such functions, well, first of - * all it allow you to read/write information from/to a binary file - * (like extracting information from DBF header), it is also a useful - * way to share information from source other than Harbour (C for - * instance). - * - * BIN2L() is the opposite of L2BIN() - * $EXAMPLES$ - * // Show number of records in DBF - * #include "fileio.ch" - * PROCEDURE Main() - * LOCAL nHandle, cBuffer := Space( 4 ) - * nHandle := FOpen( "test.dbf" ) - * IF nHandle != F_ERROR - * FSeek( nHandle, 4 ) - * FRead( nHandle, @cBuffer, hb_BLen( cBuffer ) ) - * ? "Number of records in file:", Bin2L( cBuffer ) - * FClose( nHandle ) - * ELSE - * ? "Can not open file" - * ENDIF - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * BIN2I(),BIN2U(),BIN2W(),I2BIN(),L2BIN(),W2BIN(),WORD(),U2BIN(),FREAD() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + BIN2L() + $CATEGORY$ + API + $SUBCATEGORY$ + Conversion + $ONELINER$ + Convert signed long encoded bytes into Harbour numeric + $SYNTAX$ + BIN2L( ) --> nNumber + $ARGUMENTS$ + is a character string that contain 32 bit encoded signed + long integer (least significant byte first). The first four bytes + are taken into account, the rest if any are ignored. + $RETURNS$ + BIN2L() return numeric integer (or 0 if is not a string). + $DESCRIPTION$ + BIN2L() is one of the low level binary conversion functions, those + functions convert between Harbour numeric and a character + representation of numeric value. BIN2L() take four bytes of encoded + 32 bit signed long integer and convert it into standard Harbour + numeric value. + + You might ask what is the need for such functions, well, first of + all it allow you to read/write information from/to a binary file + (like extracting information from DBF header), it is also a useful + way to share information from source other than Harbour (C for + instance). + + BIN2L() is the opposite of L2BIN() + $EXAMPLES$ + // Show number of records in DBF + #include "fileio.ch" + PROCEDURE Main() + LOCAL nHandle, cBuffer := Space( 4 ) + nHandle := FOpen( "test.dbf" ) + IF nHandle != F_ERROR + FSeek( nHandle, 4 ) + FRead( nHandle, @cBuffer, hb_BLen( cBuffer ) ) + ? "Number of records in file:", Bin2L( cBuffer ) + FClose( nHandle ) + ELSE + ? "Can not open file" + ENDIF + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + BIN2I(),BIN2U(),BIN2W(),I2BIN(),L2BIN(),W2BIN(),WORD(),U2BIN(),FREAD() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * BIN2U() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Conversion - * $ONELINER$ - * Convert unsigned long encoded bytes into Harbour numeric - * $SYNTAX$ - * BIN2U( ) --> nNumber - * $ARGUMENTS$ - * is a character string that contain 32 bit encoded unsigned - * long integer (least significant byte first). The first four bytes - * are taken into account, the rest if any are ignored. - * $RETURNS$ - * BIN2U() return numeric integer (or 0 if is not a string). - * $DESCRIPTION$ - * BIN2U() is one of the low level binary conversion functions, those - * functions convert between Harbour numeric and a character - * representation of numeric value. BIN2U() take four bytes of encoded - * 32 bit unsigned long integer and convert it into standard Harbour - * numeric value. - * - * You might ask what is the need for such functions, well, first of - * all it allow you to read/write information from/to a binary file - * (like extracting information from DBF header), it is also a useful - * way to share information from source other than Harbour (C for - * instance). - * - * BIN2U() is the opposite of U2BIN() - * $EXAMPLES$ - * // Show number of records in DBF - * #include "fileio.ch" - * PROCEDURE Main() - * LOCAL nHandle, cBuffer := Space( 4 ) - * nHandle := FOpen( "test.dbf" ) - * IF nHandle != F_ERROR - * FSeek( nHandle, 4 ) - * FRead( nHandle, @cBuffer, hb_BLen( cBuffer ) ) - * ? "Number of records in file:", Bin2U( cBuffer ) - * FClose( nHandle ) - * ELSE - * ? "Can not open file" - * ENDIF - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * XPP - * $FILES$ - * Library is rtl - * $SEEALSO$ - * BIN2I(),BIN2L(),BIN2W(),I2BIN(),L2BIN(),W2BIN(),WORD(),U2BIN(),FREAD() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + BIN2U() + $CATEGORY$ + API + $SUBCATEGORY$ + Conversion + $ONELINER$ + Convert unsigned long encoded bytes into Harbour numeric + $SYNTAX$ + BIN2U( ) --> nNumber + $ARGUMENTS$ + is a character string that contain 32 bit encoded unsigned + long integer (least significant byte first). The first four bytes + are taken into account, the rest if any are ignored. + $RETURNS$ + BIN2U() return numeric integer (or 0 if is not a string). + $DESCRIPTION$ + BIN2U() is one of the low level binary conversion functions, those + functions convert between Harbour numeric and a character + representation of numeric value. BIN2U() take four bytes of encoded + 32 bit unsigned long integer and convert it into standard Harbour + numeric value. + + You might ask what is the need for such functions, well, first of + all it allow you to read/write information from/to a binary file + (like extracting information from DBF header), it is also a useful + way to share information from source other than Harbour (C for + instance). + + BIN2U() is the opposite of U2BIN() + $EXAMPLES$ + // Show number of records in DBF + #include "fileio.ch" + PROCEDURE Main() + LOCAL nHandle, cBuffer := Space( 4 ) + nHandle := FOpen( "test.dbf" ) + IF nHandle != F_ERROR + FSeek( nHandle, 4 ) + FRead( nHandle, @cBuffer, hb_BLen( cBuffer ) ) + ? "Number of records in file:", Bin2U( cBuffer ) + FClose( nHandle ) + ELSE + ? "Can not open file" + ENDIF + RETURN + $STATUS$ + R + $COMPLIANCE$ + XPP + $FILES$ + Library is rtl + $SEEALSO$ + BIN2I(),BIN2L(),BIN2W(),I2BIN(),L2BIN(),W2BIN(),WORD(),U2BIN(),FREAD() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * I2BIN() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Conversion - * $ONELINER$ - * Convert Harbour numeric into signed short encoded bytes - * $SYNTAX$ - * I2BIN( ) --> cBuffer - * $ARGUMENTS$ - * is a numeric value to convert (decimal digits are ignored). - * $RETURNS$ - * I2BIN() return two bytes character string that contain 16 bit - * encoded signed short integer (least significant byte first). - * $DESCRIPTION$ - * I2BIN() is one of the low level binary conversion functions, those - * functions convert between Harbour numeric and a character - * representation of numeric value. I2BIN() take a numeric integer - * value and convert it into two bytes of encoded 16 bit signed short - * integer. - * - * You might ask what is the need for such functions, well, first of - * all it allow you to read/write information from/to a binary file - * (like extracting information from DBF header), it is also a useful - * way to share information from source other than Harbour (C for - * instance). - * - * I2BIN() is the opposite of BIN2I() - * $EXAMPLES$ - * // Update DBF "last update" date - * #include "fileio.ch" - * PROCEDURE Main() - * LOCAL nHandle, cYear, cMonth, cDay - * USE test - * ? "Original update date is:", LUpdate() - * CLOSE - * nHandle := FOpen( "test.dbf", FO_READWRITE ) - * IF nHandle != F_ERROR - * FSeek( nHandle, 1 ) - * cYear := I2Bin( 68 ) - * cMonth := I2Bin( 8 ) - * cDay := I2Bin( 1 ) - * FWrite( nHandle, cYear , 1 ) // write only the first byte - * FWrite( nHandle, cMonth, 1 ) - * FWrite( nHandle, cDay , 1 ) - * FClose( nHandle ) - * USE test - * ? "New update date is:", lupdate() - * CLOSE - * ELSE - * ? "Can not open file" - * ENDIF - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * BIN2I(),BIN2L(),BIN2U(),BIN2W(),L2BIN(),W2BIN(),WORD(),U2BIN(),FWRITE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + I2BIN() + $CATEGORY$ + API + $SUBCATEGORY$ + Conversion + $ONELINER$ + Convert Harbour numeric into signed short encoded bytes + $SYNTAX$ + I2BIN( ) --> cBuffer + $ARGUMENTS$ + is a numeric value to convert (decimal digits are ignored). + $RETURNS$ + I2BIN() return two bytes character string that contain 16 bit + encoded signed short integer (least significant byte first). + $DESCRIPTION$ + I2BIN() is one of the low level binary conversion functions, those + functions convert between Harbour numeric and a character + representation of numeric value. I2BIN() take a numeric integer + value and convert it into two bytes of encoded 16 bit signed short + integer. + + You might ask what is the need for such functions, well, first of + all it allow you to read/write information from/to a binary file + (like extracting information from DBF header), it is also a useful + way to share information from source other than Harbour (C for + instance). + + I2BIN() is the opposite of BIN2I() + $EXAMPLES$ + // Update DBF "last update" date + #include "fileio.ch" + PROCEDURE Main() + LOCAL nHandle, cYear, cMonth, cDay + USE test + ? "Original update date is:", LUpdate() + CLOSE + nHandle := FOpen( "test.dbf", FO_READWRITE ) + IF nHandle != F_ERROR + FSeek( nHandle, 1 ) + cYear := I2Bin( 68 ) + cMonth := I2Bin( 8 ) + cDay := I2Bin( 1 ) + FWrite( nHandle, cYear , 1 ) // write only the first byte + FWrite( nHandle, cMonth, 1 ) + FWrite( nHandle, cDay , 1 ) + FClose( nHandle ) + USE test + ? "New update date is:", lupdate() + CLOSE + ELSE + ? "Can not open file" + ENDIF + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + BIN2I(),BIN2L(),BIN2U(),BIN2W(),L2BIN(),W2BIN(),WORD(),U2BIN(),FWRITE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * W2BIN() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Conversion - * $ONELINER$ - * Convert Harbour numeric into unsigned short encoded bytes - * $SYNTAX$ - * W2BIN( ) --> cBuffer - * $ARGUMENTS$ - * is a numeric value to convert (decimal digits are ignored). - * $RETURNS$ - * W2BIN() return two bytes character string that contain 16 bit - * encoded unsigned short integer (least significant byte first). - * $DESCRIPTION$ - * W2BIN() is one of the low level binary conversion functions, those - * functions convert between Harbour numeric and a character - * representation of numeric value. W2BIN() take a numeric integer - * value and convert it into two bytes of encoded 16 bit unsigned short - * integer. - * - * You might ask what is the need for such functions, well, first of - * all it allow you to read/write information from/to a binary file - * (like extracting information from DBF header), it is also a useful - * way to share information from source other than Harbour (C for - * instance). - * - * W2BIN() is the opposite of BIN2W() - * $STATUS$ - * R - * $COMPLIANCE$ - * XPP - * $FILES$ - * Library is rtl - * $SEEALSO$ - * BIN2I(),BIN2L(),BIN2U(),BIN2W(),I2BIN(),L2BIN(),WORD(),U2BIN(),FWRITE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + W2BIN() + $CATEGORY$ + API + $SUBCATEGORY$ + Conversion + $ONELINER$ + Convert Harbour numeric into unsigned short encoded bytes + $SYNTAX$ + W2BIN( ) --> cBuffer + $ARGUMENTS$ + is a numeric value to convert (decimal digits are ignored). + $RETURNS$ + W2BIN() return two bytes character string that contain 16 bit + encoded unsigned short integer (least significant byte first). + $DESCRIPTION$ + W2BIN() is one of the low level binary conversion functions, those + functions convert between Harbour numeric and a character + representation of numeric value. W2BIN() take a numeric integer + value and convert it into two bytes of encoded 16 bit unsigned short + integer. + + You might ask what is the need for such functions, well, first of + all it allow you to read/write information from/to a binary file + (like extracting information from DBF header), it is also a useful + way to share information from source other than Harbour (C for + instance). + + W2BIN() is the opposite of BIN2W() + $STATUS$ + R + $COMPLIANCE$ + XPP + $FILES$ + Library is rtl + $SEEALSO$ + BIN2I(),BIN2L(),BIN2U(),BIN2W(),I2BIN(),L2BIN(),WORD(),U2BIN(),FWRITE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * L2BIN() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Conversion - * $ONELINER$ - * Convert Harbour numeric into signed long encoded bytes - * $SYNTAX$ - * L2BIN( ) --> cBuffer - * $ARGUMENTS$ - * is a numeric value to convert (decimal digits are ignored). - * $RETURNS$ - * L2BIN() return four bytes character string that contain 32 bit - * encoded signed long integer (least significant byte first). - * $DESCRIPTION$ - * L2BIN() is one of the low level binary conversion functions, those - * functions convert between Harbour numeric and a character - * representation of numeric value. L2BIN() take a numeric integer - * value and convert it into four bytes of encoded 32 bit signed long - * integer. - * - * You might ask what is the need for such functions, well, first of - * all it allow you to read/write information from/to a binary file - * (like extracting information from DBF header), it is also a useful - * way to share information from source other than Harbour (C for - * instance). - * - * L2BIN() is the opposite of BIN2L() - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * BIN2I(),BIN2L(),BIN2U(),BIN2W(),I2BIN(),W2BIN(),WORD(),U2BIN(),FWRITE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + L2BIN() + $CATEGORY$ + API + $SUBCATEGORY$ + Conversion + $ONELINER$ + Convert Harbour numeric into signed long encoded bytes + $SYNTAX$ + L2BIN( ) --> cBuffer + $ARGUMENTS$ + is a numeric value to convert (decimal digits are ignored). + $RETURNS$ + L2BIN() return four bytes character string that contain 32 bit + encoded signed long integer (least significant byte first). + $DESCRIPTION$ + L2BIN() is one of the low level binary conversion functions, those + functions convert between Harbour numeric and a character + representation of numeric value. L2BIN() take a numeric integer + value and convert it into four bytes of encoded 32 bit signed long + integer. + + You might ask what is the need for such functions, well, first of + all it allow you to read/write information from/to a binary file + (like extracting information from DBF header), it is also a useful + way to share information from source other than Harbour (C for + instance). + + L2BIN() is the opposite of BIN2L() + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + BIN2I(),BIN2L(),BIN2U(),BIN2W(),I2BIN(),W2BIN(),WORD(),U2BIN(),FWRITE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * U2BIN() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Conversion - * $ONELINER$ - * Convert Harbour numeric into unsigned long encoded bytes - * $SYNTAX$ - * U2BIN( ) --> cBuffer - * $ARGUMENTS$ - * is a numeric value to convert (decimal digits are ignored). - * $RETURNS$ - * U2BIN() return four bytes character string that contain 32 bit - * encoded unsigned long integer (least significant byte first). - * $DESCRIPTION$ - * U2BIN() is one of the low level binary conversion functions, those - * functions convert between Harbour numeric and a character - * representation of numeric value. U2BIN() take a numeric integer - * value and convert it into four bytes of encoded 32 bit unsigned long - * integer. - * - * You might ask what is the need for such functions, well, first of - * all it allow you to read/write information from/to a binary file - * (like extracting information from DBF header), it is also a useful - * way to share information from source other than Harbour (C for - * instance). - * - * U2BIN() is the opposite of BIN2U() - * $STATUS$ - * R - * $COMPLIANCE$ - * XPP - * $FILES$ - * Library is rtl - * $SEEALSO$ - * BIN2I(),BIN2L(),BIN2U(),BIN2W(),I2BIN(),L2BIN(),W2BIN(),WORD(),FWRITE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + U2BIN() + $CATEGORY$ + API + $SUBCATEGORY$ + Conversion + $ONELINER$ + Convert Harbour numeric into unsigned long encoded bytes + $SYNTAX$ + U2BIN( ) --> cBuffer + $ARGUMENTS$ + is a numeric value to convert (decimal digits are ignored). + $RETURNS$ + U2BIN() return four bytes character string that contain 32 bit + encoded unsigned long integer (least significant byte first). + $DESCRIPTION$ + U2BIN() is one of the low level binary conversion functions, those + functions convert between Harbour numeric and a character + representation of numeric value. U2BIN() take a numeric integer + value and convert it into four bytes of encoded 32 bit unsigned long + integer. + + You might ask what is the need for such functions, well, first of + all it allow you to read/write information from/to a binary file + (like extracting information from DBF header), it is also a useful + way to share information from source other than Harbour (C for + instance). + + U2BIN() is the opposite of BIN2U() + $STATUS$ + R + $COMPLIANCE$ + XPP + $FILES$ + Library is rtl + $SEEALSO$ + BIN2I(),BIN2L(),BIN2U(),BIN2W(),I2BIN(),L2BIN(),W2BIN(),WORD(),FWRITE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * WORD() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Conversion - * $ONELINER$ - * Converts double to integer values. - * $SYNTAX$ - * WORD( ) --> - * $ARGUMENTS$ - * is a numeric double value. - * $RETURNS$ - * WORD() return an integer in the range +-32767 - * $DESCRIPTION$ - * This function converts double values to integers to use - * within the CALL command - * $STATUS$ - * R - * $COMPLIANCE$ - * The CA-Cl*pper NG states that WORD() will only work when used in CALL - * commands parameter list, otherwise it will return NIL, in Harbour - * it will work anywhere. - * $FILES$ - * Library is rtl - * $SEEALSO$ - * CALL - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + WORD() + $CATEGORY$ + API + $SUBCATEGORY$ + Conversion + $ONELINER$ + Converts double to integer values. + $SYNTAX$ + WORD( ) --> + $ARGUMENTS$ + is a numeric double value. + $RETURNS$ + WORD() return an integer in the range +-32767 + $DESCRIPTION$ + This function converts double values to integers to use + within the CALL command + $STATUS$ + R + $COMPLIANCE$ + The CA-Cl*pper NG states that WORD() will only work when used in CALL + commands parameter list, otherwise it will return NIL, in Harbour + it will work anywhere. + $FILES$ + Library is rtl + $SEEALSO$ + CALL + $END$ */ diff --git a/harbour/doc/en/browse.txt b/harbour/doc/en/browse.txt index 85a4142ffb..65224b1818 100644 --- a/harbour/doc/en/browse.txt +++ b/harbour/doc/en/browse.txt @@ -13,363 +13,355 @@ * */ -/* TODO: put more comprehensive $EXAMPLES$. - DBEDIT() is a complex function, the doc I had made cover all the - parameters but probably not good enough for a new user that does - not know what this function is all about and how to use it. I am - not that good with the English language (and I did not want to - COPY the NG text) I suggest later some one should add to this - text. [chkedem] */ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DBEDIT()* + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Browse records in a table + $SYNTAX$ + DBEDIT( [], [], [], [], [], [], [], [], [], [], [], [] ) --> lOk + $ARGUMENTS$ + coordinate for top row display. could range from 0 + to MAXROW(), default is 0. -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DBEDIT()* - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Browse records in a table - * $SYNTAX$ - * DBEDIT( [], [], [], [], [], [], [], [], [], [], [], [] ) --> lOk - * $ARGUMENTS$ - * coordinate for top row display. could range from 0 - * to MAXROW(), default is 0. - * - * coordinate for left column display. could range - * from 0 to MAXCOL(), default is 0. - * - * coordinate for bottom row display. could range - * from 0 to MAXROW(), default is MAXROW(). - * - * coordinate for right column display. could range - * from 0 to MAXCOL(), default is MAXCOL(). - * - * is an array of character expressions that contain - * database fields names or expressions to display in each column. - * If not specified, the default is to display all fields from the - * database in the current work area. - * - * is a name of a user defined function or a code block - * that would be called every time unrecognized key is been pressed or - * when there are no keys waiting to be processed and DBEDIT() goes - * into idle mode. If is a character string, it must - * contain root name of a valid user define function without - * parentheses. Both the user define function or the code block should - * accept two parameters: nMode, nCurrentColumn. Both should return - * a numeric value that correspond to one of the expected return codes - * (see table below for a list of nMode and return codes). - * - * is an optional picture. If - * is a character string, all columns would used this value as a - * picture string. If is an array, each element - * should be a character string that correspond to a picture string - * for the column with the same index. Look at the help for @...SAY - * to get more information about picture values. - * - * contain the header titles for each column, if this - * is a character string, all columns would have that same header, if - * this is an array, each element is a character string that contain - * the header title for one column. Header may be split to more than - * one line by placing semicolon (;) in places where you want to break - * line. If omitted, the default value for each column header is taken - * from or field name if was not specified. - * - * is an array that contain characters that draw - * the lines separating the headers and the fields data. Instead of an - * array you can use a character string that would be used to display - * the same line for all fields. Default value is a double line. - * - * is an array that contain characters that draw - * the lines separating displayed columns. Instead of an array you can - * use a character string that would be used to display the same line - * for all fields. Default value is a single line. - * - * is an array that contain characters that draw - * the lines separating the fields data area and the footing area. - * Instead of an array you can use a character string that would be - * used to display the same line for all footers. Default is to have to - * no footing separators. - * - * contain the footing to be displayed at the bottom - * of each column, if this is a character string, all columns would - * have that same footer, if this is an array, each element is a - * character string that contain the footer for one column. Footer may - * be split to more than one line by placing semicolon (;) in places - * where you want to break line. If omitted, no footer are displayed. - * $RETURNS$ - * DBEDIT() return .F. if there is no database in use or if the number - * of columns to display is zero, else DBEDIT() return .T. - * $DESCRIPTION$ - * DBEDIT() display and edit records from one or more work areas in - * a grid on screen. Each column is defined by element from - * and is the equivalent of one field. Each row is equivalent of one - * database record. - * - * Following are active keys that handled by DBEDIT(): - * --------------------------------------------------- - * - * - * Key Meaning - * - * Left Move one column to the left (previous field) - * Right Move one column to the right (next field) - * Up Move up one row (previous record) - * Down Move down one row (next record) - * Page-Up Move to the previous screen - * Page-Down Move to the next screen - * Ctrl Page-Up Move to the top of the file - * Ctrl Page-Down Move to the end of the file - * Home Move to the leftmost visible column - * End Move to the rightmost visible column - * Ctrl Left Pan one column to the left - * Ctrl Right Pan one column to the right - * Ctrl Home Move to the leftmost column - * Ctrl End Move to the rightmost column - *
- * - * When is omitted, two more keys are active: - * - * - * Key Meaning - * - * Esc Terminate BROWSE() - * Enter Terminate BROWSE() - *
- * - * When DBEDIT() execute it pass the following arguments: - * nMode and the index of current record in . If - * is omitted, the index number is the FIELD() number of the open - * database structure. - * - * DBEDIT() nMode could be one of the following: - * --------------------------------------------- - * - * - * dbedit.ch Meaning - * - * DE_IDLE DBEDIT() is idle, all movement keys have been handled. - * DE_HITTOP Attempt to cursor past top of file. - * DE_HITBOTTOM Attempt to cursor past bottom of file. - * DE_EMPTY No records in work area, database is empty. - * DE_EXCEPT Key exception. - *
- * - * The user define function or code block must return a value that tell - * DBEDIT() what to do next. - * - * User function return codes: - * --------------------------- - * - * - * dbedit.ch Value Meaning - * - * DE_ABORT 0 Abort DBEDIT(). - * DE_CONT 1 Continue DBEDIT() as is. - * DE_REFRESH 2 Force reread/redisplay of all data rows. - *
- * - * The user function is called once in each of the following cases: - * - The database is empty. - * - The user try to move past top of file or past bottom file. - * - Key exception, the uses had pressed a key that is not handled by DBEDIT(). - * - The keyboard buffer is empty or a screen refresh had just occurred - * DBEDIT() is a compatibility function, it is superseded by the - * TBrowse class and there for not recommended for new applications. - * $EXAMPLES$ - * // Browse a file using default values - * USE Test - * dbEdit() - * $STATUS$ - * S - * $COMPLIANCE$ - * can take a code block value, this is a Harbour - * extension. - * - * CA-Cl*pper will throw an error if there's no database open, Harbour - * would return .F. - * - * CA-Cl*pper is buggy and will throw an error if the number of columns - * is zero, Harbour would return .F. - * - * The CA-Cl*pper 5.2 NG state that the return value is NIL, this is - * wrong and should be read logical. - * - * There is an undocumented result code (3) from the user defined - * function in CA-Cl*pper (both 87 and 5.x). This is an Append Mode which: - * "split the screen to allow data to be appended in windowed area". - * This mode is not supported by Harbour. - * $FILES$ - * Header files are dbedit.ch, inkey.ch - * Library is rtl - * $SEEALSO$ - * @...SAY,BROWSE(),TBrowse class,TRANSFORM() - * $END$ + coordinate for left column display. could range + from 0 to MAXCOL(), default is 0. + + coordinate for bottom row display. could range + from 0 to MAXROW(), default is MAXROW(). + + coordinate for right column display. could range + from 0 to MAXCOL(), default is MAXCOL(). + + is an array of character expressions that contain + database fields names or expressions to display in each column. + If not specified, the default is to display all fields from the + database in the current work area. + + is a name of a user defined function or a code block + that would be called every time unrecognized key is been pressed or + when there are no keys waiting to be processed and DBEDIT() goes + into idle mode. If is a character string, it must + contain root name of a valid user define function without + parentheses. Both the user define function or the code block should + accept two parameters: nMode, nCurrentColumn. Both should return + a numeric value that correspond to one of the expected return codes + (see table below for a list of nMode and return codes). + + is an optional picture. If + is a character string, all columns would used this value as a + picture string. If is an array, each element + should be a character string that correspond to a picture string + for the column with the same index. Look at the help for @...SAY + to get more information about picture values. + + contain the header titles for each column, if this + is a character string, all columns would have that same header, if + this is an array, each element is a character string that contain + the header title for one column. Header may be split to more than + one line by placing semicolon (;) in places where you want to break + line. If omitted, the default value for each column header is taken + from or field name if was not specified. + + is an array that contain characters that draw + the lines separating the headers and the fields data. Instead of an + array you can use a character string that would be used to display + the same line for all fields. Default value is a double line. + + is an array that contain characters that draw + the lines separating displayed columns. Instead of an array you can + use a character string that would be used to display the same line + for all fields. Default value is a single line. + + is an array that contain characters that draw + the lines separating the fields data area and the footing area. + Instead of an array you can use a character string that would be + used to display the same line for all footers. Default is to have to + no footing separators. + + contain the footing to be displayed at the bottom + of each column, if this is a character string, all columns would + have that same footer, if this is an array, each element is a + character string that contain the footer for one column. Footer may + be split to more than one line by placing semicolon (;) in places + where you want to break line. If omitted, no footer are displayed. + $RETURNS$ + DBEDIT() return .F. if there is no database in use or if the number + of columns to display is zero, else DBEDIT() return .T. + $DESCRIPTION$ + DBEDIT() display and edit records from one or more work areas in + a grid on screen. Each column is defined by element from + and is the equivalent of one field. Each row is equivalent of one + database record. + + Following are active keys that handled by DBEDIT(): + --------------------------------------------------- + + + Key Meaning + + Left Move one column to the left (previous field) + Right Move one column to the right (next field) + Up Move up one row (previous record) + Down Move down one row (next record) + Page-Up Move to the previous screen + Page-Down Move to the next screen + Ctrl Page-Up Move to the top of the file + Ctrl Page-Down Move to the end of the file + Home Move to the leftmost visible column + End Move to the rightmost visible column + Ctrl Left Pan one column to the left + Ctrl Right Pan one column to the right + Ctrl Home Move to the leftmost column + Ctrl End Move to the rightmost column + /table> + + When is omitted, two more keys are active: + + table> + Key Meaning + + Esc Terminate BROWSE() + Enter Terminate BROWSE() + /table> + + When DBEDIT() execute it pass the following arguments: + nMode and the index of current record in . If + is omitted, the index number is the FIELD() number of the open + database structure. + + DBEDIT() nMode could be one of the following: + --------------------------------------------- + +
+ dbedit.ch Meaning + + DE_IDLE DBEDIT() is idle, all movement keys have been handled. + DE_HITTOP Attempt to cursor past top of file. + DE_HITBOTTOM Attempt to cursor past bottom of file. + DE_EMPTY No records in work area, database is empty. + DE_EXCEPT Key exception. +
+ + The user define function or code block must return a value that tell + DBEDIT() what to do next. + + User function return codes: + --------------------------- + + + dbedit.ch Value Meaning + + DE_ABORT 0 Abort DBEDIT(). + DE_CONT 1 Continue DBEDIT() as is. + DE_REFRESH 2 Force reread/redisplay of all data rows. +
+ + The user function is called once in each of the following cases: + - The database is empty. + - The user try to move past top of file or past bottom file. + - Key exception, the uses had pressed a key that is not handled by DBEDIT(). + - The keyboard buffer is empty or a screen refresh had just occurred + DBEDIT() is a compatibility function, it is superseded by the + TBrowse class and there for not recommended for new applications. + $EXAMPLES$ + // Browse a file using default values + USE Test + dbEdit() + $STATUS$ + S + $COMPLIANCE$ + can take a code block value, this is a Harbour + extension. + + CA-Cl*pper will throw an error if there's no database open, Harbour + would return .F. + + CA-Cl*pper is buggy and will throw an error if the number of columns + is zero, Harbour would return .F. + + The CA-Cl*pper 5.2 NG state that the return value is NIL, this is + wrong and should be read logical. + + There is an undocumented result code (3) from the user defined + function in CA-Cl*pper (both 87 and 5.x). This is an Append Mode which: + "split the screen to allow data to be appended in windowed area". + This mode is not supported by Harbour. + $FILES$ + Header files are dbedit.ch, inkey.ch + Library is rtl + $SEEALSO$ + @...SAY,BROWSE(),TBrowse class,TRANSFORM() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * BROWSE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Browse a database file - * $SYNTAX$ - * BROWSE( [, , , ] ) --> lOk - * $ARGUMENTS$ - * coordinate for top row display. - * - * coordinate for left column display. - * - * coordinate for bottom row display. - * - * coordinate for right column display. - * $RETURNS$ - * BROWSE() return .F. if there is no database open in this work area, - * else it return .T. - * $DESCRIPTION$ - * BROWSE() is a general purpose database browser, without any - * thinking you can browse a file using the following keys: - * - * - * Key Meaning - * - * Left Move one column to the left (previous field) - * Right Move one column to the right (next field) - * Up Move up one row (previous record) - * Down Move down one row (next record) - * Page-Up Move to the previous screen - * Page-Down Move to the next screen - * Ctrl Page-Up Move to the top of the file - * Ctrl Page-Down Move to the end of the file - * Home Move to the leftmost visible column - * End Move to the rightmost visible column - * Ctrl Left Pan one column to the left - * Ctrl Right Pan one column to the right - * Ctrl Home Move to the leftmost column - * Ctrl End Move to the rightmost column - * Esc Terminate BROWSE() - *
- * - * On top of the screen you see a status line with the following - * indication: - * - * - * Record ###/### Current record number / Total number of records. - * There are no records, the file is empty. - * You are in append mode at the bottom of file. - * Current record is deleted. - * You are at the top of file. - *
- * - * You should pass whole four valid coordinate, if less than four - * parameters are passed to BROWSE() the coordinate are default to: - * 1, 0, MAXROW(), MAXCOL(). - * $EXAMPLES$ - * // this one shows you how to browse around - * USE Around - * Browse() - * $STATUS$ - * S - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * DBEDIT()*,TBrowse class - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + BROWSE() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Browse a database file + $SYNTAX$ + BROWSE( [, , , ] ) --> lOk + $ARGUMENTS$ + coordinate for top row display. + + coordinate for left column display. + + coordinate for bottom row display. + + coordinate for right column display. + $RETURNS$ + BROWSE() return .F. if there is no database open in this work area, + else it return .T. + $DESCRIPTION$ + BROWSE() is a general purpose database browser, without any + thinking you can browse a file using the following keys: + + + Key Meaning + + Left Move one column to the left (previous field) + Right Move one column to the right (next field) + Up Move up one row (previous record) + Down Move down one row (next record) + Page-Up Move to the previous screen + Page-Down Move to the next screen + Ctrl Page-Up Move to the top of the file + Ctrl Page-Down Move to the end of the file + Home Move to the leftmost visible column + End Move to the rightmost visible column + Ctrl Left Pan one column to the left + Ctrl Right Pan one column to the right + Ctrl Home Move to the leftmost column + Ctrl End Move to the rightmost column + Esc Terminate BROWSE() +
+ + On top of the screen you see a status line with the following + indication: + + + Record ###/### Current record number / Total number of records. + There are no records, the file is empty. + You are in append mode at the bottom of file. + Current record is deleted. + You are at the top of file. +
+ + You should pass whole four valid coordinate, if less than four + parameters are passed to BROWSE() the coordinate are default to: + 1, 0, MAXROW(), MAXCOL(). + $EXAMPLES$ + // this one shows you how to browse around + USE Around + Browse() + $STATUS$ + S + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + DBEDIT()*,TBrowse class + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * TBrowseDB() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Create a new TBrowse object to be used with database file - * $SYNTAX$ - * TBrowseDB( [], [], [], [] ) --> oBrowse - * $ARGUMENTS$ - * coordinate for top row display. - * - * coordinate for left column display. - * - * coordinate for bottom row display. - * - * coordinate for right column display. - * $RETURNS$ - * TBrowseDB() return new TBrowse object with the specified coordinate - * and a default :SkipBlock, :GoTopBlock and :GoBottomBlock to browse - * a database file. - * $DESCRIPTION$ - * TBrowseDB() is a quick way to create a TBrowse object along with - * the minimal support needed to browse a database. Note that the - * returned TBrowse object contain no TBColumn objects and you need - * to add column for each field by your self. - * $EXAMPLES$ - * for a good example, look at the source code for BROWSE() function - * at src/rtl/browse.prg - * $STATUS$ - * S - * $COMPLIANCE$ - * H - * $FILES$ - * Library is rtl - * $SEEALSO$ - * BROWSE(),TBColumn class,TBrowse class,TBrowseNew() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + TBrowseDB() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Create a new TBrowse object to be used with database file + $SYNTAX$ + TBrowseDB( [], [], [], [] ) --> oBrowse + $ARGUMENTS$ + coordinate for top row display. + + coordinate for left column display. + + coordinate for bottom row display. + + coordinate for right column display. + $RETURNS$ + TBrowseDB() return new TBrowse object with the specified coordinate + and a default :SkipBlock, :GoTopBlock and :GoBottomBlock to browse + a database file. + $DESCRIPTION$ + TBrowseDB() is a quick way to create a TBrowse object along with + the minimal support needed to browse a database. Note that the + returned TBrowse object contain no TBColumn objects and you need + to add column for each field by your self. + $EXAMPLES$ + for a good example, look at the source code for BROWSE() function + at src/rtl/browse.prg + $STATUS$ + S + $COMPLIANCE$ + H + $FILES$ + Library is rtl + $SEEALSO$ + BROWSE(),TBColumn class,TBrowse class,TBrowseNew() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * dbSkipper() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Helper function to skip a database - * $SYNTAX$ - * dbSkipper( ) --> nSkipped - * $ARGUMENTS$ - * is the number of records to skip relative to current record. - * Positive number would try to move the record pointer forward, while - * a negative number would try to move the record pointer back - * records. - * $RETURNS$ - * dbSkipper() return the number of actual record skipped. - * $DESCRIPTION$ - * dbSkipper() is a helper function used in browse mechanism to skip - * a number of records while giving the caller indication about the - * actual records skipped. - * $EXAMPLES$ - * // open a file and find if we've got enough records in it - * USE MonthSales - * IF dbSkipper( 100 ) == 100 - * ? "Good work! You can party now" - * ELSE - * ? "Too bad, you should really work harder" - * ENDIF - * CLOSE - * $STATUS$ - * R - * $COMPLIANCE$ - * XPP - * $FILES$ - * Library is rtl - * $SEEALSO$ - * DBSKIP(),SKIP - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + dbSkipper() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Helper function to skip a database + $SYNTAX$ + dbSkipper( ) --> nSkipped + $ARGUMENTS$ + is the number of records to skip relative to current record. + Positive number would try to move the record pointer forward, while + a negative number would try to move the record pointer back + records. + $RETURNS$ + dbSkipper() return the number of actual record skipped. + $DESCRIPTION$ + dbSkipper() is a helper function used in browse mechanism to skip + a number of records while giving the caller indication about the + actual records skipped. + $EXAMPLES$ + // open a file and find if we've got enough records in it + USE MonthSales + IF dbSkipper( 100 ) == 100 + ? "Good work! You can party now" + ELSE + ? "Too bad, you should really work harder" + ENDIF + CLOSE + $STATUS$ + R + $COMPLIANCE$ + XPP + $FILES$ + Library is rtl + $SEEALSO$ + DBSKIP(),SKIP + $END$ */ diff --git a/harbour/doc/en/cmdline.txt b/harbour/doc/en/cmdline.txt index 749bea8527..ce5aa8c0d0 100644 --- a/harbour/doc/en/cmdline.txt +++ b/harbour/doc/en/cmdline.txt @@ -2,118 +2,118 @@ * $Id$ */ -/* $DOC$ - * $TEMPLATE$ - * Document - * $NAME$ - * Command line utility - * $CATEGORY$ - * Document - * $SUBCATEGORY$ - * Compiler - * $ONELINER$ - * Compiler Options - * $DESCRIPTION$ - * This spec goes for CLIPPERCMD, HARBOURCMD, Harbour compiler and - * #pragma directives in the source code. - * - * The command line always overrides the envvar. - * - * Note that some switches are not accepted in envvar, some others in - * #pragmas. - * - * First the parser should start to step through all the tokens in the - * string separated by whitespace. (or just walk through all argv[]) - * - * 1.) If the token begins with "-", it should be treated as a new style - * switch. - * - * One or more switch characters can follow this. The "-" sign inside - * the token will turn off the switch. - * - * If the switch has an argument all the following characters are - * treated as part of the argument. - * - * The "/" sign has no special meaning here. - * - * - * Switch Result option - * - * -wn ( W N ) - * -w-n ( !W N ) - * -wi/harbour/include/ ( W I=/harbour/include/ ) - * -wi/harbour/include/n ( W I=/harbour/include/n ) - * -wes0n ( W ES=0 N ) - * -wen ( W [invalid switch: e] N ) - * -wesn ( W ES=default(0) N ) - * -wses ( W S ES=default(0) ) - * -wess ( W ES=default(0) S ) - * - ( [invalid switch] ) - * -w-n-p ( !W !N P ) - * -w-n-p- ( !W !N !P ) - * -w- -w -w- ( finally: !W ) - *
- * - * 2.) If the token begins with "/", it should be treated as a compatibility - * style switch. - * - * The parser scans the token for the next "/" sign or EOS and treats - * the resulting string as one switch. - * - * This means that a switch with an argument containing "/" sign has - * some limitations. This may be solved by allowing the usage of quote - * characters. This is mostly a problem on systems which use "/" as - * path separator. - * - * The "-" sign has no special meaning here, it can't be used to - * disable a switch. - * - * - * Switch Result option - * - * /w/n ( W N ) - * /wo/n ( [invalid switch: wo] N ) - * /ihello/world/ ( I=hello [invalid switch: world] [invalid switch: /] ) - * /i"hello/world/"/w ( I=hello/world/ W ) - * /ihello\world\ ( I=hello\world\ ) - *
- * - * 3.) If the token begins with anything else it should be skipped. - * - * The Harbour switches are always case insensitive. - * - * In the Harbour commandline the two style can be used together: - * harbour -wnes2 /gc0/q0 -iC:\hello - * - * Exceptions: - * - * - Handling of the /CREDIT undocumented switch on Harbour command line - * is unusual, check the current code for this. - * - * - The CLIPPER, HARBOUR and Harbour application command line parsing - * is a different beast, see cmdarg.c for a NOTE. - * - * Notes: - * - * - All occurrences where a path is accepted, Harbour should handle the - * quote char to specify path containing space, negative sign, slash, - * or any other chars with special meaning. - * - * /i"C:/hello/" - * -i"C:/hello-n" - * /i"C:/Program Files/" - * -i"C:/Program Files/" - * - * - * Just some examples for the various accepted forms: - * //F20 == /F20 == F20 == F:20 == F20X - * //TMPPATH:C:\hello - * F20//TMPPATH:/temp///F:30000000 NOIDLE - * F0NOIDLEX10 - * SQUAWKNOIDLE - * - * "//" should always be used on the command line. - * $SEEALSO$ - * Compiler Options - * $END$ +/* $DOC$ + $TEMPLATE$ + Document + $NAME$ + Command line utility + $CATEGORY$ + Document + $SUBCATEGORY$ + Compiler + $ONELINER$ + Compiler Options + $DESCRIPTION$ + This spec goes for CLIPPERCMD, HARBOURCMD, Harbour compiler and + #pragma directives in the source code. + + The command line always overrides the envvar. + + Note that some switches are not accepted in envvar, some others in + #pragmas. + + First the parser should start to step through all the tokens in the + string separated by whitespace. (or just walk through all argv[]) + + 1.) If the token begins with "-", it should be treated as a new style + switch. + + One or more switch characters can follow this. The "-" sign inside + the token will turn off the switch. + + If the switch has an argument all the following characters are + treated as part of the argument. + + The "/" sign has no special meaning here. + + + Switch Result option + + -wn ( W N ) + -w-n ( !W N ) + -wi/harbour/include/ ( W I=/harbour/include/ ) + -wi/harbour/include/n ( W I=/harbour/include/n ) + -wes0n ( W ES=0 N ) + -wen ( W [invalid switch: e] N ) + -wesn ( W ES=default(0) N ) + -wses ( W S ES=default(0) ) + -wess ( W ES=default(0) S ) + - ( [invalid switch] ) + -w-n-p ( !W !N P ) + -w-n-p- ( !W !N !P ) + -w- -w -w- ( finally: !W ) +
+ + 2.) If the token begins with "/", it should be treated as a compatibility + style switch. + + The parser scans the token for the next "/" sign or EOS and treats + the resulting string as one switch. + + This means that a switch with an argument containing "/" sign has + some limitations. This may be solved by allowing the usage of quote + characters. This is mostly a problem on systems which use "/" as + path separator. + + The "-" sign has no special meaning here, it can't be used to + disable a switch. + + + Switch Result option + + /w/n ( W N ) + /wo/n ( [invalid switch: wo] N ) + /ihello/world/ ( I=hello [invalid switch: world] [invalid switch: /] ) + /i"hello/world/"/w ( I=hello/world/ W ) + /ihello\world\ ( I=hello\world\ ) +
+ + 3.) If the token begins with anything else it should be skipped. + + The Harbour switches are always case insensitive. + + In the Harbour commandline the two style can be used together: + harbour -wnes2 /gc0/q0 -iC:\hello + + Exceptions: + + - Handling of the /CREDIT undocumented switch on Harbour command line + is unusual, check the current code for this. + + - The CLIPPER, HARBOUR and Harbour application command line parsing + is a different beast, see cmdarg.c for a NOTE. + + Notes: + + - All occurrences where a path is accepted, Harbour should handle the + quote char to specify path containing space, negative sign, slash, + or any other chars with special meaning. + + /i"C:/hello/" + -i"C:/hello-n" + /i"C:/Program Files/" + -i"C:/Program Files/" + + + Just some examples for the various accepted forms: + //F20 == /F20 == F20 == F:20 == F20X + //TMPPATH:C:\hello + F20//TMPPATH:/temp///F:30000000 NOIDLE + F0NOIDLEX10 + SQUAWKNOIDLE + + "//" should always be used on the command line. + $SEEALSO$ + Compiler Options + $END$ */ diff --git a/harbour/doc/en/command.txt b/harbour/doc/en/command.txt index ffc1e3b5a8..1fb2a5cd0a 100644 --- a/harbour/doc/en/command.txt +++ b/harbour/doc/en/command.txt @@ -13,481 +13,481 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * CLASS - * $CATEGORY$ - * Class - * $SUBCATEGORY$ - * Definition - * $ONELINER$ - * Define a Class for Object Oriented Programming - * $SYNTAX$ - * [CREATE] CLASS [ [,] ] [STATIC] - * $ARGUMENTS$ - * Name of the class to define. By tradition, Harbour - * classes start with "T" to avoid collisions with user- - * created classes. - * - * The Parent class(es) to use for inheritance. - * Harbour supports Multiple Inheritance. - * - * STATIC This clause causes the class function to be declared - * as a static function. It will therefore not be available outside the current module. - * $DESCRIPTION$ - * CLASS creates a class from which you can create objects. - * The CLASS command begins the class specification, in which the VAR - * elements (also known as instance variables) and METHODS of the - * class are named. The following scoping commands may also appear. - * They control the default scope of VAR and METHOD commands that follow them. - * - * - * EXPORTED: - * VISIBLE: - * HIDDEN: - * PROTECTED: - * - * The class specification ends with the END CLASS command. - * - * Classes can inherit from multiple , and the chain of - * inheritance can extend to many levels. - * - * A program uses a Class by calling the Class Constructor, usually the - * New() method, to create an object. That object is usually assigned - * to a variable, which is used to access the VAR elements and - * methods. - * - * Harbour's OOP syntax and implementation supports Scoping (Protect, Hidden and Readonly) - * and Delegating, and is largely compatible with Class(y)(tm), TopClass(tm) - * and Visual Objects(tm). - * $EXAMPLES$ - * CREATE CLASS TBColumn - * - * VAR Block // Code block to retrieve data for the column - * VAR Cargo // User-definable variable - * VAR ColorBlock // Code block that determines color of data items - * VAR ColSep // Column separator character - * VAR DefColor // Array of numeric indexes into the color table - * VAR Footing // Column footing - * VAR FootSep // Footing separator character - * VAR Heading // Column heading - * VAR HeadSep // Heading separator character - * VAR Width // Column display width - * VAR ColPos // Temporary column position on screen - * - * METHOD New() // Constructor - * - * ENDCLASS - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $SEEALSO$ - * HBClass(),Object Oriented Programming,VAR,METHOD - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + CLASS + $CATEGORY$ + Class + $SUBCATEGORY$ + Definition + $ONELINER$ + Define a Class for Object Oriented Programming + $SYNTAX$ + [CREATE] CLASS [ [,] ] [STATIC] + $ARGUMENTS$ + Name of the class to define. By tradition, Harbour + classes start with "T" to avoid collisions with user- + created classes. + + The Parent class(es) to use for inheritance. + Harbour supports Multiple Inheritance. + + STATIC This clause causes the class function to be declared + as a static function. It will therefore not be available outside the current module. + $DESCRIPTION$ + CLASS creates a class from which you can create objects. + The CLASS command begins the class specification, in which the VAR + elements (also known as instance variables) and METHODS of the + class are named. The following scoping commands may also appear. + They control the default scope of VAR and METHOD commands that follow them. + + + EXPORTED: + VISIBLE: + HIDDEN: + PROTECTED: + + The class specification ends with the END CLASS command. + + Classes can inherit from multiple , and the chain of + inheritance can extend to many levels. + + A program uses a Class by calling the Class Constructor, usually the + New() method, to create an object. That object is usually assigned + to a variable, which is used to access the VAR elements and + methods. + + Harbour's OOP syntax and implementation supports Scoping (Protect, Hidden and Readonly) + and Delegating, and is largely compatible with Class(y)(tm), TopClass(tm) + and Visual Objects(tm). + $EXAMPLES$ + CREATE CLASS TBColumn + + VAR Block // Code block to retrieve data for the column + VAR Cargo // User-definable variable + VAR ColorBlock // Code block that determines color of data items + VAR ColSep // Column separator character + VAR DefColor // Array of numeric indexes into the color table + VAR Footing // Column footing + VAR FootSep // Footing separator character + VAR Heading // Column heading + VAR HeadSep // Heading separator character + VAR Width // Column display width + VAR ColPos // Temporary column position on screen + + METHOD New() // Constructor + + ENDCLASS + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + All + $SEEALSO$ + HBClass(),Object Oriented Programming,VAR,METHOD + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * VAR - * $CATEGORY$ - * Class - * $SUBCATEGORY$ - * Data - * $ONELINER$ - * Alternate syntax for VAR: instance variable for the objects. - * $SYNTAX$ - * VAR [,] [ AS ] [ INIT ] - * [[EXPORTED | VISIBLE] | [PROTECTED] | [HIDDEN]] [READONLY | RO] - * $ARGUMENTS$ - * Name of the VAR +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + VAR + $CATEGORY$ + Class + $SUBCATEGORY$ + Data + $ONELINER$ + Alternate syntax for VAR: instance variable for the objects. + $SYNTAX$ + VAR [,] [ AS ] [ INIT ] + [[EXPORTED | VISIBLE] | [PROTECTED] | [HIDDEN]] [READONLY | RO] + $ARGUMENTS$ + Name of the VAR - * Optional data type specification from the following: - * Character, Numeric, Date, Logical, Codeblock, Nil. - * - * Optional initial value when creating a new object. - * - * EXPORTED Specifies that this VAR is accessible to functions and - * methods outside of the class. VISIBLE is a synonym for EXPORTED. - * - * PROTECTED Specifies that this VAR is only accessible to functions and methods within this class and its subclasses. - * - * HIDDEN Specifies that this VAR is only accessible to the - * class where it was defined, and is not inherited by the - * subclasses. - * - * READONLY Restricts assignment to the variable. If specified with - * the EXPORTED clause, assignment is only permitted from the current - * class and its subclasses. If specified with the PROTECTED clause, - * assignment is only permitted from the current class. - * RO is a synonym for READONLY. - * $DESCRIPTION$ - * VAR elements can also be thought of as the "properties" of an - * object. They can be of any data type, including codeblock. - * Once an object has been created, the VAR elements are referenced - * with the colon (:) as in MyObject:Heading := "Last name". - * Usually a class also defines methods to manipulate the VAR. - * - * You can use the "AS " clause to enforce that the VAR is - * maintained as a certain type. Otherwise it will take on the type of - * whatever value is first assigned to it. - * - * Use the "INIT " clause to initialize that VAR to - * whenever a new object is created. - * - * VAR can be a synonym for VAR, or it can use a slightly different - * syntax for compatibility with other dialects. - * $EXAMPLES$ - * CREATE CLASS TBColumn - * - * VAR Block // Code block to retrieve data for the column - * VAR Cargo // User-definable variable - * VAR ColorBlock // Code block that determines color of data items - * VAR ColSep // Column separator character - * VAR DefColor // Array of numeric indexes into the color table - * VAR Footing // Column footing - * VAR FootSep // Footing separator character - * VAR Heading // Column heading - * VAR HeadSep // Heading separator character - * VAR Width // Column display width - * VAR ColPos // Temporary column position on screen - * - * METHOD New() // Constructor - * - * ENDCLASS - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $SEEALSO$ - * Object Oriented Programming,CLASS,METHOD,CLASS VAR,VAR - * $END$ + Optional data type specification from the following: + Character, Numeric, Date, Logical, Codeblock, Nil. + + Optional initial value when creating a new object. + + EXPORTED Specifies that this VAR is accessible to functions and + methods outside of the class. VISIBLE is a synonym for EXPORTED. + + PROTECTED Specifies that this VAR is only accessible to functions and methods within this class and its subclasses. + + HIDDEN Specifies that this VAR is only accessible to the + class where it was defined, and is not inherited by the + subclasses. + + READONLY Restricts assignment to the variable. If specified with + the EXPORTED clause, assignment is only permitted from the current + class and its subclasses. If specified with the PROTECTED clause, + assignment is only permitted from the current class. + RO is a synonym for READONLY. + $DESCRIPTION$ + VAR elements can also be thought of as the "properties" of an + object. They can be of any data type, including codeblock. + Once an object has been created, the VAR elements are referenced + with the colon (:) as in MyObject:Heading := "Last name". + Usually a class also defines methods to manipulate the VAR. + + You can use the "AS " clause to enforce that the VAR is + maintained as a certain type. Otherwise it will take on the type of + whatever value is first assigned to it. + + Use the "INIT " clause to initialize that VAR to + whenever a new object is created. + + VAR can be a synonym for VAR, or it can use a slightly different + syntax for compatibility with other dialects. + $EXAMPLES$ + CREATE CLASS TBColumn + + VAR Block // Code block to retrieve data for the column + VAR Cargo // User-definable variable + VAR ColorBlock // Code block that determines color of data items + VAR ColSep // Column separator character + VAR DefColor // Array of numeric indexes into the color table + VAR Footing // Column footing + VAR FootSep // Footing separator character + VAR Heading // Column heading + VAR HeadSep // Heading separator character + VAR Width // Column display width + VAR ColPos // Temporary column position on screen + + METHOD New() // Constructor + + ENDCLASS + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + All + $SEEALSO$ + Object Oriented Programming,CLASS,METHOD,CLASS VAR,VAR + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * CLASS VAR - * $CATEGORY$ - * Class - * $SUBCATEGORY$ - * Data - * $ONELINER$ - * Define a CLASS VAR variable for a class (NOT for an Object!) - * $SYNTAX$ - * CLASS VAR [,] [ AS ] [ INIT ] - * $ARGUMENTS$ - * Name of the VAR - * - * Optional data type specification from the following: - * Character, Numeric, Date, Logical, Codeblock, Nil - * - * Optional initial value at program startup - * $DESCRIPTION$ - * CLASS VAR variables can also be thought of as the "properties" of an - * entire class. Each CLASS VAR exists only once, no matter how many - * objects are created. A common usage is for a counter that is - * incremented whenever an object is created and decremented when one - * is destroyed, thus monitoring the number of objects in existence - * for this class. - * - * You can use the "AS " clause to enforce that the CLASS VAR is - * maintained as a certain type. Otherwise it will take on the type of - * whatever value is first assigned to it. - * Use the "INIT " clause to initialize that VAR to - * whenever the class is first used. - * $EXAMPLES$ - * CREATE CLASS TWindow - * VAR hWnd, nOldProc - * CLASS VAR lRegistered AS LOGICAL - * ENDCLASS - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $SEEALSO$ - * Object Oriented Programming,CLASS,METHOD,VAR - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + CLASS VAR + $CATEGORY$ + Class + $SUBCATEGORY$ + Data + $ONELINER$ + Define a CLASS VAR variable for a class (NOT for an Object!) + $SYNTAX$ + CLASS VAR [,] [ AS ] [ INIT ] + $ARGUMENTS$ + Name of the VAR + + Optional data type specification from the following: + Character, Numeric, Date, Logical, Codeblock, Nil + + Optional initial value at program startup + $DESCRIPTION$ + CLASS VAR variables can also be thought of as the "properties" of an + entire class. Each CLASS VAR exists only once, no matter how many + objects are created. A common usage is for a counter that is + incremented whenever an object is created and decremented when one + is destroyed, thus monitoring the number of objects in existence + for this class. + + You can use the "AS " clause to enforce that the CLASS VAR is + maintained as a certain type. Otherwise it will take on the type of + whatever value is first assigned to it. + Use the "INIT " clause to initialize that VAR to + whenever the class is first used. + $EXAMPLES$ + CREATE CLASS TWindow + VAR hWnd, nOldProc + CLASS VAR lRegistered AS LOGICAL + ENDCLASS + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + All + $SEEALSO$ + Object Oriented Programming,CLASS,METHOD,VAR + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * METHOD - * $CATEGORY$ - * Class - * $SUBCATEGORY$ - * Method - * $ONELINER$ - * Declare a METHOD for a class in the class header - * $SYNTAX$ - * METHOD ( [] ) [CONSTRUCTOR] - * - * METHOD ( [] ) INLINE - * - * METHOD ( [] ) BLOCK - * - * METHOD ( [] ) EXTERN ([]) - * - * METHOD ( [] ) SETGET - * - * METHOD ( [] ) VIRTUAL - * - * METHOD ( [] ) OPERATOR - * - * METHOD ( [] ) CLASS - * $ARGUMENTS$ - * Name of the method to define - * - * Optional parameter list - * $DESCRIPTION$ - * Methods are "class functions" which do the work of the class. - * All methods must be defined in the class header between the - * CLASS and ENDCLASS commands. If the body of a method is not fully - * defined here, the full body is written below the ENDCLASS command - * using this syntax: - * - * METHOD ( [] ) CLASS - * - * Methods can reference the current object with the keyword "Self:" or - * its shorthand version "::". - * - * CLAUSES: - * - * CONSTRUCTOR Defines a special method Class Constructor method, - * used to create objects. This is usually the - * New() method. Constructors always return the new - * object. - * - * INLINE Fast and easy to code, INLINE lets you define the - * code for the method immediately within the definition - * of the Class. Any methods not declared INLINE or BLOCK - * must be fully defined after the ENDCLASS command. - * The following INLINE receives a parameter - * of Self. If you need to receive more parameters, use - * the BLOCK clause instead. - * - * BLOCK Use this clause when you want to declare fast 'inline' - * methods that need parameters. The first parameter to - * must be Self, as in: - * - * METHOD BLOCK {| Self, , , ..., | ... } - * - * EXTERN If an external function does what the method needs, - * use this clause to make an optimized call to that - * function directly. - * - * SETGET For calculated Data. The name of the method can be - * manipulated like a Data element to Set or Get a value. - * - * VIRTUAL Methods that do nothing. Useful for Base classes where - * the child class will define the method's behavior, or - * when you are first creating and testing a Class. - * - * OPERATOR Operator Overloading for classes. - * See example Tests/TestOp.prg for details. - * - * CLASS - * Use this syntax only for defining a full method after - * the ENDCLASS command. - * $EXAMPLES$ - * CREATE CLASS TWindow - * VAR hWnd, nOldProc - * METHOD New( ) CONSTRUCTOR - * METHOD Capture() INLINE SetCapture( ::hWnd ) - * METHOD End() BLOCK {| Self, lEnd | iif( lEnd := ::lValid(),; - * ::PostMsg( WM_CLOSE ), ), lEnd } - * METHOD EraseBkGnd( hDC ) - * METHOD cTitle( cNewTitle ) SETGET - * METHOD Close() VIRTUAL - * ENDCLASS - * - * METHOD New( ) CLASS TWindow - * local nVar, cStr - * ... ... - * ... ... - * RETURN Self - * $TESTS$ - * TestOp.prg - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $SEEALSO$ - * HBClass(),Object Oriented Programming,VAR,CLASS - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + METHOD + $CATEGORY$ + Class + $SUBCATEGORY$ + Method + $ONELINER$ + Declare a METHOD for a class in the class header + $SYNTAX$ + METHOD ( [] ) [CONSTRUCTOR] + + METHOD ( [] ) INLINE + + METHOD ( [] ) BLOCK + + METHOD ( [] ) EXTERN ([]) + + METHOD ( [] ) SETGET + + METHOD ( [] ) VIRTUAL + + METHOD ( [] ) OPERATOR + + METHOD ( [] ) CLASS + $ARGUMENTS$ + Name of the method to define + + Optional parameter list + $DESCRIPTION$ + Methods are "class functions" which do the work of the class. + All methods must be defined in the class header between the + CLASS and ENDCLASS commands. If the body of a method is not fully + defined here, the full body is written below the ENDCLASS command + using this syntax: + + METHOD ( [] ) CLASS + + Methods can reference the current object with the keyword "Self:" or + its shorthand version "::". + + CLAUSES: + + CONSTRUCTOR Defines a special method Class Constructor method, + used to create objects. This is usually the + New() method. Constructors always return the new + object. + + INLINE Fast and easy to code, INLINE lets you define the + code for the method immediately within the definition + of the Class. Any methods not declared INLINE or BLOCK + must be fully defined after the ENDCLASS command. + The following INLINE receives a parameter + of Self. If you need to receive more parameters, use + the BLOCK clause instead. + + BLOCK Use this clause when you want to declare fast 'inline' + methods that need parameters. The first parameter to + must be Self, as in: + + METHOD BLOCK {| Self, , , ..., | ... } + + EXTERN If an external function does what the method needs, + use this clause to make an optimized call to that + function directly. + + SETGET For calculated Data. The name of the method can be + manipulated like a Data element to Set or Get a value. + + VIRTUAL Methods that do nothing. Useful for Base classes where + the child class will define the method's behavior, or + when you are first creating and testing a Class. + + OPERATOR Operator Overloading for classes. + See example Tests/TestOp.prg for details. + + CLASS + Use this syntax only for defining a full method after + the ENDCLASS command. + $EXAMPLES$ + CREATE CLASS TWindow + VAR hWnd, nOldProc + METHOD New( ) CONSTRUCTOR + METHOD Capture() INLINE SetCapture( ::hWnd ) + METHOD End() BLOCK {| Self, lEnd | iif( lEnd := ::lValid(),; + ::PostMsg( WM_CLOSE ), ), lEnd } + METHOD EraseBkGnd( hDC ) + METHOD cTitle( cNewTitle ) SETGET + METHOD Close() VIRTUAL + ENDCLASS + + METHOD New( ) CLASS TWindow + local nVar, cStr + ... ... + ... ... + RETURN Self + $TESTS$ + TestOp.prg + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + All + $SEEALSO$ + HBClass(),Object Oriented Programming,VAR,CLASS + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * MESSAGE - * $CATEGORY$ - * Class - * $SUBCATEGORY$ - * Method - * $ONELINER$ - * Route a method call to another Method - * $SYNTAX$ - * MESSAGE METHOD ( [] ) - * - * MESSAGE () METHOD ( [] ) - * $ARGUMENTS$ - * The pseudo-method name to define - * - * The method to create and call when - * is invoked. - * - * Optional parameter list for the method - * $DESCRIPTION$ - * The MESSAGE command is a seldom-used feature that lets you re-route - * a call to a method with a different name. This can be necessary if - * a method name conflicts with a public function that needs to be - * called from within the class methods. - * - * For example, your app may have a public function called BeginPaint() - * that is used in painting windows. It would also be natural to have a - * Window class method called :BeginPaint() that the application can - * call. But within the class method you would not be able to call the - * public function because internally methods are based on static - * functions (which hide public functions of the same name). - * - * The MESSAGE command lets you create the true method with a different - * name (::xBeginPaint()), yet still allow the ::BeginPaint() syntax - * to call ::xBeginPaint(). This is then free to call the public - * function BeginPaint(). - * $EXAMPLES$ - * CREATE CLASS TWindow - * VAR hWnd, nOldProc - * METHOD New( ) CONSTRUCTOR - * MESSAGE BeginPaint METHOD xBeginPaint() - * ENDCLASS - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $SEEALSO$ - * METHOD,VAR,CLASS,Object Oriented Programming - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + MESSAGE + $CATEGORY$ + Class + $SUBCATEGORY$ + Method + $ONELINER$ + Route a method call to another Method + $SYNTAX$ + MESSAGE METHOD ( [] ) + + MESSAGE () METHOD ( [] ) + $ARGUMENTS$ + The pseudo-method name to define + + The method to create and call when + is invoked. + + Optional parameter list for the method + $DESCRIPTION$ + The MESSAGE command is a seldom-used feature that lets you re-route + a call to a method with a different name. This can be necessary if + a method name conflicts with a public function that needs to be + called from within the class methods. + + For example, your app may have a public function called BeginPaint() + that is used in painting windows. It would also be natural to have a + Window class method called :BeginPaint() that the application can + call. But within the class method you would not be able to call the + public function because internally methods are based on static + functions (which hide public functions of the same name). + + The MESSAGE command lets you create the true method with a different + name (::xBeginPaint()), yet still allow the ::BeginPaint() syntax + to call ::xBeginPaint(). This is then free to call the public + function BeginPaint(). + $EXAMPLES$ + CREATE CLASS TWindow + VAR hWnd, nOldProc + METHOD New( ) CONSTRUCTOR + MESSAGE BeginPaint METHOD xBeginPaint() + ENDCLASS + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + All + $SEEALSO$ + METHOD,VAR,CLASS,Object Oriented Programming + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * ERROR HANDLER - * $CATEGORY$ - * Class - * $SUBCATEGORY$ - * Method - * $ONELINER$ - * Designate a method as an error handler for the class - * $SYNTAX$ - * ERROR HANDLER ( [] ) - * $ARGUMENTS$ - * Name of the method to define - * - * Optional parameter list - * $DESCRIPTION$ - * ERROR HANDLER names the method that should handle errors for the - * class being defined. - * $EXAMPLES$ - * CREATE CLASS TWindow - * ERROR HANDLER MyErrHandler() - * ENDCLASS - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $SEEALSO$ - * Object Oriented Programming,ON ERROR,CLASS,METHOD,VAR - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + ERROR HANDLER + $CATEGORY$ + Class + $SUBCATEGORY$ + Method + $ONELINER$ + Designate a method as an error handler for the class + $SYNTAX$ + ERROR HANDLER ( [] ) + $ARGUMENTS$ + Name of the method to define + + Optional parameter list + $DESCRIPTION$ + ERROR HANDLER names the method that should handle errors for the + class being defined. + $EXAMPLES$ + CREATE CLASS TWindow + ERROR HANDLER MyErrHandler() + ENDCLASS + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + All + $SEEALSO$ + Object Oriented Programming,ON ERROR,CLASS,METHOD,VAR + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * ON ERROR - * $CATEGORY$ - * Class - * $SUBCATEGORY$ - * Method - * $ONELINER$ - * Designate a method as an error handler for the class - * $SYNTAX$ - * ON ERROR ( [] ) - * $ARGUMENTS$ - * Name of the method to define - * - * Optional parameter list - * $DESCRIPTION$ - * ON ERROR is a synonym for ERROR HANDLER. - * It names the method that should handle errors for the - * class being defined. - * $EXAMPLES$ - * CREATE CLASS TWindow - * ON ERROR MyErrHandler() - * ENDCLASS - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $SEEALSO$ - * Object Oriented Programming,ERROR HANDLER,CLASS,METHOD,VAR - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + ON ERROR + $CATEGORY$ + Class + $SUBCATEGORY$ + Method + $ONELINER$ + Designate a method as an error handler for the class + $SYNTAX$ + ON ERROR ( [] ) + $ARGUMENTS$ + Name of the method to define + + Optional parameter list + $DESCRIPTION$ + ON ERROR is a synonym for ERROR HANDLER. + It names the method that should handle errors for the + class being defined. + $EXAMPLES$ + CREATE CLASS TWindow + ON ERROR MyErrHandler() + ENDCLASS + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + All + $SEEALSO$ + Object Oriented Programming,ERROR HANDLER,CLASS,METHOD,VAR + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * ENDCLASS - * $CATEGORY$ - * Class - * $SUBCATEGORY$ - * Definition - * $ONELINER$ - * End the declaration of a class. - * $SYNTAX$ - * ENDCLASS - * $ARGUMENTS$ - * (This statement has no arguments) - * $DESCRIPTION$ - * ENDCLASS marks the end of a class declaration. - * It is usually followed by the class methods that are not INLINE. - * $EXAMPLES$ - * CREATE CLASS TWindow - * VAR hWnd, nOldProc - * ENDCLASS - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $SEEALSO$ - * Object Oriented Programming,CLASS,METHOD,VAR - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + ENDCLASS + $CATEGORY$ + Class + $SUBCATEGORY$ + Definition + $ONELINER$ + End the declaration of a class. + $SYNTAX$ + ENDCLASS + $ARGUMENTS$ + (This statement has no arguments) + $DESCRIPTION$ + ENDCLASS marks the end of a class declaration. + It is usually followed by the class methods that are not INLINE. + $EXAMPLES$ + CREATE CLASS TWindow + VAR hWnd, nOldProc + ENDCLASS + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + All + $SEEALSO$ + Object Oriented Programming,CLASS,METHOD,VAR + $END$ */ diff --git a/harbour/doc/en/compiler.txt b/harbour/doc/en/compiler.txt index 0690a3d7bd..65fabe9343 100644 --- a/harbour/doc/en/compiler.txt +++ b/harbour/doc/en/compiler.txt @@ -2,390 +2,389 @@ * $Id$ */ -/* $DOC$ - * $TEMPLATE$ - * Document - * $NAME$ - * Compiler Options - * $CATEGORY$ - * Document - * $SUBCATEGORY$ - * Compiler - * $ONELINER$ - * Compiler Options - * $DESCRIPTION$ - * - * Invoking the Harbour compiler: - * ============================== - * - * harbour [options] - * or - * harbour [options] - * or - * harbour [options] [options] - * - * The command line options have to be separated by at least one space. - * The option can start with either '/' character or '-' character. - * - * The Harbour command line options: - * ================================= - * - * /a automatic memvar declaration - * ================= - * - * This causes all variables declared by PARAMETER, PRIVATE or PUBLIC - * statements to be automatically declared as MEMVAR variables. - * - * /b debug info - * ================= - * - * The compiler generates all information required for debugging - * - * /build display detailed version info - * ================= - * - * /credits display credits - * ================= - * - * /d[=] #define - * ================= - * - * /es[] set exit severity - * ================= - * - * /es or /es0 - all warnings are ignored and exit code returned by - * the compiler is equal to 0 if there are no errors - * in compiled source file. - * - * /es1 - any warnings generate a non-zero exit code, but - * output is still created. - * - * /es2 - all warnings are treated as errors and no output - * file is created. The exit code is set to a non-zero - * value. - * - * /fn[:[l|u]|-] set filename casing (l=lower u=upper) - * ================= - * - * /fd[:[l|u]|-] set directory casing (l=lower u=upper) - * ================= - * - * /fp[:] set path separator - * ================= - * - * /fs[-] turn filename space trimming on or off (default) - * ================= - * - * /g output type generated is - * ================= - * - * /gc[] output type: C source (.c) (default) - * : 0=compact (default) 1=normal 2=verbose - * 3=generate real C code - * - * /gh output type: Harbour Portable Object (.hrb) - * - * /gd[.] generate dependencies list into (.d) file - * - * /ge[] error output : 0=Clipper (default) - * 1=IDE friendly - * - * /i #include file search path - * ================= - * - * /i[-|+] disable/enable support for INCLUDE envvar - * ================= - * - * /j[] generate i18n gettext file (.pot) - * ================= - * - * /k compilation mode (type -k? for more data) - * ================= - * - * /kc clear all flags (strict Clipper mode) - * - * /kh Harbour mode (default) - * - * /ko allow operator optimizations - * - * /ki enable support for HB_INLINE (default) - * - * /kr runtime settings enabled - * - * /ks allow indexed assignment on all types - * - * /kx extended Xbase++ mode (default) - * - * /ku strings in user encoding - * - * /kd accept macros with declared symbols - * - * /km turn off macrotext substitution - * - * /kj turn off jump optimization in pcode - * - * /k? this info - * - * /l suppress line number information - * ================= - * - * The compiler does not generate the source code line numbers in - * the output file. The PROCLINE() function will return 0 for - * modules compiled using this option. - * - * /m compile module only - * ================= - * - * /n[] no implicit starting procedure - * ================= - * : 0=no implicit starting procedure - * 1=no starting procedure at all - * 2=add starting procedure if necessary - * - * The compiler does not create a procedure with the same name as - * the compiled file. This means that any declarations placed - * before the first PROCEDURE or FUNCTION statement have file- - * wide scope and can be accessed/used in all functions/procedures - * defined in the compiled source file. All executable statements - * placed at the beginning of the file and before the first - * PROCEDURE/FUNCTION statement are ignored. - * - * /o object file drive and/or path - * ================= - * - * /p generate pre-processed output (.ppo) file - * ================= - * - * The compiler only creates the file that contains the result of - * pre-processing the source file. - * - * /p+ generate pre-processor trace (.ppt) file - * ================= - * - * /q quiet - * ================= - * - * The compiler does not print any messages during compiling - * (except the copyright info). - * - * /q0 quiet and don't display program header - * - * /q2 disable all output messages - * - * /r[] request linker to search (or none) - * ================= - * - * Currently not supported in Harbour. - * - * /r= sets maximum number of preprocessor iterations - * ================= - * - * This set the maximum number of preprocessor iterations - * during processing the source code. If this switch is not - * used then the preprocessor stops after 1024 iterations. - * This value is used to stop processing of infinite loops, - * for example: - * #command ( => (,7 - * - * /s[m] syntax check only [minimal for dependencies list] - * ================= - * - * The compiler checks the syntax only. No output file is generated. - * - * /t path for temp file creation - * ================= - * - * Currently not used in Harbour (the Harbour compiler does not - * create any temporary files). - * - * /u[] use command def set in (or none) - * ================= - * - * /u+ add command def set from - * ================= - * - * /undef: #undef - * ================= - * - * /v variables are assumed M-> - * ================= - * - * All undeclared or unaliased variables are assumed MEMVAR - * variables (private or public variables). If this switch is not - * used then the scope of such variables is checked at runtime. - * - * /w[] set warning level number (0..3, default 1) - * ================= - * - * /w0 - no warnings - * - * /w or /w1 - CA-Cl*pper compatible warnings - * - * /w2 - some useful warnings missed in CA-Cl*pper - * - * /w3 - warnings generated for Harbour language extensions - * and also enables strong type checking but only - * warns against declared types, or types which may be - * calculated at compile time - * - * /x[] set symbol init function name prefix (for .c only) - * ================= - * - * Sets the prefix added to the generated symbol init function name - * (in C output currently). This function is generated - * automatically for every PRG module compiled. This additional - * prefix can be used to suppress problems with duplicated symbols - * during linking an application with some third party libraries. - * - * /z suppress shortcutting (.and. & .or.) - * ================= - * - * Compilation in batch mode. - * ========================== - * - * @ compile list of modules in - * ================= - * - * Not supported yet. - * - * Known incompatibilities between Harbour and CA-Cl*pper compilers - * ============================================================= - * - * NOTE: - * - * If you want a 100% compatible runtime libraries then - * you have to define HARBOUR_STRICT_CLIPPER_COMPATIBILITY. This - * option should be defined in the file include/hbsetup.h (in fact this - * option is placed in a comment by default - you need to remove the - * /* */ characters only). This change has to be done before invoking - * the make utility. - * - * - * Handling of undeclared variables - * ================================ - * - * When a value is assigned to an undeclared variable and the '-v' - * command line option is not used, then the CA-Cl*pper compiler assumes - * that the variable is a PRIVATE or a PUBLIC variable and generates - * POPM (pop memvar) opcode. - * - * When the value of an undeclared variable is accessed and the '-v' - * command line option is not used, the CA-Cl*pper compiler generates PUSHV - * (push variable) opcode that determines the type of variable at runtime. - * If a field with the requested name exists in the current workarea then - * its value is used. If there is no field then a PRIVATE or a PUBLIC - * variable is used (if exists). - * - * The Harbour compiler generates an opcode to determine the type of - * variable at runtime (POPVARIABLE or PUSHVARIABLE) in both cases - * (assignment and access). - * - * The difference can be checked by the following code: - * - * - * PROCEDURE Main() - * PRIVATE myname - * - * DBCREATE( "TEST", { { "MYNAME", "C", 10, 0} } ) - * USE test NEW - * SELECT test - * APPEND BLANK - * - * FIELD->myname := "FIELD" - * MEMVAR->myname := "MEMVAR" - * - * myname := myname + " assigned" - * - * // In CA-Cl*pper: "FIELD", In Harbour: "FIELD assigned" - * ? FIELD->myname - * - * // In CA-Cl*pper: "MEMVAR assigned", In Harbour: "MEMVAR" - * ? MEMVAR->myname - * - * USE - * - * RETURN - * - * - * Passing an undeclared variable by the reference - * =============================================== - * - * The CA-Cl*pper compiler uses the special opcode PUSHP to pass a - * reference to an undeclared variable ( '@' operator ). The type of - * passed variable is checked at runtime (field or memvar). However, - * field variables cannot be passed by reference. This means that - * CA-Cl*pper checks the memvar variable only and doesn't look for a field. - * This is the reason why the Harbour compiler uses the usual - * PUSHMEMVARREF opcode in such cases. Notice that the runtime behavior - * is the same in CA-Cl*pper and in Harbour - only the generated opcodes - * are different. - * - * - * Handling of object messages - * =========================== - * - * The HARBOUR_STRICT_CLIPPER_COMPATIBILITY setting determines - * the way chained send messages are handled. - * - * For example, the following code: - * - * a:b( COUNT() ):c += 1 - * - * will be handled as: - * - * a:b( COUNT() ):c := a:b( COUNT() ):c + 1 - * - * in strict CA-Cl*pper compatibility mode and - * - * temp := a:b( COUNT() ), temp:c += 1 - * - * in non-strict mode. - * - * In practice, CA-Cl*pper will call the COUNT() function two times: - * the first time before addition and the second one after addition. - * In Harbour, COUNT() will be called only once, before addition. - * - * The Harbour (non-strict) method is: - * 1) faster - * 2) it guarantees that the same instance variable of the same object - * will be changed - * - * (See also: src/compiler/expropt.c) - * - * Initialization of static variables - * ================================== - * - * There is a difference in the initialization of static - * variables that are initialized with a codeblock that refers to - * a local variable. For example: - - * - * PROCEDURE TEST() - * LOCAL MyLocalVar - * STATIC MyStaticVar := {|| MyLocalVar } - * - * MyLocalVar :=0 - * ? EVAL( MyStaticVar ) - * - * RETURN - * - - * The above code compiles fine in CA-Cl*pper, but it generates a - * runtime error Error/BASE 1132 Bound error: array access - * Called form (b)STATICS$(0) - * - * In Harbour this code generates a compile time error: - * Error E0009 Illegal variable (b) initializer: 'MyLocalVar' - * - * Both CA-Cl*pper and Harbour are handling all local variables used in a - * codeblock in a special way: they are detached from the local stack - * of function/procedure where they are declared. This allows access to - * these variables after the exit from a function/procedure. However, - * all static variables are initialized in a separate procedure - * ('STATICS$' in CA-Cl*pper and '(_INITSTATICS)' in Harbour) before the - * main procedure and before all INIT procedures. The local variables - * don't exist on the eval stack when static variables are initialized, - * so they cannot be detached. - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Document + $NAME$ + Compiler Options + $CATEGORY$ + Document + $SUBCATEGORY$ + Compiler + $ONELINER$ + Compiler Options + $DESCRIPTION$ + Invoking the Harbour compiler: + ============================== + + harbour [options] + or + harbour [options] + or + harbour [options] [options] + + The command line options have to be separated by at least one space. + The option can start with either '/' character or '-' character. + + The Harbour command line options: + ================================= + + /a automatic memvar declaration + ================= + + This causes all variables declared by PARAMETER, PRIVATE or PUBLIC + statements to be automatically declared as MEMVAR variables. + + /b debug info + ================= + + The compiler generates all information required for debugging + + /build display detailed version info + ================= + + /credits display credits + ================= + + /d[=] #define + ================= + + /es[] set exit severity + ================= + + /es or /es0 - all warnings are ignored and exit code returned by + the compiler is equal to 0 if there are no errors + in compiled source file. + + /es1 - any warnings generate a non-zero exit code, but + output is still created. + + /es2 - all warnings are treated as errors and no output + file is created. The exit code is set to a non-zero + value. + + /fn[:[l|u]|-] set filename casing (l=lower u=upper) + ================= + + /fd[:[l|u]|-] set directory casing (l=lower u=upper) + ================= + + /fp[:] set path separator + ================= + + /fs[-] turn filename space trimming on or off (default) + ================= + + /g output type generated is + ================= + + /gc[] output type: C source (.c) (default) + : 0=compact (default) 1=normal 2=verbose + 3=generate real C code + + /gh output type: Harbour Portable Object (.hrb) + + /gd[.] generate dependencies list into (.d) file + + /ge[] error output : 0=Clipper (default) + 1=IDE friendly + + /i #include file search path + ================= + + /i[-|+] disable/enable support for INCLUDE envvar + ================= + + /j[] generate i18n gettext file (.pot) + ================= + + /k compilation mode (type -k? for more data) + ================= + + /kc clear all flags (strict Clipper mode) + + /kh Harbour mode (default) + + /ko allow operator optimizations + + /ki enable support for HB_INLINE (default) + + /kr runtime settings enabled + + /ks allow indexed assignment on all types + + /kx extended Xbase++ mode (default) + + /ku strings in user encoding + + /kd accept macros with declared symbols + + /km turn off macrotext substitution + + /kj turn off jump optimization in pcode + + /k? this info + + /l suppress line number information + ================= + + The compiler does not generate the source code line numbers in + the output file. The PROCLINE() function will return 0 for + modules compiled using this option. + + /m compile module only + ================= + + /n[] no implicit starting procedure + ================= + : 0=no implicit starting procedure + 1=no starting procedure at all + 2=add starting procedure if necessary + + The compiler does not create a procedure with the same name as + the compiled file. This means that any declarations placed + before the first PROCEDURE or FUNCTION statement have file- + wide scope and can be accessed/used in all functions/procedures + defined in the compiled source file. All executable statements + placed at the beginning of the file and before the first + PROCEDURE/FUNCTION statement are ignored. + + /o object file drive and/or path + ================= + + /p generate pre-processed output (.ppo) file + ================= + + The compiler only creates the file that contains the result of + pre-processing the source file. + + /p+ generate pre-processor trace (.ppt) file + ================= + + /q quiet + ================= + + The compiler does not print any messages during compiling + (except the copyright info). + + /q0 quiet and don't display program header + + /q2 disable all output messages + + /r[] request linker to search (or none) + ================= + + Currently not supported in Harbour. + + /r= sets maximum number of preprocessor iterations + ================= + + This set the maximum number of preprocessor iterations + during processing the source code. If this switch is not + used then the preprocessor stops after 1024 iterations. + This value is used to stop processing of infinite loops, + for example: + #command ( => (,7 + + /s[m] syntax check only [minimal for dependencies list] + ================= + + The compiler checks the syntax only. No output file is generated. + + /t path for temp file creation + ================= + + Currently not used in Harbour (the Harbour compiler does not + create any temporary files). + + /u[] use command def set in (or none) + ================= + + /u+ add command def set from + ================= + + /undef: #undef + ================= + + /v variables are assumed M-> + ================= + + All undeclared or unaliased variables are assumed MEMVAR + variables (private or public variables). If this switch is not + used then the scope of such variables is checked at runtime. + + /w[] set warning level number (0..3, default 1) + ================= + + /w0 - no warnings + + /w or /w1 - CA-Cl*pper compatible warnings + + /w2 - some useful warnings missed in CA-Cl*pper + + /w3 - warnings generated for Harbour language extensions + and also enables strong type checking but only + warns against declared types, or types which may be + calculated at compile time + + /x[] set symbol init function name prefix (for .c only) + ================= + + Sets the prefix added to the generated symbol init function name + (in C output currently). This function is generated + automatically for every PRG module compiled. This additional + prefix can be used to suppress problems with duplicated symbols + during linking an application with some third party libraries. + + /z suppress shortcutting (.and. & .or.) + ================= + + Compilation in batch mode. + ========================== + + @ compile list of modules in + ================= + + Not supported yet. + + Known incompatibilities between Harbour and CA-Cl*pper compilers + ============================================================= + + NOTE: + + If you want a 100% compatible runtime libraries then + you have to define HARBOUR_STRICT_CLIPPER_COMPATIBILITY. This + option should be defined in the file include/hbsetup.h (in fact this + option is placed in a comment by default - you need to remove the + /* */ characters only). This change has to be done before invoking + the make utility. + + + Handling of undeclared variables + ================================ + + When a value is assigned to an undeclared variable and the '-v' + command line option is not used, then the CA-Cl*pper compiler assumes + that the variable is a PRIVATE or a PUBLIC variable and generates + POPM (pop memvar) opcode. + + When the value of an undeclared variable is accessed and the '-v' + command line option is not used, the CA-Cl*pper compiler generates PUSHV + (push variable) opcode that determines the type of variable at runtime. + If a field with the requested name exists in the current workarea then + its value is used. If there is no field then a PRIVATE or a PUBLIC + variable is used (if exists). + + The Harbour compiler generates an opcode to determine the type of + variable at runtime (POPVARIABLE or PUSHVARIABLE) in both cases + (assignment and access). + + The difference can be checked by the following code: + + + PROCEDURE Main() + PRIVATE myname + + DBCREATE( "TEST", { { "MYNAME", "C", 10, 0} } ) + USE test NEW + SELECT test + APPEND BLANK + + FIELD->myname := "FIELD" + MEMVAR->myname := "MEMVAR" + + myname := myname + " assigned" + + // In CA-Cl*pper: "FIELD", In Harbour: "FIELD assigned" + ? FIELD->myname + + // In CA-Cl*pper: "MEMVAR assigned", In Harbour: "MEMVAR" + ? MEMVAR->myname + + USE + + RETURN + + + Passing an undeclared variable by the reference + =============================================== + + The CA-Cl*pper compiler uses the special opcode PUSHP to pass a + reference to an undeclared variable ( '@' operator ). The type of + passed variable is checked at runtime (field or memvar). However, + field variables cannot be passed by reference. This means that + CA-Cl*pper checks the memvar variable only and doesn't look for a field. + This is the reason why the Harbour compiler uses the usual + PUSHMEMVARREF opcode in such cases. Notice that the runtime behavior + is the same in CA-Cl*pper and in Harbour - only the generated opcodes + are different. + + + Handling of object messages + =========================== + + The HARBOUR_STRICT_CLIPPER_COMPATIBILITY setting determines + the way chained send messages are handled. + + For example, the following code: + + a:b( COUNT() ):c += 1 + + will be handled as: + + a:b( COUNT() ):c := a:b( COUNT() ):c + 1 + + in strict CA-Cl*pper compatibility mode and + + temp := a:b( COUNT() ), temp:c += 1 + + in non-strict mode. + + In practice, CA-Cl*pper will call the COUNT() function two times: + the first time before addition and the second one after addition. + In Harbour, COUNT() will be called only once, before addition. + + The Harbour (non-strict) method is: + 1) faster + 2) it guarantees that the same instance variable of the same object + will be changed + + (See also: src/compiler/expropt.c) + + Initialization of static variables + ================================== + + There is a difference in the initialization of static + variables that are initialized with a codeblock that refers to + a local variable. For example: + + + PROCEDURE TEST() + LOCAL MyLocalVar + STATIC MyStaticVar := {|| MyLocalVar } + + MyLocalVar :=0 + ? EVAL( MyStaticVar ) + + RETURN + + + The above code compiles fine in CA-Cl*pper, but it generates a + runtime error Error/BASE 1132 Bound error: array access + Called form (b)STATICS$(0) + + In Harbour this code generates a compile time error: + Error E0009 Illegal variable (b) initializer: 'MyLocalVar' + + Both CA-Cl*pper and Harbour are handling all local variables used in a + codeblock in a special way: they are detached from the local stack + of function/procedure where they are declared. This allows access to + these variables after the exit from a function/procedure. However, + all static variables are initialized in a separate procedure + ('STATICS$' in CA-Cl*pper and '(_INITSTATICS)' in Harbour) before the + main procedure and before all INIT procedures. The local variables + don't exist on the eval stack when static variables are initialized, + so they cannot be detached. + + $END$ */ diff --git a/harbour/doc/en/datetime.txt b/harbour/doc/en/datetime.txt index 44cad102e1..d1e6a84b20 100644 --- a/harbour/doc/en/datetime.txt +++ b/harbour/doc/en/datetime.txt @@ -2,7 +2,6 @@ * $Id$ */ - /* * The following parts are Copyright of the individual authors. * www - http://harbour-project.org @@ -14,568 +13,568 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * CDOW() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * Converts a date to the day of week - * $SYNTAX$ - * CDOW() --> cDay - * $ARGUMENTS$ - * Any date expression. - * $RETURNS$ - * The current day of week. - * $DESCRIPTION$ - * This function returns a character string of the day of the week, - * from a date expression passed to it. - * If a NULL date is passed to the function, the value of the function - * will be a NULL byte. - * $EXAMPLES$ - * ? CDOW( Date() ) - * IF CDOW( Date() + 10 ) == "Sunday" - * ? "This is a sunny day." - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * DAY(),DOW(),DATE(),CMONTH() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + CDOW() + $CATEGORY$ + API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + Converts a date to the day of week + $SYNTAX$ + CDOW() --> cDay + $ARGUMENTS$ + Any date expression. + $RETURNS$ + The current day of week. + $DESCRIPTION$ + This function returns a character string of the day of the week, + from a date expression passed to it. + If a NULL date is passed to the function, the value of the function + will be a NULL byte. + $EXAMPLES$ + ? CDOW( Date() ) + IF CDOW( Date() + 10 ) == "Sunday" + ? "This is a sunny day." + ENDIF + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + DAY(),DOW(),DATE(),CMONTH() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * CMONTH() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * Return the name of the month. - * $SYNTAX$ - * CMONTH() --> cMonth - * $ARGUMENTS$ - * Any date expression. - * $RETURNS$ - * The current month name - * $DESCRIPTION$ - * This function returns the name of the month (January,February,etc.) - * from a date expression passed to it. - * If a NULL date is passed to the function, the value of the function - * will be a NULL byte. - * $EXAMPLES$ - * ? CMonth( Date() ) - * IF CMonth( Date() + 10 ) =="March" - * ? "Have you done your system BACKUP?" - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * CDOW(),DATE(),MONTH(),YEAR(),DOW(),DTOC() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + CMONTH() + $CATEGORY$ + API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + Return the name of the month. + $SYNTAX$ + CMONTH() --> cMonth + $ARGUMENTS$ + Any date expression. + $RETURNS$ + The current month name + $DESCRIPTION$ + This function returns the name of the month (January,February,etc.) + from a date expression passed to it. + If a NULL date is passed to the function, the value of the function + will be a NULL byte. + $EXAMPLES$ + ? CMonth( Date() ) + IF CMonth( Date() + 10 ) =="March" + ? "Have you done your system BACKUP?" + ENDIF + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + CDOW(),DATE(),MONTH(),YEAR(),DOW(),DTOC() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DATE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * Return the Current OS Date - * $SYNTAX$ - * DATE() --> dCurDate - * $ARGUMENTS$ - * None - * $RETURNS$ - * Current system date. - * $DESCRIPTION$ - * This function returns the current system date. - * $EXAMPLES$ - * ? Date() - * $TESTS$ - * ? "Today is ",Day(Date())," of ",cMonth(Date())," of ",Year(Date()) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * CTOD(),DTOS(),DTOC(),DAY(),MONTH(),CMONTH() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DATE() + $CATEGORY$ + API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + Return the Current OS Date + $SYNTAX$ + DATE() --> dCurDate + $ARGUMENTS$ + None + $RETURNS$ + Current system date. + $DESCRIPTION$ + This function returns the current system date. + $EXAMPLES$ + ? Date() + $TESTS$ + ? "Today is ",Day(Date())," of ",cMonth(Date())," of ",Year(Date()) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + CTOD(),DTOS(),DTOC(),DAY(),MONTH(),CMONTH() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * CTOD() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * Converts a character string to a date expression - * $SYNTAX$ - * CTOD() --> dDate - * $ARGUMENTS$ - * A character date in format 'mm/dd/yy' - * $RETURNS$ - * A date expression - * $DESCRIPTION$ - * This function converts a date that has been entered as a character - * expression to a date expression. The character expression will be in - * the form "MM/DD/YY" (based on the default value in SET DATE) or in - * the appropriate format specified by the SET DATE TO command. If an - * improper character string is passed to the function, an empty date - * value will be returned. - * $EXAMPLES$ - * ? CToD( "12/21/00" ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * SET DATE,DATE(),DTOS() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + CTOD() + $CATEGORY$ + API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + Converts a character string to a date expression + $SYNTAX$ + CTOD() --> dDate + $ARGUMENTS$ + A character date in format 'mm/dd/yy' + $RETURNS$ + A date expression + $DESCRIPTION$ + This function converts a date that has been entered as a character + expression to a date expression. The character expression will be in + the form "MM/DD/YY" (based on the default value in SET DATE) or in + the appropriate format specified by the SET DATE TO command. If an + improper character string is passed to the function, an empty date + value will be returned. + $EXAMPLES$ + ? CToD( "12/21/00" ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + SET DATE,DATE(),DTOS() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DAY() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * Return the numeric day of the month. - * $SYNTAX$ - * DAY() --> nMonth - * $ARGUMENTS$ - * Any valid date expression. - * $RETURNS$ - * Numeric value of the day of month. - * $DESCRIPTION$ - * This function returns the numeric value of the day of month from a - * date. - * $EXAMPLES$ - * ? Day( Date() ) - * ? Day( Date() + 6325 ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * CTOD(),DTOS(),DTOC(),DATE(),MONTH(),CMONTH() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DAY() + $CATEGORY$ + API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + Return the numeric day of the month. + $SYNTAX$ + DAY() --> nMonth + $ARGUMENTS$ + Any valid date expression. + $RETURNS$ + Numeric value of the day of month. + $DESCRIPTION$ + This function returns the numeric value of the day of month from a + date. + $EXAMPLES$ + ? Day( Date() ) + ? Day( Date() + 6325 ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + CTOD(),DTOS(),DTOC(),DATE(),MONTH(),CMONTH() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DAYS() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * Convert elapsed seconds into days - * $SYNTAX$ - * DAYS( ) --> nDay - * $ARGUMENTS$ - * The number of seconds - * $RETURNS$ - * The number of days - * $DESCRIPTION$ - * This function converts seconds to the equivalent number - * of days; 86399 seconds represents one day, 0 seconds being midnight. - * $EXAMPLES$ - * ? Days( 2434234 ) - * ? "Has been passed", Days( 63251 ), "since midnight" - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * SECONDS(),SECS(),ELAPTIME() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DAYS() + $CATEGORY$ + API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + Convert elapsed seconds into days + $SYNTAX$ + DAYS( ) --> nDay + $ARGUMENTS$ + The number of seconds + $RETURNS$ + The number of days + $DESCRIPTION$ + This function converts seconds to the equivalent number + of days; 86399 seconds represents one day, 0 seconds being midnight. + $EXAMPLES$ + ? Days( 2434234 ) + ? "Has been passed", Days( 63251 ), "since midnight" + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + SECONDS(),SECS(),ELAPTIME() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DOW() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * Value for the day of week. - * $SYNTAX$ - * DOW() --> nDay - * $ARGUMENTS$ - * Any valid date expression - * $RETURNS$ - * The current day number - * $DESCRIPTION$ - * This function returns the number representing the day of the week - * for the date expressed as . - * $EXAMPLES$ - * ? DOW( Date() ) - * ? DOW( Date() - 6584 ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * DTOC(),CDOW(),DATE(),DTOS(),DAY() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DOW() + $CATEGORY$ + API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + Value for the day of week. + $SYNTAX$ + DOW() --> nDay + $ARGUMENTS$ + Any valid date expression + $RETURNS$ + The current day number + $DESCRIPTION$ + This function returns the number representing the day of the week + for the date expressed as . + $EXAMPLES$ + ? DOW( Date() ) + ? DOW( Date() - 6584 ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + DTOC(),CDOW(),DATE(),DTOS(),DAY() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DTOC() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * Date to character conversion - * $SYNTAX$ - * DTOC() --> cDate - * $ARGUMENTS$ - * Any date - * $RETURNS$ - * Character represention of date - * $DESCRIPTION$ - * This function converts any date expression (a field or variable) - * expressed as to a character expression in the default - * format "MM/DD/YY". The date format expressed by this function is - * controled in part by the date format specified in the SET DATE - * command - * $EXAMPLES$ - * ? DToC( Date() ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * SET DATE,DATE(),DTOS() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DTOC() + $CATEGORY$ + API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + Date to character conversion + $SYNTAX$ + DTOC() --> cDate + $ARGUMENTS$ + Any date + $RETURNS$ + Character represention of date + $DESCRIPTION$ + This function converts any date expression (a field or variable) + expressed as to a character expression in the default + format "MM/DD/YY". The date format expressed by this function is + controled in part by the date format specified in the SET DATE + command + $EXAMPLES$ + ? DToC( Date() ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + SET DATE,DATE(),DTOS() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DTOS() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * Date to string conversion - * $SYNTAX$ - * DTOS() --> cDate - * $ARGUMENTS$ - * Any date - * $RETURNS$ - * String notation of the date - * $DESCRIPTION$ - * This function returns the value of as a character - * string in the format of YYYYMMDD. If the value of is - * an empty date, this function will return eight blank spaces. - * $EXAMPLES$ - * ? DToS( Date() ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * DTOC(),DATE(),DTOS() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DTOS() + $CATEGORY$ + API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + Date to string conversion + $SYNTAX$ + DTOS() --> cDate + $ARGUMENTS$ + Any date + $RETURNS$ + String notation of the date + $DESCRIPTION$ + This function returns the value of as a character + string in the format of YYYYMMDD. If the value of is + an empty date, this function will return eight blank spaces. + $EXAMPLES$ + ? DToS( Date() ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + DTOC(),DATE(),DTOS() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ELAPTIME() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * Calculates elapted time. - * $SYNTAX$ - * ELAPTIME(,) --> cDiference - * $ARGUMENTS$ - * Start in time as a string format - * End time as a string format - * $RETURNS$ - * Difference between the times - * $DESCRIPTION$ - * This function returns a string that shows the difference between - * the starting time represented as and the ending time - * as . If the stating time is greater then the ending - * time, the function will assume that the date changed once. - * $EXAMPLES$ - * STATIC s_cStartTime - * INIT PROCEDURE Startup() - * s_cStartTime := Time() - * RETURN - * EXIT PROCEDURE StartExit() - * ? "You used this program by", ElapTime( s_cStartTime, Time() ) - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * SECS(),SECONDS(),TIME(),DAY() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ELAPTIME() + $CATEGORY$ + API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + Calculates elapted time. + $SYNTAX$ + ELAPTIME(,) --> cDiference + $ARGUMENTS$ + Start in time as a string format + End time as a string format + $RETURNS$ + Difference between the times + $DESCRIPTION$ + This function returns a string that shows the difference between + the starting time represented as and the ending time + as . If the stating time is greater then the ending + time, the function will assume that the date changed once. + $EXAMPLES$ + STATIC s_cStartTime + INIT PROCEDURE Startup() + s_cStartTime := Time() + RETURN + EXIT PROCEDURE StartExit() + ? "You used this program by", ElapTime( s_cStartTime, Time() ) + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + SECS(),SECONDS(),TIME(),DAY() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * MONTH() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * Converts a date expression to a month value - * $SYNTAX$ - * MONTH() --> nMonth - * $ARGUMENTS$ - * Any valid date expression - * $RETURNS$ - * Corresponding number of the month in the year, ranging from - * 0 to 12 - * $DESCRIPTION$ - * This function returns a number that represents the month of a given - * date expression . If a NULL date (CTOD('')) is passed to the - * function, the value of the function will be 0. - * $EXAMPLES$ - * ? Month( Date() ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * CDOW(),DOW(),YEAR(),CMONTH() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + MONTH() + $CATEGORY$ + API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + Converts a date expression to a month value + $SYNTAX$ + MONTH() --> nMonth + $ARGUMENTS$ + Any valid date expression + $RETURNS$ + Corresponding number of the month in the year, ranging from + 0 to 12 + $DESCRIPTION$ + This function returns a number that represents the month of a given + date expression . If a NULL date (CTOD('')) is passed to the + function, the value of the function will be 0. + $EXAMPLES$ + ? Month( Date() ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + CDOW(),DOW(),YEAR(),CMONTH() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SECONDS() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * Returns the number of elapsed seconds past midnight. - * $SYNTAX$ - * SECONDS() --> nSeconds - * $ARGUMENTS$ - * None - * $RETURNS$ - * Number of seconds since midnight - * $DESCRIPTION$ - * This function returns a numeric value representing the number of - * elapsed seconds based on the current system time. - * The system time is considered to start at 0 (midnight); it continues - * up to 86399 seconds. The value of the return expression is displayed - * in both seconds and hundredths of seconds. - * $EXAMPLES$ - * ? Seconds() - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * TIME() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SECONDS() + $CATEGORY$ + API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + Returns the number of elapsed seconds past midnight. + $SYNTAX$ + SECONDS() --> nSeconds + $ARGUMENTS$ + None + $RETURNS$ + Number of seconds since midnight + $DESCRIPTION$ + This function returns a numeric value representing the number of + elapsed seconds based on the current system time. + The system time is considered to start at 0 (midnight); it continues + up to 86399 seconds. The value of the return expression is displayed + in both seconds and hundredths of seconds. + $EXAMPLES$ + ? Seconds() + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + TIME() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SECS() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * Return the number of seconds from the system date. - * $SYNTAX$ - * SECS( ) --> nSeconds - * $ARGUMENTS$ - * Character expression in a time string format - * $RETURNS$ - * Number of seconds - * $DESCRIPTION$ - * This function returns a numeric value that is a number of elapsed - * seconds from midnight based on a time string given as . - * $EXAMPLES$ - * ? Secs( Time() ) - * ? Secs( Time() - 10 ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * SECONDS(),ELAPTIME(),TIME() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SECS() + $CATEGORY$ + API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + Return the number of seconds from the system date. + $SYNTAX$ + SECS( ) --> nSeconds + $ARGUMENTS$ + Character expression in a time string format + $RETURNS$ + Number of seconds + $DESCRIPTION$ + This function returns a numeric value that is a number of elapsed + seconds from midnight based on a time string given as . + $EXAMPLES$ + ? Secs( Time() ) + ? Secs( Time() - 10 ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + SECONDS(),ELAPTIME(),TIME() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * TIME() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * Returns the system time as a string - * $SYNTAX$ - * TIME() --> cTime - * $ARGUMENTS$ - * None - * $RETURNS$ - * Character string representing time - * $DESCRIPTION$ - * This function returns the system time represented as a character - * expression in the format of HH:MM:SS - * $EXAMPLES$ - * ? Time() - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * DATE(),SECONDS() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + TIME() + $CATEGORY$ + API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + Returns the system time as a string + $SYNTAX$ + TIME() --> cTime + $ARGUMENTS$ + None + $RETURNS$ + Character string representing time + $DESCRIPTION$ + This function returns the system time represented as a character + expression in the format of HH:MM:SS + $EXAMPLES$ + ? Time() + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + DATE(),SECONDS() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * YEAR() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * Converts the year portion of a date into a numeric value - * $SYNTAX$ - * YEAR() --> nYear - * $ARGUMENTS$ - * Any valid date expression - * $RETURNS$ - * The year portion of the date. - * $DESCRIPTION$ - * This function returns the numeric value for the year in . - * This value will always be a four-digit number and is not affected - * by the setting of the SET CENTURY and SET DATE commands. Addition - * ally, an empty date expression passed to this function will yield - * a zero value. - * $EXAMPLES$ - * ? Year( Date() ) - * ? Year( SToD( "32510125" ) ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * DAY(),MONTH() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + YEAR() + $CATEGORY$ + API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + Converts the year portion of a date into a numeric value + $SYNTAX$ + YEAR() --> nYear + $ARGUMENTS$ + Any valid date expression + $RETURNS$ + The year portion of the date. + $DESCRIPTION$ + This function returns the numeric value for the year in . + This value will always be a four-digit number and is not affected + by the setting of the SET CENTURY and SET DATE commands. Addition + ally, an empty date expression passed to this function will yield + a zero value. + $EXAMPLES$ + ? Year( Date() ) + ? Year( SToD( "32510125" ) ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + DAY(),MONTH() + $END$ */ diff --git a/harbour/doc/en/dbdelim.txt b/harbour/doc/en/dbdelim.txt index 64dc353981..65959c409d 100644 --- a/harbour/doc/en/dbdelim.txt +++ b/harbour/doc/en/dbdelim.txt @@ -13,75 +13,75 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * __dbDelim() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Copies the contents of a database to a delimited text file or - * appends the contents of a delimited text file to a database. - * $SYNTAX$ - * __dbDelim( , , [], [], - * [], [], [], [], ) - * $ARGUMENTS$ - * If set to .T., copies records to a delimited file. - * If set to .F., append records from a delimited file. - * - * The name of the text file to copy to or append from. - * If a file extension is not specified, ".txt" is used by default. - * - * Either the character to use as the character field - * delimiter (only the first character is used). or "BLANK" (not case - * sensitive), which eliminates the character field delimiters and - * sets the field separator to a single space instead of a comma. - * - * An aray of field names to limit the processint to. If - * not specified, or if empty, then all fields are processed. - * - * An optional code block containing a FOR expression that - * will reduce the number of records to be processed. - * - * An optional code block containing a WHILE expression - * that will reduce the number of records to be processed. - * - * If present, but nRecord is not present, specifies to - * process this number of records, starting with the current record. - * A value of 0 means to process no records. - * - * If present, specifies the only record to process. A - * value of 0 means to process no records. Overrides and . - * - * If is .T., then if is set to .T. and there are no - * , , or arguments, processes all records from - * current to last. - * $DESCRIPTION$ - * __dbDelim() copies all or selected contents of a database table - * to an SDF text file or appends all or selected contents of an SDF - * text file to a database table. - * $EXAMPLES$ - * // Copy delinquent accounts into a delimited text file. - * USE ACCOUNTS NEW - * COPY TO overdue DELIMITED FOR !Empty( accounts->duedate ) ; - * .AND. DATE() - accounts->duedate > 30 - * // Import new customer records. - * USE CUSTOMER NEW - * APPEND FROM customer DELIMITED - * $TESTS$ - * - * $STATUS$ - * S - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * - * $SEEALSO$ - * __dbSDF(), APPEND FROM, COPY TO - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + __dbDelim() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Copies the contents of a database to a delimited text file or + appends the contents of a delimited text file to a database. + $SYNTAX$ + __dbDelim( , , [], [], + [], [], [], [], ) + $ARGUMENTS$ + If set to .T., copies records to a delimited file. + If set to .F., append records from a delimited file. + + The name of the text file to copy to or append from. + If a file extension is not specified, ".txt" is used by default. + + Either the character to use as the character field + delimiter (only the first character is used). or "BLANK" (not case + sensitive), which eliminates the character field delimiters and + sets the field separator to a single space instead of a comma. + + An aray of field names to limit the processint to. If + not specified, or if empty, then all fields are processed. + + An optional code block containing a FOR expression that + will reduce the number of records to be processed. + + An optional code block containing a WHILE expression + that will reduce the number of records to be processed. + + If present, but nRecord is not present, specifies to + process this number of records, starting with the current record. + A value of 0 means to process no records. + + If present, specifies the only record to process. A + value of 0 means to process no records. Overrides and . + + If is .T., then if is set to .T. and there are no + , , or arguments, processes all records from + current to last. + $DESCRIPTION$ + __dbDelim() copies all or selected contents of a database table + to an SDF text file or appends all or selected contents of an SDF + text file to a database table. + $EXAMPLES$ + // Copy delinquent accounts into a delimited text file. + USE ACCOUNTS NEW + COPY TO overdue DELIMITED FOR !Empty( accounts->duedate ) ; + .AND. DATE() - accounts->duedate > 30 + // Import new customer records. + USE CUSTOMER NEW + APPEND FROM customer DELIMITED + $TESTS$ + + $STATUS$ + S + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + + $SEEALSO$ + __dbSDF(), APPEND FROM, COPY TO + $END$ */ diff --git a/harbour/doc/en/dbsdf.txt b/harbour/doc/en/dbsdf.txt index fe4b5d4464..3803dbf598 100644 --- a/harbour/doc/en/dbsdf.txt +++ b/harbour/doc/en/dbsdf.txt @@ -13,70 +13,70 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * __dbSDF() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Copies the contents of a database to an SDF text file or - * appends the contents of an SDF text file to a database. - * $SYNTAX$ - * __dbSDF( , , [], - * [], [], [], [], ) - * $ARGUMENTS$ - * If set to .T., copies records to an SDF file. - * If set to .F., append records from an SDF file. - * - * The name of the text file to copy to or append from. - * If a file extension is not specified, ".txt" is used by default. - * - * An aray of field names to limit the processint to. If - * not specified, or if empty, then all fields are processed. - * - * An optional code block containing a FOR expression that - * will reduce the number of records to be processed. - * - * An optional code block containing a WHILE expression - * that will reduce the number of records to be processed. - * - * If present, but is not present, specifies to - * process this number of records, starting with the current record. - * A value of 0 means to process no records. - * - * If present, specifies the only record to process. A - * value of 0 means to process no records. Overrides and . - * - * If is .T., then if is set to .T. and there are no - * , , or arguments, processes all records from - * current to last. - * $DESCRIPTION$ - * __dbSDF() copies all or selected contents of a database table - * to an SDF text file or appends all or selected contents of an - * SDF text file to a database table. - * $EXAMPLES$ - * // Copy delinquent accounts into an SDF text file. - * USE ACCOUNTS NEW - * COPY TO overdue SDF FOR !Empty( accounts->duedate ) ; - * .AND. DATE() - accounts->duedate > 30 - * // Import new customer records. - * USE CUSTOMER NEW - * APPEND FROM customer SDF - * $TESTS$ - * - * $STATUS$ - * S - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * - * $SEEALSO$ - * __dbDelim(), APPEND FROM, COPY TO - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + __dbSDF() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Copies the contents of a database to an SDF text file or + appends the contents of an SDF text file to a database. + $SYNTAX$ + __dbSDF( , , [], + [], [], [], [], ) + $ARGUMENTS$ + If set to .T., copies records to an SDF file. + If set to .F., append records from an SDF file. + + The name of the text file to copy to or append from. + If a file extension is not specified, ".txt" is used by default. + + An aray of field names to limit the processint to. If + not specified, or if empty, then all fields are processed. + + An optional code block containing a FOR expression that + will reduce the number of records to be processed. + + An optional code block containing a WHILE expression + that will reduce the number of records to be processed. + + If present, but is not present, specifies to + process this number of records, starting with the current record. + A value of 0 means to process no records. + + If present, specifies the only record to process. A + value of 0 means to process no records. Overrides and . + + If is .T., then if is set to .T. and there are no + , , or arguments, processes all records from + current to last. + $DESCRIPTION$ + __dbSDF() copies all or selected contents of a database table + to an SDF text file or appends all or selected contents of an + SDF text file to a database table. + $EXAMPLES$ + // Copy delinquent accounts into an SDF text file. + USE ACCOUNTS NEW + COPY TO overdue SDF FOR !Empty( accounts->duedate ) ; + .AND. DATE() - accounts->duedate > 30 + // Import new customer records. + USE CUSTOMER NEW + APPEND FROM customer SDF + $TESTS$ + + $STATUS$ + S + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + + $SEEALSO$ + __dbDelim(), APPEND FROM, COPY TO + $END$ */ diff --git a/harbour/doc/en/dbstrux.txt b/harbour/doc/en/dbstrux.txt index 887598bd86..8ac04c57a1 100644 --- a/harbour/doc/en/dbstrux.txt +++ b/harbour/doc/en/dbstrux.txt @@ -15,697 +15,697 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * __dbCopyStruct() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Create a new database based on current database structure - * $SYNTAX$ - * __dbCopyStruct( , [] ) - * $ARGUMENTS$ - * is the name of the new database file to create. (.dbf) - * is the default extension if none is given. - * - * is an array where each element is a field name. - * Names could be specified as uppercase or lowercase. - * $DESCRIPTION$ - * __dbCopyStruct() create a new empty database file with a structure - * that is based on the currently open database in this work-area. If - * is empty, the newly created file would have the same - * structure as the currently open database. Else, the new file would - * contain only fields that exactly match . - * - * __dbCopyStruct() can be use to create a sub-set of the currently - * open database, based on a given field list. - * - * COPY STRUCTURE command is preprocessed into __dbCopyStruct() - * function during compile time. - * $EXAMPLES$ - * // Create a new file that contain the same structure - * USE TEST - * __dbCopyStruct( "mycopy.dbf" ) - * - * // Create a new file that contain part of the original structure - * LOCAL aList - * USE TEST - * aList := { "NAME" } - * __dbCopyStruct( "onlyname.dbf", aList ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rdd - * $SEEALSO$ - * COPY STRUCTURE,COPY STRUCTURE EXTENDED,DBCREATE(),DBSTRUCT(),__dbCopyXStruct(),__dbCreate(),__dbStructFilter() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + __dbCopyStruct() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Create a new database based on current database structure + $SYNTAX$ + __dbCopyStruct( , [] ) + $ARGUMENTS$ + is the name of the new database file to create. (.dbf) + is the default extension if none is given. + + is an array where each element is a field name. + Names could be specified as uppercase or lowercase. + $DESCRIPTION$ + __dbCopyStruct() create a new empty database file with a structure + that is based on the currently open database in this work-area. If + is empty, the newly created file would have the same + structure as the currently open database. Else, the new file would + contain only fields that exactly match . + + __dbCopyStruct() can be use to create a sub-set of the currently + open database, based on a given field list. + + COPY STRUCTURE command is preprocessed into __dbCopyStruct() + function during compile time. + $EXAMPLES$ + // Create a new file that contain the same structure + USE TEST + __dbCopyStruct( "mycopy.dbf" ) + + // Create a new file that contain part of the original structure + LOCAL aList + USE TEST + aList := { "NAME" } + __dbCopyStruct( "onlyname.dbf", aList ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rdd + $SEEALSO$ + COPY STRUCTURE,COPY STRUCTURE EXTENDED,DBCREATE(),DBSTRUCT(),__dbCopyXStruct(),__dbCreate(),__dbStructFilter() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * COPY STRUCTURE - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Create a new database based on current database structure - * $SYNTAX$ - * COPY STRUCTURE TO [FIELDS ] - * $ARGUMENTS$ - * TO is the name of the new database file to - * create. (.dbf) is the default extension if none is given. It can be - * specified as a literal file name or as a character expression - * enclosed in parentheses. - * - * FIELDS is an optional list of field names to copy - * from the currently open database in the specified order, the default - * is all fields. Names could be specified as uppercase or lowercase. - * $DESCRIPTION$ - * COPY STRUCTURE create a new empty database file with a structure - * that is based on the currently open database in this work-area. - * - * COPY STRUCTURE can be use to create a sub-set of the currently - * open database, based on a given field list. - * - * COPY STRUCTURE command is preprocessed into __dbCopyStruct() - * function during compile time. - * $EXAMPLES$ - * // Create a new file that contains the same structure - * USE TEST - * COPY STRUCTURE TO MyCopy - * - * // Create a new file that contains part of the original structure - * USE TEST - * COPY STRUCTURE TO SomePart FIELDS name, address - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $SEEALSO$ - * COPY STRUCTURE EXTENDED,DBCREATE(),DBSTRUCT(),__dbCopyStruct(),__dbCopyXStruct(),__dbCreate(),__dbStructFilter() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + COPY STRUCTURE + $CATEGORY$ + Command + $SUBCATEGORY$ + Database + $ONELINER$ + Create a new database based on current database structure + $SYNTAX$ + COPY STRUCTURE TO [FIELDS ] + $ARGUMENTS$ + TO is the name of the new database file to + create. (.dbf) is the default extension if none is given. It can be + specified as a literal file name or as a character expression + enclosed in parentheses. + + FIELDS is an optional list of field names to copy + from the currently open database in the specified order, the default + is all fields. Names could be specified as uppercase or lowercase. + $DESCRIPTION$ + COPY STRUCTURE create a new empty database file with a structure + that is based on the currently open database in this work-area. + + COPY STRUCTURE can be use to create a sub-set of the currently + open database, based on a given field list. + + COPY STRUCTURE command is preprocessed into __dbCopyStruct() + function during compile time. + $EXAMPLES$ + // Create a new file that contains the same structure + USE TEST + COPY STRUCTURE TO MyCopy + + // Create a new file that contains part of the original structure + USE TEST + COPY STRUCTURE TO SomePart FIELDS name, address + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $SEEALSO$ + COPY STRUCTURE EXTENDED,DBCREATE(),DBSTRUCT(),__dbCopyStruct(),__dbCopyXStruct(),__dbCreate(),__dbStructFilter() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __dbCopyXStruct() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Copy current database structure into a definition file - * $SYNTAX$ - * __dbCopyXStruct( ) --> lSuccess - * $ARGUMENTS$ - * is the name of target definition file to create. (.dbf) - * is the default extension if none is given. - * $RETURNS$ - * __dbCopyXStruct() returns .F. if no database is USED in the current - * work-area, .T. on success, or a run-time error if the file create - * operation had failed. - * $DESCRIPTION$ - * __dbCopyXStruct() create a new database named with a - * pre-defined structure (also called "structure extended file"): - * - * - * Field name Type Length Decimals - * - * FIELD_NAME C 10 0 - * FIELD_TYPE C 1 0 - * FIELD_LEN N 3 0 - * FIELD_DEC N 3 0 - *
- * - * Each record in the new file contains information about one field in - * the original file. CREATE FROM could be used to create a database - * from the structure extended file. - * - * For prehistoric compatibility reasons, Character fields which are - * longer than 255 characters are treated in a special way by writing - * part of the length in the FIELD_DEC according to the following - * formula (this is done internally): - * - * - * FIELD->FIELD_DEC := int( nLength / 256 ) - * FIELD->FIELD_LEN := ( nLength % 256 ) - * - * - * Later if you want to calculate the length of a field you can use - * the following formula: - * - * - * nLength := iif( FIELD->FIELD_TYPE == "C", ; - * FIELD->FIELD_DEC * 256 + FIELD->FIELD_LEN, ; - * FIELD->FIELD_LEN ) - * - * - * COPY STRUCTURE EXTENDED command is preprocessed into - * __dbCopyXStruct() function during compile time. - * $EXAMPLES$ - * // Open a database, then copy its structure to a new file, - * // Open the new file and list all its records - * USE Test - * __dbCopyXStruct( "TestStru" ) - * USE TestStru - * LIST - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rdd - * $SEEALSO$ - * COPY STRUCTURE,COPY STRUCTURE EXTENDED,CREATE,CREATE FROM,DBCREATE(),DBSTRUCT(),__dbCopyStruct(),__dbCreate() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __dbCopyXStruct() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Copy current database structure into a definition file + $SYNTAX$ + __dbCopyXStruct( ) --> lSuccess + $ARGUMENTS$ + is the name of target definition file to create. (.dbf) + is the default extension if none is given. + $RETURNS$ + __dbCopyXStruct() returns .F. if no database is USED in the current + work-area, .T. on success, or a run-time error if the file create + operation had failed. + $DESCRIPTION$ + __dbCopyXStruct() create a new database named with a + pre-defined structure (also called "structure extended file"): + + + Field name Type Length Decimals + + FIELD_NAME C 10 0 + FIELD_TYPE C 1 0 + FIELD_LEN N 3 0 + FIELD_DEC N 3 0 +
+ + Each record in the new file contains information about one field in + the original file. CREATE FROM could be used to create a database + from the structure extended file. + + For prehistoric compatibility reasons, Character fields which are + longer than 255 characters are treated in a special way by writing + part of the length in the FIELD_DEC according to the following + formula (this is done internally): + + + FIELD->FIELD_DEC := int( nLength / 256 ) + FIELD->FIELD_LEN := ( nLength % 256 ) + + + Later if you want to calculate the length of a field you can use + the following formula: + + + nLength := iif( FIELD->FIELD_TYPE == "C", ; + FIELD->FIELD_DEC * 256 + FIELD->FIELD_LEN, ; + FIELD->FIELD_LEN ) + + + COPY STRUCTURE EXTENDED command is preprocessed into + __dbCopyXStruct() function during compile time. + $EXAMPLES$ + // Open a database, then copy its structure to a new file, + // Open the new file and list all its records + USE Test + __dbCopyXStruct( "TestStru" ) + USE TestStru + LIST + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rdd + $SEEALSO$ + COPY STRUCTURE,COPY STRUCTURE EXTENDED,CREATE,CREATE FROM,DBCREATE(),DBSTRUCT(),__dbCopyStruct(),__dbCreate() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * COPY STRUCTURE EXTENDED - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Copy current database structure into a definition file - * $SYNTAX$ - * COPY STRUCTURE EXTENDED TO - * $ARGUMENTS$ - * The name of the target definition file to - * create. (.dbf) is the default extension if none is given. It can be - * specified as a literal file name or as a character expression - * enclosed in parentheses. - * $DESCRIPTION$ - * COPY STRUCTURE EXTENDED create a new database named with - * a pre-defined structure (also called "structure extended file"): - * - * - * Field name Type Length Decimals - * - * FIELD_NAME C 10 0 - * FIELD_TYPE C 1 0 - * FIELD_LEN N 3 0 - * FIELD_DEC N 3 0 - *
- * - * Each record in the new file contains information about one field in - * the original file. CREATE FROM could be used to create a database - * from the structure extended file. - * - * For prehistoric compatibility reasons, Character fields which are - * longer than 255 characters are treated in a special way by writing - * part of the length in the FIELD_DEC according to the following - * formula (this is done internally): - * - * - * FIELD->FIELD_DEC := int( nLength / 256 ) - * FIELD->FIELD_LEN := ( nLength % 256 ) - * - * - * Later if you want to calculate the length of a field you can use - * the following formula: - * - * - * nLength := iif( FIELD->FIELD_TYPE == "C", ; - * FIELD->FIELD_DEC * 256 + FIELD->FIELD_LEN, ; - * FIELD->FIELD_LEN ) - * - * - * COPY STRUCTURE EXTENDED command is preprocessed into - * __dbCopyXStruct() function during compile time. - * $EXAMPLES$ - * // Open a database, then copy its structure to a new file, - * // Open the new file and list all its records - * USE Test - * COPY STRUCTURE EXTENDED TO TestStru - * USE TestStru - * LIST - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $SEEALSO$ - * COPY STRUCTURE,CREATE,CREATE FROM,DBCREATE(),DBSTRUCT(),__dbCopyStruct(),__dbCopyXStruct(),__dbCreate() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + COPY STRUCTURE EXTENDED + $CATEGORY$ + Command + $SUBCATEGORY$ + Database + $ONELINER$ + Copy current database structure into a definition file + $SYNTAX$ + COPY STRUCTURE EXTENDED TO + $ARGUMENTS$ + The name of the target definition file to + create. (.dbf) is the default extension if none is given. It can be + specified as a literal file name or as a character expression + enclosed in parentheses. + $DESCRIPTION$ + COPY STRUCTURE EXTENDED create a new database named with + a pre-defined structure (also called "structure extended file"): + + + Field name Type Length Decimals + + FIELD_NAME C 10 0 + FIELD_TYPE C 1 0 + FIELD_LEN N 3 0 + FIELD_DEC N 3 0 +
+ + Each record in the new file contains information about one field in + the original file. CREATE FROM could be used to create a database + from the structure extended file. + + For prehistoric compatibility reasons, Character fields which are + longer than 255 characters are treated in a special way by writing + part of the length in the FIELD_DEC according to the following + formula (this is done internally): + + + FIELD->FIELD_DEC := int( nLength / 256 ) + FIELD->FIELD_LEN := ( nLength % 256 ) + + + Later if you want to calculate the length of a field you can use + the following formula: + + + nLength := iif( FIELD->FIELD_TYPE == "C", ; + FIELD->FIELD_DEC * 256 + FIELD->FIELD_LEN, ; + FIELD->FIELD_LEN ) + + + COPY STRUCTURE EXTENDED command is preprocessed into + __dbCopyXStruct() function during compile time. + $EXAMPLES$ + // Open a database, then copy its structure to a new file, + // Open the new file and list all its records + USE Test + COPY STRUCTURE EXTENDED TO TestStru + USE TestStru + LIST + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $SEEALSO$ + COPY STRUCTURE,CREATE,CREATE FROM,DBCREATE(),DBSTRUCT(),__dbCopyStruct(),__dbCopyXStruct(),__dbCreate() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __dbCreate() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Create structure extended file or use one to create new file - * $SYNTAX$ - * __dbCreate( , [], [], [], [] ) --> lUsed - * $ARGUMENTS$ - * is the target file name to create and then open. (.dbf) - * is the default extension if none is given. - * - * is an optional structure extended file name from which - * the target file is going to be built. If omitted, a new - * empty structure extended file with the name is created - * and opened in the current work-area. - * - * is RDD name to create target with. If omitted, the - * default RDD is used. - * - * is an optional logical expression, (.T.) opens the target file - * name in the next available unused work-area and makes - * it the current work-area. (.F.) opens the target file in the current - * work-area. Default value is (.F.). The value of is ignored if - * is not specified. - * - * is an optional alias to USE the target file with. If not - * specified, alias is based on the root name of . - * $RETURNS$ - * __dbCreate() returns (.T.) if there is database USED in the - * current work-area (this might be the newly selected work-area), or - * (.F.) if there is no database USED. Note that on success a (.T.) - * would be returned, but on failure you probably end up with a - * run-time error and not a (.F.) value. - * $DESCRIPTION$ - * __dbCreate() works in two modes depending on the value of : - * - * 1) If is empty or not specified a new empty - * structure extended file with the name is created and - * then opened in the current work-area ( is ignored). The new - * file has the following structure: - * - * - * Field name Type Length Decimals - * - * FIELD_NAME C 10 0 - * FIELD_TYPE C 1 0 - * FIELD_LEN N 3 0 - * FIELD_DEC N 3 0 - *
- * - * The CREATE command is preprocessed into the __dbCopyStruct() function - * during compile time and uses this mode. - * - * 2) If is specified, it is opened and assumed to - * be a structure extended file where each record contains at least the - * following fields (in no particular order): FIELD_NAME, FIELD_TYPE, - * FIELD_LEN and FIELD_DEC. Any other field is ignored. From this - * information the file is then created and opened in the - * current or new work-area (according to ), if this is a new - * work-area it becomes the current. - * - * For prehistoric compatibility reasons, structure extended file - * Character fields which are longer than 255 characters should be - * treated in a special way by writing part of the length in the - * FIELD_DEC according to the following formula: - * - * - * FIELD->FIELD_DEC := int( nLength / 256 ) - * FIELD->FIELD_LEN := ( nLength % 256 ) - * - * - * CREATE FROM command is preprocessed into __dbCopyStruct() function - * during compile time and use this mode. - * $EXAMPLES$ - * // CREATE a new structure extended file, append some records and - * // then CREATE FROM this file a new database file - * - * __dbCreate( "template" ) - * dbAppend() - * FIELD->FIELD_NAME := "CHANNEL" - * FIELD->FIELD_TYPE := "N" - * FIELD->FIELD_LEN := 2 - * FIELD->FIELD_DEC := 0 - * dbAppend() - * FIELD->FIELD_NAME := "PROGRAM" - * FIELD->FIELD_TYPE := "C" - * FIELD->FIELD_LEN := 20 - * FIELD->FIELD_DEC := 0 - * dbAppend() - * FIELD->FIELD_NAME := "REVIEW" - * FIELD->FIELD_TYPE := "C" // this field is 1000 char long - * FIELD->FIELD_LEN := 232 // 1000 % 256 = 232 - * FIELD->FIELD_DEC := 3 // 1000 / 256 = 3 - * dbCloseArea() - * __dbCreate( "TV_Guide", "template" ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rdd - * $SEEALSO$ - * COPY STRUCTURE,COPY STRUCTURE EXTENDED,CREATE,CREATE FROM,DBCREATE(),DBSTRUCT(),__dbCopyStruct(),__dbCopyXStruct() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __dbCreate() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Create structure extended file or use one to create new file + $SYNTAX$ + __dbCreate( , [], [], [], [] ) --> lUsed + $ARGUMENTS$ + is the target file name to create and then open. (.dbf) + is the default extension if none is given. + + is an optional structure extended file name from which + the target file is going to be built. If omitted, a new + empty structure extended file with the name is created + and opened in the current work-area. + + is RDD name to create target with. If omitted, the + default RDD is used. + + is an optional logical expression, (.T.) opens the target file + name in the next available unused work-area and makes + it the current work-area. (.F.) opens the target file in the current + work-area. Default value is (.F.). The value of is ignored if + is not specified. + + is an optional alias to USE the target file with. If not + specified, alias is based on the root name of . + $RETURNS$ + __dbCreate() returns (.T.) if there is database USED in the + current work-area (this might be the newly selected work-area), or + (.F.) if there is no database USED. Note that on success a (.T.) + would be returned, but on failure you probably end up with a + run-time error and not a (.F.) value. + $DESCRIPTION$ + __dbCreate() works in two modes depending on the value of : + + 1) If is empty or not specified a new empty + structure extended file with the name is created and + then opened in the current work-area ( is ignored). The new + file has the following structure: + + + Field name Type Length Decimals + + FIELD_NAME C 10 0 + FIELD_TYPE C 1 0 + FIELD_LEN N 3 0 + FIELD_DEC N 3 0 +
+ + The CREATE command is preprocessed into the __dbCopyStruct() function + during compile time and uses this mode. + + 2) If is specified, it is opened and assumed to + be a structure extended file where each record contains at least the + following fields (in no particular order): FIELD_NAME, FIELD_TYPE, + FIELD_LEN and FIELD_DEC. Any other field is ignored. From this + information the file is then created and opened in the + current or new work-area (according to ), if this is a new + work-area it becomes the current. + + For prehistoric compatibility reasons, structure extended file + Character fields which are longer than 255 characters should be + treated in a special way by writing part of the length in the + FIELD_DEC according to the following formula: + + + FIELD->FIELD_DEC := int( nLength / 256 ) + FIELD->FIELD_LEN := ( nLength % 256 ) + + + CREATE FROM command is preprocessed into __dbCopyStruct() function + during compile time and use this mode. + $EXAMPLES$ + // CREATE a new structure extended file, append some records and + // then CREATE FROM this file a new database file + + __dbCreate( "template" ) + dbAppend() + FIELD->FIELD_NAME := "CHANNEL" + FIELD->FIELD_TYPE := "N" + FIELD->FIELD_LEN := 2 + FIELD->FIELD_DEC := 0 + dbAppend() + FIELD->FIELD_NAME := "PROGRAM" + FIELD->FIELD_TYPE := "C" + FIELD->FIELD_LEN := 20 + FIELD->FIELD_DEC := 0 + dbAppend() + FIELD->FIELD_NAME := "REVIEW" + FIELD->FIELD_TYPE := "C" // this field is 1000 char long + FIELD->FIELD_LEN := 232 // 1000 % 256 = 232 + FIELD->FIELD_DEC := 3 // 1000 / 256 = 3 + dbCloseArea() + __dbCreate( "TV_Guide", "template" ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rdd + $SEEALSO$ + COPY STRUCTURE,COPY STRUCTURE EXTENDED,CREATE,CREATE FROM,DBCREATE(),DBSTRUCT(),__dbCopyStruct(),__dbCopyXStruct() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * CREATE - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Create empty structure extended file - * $SYNTAX$ - * CREATE [VIA ] [ALIAS ] - * $ARGUMENTS$ - * is the target file name to create and then open. (.dbf) - * is the default extension if none is given. It can be specified as - * literal file name or as a character expression enclosed in - * parentheses. - * - * VIA is RDD name to create target with. If omitted, - * the default RDD is used. It can be specified as literal name or as a - * character expression enclosed in parentheses. - * - * ALIAS is an optional alias to USE the target file - * with. If not specified, alias is based on the root name of - * . - * $DESCRIPTION$ - * CREATE a new empty structure extended file with the name - * and then open it in the current work-area. The new file has the - * following structure: - * - * - * Field name Type Length Decimals - * - * FIELD_NAME C 10 0 - * FIELD_TYPE C 1 0 - * FIELD_LEN N 3 0 - * FIELD_DEC N 3 0 - *
- * - * CREATE command is preprocessed into __dbCopyStruct() function during - * compile time and use this mode. - * $EXAMPLES$ - * // CREATE a new structure extended file, append some records and - * // then CREATE FROM this file a new database file - * - * CREATE template - * APPEND BLANK - * FIELD->FIELD_NAME := "CHANNEL" - * FIELD->FIELD_TYPE := "N" - * FIELD->FIELD_LEN := 2 - * FIELD->FIELD_DEC := 0 - * APPEND BLANK - * FIELD->FIELD_NAME := "PROGRAM" - * FIELD->FIELD_TYPE := "C" - * FIELD->FIELD_LEN := 20 - * FIELD->FIELD_DEC := 0 - * APPEND BLANK - * FIELD->FIELD_NAME := "REVIEW" - * FIELD->FIELD_TYPE := "C" // this field is 1000 char long - * FIELD->FIELD_LEN := 232 // 1000 % 256 = 232 - * FIELD->FIELD_DEC := 3 // 1000 / 256 = 3 - * CLOSE - * CREATE TV_Guide FROM template - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $SEEALSO$ - * COPY STRUCTURE,COPY STRUCTURE EXTENDED,CREATE FROM,DBCREATE(),DBSTRUCT(),__dbCopyStruct(),__dbCopyXStruct(),__dbCreate() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + CREATE + $CATEGORY$ + Command + $SUBCATEGORY$ + Database + $ONELINER$ + Create empty structure extended file + $SYNTAX$ + CREATE [VIA ] [ALIAS ] + $ARGUMENTS$ + is the target file name to create and then open. (.dbf) + is the default extension if none is given. It can be specified as + literal file name or as a character expression enclosed in + parentheses. + + VIA is RDD name to create target with. If omitted, + the default RDD is used. It can be specified as literal name or as a + character expression enclosed in parentheses. + + ALIAS is an optional alias to USE the target file + with. If not specified, alias is based on the root name of + . + $DESCRIPTION$ + CREATE a new empty structure extended file with the name + and then open it in the current work-area. The new file has the + following structure: + + + Field name Type Length Decimals + + FIELD_NAME C 10 0 + FIELD_TYPE C 1 0 + FIELD_LEN N 3 0 + FIELD_DEC N 3 0 +
+ + CREATE command is preprocessed into __dbCopyStruct() function during + compile time and use this mode. + $EXAMPLES$ + // CREATE a new structure extended file, append some records and + // then CREATE FROM this file a new database file + + CREATE template + APPEND BLANK + FIELD->FIELD_NAME := "CHANNEL" + FIELD->FIELD_TYPE := "N" + FIELD->FIELD_LEN := 2 + FIELD->FIELD_DEC := 0 + APPEND BLANK + FIELD->FIELD_NAME := "PROGRAM" + FIELD->FIELD_TYPE := "C" + FIELD->FIELD_LEN := 20 + FIELD->FIELD_DEC := 0 + APPEND BLANK + FIELD->FIELD_NAME := "REVIEW" + FIELD->FIELD_TYPE := "C" // this field is 1000 char long + FIELD->FIELD_LEN := 232 // 1000 % 256 = 232 + FIELD->FIELD_DEC := 3 // 1000 / 256 = 3 + CLOSE + CREATE TV_Guide FROM template + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $SEEALSO$ + COPY STRUCTURE,COPY STRUCTURE EXTENDED,CREATE FROM,DBCREATE(),DBSTRUCT(),__dbCopyStruct(),__dbCopyXStruct(),__dbCreate() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * CREATE FROM - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Create new database file from a structure extended file - * $SYNTAX$ - * CREATE FROM [VIA ] [NEW] [ALIAS ] - * $ARGUMENTS$ - * is the target file name to create and then open. (.dbf) - * is the default extension if none is given. It can be specified as - * literal file name or as a character expression enclosed in - * parentheses. - * - * FROM is a structure extended file name from - * which the target file is going to be built. It can be - * specified as literal file name or as a character expression enclosed - * in parentheses. - * - * VIA is RDD name to create target with. If omitted, - * the default RDD is used. It can be specified as literal name or as a - * character expression enclosed in parentheses. - * - * NEW open the target file name in the next - * available unused work-area and making it the current work-area. If - * omitted open the target file in current work-area. - * - * ALIAS is an optional alias to USE the target file - * with. If not specified, alias is based on the root name of - * . - * $DESCRIPTION$ - * CREATE FROM open a structure extended file where each - * record contain at least the following fields (in no particular - * order): FIELD_NAME, FIELD_TYPE, FIELD_LEN and FIELD_DEC. Any other - * field is ignored. From this information the file is - * then created and opened in the current or new work-area (according to - * the NEW clause), if this is a new work-area it becomes the current. - * - * For prehistoric compatibility reasons, structure extended file - * Character fields which are longer than 255 characters should be - * treated in a special way by writing part of the length in the - * FIELD_DEC according to the following formula: - * - * - * FIELD->FIELD_DEC := int( nLength / 256 ) - * FIELD->FIELD_LEN := ( nLength % 256 ) - * - * - * CREATE FROM command is preprocessed into __dbCopyStruct() function - * during compile time and uses this mode. - * $EXAMPLES$ - * See example in the CREATE command - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $SEEALSO$ - * COPY STRUCTURE,COPY STRUCTURE EXTENDED,CREATE,DBCREATE(),DBSTRUCT(),__dbCopyStruct(),__dbCopyXStruct(),__dbCreate() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + CREATE FROM + $CATEGORY$ + Command + $SUBCATEGORY$ + Database + $ONELINER$ + Create new database file from a structure extended file + $SYNTAX$ + CREATE FROM [VIA ] [NEW] [ALIAS ] + $ARGUMENTS$ + is the target file name to create and then open. (.dbf) + is the default extension if none is given. It can be specified as + literal file name or as a character expression enclosed in + parentheses. + + FROM is a structure extended file name from + which the target file is going to be built. It can be + specified as literal file name or as a character expression enclosed + in parentheses. + + VIA is RDD name to create target with. If omitted, + the default RDD is used. It can be specified as literal name or as a + character expression enclosed in parentheses. + + NEW open the target file name in the next + available unused work-area and making it the current work-area. If + omitted open the target file in current work-area. + + ALIAS is an optional alias to USE the target file + with. If not specified, alias is based on the root name of + . + $DESCRIPTION$ + CREATE FROM open a structure extended file where each + record contain at least the following fields (in no particular + order): FIELD_NAME, FIELD_TYPE, FIELD_LEN and FIELD_DEC. Any other + field is ignored. From this information the file is + then created and opened in the current or new work-area (according to + the NEW clause), if this is a new work-area it becomes the current. + + For prehistoric compatibility reasons, structure extended file + Character fields which are longer than 255 characters should be + treated in a special way by writing part of the length in the + FIELD_DEC according to the following formula: + + + FIELD->FIELD_DEC := int( nLength / 256 ) + FIELD->FIELD_LEN := ( nLength % 256 ) + + + CREATE FROM command is preprocessed into __dbCopyStruct() function + during compile time and uses this mode. + $EXAMPLES$ + See example in the CREATE command + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $SEEALSO$ + COPY STRUCTURE,COPY STRUCTURE EXTENDED,CREATE,DBCREATE(),DBSTRUCT(),__dbCopyStruct(),__dbCopyXStruct(),__dbCreate() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __FLEDIT()* - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Filter a database structure array - * $SYNTAX$ - * __FLEDIT( , [] ) --> aStructFiltered - * $ARGUMENTS$ - * is a multidimensional array with database fields - * structure, which is usually the output from DBSTRUCT(), where each - * array element has the following structure: - * - * - * Position Description dbstruct.ch - * - * 1 cFieldName DBS_NAME - * 2 cFieldType DBS_TYPE - * 3 nFieldLength DBS_LEN - * 4 nDecimals DBS_DEC - *
- * - * is an array where each element is a field name. - * Names could be specified as uppercase or lowercase. - * $RETURNS$ - * __FLEDIT() return a new multidimensional array where each element is - * in the same structure as the original , but the array is - * built according to the list of fields in . If - * is empty, __FLEDIT() return reference to the original - * array. - * $DESCRIPTION$ - * __FLEDIT() can be use to create a sub-set of a database structure, - * based on a given field list. - * - * Note that field names in MUST be specified in uppercase - * or else no match would found. - * - * SET EXACT has no effect on the return value. - * - * __FLEDIT() is a compatibility function and it is synonym for - * __dbStructFilter() which does exactly the same. - * $EXAMPLES$ - * LOCAL aStruct, aList, aRet - * aStruct := { { "CODE", "N", 4, 0 }, ; - * { "NAME", "C", 10, 0 }, ; - * { "PHONE", "C", 13, 0 }, ; - * { "IQ", "N", 3, 0 } } - * aList := { "IQ", "NAME" } - * aRet := __FLEDIT( aStruct, aList ) - * // { { "IQ", "N", 3, 0 }, { "NAME", "C", 10, 0 } } - * - * aRet := __FLEDIT( aStruct, {} ) - * ? aRet == aStruct // .T. - * - * aList := { "iq", "NOTEXIST" } - * aRet := __FLEDIT( aStruct, aList ) - * // { { "IQ", "N", 3, 0 } } - * - * aList := { "NOTEXIST" } - * aRet := __FLEDIT( aStruct, aList ) // {} - * - * - * // Create a new file that contain part of the original structure - * LOCAL aStruct, aList, aRet - * USE TEST - * aStruct := dbStruct() - * aList := { "NAME" } - * dbCreate( "onlyname.dbf", __FLEDIT( aStruct, aList ) ) - * $STATUS$ - * R - * $COMPLIANCE$ - * CA-Cl*pper has internal undocumented function named __FLEDIT(), - * in Harbour we name it __dbStructFilter(). The new name gives a better - * description of what this function does. In Harbour __FLEDIT() simply - * calls __dbStructFilter() and therefor the latter is the recommended - * function to use. - * - * This function is only visible if src/rdd/dbstrux.prg was compiled - * with the HB_CLP_UNDOC flag. - * $PLATFORMS$ - * All - * $FILES$ - * Header file is dbstruct.ch - * Library is rdd - * $SEEALSO$ - * DBCREATE(),DBSTRUCT(),__dbCopyStruct(),__dbStructFilter() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __FLEDIT()* + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Filter a database structure array + $SYNTAX$ + __FLEDIT( , [] ) --> aStructFiltered + $ARGUMENTS$ + is a multidimensional array with database fields + structure, which is usually the output from DBSTRUCT(), where each + array element has the following structure: + + + Position Description dbstruct.ch + + 1 cFieldName DBS_NAME + 2 cFieldType DBS_TYPE + 3 nFieldLength DBS_LEN + 4 nDecimals DBS_DEC +
+ + is an array where each element is a field name. + Names could be specified as uppercase or lowercase. + $RETURNS$ + __FLEDIT() return a new multidimensional array where each element is + in the same structure as the original , but the array is + built according to the list of fields in . If + is empty, __FLEDIT() return reference to the original + array. + $DESCRIPTION$ + __FLEDIT() can be use to create a sub-set of a database structure, + based on a given field list. + + Note that field names in MUST be specified in uppercase + or else no match would found. + + SET EXACT has no effect on the return value. + + __FLEDIT() is a compatibility function and it is synonym for + __dbStructFilter() which does exactly the same. + $EXAMPLES$ + LOCAL aStruct, aList, aRet + aStruct := { { "CODE", "N", 4, 0 }, ; + { "NAME", "C", 10, 0 }, ; + { "PHONE", "C", 13, 0 }, ; + { "IQ", "N", 3, 0 } } + aList := { "IQ", "NAME" } + aRet := __FLEDIT( aStruct, aList ) + // { { "IQ", "N", 3, 0 }, { "NAME", "C", 10, 0 } } + + aRet := __FLEDIT( aStruct, {} ) + ? aRet == aStruct // .T. + + aList := { "iq", "NOTEXIST" } + aRet := __FLEDIT( aStruct, aList ) + // { { "IQ", "N", 3, 0 } } + + aList := { "NOTEXIST" } + aRet := __FLEDIT( aStruct, aList ) // {} + + + // Create a new file that contain part of the original structure + LOCAL aStruct, aList, aRet + USE TEST + aStruct := dbStruct() + aList := { "NAME" } + dbCreate( "onlyname.dbf", __FLEDIT( aStruct, aList ) ) + $STATUS$ + R + $COMPLIANCE$ + CA-Cl*pper has internal undocumented function named __FLEDIT(), + in Harbour we name it __dbStructFilter(). The new name gives a better + description of what this function does. In Harbour __FLEDIT() simply + calls __dbStructFilter() and therefor the latter is the recommended + function to use. + + This function is only visible if src/rdd/dbstrux.prg was compiled + with the HB_CLP_UNDOC flag. + $PLATFORMS$ + All + $FILES$ + Header file is dbstruct.ch + Library is rdd + $SEEALSO$ + DBCREATE(),DBSTRUCT(),__dbCopyStruct(),__dbStructFilter() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __dbStructFilter() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Filter a database structure array - * $SYNTAX$ - * __dbStructFilter( , [] ) --> aStructFiltered - * $ARGUMENTS$ - * is a multidimensional array with database fields - * structure, which is usually the output from DBSTRUCT(), where each - * array element has the following structure: - * - * - * Position Description dbstruct.ch - * - * 1 cFieldName DBS_NAME - * 2 cFieldType DBS_TYPE - * 3 nFieldLength DBS_LEN - * 4 nDecimals DBS_DEC - *
- * - * is an array where each element is a field name. - * Names could be specified as uppercase or lowercase. - * $RETURNS$ - * __dbStructFilter() return a new multidimensional array where each - * element is in the same structure as the original , but the - * array is built according to the list of fields in . If - * is empty, __dbStructFilter() return reference to the - * original array. - * $DESCRIPTION$ - * __dbStructFilter() can be use to create a sub-set of a database - * structure, based on a given field list. - * - * Note that field names in MUST be specified in uppercase - * or else no match would be found. - * - * SET EXACT has no effect on the return value. - * $EXAMPLES$ - * LOCAL aStruct, aList, aRet - * aStruct := { { "CODE", "N", 4, 0 }, ; - * { "NAME", "C", 10, 0 }, ; - * { "PHONE", "C", 13, 0 }, ; - * { "IQ", "N", 3, 0 } } - * aList := { "IQ", "NAME" } - * aRet := __dbStructFilter( aStruct, aList ) - * // { { "IQ", "N", 3, 0 }, { "NAME", "C", 10, 0 } } - * - * aRet := __dbStructFilter( aStruct, {} ) - * ? aRet == aStruct // .T. - * - * aList := { "iq", "NOTEXIST" } - * aRet := __dbStructFilter( aStruct, aList ) - * // { { "IQ", "N", 3, 0 } } - * - * aList := { "NOTEXIST" } - * aRet := __dbStructFilter( aStruct, aList ) // {} - * - * - * // Create a new file that contain part of the original structure - * LOCAL aStruct, aList, aRet - * USE TEST - * aStruct := dbStruct() - * aList := { "NAME" } - * dbCreate( "onlyname.dbf", __dbStructFilter( aStruct, aList ) ) - * $STATUS$ - * R - * $COMPLIANCE$ - * __dbStructFilter() is a Harbour extension. CA-Cl*pper has an internal - * undocumented function named __FLEDIT() that does exactly the same - * thing. The new name gives a better description of what this function does. - * $PLATFORMS$ - * All - * $FILES$ - * Header file is dbstruct.ch - * Library is rdd - * $SEEALSO$ - * DBCREATE(),DBSTRUCT(),__dbCopyStruct(),__FLEDIT()* - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __dbStructFilter() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Filter a database structure array + $SYNTAX$ + __dbStructFilter( , [] ) --> aStructFiltered + $ARGUMENTS$ + is a multidimensional array with database fields + structure, which is usually the output from DBSTRUCT(), where each + array element has the following structure: + + + Position Description dbstruct.ch + + 1 cFieldName DBS_NAME + 2 cFieldType DBS_TYPE + 3 nFieldLength DBS_LEN + 4 nDecimals DBS_DEC +
+ + is an array where each element is a field name. + Names could be specified as uppercase or lowercase. + $RETURNS$ + __dbStructFilter() return a new multidimensional array where each + element is in the same structure as the original , but the + array is built according to the list of fields in . If + is empty, __dbStructFilter() return reference to the + original array. + $DESCRIPTION$ + __dbStructFilter() can be use to create a sub-set of a database + structure, based on a given field list. + + Note that field names in MUST be specified in uppercase + or else no match would be found. + + SET EXACT has no effect on the return value. + $EXAMPLES$ + LOCAL aStruct, aList, aRet + aStruct := { { "CODE", "N", 4, 0 }, ; + { "NAME", "C", 10, 0 }, ; + { "PHONE", "C", 13, 0 }, ; + { "IQ", "N", 3, 0 } } + aList := { "IQ", "NAME" } + aRet := __dbStructFilter( aStruct, aList ) + // { { "IQ", "N", 3, 0 }, { "NAME", "C", 10, 0 } } + + aRet := __dbStructFilter( aStruct, {} ) + ? aRet == aStruct // .T. + + aList := { "iq", "NOTEXIST" } + aRet := __dbStructFilter( aStruct, aList ) + // { { "IQ", "N", 3, 0 } } + + aList := { "NOTEXIST" } + aRet := __dbStructFilter( aStruct, aList ) // {} + + + // Create a new file that contain part of the original structure + LOCAL aStruct, aList, aRet + USE TEST + aStruct := dbStruct() + aList := { "NAME" } + dbCreate( "onlyname.dbf", __dbStructFilter( aStruct, aList ) ) + $STATUS$ + R + $COMPLIANCE$ + __dbStructFilter() is a Harbour extension. CA-Cl*pper has an internal + undocumented function named __FLEDIT() that does exactly the same + thing. The new name gives a better description of what this function does. + $PLATFORMS$ + All + $FILES$ + Header file is dbstruct.ch + Library is rdd + $SEEALSO$ + DBCREATE(),DBSTRUCT(),__dbCopyStruct(),__FLEDIT()* + $END$ */ diff --git a/harbour/doc/en/dir.txt b/harbour/doc/en/dir.txt index deed1308e7..7368651ab1 100644 --- a/harbour/doc/en/dir.txt +++ b/harbour/doc/en/dir.txt @@ -13,194 +13,194 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __Dir()* - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Display listings of files - * $SYNTAX$ - * __Dir( [] ) --> NIL - * $ARGUMENTS$ - * File mask to include in the function return. It could - * contain path and standard wildcard characters as supported by your - * OS (like * and ?). If contains no path, then SET DEFAULT - * path is used to display files in the mask. - * $RETURNS$ - * __Dir() always returns NIL. - * $DESCRIPTION$ - * If no is given, __Dir() displays information about all - * *.dbf in the SET DEFAULT path. This information contains: file name, - * number of records, last update date and the size of each file. - * - * If is given, __Dir() list all files that match the mask - * with the following details: Name, Extension, Size, Date. - * - * DIR command is preprocessed into __Dir() function during compile - * time. - * - * __Dir() is a compatibility function, it is superseded by DIRECTORY() - * which return all the information in a multidimensional array. - * $EXAMPLES$ - * __Dir() // information for all DBF files in current directory - * - * __Dir( "*.dbf" ) // list all DBF file in current directory - * - * // list all PRG files in Harbour Run-Time library - * // for MS-DOS compatible operating systems - * __Dir( "src\rtl\*.prg" ) - * - * // list all files in the public section on a Unix like machine - * __Dir( "/pub" ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All(LFN) - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ADIR(),DIRECTORY(),SET DEFAULT,DIR - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __Dir()* + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Display listings of files + $SYNTAX$ + __Dir( [] ) --> NIL + $ARGUMENTS$ + File mask to include in the function return. It could + contain path and standard wildcard characters as supported by your + OS (like * and ?). If contains no path, then SET DEFAULT + path is used to display files in the mask. + $RETURNS$ + __Dir() always returns NIL. + $DESCRIPTION$ + If no is given, __Dir() displays information about all + *.dbf in the SET DEFAULT path. This information contains: file name, + number of records, last update date and the size of each file. + + If is given, __Dir() list all files that match the mask + with the following details: Name, Extension, Size, Date. + + DIR command is preprocessed into __Dir() function during compile + time. + + __Dir() is a compatibility function, it is superseded by DIRECTORY() + which return all the information in a multidimensional array. + $EXAMPLES$ + __Dir() // information for all DBF files in current directory + + __Dir( "*.dbf" ) // list all DBF file in current directory + + // list all PRG files in Harbour Run-Time library + // for MS-DOS compatible operating systems + __Dir( "src\rtl\*.prg" ) + + // list all files in the public section on a Unix like machine + __Dir( "/pub" ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All(LFN) + $FILES$ + Library is rtl + $SEEALSO$ + ADIR(),DIRECTORY(),SET DEFAULT,DIR + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * DIR - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Display listings of files - * $SYNTAX$ - * DIR [] - * $ARGUMENTS$ - * File mask to include in the function return. It could - * contain path and standard wildcard characters as supported by your - * OS (like * and ?). If contains no path, then SET DEFAULT - * path is used to display files in the mask. - * $DESCRIPTION$ - * If no is given, __Dir() display information about all - * *.dbf in the SET DEFAULT path, this information contain: file name, - * number of records, last update date and the size of each file. - * - * If is given, __Dir() list all files that match the mask - * with the following details: Name, Extension, Size, Date. - * - * DIR command is preprocessed into __Dir() function during compile - * time. - * - * __Dir() is a compatibility function, it is superseded by DIRECTORY() - * which returns all the information in a multidimensional array. - * $EXAMPLES$ - * DIR // information for all DBF files in current directory - * - * dir "*.dbf" // list all DBF file in current directory - * - * // list all PRG files in Harbour Run-Time library - * // for MS-DOS compatible operating systems - * Dir "src\rtl\*.prg" - * - * // list all files in the public section on a Unix like machine - * Dir "/pub" - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All(LFN) - * $SEEALSO$ - * ADIR(),DIRECTORY(),SET DEFAULT,__DIR()* - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + DIR + $CATEGORY$ + Command + $SUBCATEGORY$ + FileSys + $ONELINER$ + Display listings of files + $SYNTAX$ + DIR [] + $ARGUMENTS$ + File mask to include in the function return. It could + contain path and standard wildcard characters as supported by your + OS (like * and ?). If contains no path, then SET DEFAULT + path is used to display files in the mask. + $DESCRIPTION$ + If no is given, __Dir() display information about all + *.dbf in the SET DEFAULT path, this information contain: file name, + number of records, last update date and the size of each file. + + If is given, __Dir() list all files that match the mask + with the following details: Name, Extension, Size, Date. + + DIR command is preprocessed into __Dir() function during compile + time. + + __Dir() is a compatibility function, it is superseded by DIRECTORY() + which returns all the information in a multidimensional array. + $EXAMPLES$ + DIR // information for all DBF files in current directory + + dir "*.dbf" // list all DBF file in current directory + + // list all PRG files in Harbour Run-Time library + // for MS-DOS compatible operating systems + Dir "src\rtl\*.prg" + + // list all files in the public section on a Unix like machine + Dir "/pub" + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All(LFN) + $SEEALSO$ + ADIR(),DIRECTORY(),SET DEFAULT,__DIR()* + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ADIR() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Fill pre-defined arrays with file/directory information - * $SYNTAX$ - * ADIR( [], [], [], [], - * [], [] ) --> nDirEnries - * $ARGUMENTS$ - * File mask to include in the function return. It could - * contain path and standard wildcard characters as supported by your - * OS (like * and ?). If you omit or if contains - * no path, then the path from SET DEFAULT is used. - * - * Array to fill with file name of files that meet . - * Each element is a Character string and include the file name and - * extension without the path. The name is the long file name as - * reported by the OS and not necessarily the 8.3 uppercase name. - * - * Array to fill with file size of files that meet . - * Each element is a Numeric integer for the file size in Bytes. - * Directories are always zero in size. - * - * Array to fill with file last modification date of files that - * meet . Each element is of type Date. - * - * Array to fill with file last modification time of files that - * meet . Each element is a Character string in the format - * HH:mm:ss. - * - * Array to fill with attribute of files that meet . - * Each element is a Character string, see DIRECTORY() for information - * about attribute values. If you pass array to , the function - * is going to return files with normal, hidden, system and directory - * attributes. If is not specified or with type other than - * Array, only files with normal attribute would return. - * $RETURNS$ - * ADIR() return the number of file entries that meet - * $DESCRIPTION$ - * ADIR() return the number of files and/or directories that match - * a specified skeleton, it also fill a series of given arrays with - * the name, size, date, time and attribute of those files. The passed - * arrays should pre-initialized to the proper size, see example below. - * In order to include hidden, system or directories must be - * specified. - * - * ADIR() is a compatibility function, it is superseded by DIRECTORY() - * which returns all the information in a multidimensional array. - * $EXAMPLES$ - * LOCAL aName, aSize, aDate, aTime, aAttr, nLen, i - * nLen := ADir( "*.jpg" ) // Number of JPG files in this directory - * IF nLen > 0 - * aName := Array( nLen ) // make room to store the information - * aSize := Array( nLen ) - * aDate := Array( nLen ) - * aTime := Array( nLen ) - * aAttr := Array( nLen ) - * ADir( "*.prg", aName, aSize, aDate, aTime, aAttr ) - * FOR i := 1 TO nLen - * ? aName[ i ], aSize[ i ], aDate[ i ], aTime[ i ], aAttr[ i ] - * NEXT - * ELSE - * ? "This directory is clean from smut" - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * is going to be filled with long file name and not necessarily - * the 8.3 uppercase name. - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ARRAY(),DIRECTORY(),SET DEFAULT - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ADIR() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Fill pre-defined arrays with file/directory information + $SYNTAX$ + ADIR( [], [], [], [], + [], [] ) --> nDirEnries + $ARGUMENTS$ + File mask to include in the function return. It could + contain path and standard wildcard characters as supported by your + OS (like * and ?). If you omit or if contains + no path, then the path from SET DEFAULT is used. + + Array to fill with file name of files that meet . + Each element is a Character string and include the file name and + extension without the path. The name is the long file name as + reported by the OS and not necessarily the 8.3 uppercase name. + + Array to fill with file size of files that meet . + Each element is a Numeric integer for the file size in Bytes. + Directories are always zero in size. + + Array to fill with file last modification date of files that + meet . Each element is of type Date. + + Array to fill with file last modification time of files that + meet . Each element is a Character string in the format + HH:mm:ss. + + Array to fill with attribute of files that meet . + Each element is a Character string, see DIRECTORY() for information + about attribute values. If you pass array to , the function + is going to return files with normal, hidden, system and directory + attributes. If is not specified or with type other than + Array, only files with normal attribute would return. + $RETURNS$ + ADIR() return the number of file entries that meet + $DESCRIPTION$ + ADIR() return the number of files and/or directories that match + a specified skeleton, it also fill a series of given arrays with + the name, size, date, time and attribute of those files. The passed + arrays should pre-initialized to the proper size, see example below. + In order to include hidden, system or directories must be + specified. + + ADIR() is a compatibility function, it is superseded by DIRECTORY() + which returns all the information in a multidimensional array. + $EXAMPLES$ + LOCAL aName, aSize, aDate, aTime, aAttr, nLen, i + nLen := ADir( "*.jpg" ) // Number of JPG files in this directory + IF nLen > 0 + aName := Array( nLen ) // make room to store the information + aSize := Array( nLen ) + aDate := Array( nLen ) + aTime := Array( nLen ) + aAttr := Array( nLen ) + ADir( "*.prg", aName, aSize, aDate, aTime, aAttr ) + FOR i := 1 TO nLen + ? aName[ i ], aSize[ i ], aDate[ i ], aTime[ i ], aAttr[ i ] + NEXT + ELSE + ? "This directory is clean from smut" + ENDIF + $STATUS$ + R + $COMPLIANCE$ + is going to be filled with long file name and not necessarily + the 8.3 uppercase name. + $FILES$ + Library is rtl + $SEEALSO$ + ARRAY(),DIRECTORY(),SET DEFAULT + $END$ */ diff --git a/harbour/doc/en/diskspac.txt b/harbour/doc/en/diskspac.txt index f00a7af09f..262899479e 100644 --- a/harbour/doc/en/diskspac.txt +++ b/harbour/doc/en/diskspac.txt @@ -13,107 +13,107 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DISKSPACE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Get the amount of space available on a disk - * $SYNTAX$ - * DISKSPACE( [] ) --> nDiskbytes - * $ARGUMENTS$ - * The number of the drive you are requesting info on where 1 = A, - * 2 = B, etc. For 0 or no parameter, DiskSpace will operate on the current - * drive. The default is 0 - * $RETURNS$ - * The number of bytes on the requested disk that match the - * requested type. - * $DESCRIPTION$ - * By default, this function will return the number of bytes of - * free space on the current drive that is available to the user - * requesting the information. - * - * If information is requested on a disk that is not available, a runtime - * error 2018 will be raised. - * $EXAMPLES$ - * ? "You can use : " + hb_ntos( DiskSpace() ) + " bytes " - * - * Note: See tests\tstdspac.prg for another example - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * DOS,Win,OS2 - * $FILES$ - * Library is rtl - * Header is fileio.ch - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DISKSPACE() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Get the amount of space available on a disk + $SYNTAX$ + DISKSPACE( [] ) --> nDiskbytes + $ARGUMENTS$ + The number of the drive you are requesting info on where 1 = A, + 2 = B, etc. For 0 or no parameter, DiskSpace will operate on the current + drive. The default is 0 + $RETURNS$ + The number of bytes on the requested disk that match the + requested type. + $DESCRIPTION$ + By default, this function will return the number of bytes of + free space on the current drive that is available to the user + requesting the information. + + If information is requested on a disk that is not available, a runtime + error 2018 will be raised. + $EXAMPLES$ + ? "You can use : " + hb_ntos( DiskSpace() ) + " bytes " + + Note: See tests\tstdspac.prg for another example + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + DOS,Win,OS2 + $FILES$ + Library is rtl + Header is fileio.ch + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_DISKSPACE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Get the amount of space available on a disk - * $SYNTAX$ - * HB_DISKSPACE( [] [, ] ) --> nDiskbytes - * $ARGUMENTS$ - * The drive letter you are requesting info on. The default - * is A: +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_DISKSPACE() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Get the amount of space available on a disk + $SYNTAX$ + HB_DISKSPACE( [] [, ] ) --> nDiskbytes + $ARGUMENTS$ + The drive letter you are requesting info on. The default + is A: - * The type of space being requested. The default is HB_DISK_AVAIL. - * $RETURNS$ - * The number of bytes on the requested disk that match the - * requested type. - * $DESCRIPTION$ - * By default, this function will return the number of bytes of - * free space on the current drive that is available to the user - * requesting the information. - * - * There are 4 types of information available: - * - * HB_FS_AVAIL The amount of space available to the user making the - * request. This value could be less than HB_FS_FREE if - * disk quotas are supported by the O/S in use at runtime, - * and disk quotas are in effect. Otherwise, the value - * will be equal to that returned for HB_FS_FREE. - * - * HB_FS_FREE The actual amount of free diskspace on the drive. - * - * HB_FS_USED The number of bytes in use on the disk. - * - * HB_FS_TOTAL The total amount of space allocated for the user if - * disk quotas are in effect, otherwise, the actual size - * of the drive. - * - * If information is requested on a disk that is not available, a runtime - * error 2018 will be raised. - * $EXAMPLES$ - * #include "fileio.ch" - * ? "You can use : " + hb_ntos( hb_DiskSpace() ) + " bytes " +; - * "Out of a total of " + hb_ntos( hb_DiskSpace( "C:", HB_FS_TOTAL ) ) - * - * Note: See tests\tstdspac.prg for another example - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * DOS,Win,OS2,Unix - * $FILES$ - * Library is rtl - * Header is fileio.ch - * $END$ + The type of space being requested. The default is HB_DISK_AVAIL. + $RETURNS$ + The number of bytes on the requested disk that match the + requested type. + $DESCRIPTION$ + By default, this function will return the number of bytes of + free space on the current drive that is available to the user + requesting the information. + + There are 4 types of information available: + + HB_FS_AVAIL The amount of space available to the user making the + request. This value could be less than HB_FS_FREE if + disk quotas are supported by the O/S in use at runtime, + and disk quotas are in effect. Otherwise, the value + will be equal to that returned for HB_FS_FREE. + + HB_FS_FREE The actual amount of free diskspace on the drive. + + HB_FS_USED The number of bytes in use on the disk. + + HB_FS_TOTAL The total amount of space allocated for the user if + disk quotas are in effect, otherwise, the actual size + of the drive. + + If information is requested on a disk that is not available, a runtime + error 2018 will be raised. + $EXAMPLES$ + #include "fileio.ch" + ? "You can use : " + hb_ntos( hb_DiskSpace() ) + " bytes " +; + "Out of a total of " + hb_ntos( hb_DiskSpace( "C:", HB_FS_TOTAL ) ) + + Note: See tests\tstdspac.prg for another example + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + DOS,Win,OS2,Unix + $FILES$ + Library is rtl + Header is fileio.ch + $END$ */ diff --git a/harbour/doc/en/errsys.txt b/harbour/doc/en/errsys.txt index ea19c17a83..a07853bc4e 100644 --- a/harbour/doc/en/errsys.txt +++ b/harbour/doc/en/errsys.txt @@ -13,34 +13,34 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ERRORSYS() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * Install default error handler - * $SYNTAX$ - * ERRORSYS() --> NIL - * $ARGUMENTS$ - * None. - * $RETURNS$ - * ERRORSYS() always return NIL. - * $DESCRIPTION$ - * ERRORSYS() is called upon startup by Harbour and installs the default - * error handler. Normally you should not call this function directly, - * instead use ERRORBLOCK() to install your own error handler. - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ERRORBLOCK(),Error class - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ERRORSYS() + $CATEGORY$ + API + $SUBCATEGORY$ + Error + $ONELINER$ + Install default error handler + $SYNTAX$ + ERRORSYS() --> NIL + $ARGUMENTS$ + None. + $RETURNS$ + ERRORSYS() always return NIL. + $DESCRIPTION$ + ERRORSYS() is called upon startup by Harbour and installs the default + error handler. Normally you should not call this function directly, + instead use ERRORBLOCK() to install your own error handler. + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + ERRORBLOCK(),Error class + $END$ */ diff --git a/harbour/doc/en/eval.txt b/harbour/doc/en/eval.txt index 50caab2789..cb9a30b5ff 100644 --- a/harbour/doc/en/eval.txt +++ b/harbour/doc/en/eval.txt @@ -13,56 +13,56 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * EVAL() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Execute and Execution - * $ONELINER$ - * Evaluate a code block - * $SYNTAX$ - * EVAL( [, [,...]]) --> xExpression - * $ARGUMENTS$ - * Code block expression to be evaluated - * - * Argument to be passed to the code block expression - * - * Argument list to be passed to the code block expression - * $RETURNS$ - * The result of the evaluated code block - * $DESCRIPTION$ - * This function evaluates the code bloc expressed as and - * returns its evaluated value. If their are multiple expressions within - * the code block, the last expression will be value of this function. - * - * If the code block requires parameters to be passed to it,they are - * specified in the parameter list and following. Each parameter - * is separated by a comma within the expression list. - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL bBlock := {|| NIL } - * ? Eval( 1 ) - * ? Eval( @bBlock ) - * - * ? Eval( {| p1 | p1 }, "A", "B" ) - * ? Eval( {| p1, p2 | p1 + p2 }, "A", "B" ) - * ? Eval( {| p1, p2, p3 | p1 }, "A", "B" ) - * RETURN - * $TESTS$ - * See examples - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is vm - * $SEEALSO$ - * AEVAL(),DBEVAL() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + EVAL() + $CATEGORY$ + API + $SUBCATEGORY$ + Execute and Execution + $ONELINER$ + Evaluate a code block + $SYNTAX$ + EVAL( [, [,...]]) --> xExpression + $ARGUMENTS$ + Code block expression to be evaluated + + Argument to be passed to the code block expression + + Argument list to be passed to the code block expression + $RETURNS$ + The result of the evaluated code block + $DESCRIPTION$ + This function evaluates the code bloc expressed as and + returns its evaluated value. If their are multiple expressions within + the code block, the last expression will be value of this function. + + If the code block requires parameters to be passed to it,they are + specified in the parameter list and following. Each parameter + is separated by a comma within the expression list. + $EXAMPLES$ + PROCEDURE Main() + LOCAL bBlock := {|| NIL } + ? Eval( 1 ) + ? Eval( @bBlock ) + + ? Eval( {| p1 | p1 }, "A", "B" ) + ? Eval( {| p1, p2 | p1 + p2 }, "A", "B" ) + ? Eval( {| p1, p2, p3 | p1 }, "A", "B" ) + RETURN + $TESTS$ + See examples + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is vm + $SEEALSO$ + AEVAL(),DBEVAL() + $END$ */ diff --git a/harbour/doc/en/file.txt b/harbour/doc/en/file.txt index 4ec1416ec3..993d7f3b48 100644 --- a/harbour/doc/en/file.txt +++ b/harbour/doc/en/file.txt @@ -21,1160 +21,1158 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * FOPEN() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Open a file. - * $SYNTAX$ - * FOPEN( , [] ) --> nHandle - * $ARGUMENTS$ - * Name of file to open. - * - * File open mode. - * $RETURNS$ - * A file handle. - * $DESCRIPTION$ - * This function opens a file expressed as and returns a - * file handle to be used with other low-level file functions. The - * value of represents the status of the file to be opened; - * the default value is 0. The file open modes are as follows: +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + FOPEN() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Open a file. + $SYNTAX$ + FOPEN( , [] ) --> nHandle + $ARGUMENTS$ + Name of file to open. - * - * nMode fileio.ch Meaning - * - * 0 FO_READ Read only - * 1 FO_WRITE Write only - * 2 FO_READWRITE Read/write - * 16 FO_EXCLUSIVE Exclusive read only - * 32 FO_DENYWRITE Prevent others from writing - * 48 FO_DENYREAD Deny read only - * 64 FO_DENYNONE Not deny, Let to others Read / Write - * 64 FO_SHARED same as FO_DENYNONE - *
- * - * If there is an error in opening a file, a -1 will be returned by - * the function. Files handles may be in the range of 0 to 65535. The - * status of the SET DEFAULT TO and SET PATH TO commands has no effect - * on this function. Directory names and paths must be specified along - * with the file that is to be opened. - * - * If an error has occurred, see the returns values from FERROR() for - * possible reasons for the error. - * $EXAMPLES$ - * #include "fileio.ch" - * IF ( nH := FOpen( "x.txt", FO_READWRITE + FO_DENYNONE ) ) == F_ERROR - * ? "File can't be opened" - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * Header is fileio.ch - * $SEEALSO$ - * FCREATE(),FERROR(),FCLOSE() - * $END$ + File open mode. + $RETURNS$ + A file handle. + $DESCRIPTION$ + This function opens a file expressed as and returns a + file handle to be used with other low-level file functions. The + value of represents the status of the file to be opened; + the default value is 0. The file open modes are as follows: + + + nMode fileio.ch Meaning + + 0 FO_READ Read only + 1 FO_WRITE Write only + 2 FO_READWRITE Read/write + 16 FO_EXCLUSIVE Exclusive read only + 32 FO_DENYWRITE Prevent others from writing + 48 FO_DENYREAD Deny read only + 64 FO_DENYNONE Not deny, Let to others Read / Write + 64 FO_SHARED same as FO_DENYNONE +
+ + If there is an error in opening a file, a -1 will be returned by + the function. Files handles may be in the range of 0 to 65535. The + status of the SET DEFAULT TO and SET PATH TO commands has no effect + on this function. Directory names and paths must be specified along + with the file that is to be opened. + + If an error has occurred, see the returns values from FERROR() for + possible reasons for the error. + $EXAMPLES$ + #include "fileio.ch" + IF ( nH := FOpen( "x.txt", FO_READWRITE + FO_DENYNONE ) ) == F_ERROR + ? "File can't be opened" + ENDIF + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + Header is fileio.ch + $SEEALSO$ + FCREATE(),FERROR(),FCLOSE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * FCREATE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Creates a file. - * $SYNTAX$ - * FCREATE( , [] ) --> nHandle - * $ARGUMENTS$ - * is the name of the file to create. - * - * Numeric code for the file attributes. - * $RETURNS$ - * Numeric file handle to be used in other operations. - * $DESCRIPTION$ - * This function creates a new file with a filename of . The - * default value of is 0 and is used to set the - * attribute byte for the file being created by this function. - * The return value will be a file handle that is associated - * with the new file. This number will be between zero to 65,535, - * inclusive. If an error occurs, the return value of this function - * will be -1. - * - * If the file already exists, the existing file will be - * truncated to a file length of 0 bytes. +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + FCREATE() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Creates a file. + $SYNTAX$ + FCREATE( , [] ) --> nHandle + $ARGUMENTS$ + is the name of the file to create. - * If specified, the following table shows the value for - * and their related meaning to the file being created by - * this function. - * - * - * fileio.ch Meaning - * - * 0 FC_NORMAL Normal/Default,Read/Write - * 1 FC_READONLY Read-only file attribute is set - * 2 FC_HIDDEN Hidden,Excluded from normal DIR search - * 4 FC_SYSTEM Create,Excluded from normal DIR search - *
- * $EXAMPLES$ - * #include "fileio.ch" - * IF ( nh := FCreate( "test.txt" ) ) == F_ERROR - * ? "Cannot create file" - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * Header is fileio.ch - * $SEEALSO$ - * FCLOSE(),FOPEN(),FWRITE(),FREAD(),FERROR() - * $END$ + Numeric code for the file attributes. + $RETURNS$ + Numeric file handle to be used in other operations. + $DESCRIPTION$ + This function creates a new file with a filename of . The + default value of is 0 and is used to set the + attribute byte for the file being created by this function. + The return value will be a file handle that is associated + with the new file. This number will be between zero to 65,535, + inclusive. If an error occurs, the return value of this function + will be -1. + + If the file already exists, the existing file will be + truncated to a file length of 0 bytes. + + If specified, the following table shows the value for + and their related meaning to the file being created by + this function. + + + fileio.ch Meaning + + 0 FC_NORMAL Normal/Default,Read/Write + 1 FC_READONLY Read-only file attribute is set + 2 FC_HIDDEN Hidden,Excluded from normal DIR search + 4 FC_SYSTEM Create,Excluded from normal DIR search +
+ $EXAMPLES$ + #include "fileio.ch" + IF ( nh := FCreate( "test.txt" ) ) == F_ERROR + ? "Cannot create file" + ENDIF + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + Header is fileio.ch + $SEEALSO$ + FCLOSE(),FOPEN(),FWRITE(),FREAD(),FERROR() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * FREAD() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Reads a specified number of bytes from a file. - * $SYNTAX$ - * FREAD( , @, ) --> nBytes - * $ARGUMENTS$ - * File handle +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + FREAD() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Reads a specified number of bytes from a file. + $SYNTAX$ + FREAD( , @, ) --> nBytes + $ARGUMENTS$ + File handle - * Character expression passed by reference. + Character expression passed by reference. - * Number of bytes to read. - * $RETURNS$ - * the number of bytes successfully read from the file. - * - * $DESCRIPTION$ - * This function reads the characters from a file whose file handle - * is into a character memory variable expressed as . - * The function returns the number of bytes successfully read into - * . + Number of bytes to read. + $RETURNS$ + the number of bytes successfully read from the file. + + $DESCRIPTION$ + This function reads the characters from a file whose file handle + is into a character memory variable expressed as . + The function returns the number of bytes successfully read into + . - * The value of is obtained from either a call to the FOPEN() - * or the FCREATE() function. + The value of is obtained from either a call to the FOPEN() + or the FCREATE() function. - * The expression is passed by reference and must be defined - * before this function is called. It also must be at least the same - * length as . + The expression is passed by reference and must be defined + before this function is called. It also must be at least the same + length as . - * is the number of bytes to read, starting at the current - * file pointer position. If this function is successful in reading - * the characters from the file, the length of or the number - * of bytes specified in will be the value returned. The current - * file pointer advances the number of bytes read with each successive - * read. The return value is the number of bytes successfully read - * from the file. If a 0 is returned, or if the number of - * bytes read matches neither the length of nor the specified - * value in an end-of-file condition has been reached. - * $EXAMPLES$ - * #include "fileio.ch" - * cBuffer := Space( 500 ) - * IF ( nH := FOpen( "x.txt" ) ) == F_ERROR - * FRead( nH, @cBuffer, 500 ) - * ? cbuffer - * ENDIF - * FClose( nH ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All(64K) - * $FILES$ - * Library is rtl - * $SEEALSO$ - * BIN2I(),BIN2L(),BIN2W(),FERROR(),FWRITE() - * $END$ + is the number of bytes to read, starting at the current + file pointer position. If this function is successful in reading + the characters from the file, the length of or the number + of bytes specified in will be the value returned. The current + file pointer advances the number of bytes read with each successive + read. The return value is the number of bytes successfully read + from the file. If a 0 is returned, or if the number of + bytes read matches neither the length of nor the specified + value in an end-of-file condition has been reached. + $EXAMPLES$ + #include "fileio.ch" + cBuffer := Space( 500 ) + IF ( nH := FOpen( "x.txt" ) ) == F_ERROR + FRead( nH, @cBuffer, 500 ) + ? cbuffer + ENDIF + FClose( nH ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All(64K) + $FILES$ + Library is rtl + $SEEALSO$ + BIN2I(),BIN2L(),BIN2W(),FERROR(),FWRITE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * FWRITE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Writes characters to a file. - * $SYNTAX$ - * FWRITE( , , [] ) --> nBytesWritten - * $ARGUMENTS$ - * File handle number. +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + FWRITE() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Writes characters to a file. + $SYNTAX$ + FWRITE( , , [] ) --> nBytesWritten + $ARGUMENTS$ + File handle number. - * Character expression to be written. + Character expression to be written. - * The number of bytes to write. - * $RETURNS$ - * the number of bytes successfully written. - * $DESCRIPTION$ - * This function writes the contents of to the file designated - * by its file handle . If used, is the number of - * bytes in to write. + The number of bytes to write. + $RETURNS$ + the number of bytes successfully written. + $DESCRIPTION$ + This function writes the contents of to the file designated + by its file handle . If used, is the number of + bytes in to write. - * The returned value is the number of bytes successfully written to the - * file. If the returned value is 0, an error has occurred (unless - * this is intended). A successful write occurs when the number returned - * by FWrite() is equal to either Len( ) or . + The returned value is the number of bytes successfully written to the + file. If the returned value is 0, an error has occurred (unless + this is intended). A successful write occurs when the number returned + by FWrite() is equal to either Len( ) or . - * The value of is the string or variable to be written to the - * open file . + The value of is the string or variable to be written to the + open file . - * The value of is the number of bytes to write out to the file. - * The disk write begins with the current file position in . If - * this variable is not used, the entire contents of is written - * to the file. - * To truncate a file, a call of FWRITE( nHandle, "", 0 ) is needed. - * $EXAMPLES$ - * nHandle := FCreate( "x.txt" ) - * FOR X := 1 TO 10 - * FWrite( nHandle, Str( x ) ) - * NEXT - * FClose( nHandle ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All(64K) - * $FILES$ - * Library is rtl - * $SEEALSO$ - * FCLOSE(), FCREATE(), FERROR(), FOPEN(), I2BIN(), L2BIN() - * $END$ + The value of is the number of bytes to write out to the file. + The disk write begins with the current file position in . If + this variable is not used, the entire contents of is written + to the file. + To truncate a file, a call of FWRITE( nHandle, "", 0 ) is needed. + $EXAMPLES$ + nHandle := FCreate( "x.txt" ) + FOR X := 1 TO 10 + FWrite( nHandle, Str( x ) ) + NEXT + FClose( nHandle ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All(64K) + $FILES$ + Library is rtl + $SEEALSO$ + FCLOSE(), FCREATE(), FERROR(), FOPEN(), I2BIN(), L2BIN() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * FERROR() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Reports the error status of low-level file functions - * $SYNTAX$ - * FERROR() --> - * $RETURNS$ - * Value of the OS error last encountered by a - * low-level file function. - * - * FERROR() Return Values - * - * - * Error Meaning - * - * 0 Successful - * 2 File not found - * 3 Path not found - * 4 Too many files open - * 5 Access denied - * 6 Invalid handle - * 8 Insufficient memory - * 15 Invalid drive specified - * 19 Attempted to write to a write-protected disk - * 21 Drive not ready - * 23 Data CRC error - * 29 Write fault - * 30 Read fault - * 32 Sharing violation - * 33 Lock Violation - *
- * $DESCRIPTION$ - * After every low-level file function,this function will return - * a value that provides additional information on the status of - * the last low-level file functions's performance. If the FERROR() - * function returns a 0, no error was detected. Below is a table - * of possibles values returned by the FERROR() function. - * $EXAMPLES$ - * #include "fileio.ch" - * nHandle := FCreate( "temp.txt", FC_NORMAL ) - * IF FError() != 0 - * ? "Cannot create file, OS error ", FError() - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * FCLOSE(),FERASE(),FOPEN(),FWRITE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + FERROR() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Reports the error status of low-level file functions + $SYNTAX$ + FERROR() --> + $RETURNS$ + Value of the OS error last encountered by a + low-level file function. + + FERROR() Return Values + + + Error Meaning + + 0 Successful + 2 File not found + 3 Path not found + 4 Too many files open + 5 Access denied + 6 Invalid handle + 8 Insufficient memory + 15 Invalid drive specified + 19 Attempted to write to a write-protected disk + 21 Drive not ready + 23 Data CRC error + 29 Write fault + 30 Read fault + 32 Sharing violation + 33 Lock Violation +
+ $DESCRIPTION$ + After every low-level file function,this function will return + a value that provides additional information on the status of + the last low-level file functions's performance. If the FERROR() + function returns a 0, no error was detected. Below is a table + of possibles values returned by the FERROR() function. + $EXAMPLES$ + #include "fileio.ch" + nHandle := FCreate( "temp.txt", FC_NORMAL ) + IF FError() != 0 + ? "Cannot create file, OS error ", FError() + ENDIF + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + FCLOSE(),FERASE(),FOPEN(),FWRITE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * FCLOSE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Closes an open file - * $SYNTAX$ - * FCLOSE( ) --> - * $ARGUMENTS$ - * File handle - * $RETURNS$ - * Logical TRUE (.T.) or FALSE (.F.) - * $DESCRIPTION$ - * This function closes an open file with a file handle - * of and writes the associated buffers to the - * disk. The value is derived from the FCREATE() - * or FOPEN() function. - * $EXAMPLES$ - * #include "fileio.ch" - * nHandle := FOpen( "x.txt" ) - * ? FSeek( nHandle, 0, FS_END ) - * FClose( nHandle ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * FOPEN(),FCREATE(),FREAD(),FWRITE(),FERROR() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + FCLOSE() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Closes an open file + $SYNTAX$ + FCLOSE( ) --> + $ARGUMENTS$ + File handle + $RETURNS$ + Logical TRUE (.T.) or FALSE (.F.) + $DESCRIPTION$ + This function closes an open file with a file handle + of and writes the associated buffers to the + disk. The value is derived from the FCREATE() + or FOPEN() function. + $EXAMPLES$ + #include "fileio.ch" + nHandle := FOpen( "x.txt" ) + ? FSeek( nHandle, 0, FS_END ) + FClose( nHandle ) + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + FOPEN(),FCREATE(),FREAD(),FWRITE(),FERROR() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * FERASE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Erase a file from disk - * $SYNTAX$ - * FERASE( ) --> nSuccess - * $ARGUMENTS$ - * Name of file to erase. - * $RETURNS$ - * 0 if successful, -1 if not - * $DESCRIPTION$ - * This function deletes the file specified in from the disk. - * No extensions are assumed. The drive and path my be included in - * ; neither the SET DEFAULT not the SET PATH command controls - * the performance of this function. If the drive or path is not used, - * the function will look for the file only on the currently selected - * directory on the logged drive. - * - * If the function is able to successfully delete the file from the - * disk, the value of the function will be 0; otherwise a -1 will - * be returned. If not successfull, additional information may be - * obtained by calling the FERROR() function. - * - * Note: Any file to be removed by FERASE() must still be closed. - * - * $EXAMPLES$ - * #include "fileio.ch" - * IF FErase( "test.txt" ) != F_ERROR - * ? "File successfully erased" - * ELSE - * ? "File can not be deleted" - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * FERROR(),FRENAME() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + FERASE() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Erase a file from disk + $SYNTAX$ + FERASE( ) --> nSuccess + $ARGUMENTS$ + Name of file to erase. + $RETURNS$ + 0 if successful, -1 if not + $DESCRIPTION$ + This function deletes the file specified in from the disk. + No extensions are assumed. The drive and path my be included in + ; neither the SET DEFAULT not the SET PATH command controls + the performance of this function. If the drive or path is not used, + the function will look for the file only on the currently selected + directory on the logged drive. + + If the function is able to successfully delete the file from the + disk, the value of the function will be 0; otherwise a -1 will + be returned. If not successfull, additional information may be + obtained by calling the FERROR() function. + + Note: Any file to be removed by FERASE() must still be closed. + + $EXAMPLES$ + #include "fileio.ch" + IF FErase( "test.txt" ) != F_ERROR + ? "File successfully erased" + ELSE + ? "File can not be deleted" + ENDIF + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + FERROR(),FRENAME() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * FRENAME() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Renames a file - * $SYNTAX$ - * FRENAME( , ) --> nSuccess - * $ARGUMENTS$ - * Old filename to be changed +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + FRENAME() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Renames a file + $SYNTAX$ + FRENAME( , ) --> nSuccess + $ARGUMENTS$ + Old filename to be changed - * New filename - * $RETURNS$ - * If successful, a 0 will be returned otherwise, - * a -1 will be returned. - * $DESCRIPTION$ - * This function renames the specified file to . - * A filename and/or directory name may be specified for either para- - * meter. However, if a path is supplied as part of and - * this path is different from either the path specified in - * or (if none is used) the current drive and directory, the function - * will not execute successfully. + New filename + $RETURNS$ + If successful, a 0 will be returned otherwise, + a -1 will be returned. + $DESCRIPTION$ + This function renames the specified file to . + A filename and/or directory name may be specified for either para- + meter. However, if a path is supplied as part of and + this path is different from either the path specified in + or (if none is used) the current drive and directory, the function + will not execute successfully. - * Neither parameter is subject to the control of the SET PATH TO or - * SET DEFAULT TO commands. In attempting to locate the file to be - * renamed, this function will search the default drive and directory - * or the drive and path specified in . It will not search - * directories named by the SET PATH TO and SET DEFAULT TO commands - * or by the PATH environment variable. + Neither parameter is subject to the control of the SET PATH TO or + SET DEFAULT TO commands. In attempting to locate the file to be + renamed, this function will search the default drive and directory + or the drive and path specified in . It will not search + directories named by the SET PATH TO and SET DEFAULT TO commands + or by the PATH environment variable. - * If the file specified in exists or the file is open, - * the function will be unable to rename the file. If the function - * is unable to complete its operation,it will return a value of -1. - * If it is able to rename the file, the return value for the function - * will be 0. A call to FERROR() function will give additional infor- - * mation about any error found. - * $EXAMPLES$ - * #include "fileio.ch" - * nResult := FRename( "x.txt", "x1.txt" ) - * IF nResult == F_ERROR - * ? "File could not be renamed." - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ERASE,FERASE(),FERROR(),FILE(),RENAME - * $END$ + If the file specified in exists or the file is open, + the function will be unable to rename the file. If the function + is unable to complete its operation,it will return a value of -1. + If it is able to rename the file, the return value for the function + will be 0. A call to FERROR() function will give additional infor- + mation about any error found. + $EXAMPLES$ + #include "fileio.ch" + nResult := FRename( "x.txt", "x1.txt" ) + IF nResult == F_ERROR + ? "File could not be renamed." + ENDIF + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + ERASE,FERASE(),FERROR(),FILE(),RENAME + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * FSEEK() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Positions the file pointer in a file. - * $SYNTAX$ - * FSEEK( , , [] ) --> nPosition - * $ARGUMENTS$ - * File handle. +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + FSEEK() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Positions the file pointer in a file. + $SYNTAX$ + FSEEK( , , [] ) --> nPosition + $ARGUMENTS$ + File handle. - * The number of bytes to move. + The number of bytes to move. - * The relative position in the file. - * $RETURNS$ - * the current position relative to begin-of-file - * $DESCRIPTION$ - * This function sets the file pointer in the file whose file - * handle is and moves the file pointer by bytes - * from the file position designated by . The returned value - * is the relative position of the file pointer to the beginning-of-file - * marker once the operation has been completed. + The relative position in the file. + $RETURNS$ + the current position relative to begin-of-file + $DESCRIPTION$ + This function sets the file pointer in the file whose file + handle is and moves the file pointer by bytes + from the file position designated by . The returned value + is the relative position of the file pointer to the beginning-of-file + marker once the operation has been completed. - * is the file handle number. It is obtained from the FOPEN() - * or FCREATE() function. + is the file handle number. It is obtained from the FOPEN() + or FCREATE() function. - * The value of is the number of bytes to move the file pointer - * from the position determined by . The value of may - * be a negative number, suggesting backward movement. + The value of is the number of bytes to move the file pointer + from the position determined by . The value of may + be a negative number, suggesting backward movement. - * The value of designates the starting point from which the - * file pointer should he moved, as shown in the following table: + The value of designates the starting point from which the + file pointer should he moved, as shown in the following table: - * - * fileio.ch File position - * - * 0 FS_SET Beginning of file - * 1 FS_RELATIVE Current file pointer position - * 2 FS_END End of file - *
- * - * If a value is not provided for , it defaults to 0 and - * moves the file pointer from the beginning of the file. - * $EXAMPLES$ - * // here is a function that read one text line from an open file - * - * // nH = file handle obtained from FOpen() - * // cB = a string buffer passed-by-reference to hold the result - * // nMaxLine = maximum number of bytes to read - * - * FUNCTION FREADln( nH, cB, nMaxLine ) - * LOCAL cLine, nSavePos, nEol, nNumRead - * cLine := Space( nMaxLine ) - * cB := "" - * nSavePos := FSeek( nH, 0, FS_RELATIVE ) - * nNumRead := FRead( nH, @cLine, nMaxLine ) - * IF ( nEol := At( hb_eol(), SubStr( cLine, 1, nNumRead ) ) ) == 0 - * cB := cLine - * ELSE - * cB := SubStr( cLine, 1, nEol - 1 ) - * FSEEK( nH, nSavePos + nEol + 1, FS_SET ) - * ENDIF - * RETURN nNumRead != 0 - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * Header is fileio.ch - * $SEEALSO$ - * FCREATE(),FERROR(),FOPEN(),FREAD(),FREADSTR(),FWRITE() - * $END$ + + fileio.ch File position + + 0 FS_SET Beginning of file + 1 FS_RELATIVE Current file pointer position + 2 FS_END End of file +
+ + If a value is not provided for , it defaults to 0 and + moves the file pointer from the beginning of the file. + $EXAMPLES$ + // here is a function that read one text line from an open file + + // nH = file handle obtained from FOpen() + // cB = a string buffer passed-by-reference to hold the result + // nMaxLine = maximum number of bytes to read + + FUNCTION FREADln( nH, cB, nMaxLine ) + LOCAL cLine, nSavePos, nEol, nNumRead + cLine := Space( nMaxLine ) + cB := "" + nSavePos := FSeek( nH, 0, FS_RELATIVE ) + nNumRead := FRead( nH, @cLine, nMaxLine ) + IF ( nEol := At( hb_eol(), SubStr( cLine, 1, nNumRead ) ) ) == 0 + cB := cLine + ELSE + cB := SubStr( cLine, 1, nEol - 1 ) + FSEEK( nH, nSavePos + nEol + 1, FS_SET ) + ENDIF + RETURN nNumRead != 0 + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + Header is fileio.ch + $SEEALSO$ + FCREATE(),FERROR(),FOPEN(),FREAD(),FREADSTR(),FWRITE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * FILE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Tests for the existence of file(s) - * $SYNTAX$ - * FILE( ) --> lExists - * $ARGUMENTS$ - * Filename skeleton or file name to find. - * $RETURNS$ - * a logical true (.T.) if the file exists or logical - * false (.F.). - * $DESCRIPTION$ - * This function return a logical true (.T.) if the given filename - * exist. - * - * Filename skeletons symbols may be used in the filename in , - * as may the drive and/or path name. If a path is not explicitly - * specified, File() will look for the file in the SET DEFAULT path, - * then in each SET PATH path, until the file is found or there are - * no more paths to search. The PATH environment variable is never - * searched and the current drive/directory is only searched if - * SET DEFAULT is blank. - * $EXAMPLES$ - * ? File( "C:\harbour\doc\compiler.txt" ) - * ? File( "C:/harbour/doc/subcodes.txt" ) - * $STATUS$ - * S (wild card support is missing) - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * SET DEFAULT,SET PATH,SET() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + FILE() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Tests for the existence of file(s) + $SYNTAX$ + FILE( ) --> lExists + $ARGUMENTS$ + Filename skeleton or file name to find. + $RETURNS$ + a logical true (.T.) if the file exists or logical + false (.F.). + $DESCRIPTION$ + This function return a logical true (.T.) if the given filename + exist. + + Filename skeletons symbols may be used in the filename in , + as may the drive and/or path name. If a path is not explicitly + specified, File() will look for the file in the SET DEFAULT path, + then in each SET PATH path, until the file is found or there are + no more paths to search. The PATH environment variable is never + searched and the current drive/directory is only searched if + SET DEFAULT is blank. + $EXAMPLES$ + ? File( "C:\harbour\doc\compiler.txt" ) + ? File( "C:/harbour/doc/subcodes.txt" ) + $STATUS$ + S (wild card support is missing) + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + SET DEFAULT,SET PATH,SET() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * FREADSTR() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Reads a string from a file. - * $SYNTAX$ - * FREADSTR(, ) --> cString - * $ARGUMENTS$ - * File handle number. - * - * Number of bytes to read. - * $RETURNS$ - * an character expression - * $DESCRIPTION$ - * This function returns a character string of bytes from a - * file whose file handle is . +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + FREADSTR() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Reads a string from a file. + $SYNTAX$ + FREADSTR(, ) --> cString + $ARGUMENTS$ + File handle number. - * The value of the file handle is obtained from either the - * FOPEN() or FCREATE() functions. + Number of bytes to read. + $RETURNS$ + an character expression + $DESCRIPTION$ + This function returns a character string of bytes from a + file whose file handle is . - * The value of is the number of bytes to read from the file. - * The returned string will be the number of characters specified in - * or the number of bytes read before an end-of-file charac- - * ter (ASCII 26) is found. + The value of the file handle is obtained from either the + FOPEN() or FCREATE() functions. - * NOTE This function is similar to the FREAD() function, except that - * it will not read binary characters that may he required as part of - * a header of a file construct. Characters Such as CHR( 0 ) and CHR( 26 ) - * may keep this function from performing its intended operation. In this - * event, the FREAD() function should he used in place of the FREADSTR() - * function. - * $EXAMPLES$ - * #include "fileio.ch" - * IF ( nH := FOpen( "x.txt" ) ) != F_ERROR - * cStr := FReadStr( nH, 100 ) - * ? cStr - * FClose( nH ) - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All(64K) - * $FILES$ - * Library is rtl - * $SEEALSO$ - * BIN2I(),BIN2L(),BIN2W(),FERROR(),FREAD(),FSEEK() - * $END$ + The value of is the number of bytes to read from the file. + The returned string will be the number of characters specified in + or the number of bytes read before an end-of-file charac- + ter (ASCII 26) is found. + + NOTE This function is similar to the FREAD() function, except that + it will not read binary characters that may he required as part of + a header of a file construct. Characters Such as CHR( 0 ) and CHR( 26 ) + may keep this function from performing its intended operation. In this + event, the FREAD() function should he used in place of the FREADSTR() + function. + $EXAMPLES$ + #include "fileio.ch" + IF ( nH := FOpen( "x.txt" ) ) != F_ERROR + cStr := FReadStr( nH, 100 ) + ? cStr + FClose( nH ) + ENDIF + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All(64K) + $FILES$ + Library is rtl + $SEEALSO$ + BIN2I(),BIN2L(),BIN2W(),FERROR(),FREAD(),FSEEK() + $END$ */ -/* HARBOUR COMMANDS */ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + RENAME + $CATEGORY$ + Command + $SUBCATEGORY$ + FileSys + $ONELINER$ + Changes the name of a specified file + $SYNTAX$ + RENAME TO + $ARGUMENTS$ + Old filename -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * RENAME - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Changes the name of a specified file - * $SYNTAX$ - * RENAME TO - * $ARGUMENTS$ - * Old filename + New Filename + $DESCRIPTION$ + This command changes the name of to . Both + and must include a file extension. This command + if not affected by the SET PATH TO or SET DEFAULT TO commands;drive + and directory designates must be specified if either file is in a + directory other then the default drive and directory. - * New Filename - * $DESCRIPTION$ - * This command changes the name of to . Both - * and must include a file extension. This command - * if not affected by the SET PATH TO or SET DEFAULT TO commands;drive - * and directory designates must be specified if either file is in a - * directory other then the default drive and directory. - * - * If id currently open or if it previously exists, this - * command will not perform the desired operation. - * $EXAMPLES$ - * RENAME hello.txt TO hello.old - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * CURDIR(),ERASE,FILE(),FERASE(),FRENAME() - * $END$ + If id currently open or if it previously exists, this + command will not perform the desired operation. + $EXAMPLES$ + RENAME hello.txt TO hello.old + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + CURDIR(),ERASE,FILE(),FERASE(),FRENAME() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * ERASE - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Remove a file from disk - * $SYNTAX$ - * ERASE - * $ARGUMENTS$ - * Name of file to remove - * $DESCRIPTION$ - * This command removes a file from the disk. The use of a drive,directo- - * ry, and wild-card skeleton operator is allowed for the root of the - * filename. The file extension is required. The SET DEFAULT and SET PATH - * commands do not affect this command. +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + ERASE + $CATEGORY$ + Command + $SUBCATEGORY$ + FileSys + $ONELINER$ + Remove a file from disk + $SYNTAX$ + ERASE + $ARGUMENTS$ + Name of file to remove + $DESCRIPTION$ + This command removes a file from the disk. The use of a drive,directo- + ry, and wild-card skeleton operator is allowed for the root of the + filename. The file extension is required. The SET DEFAULT and SET PATH + commands do not affect this command. - * The file must be considered closed by the operating system before it - * may be deleted. - * $EXAMPLES$ - * ERASE C:\temp\read.txt - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * CURDIR(), FILE(), FERASE(), DELETE FILE - * $END$ + The file must be considered closed by the operating system before it + may be deleted. + $EXAMPLES$ + ERASE C:\temp\read.txt + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + CURDIR(), FILE(), FERASE(), DELETE FILE + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * DELETE FILE - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Remove a file from disk - * $SYNTAX$ - * DELETE FILE - * $ARGUMENTS$ - * Name of file to remove - * $DESCRIPTION$ - * This command removes a file from the disk. The use of a drive,directo- - * ry,and wild-card skeleton operator is allowed for the root of the - * filename. The file extension is required. The SET DEFAULT and SET PATH - * commands do not affect this command. +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + DELETE FILE + $CATEGORY$ + Command + $SUBCATEGORY$ + FileSys + $ONELINER$ + Remove a file from disk + $SYNTAX$ + DELETE FILE + $ARGUMENTS$ + Name of file to remove + $DESCRIPTION$ + This command removes a file from the disk. The use of a drive,directo- + ry,and wild-card skeleton operator is allowed for the root of the + filename. The file extension is required. The SET DEFAULT and SET PATH + commands do not affect this command. - * The file must be considered closed by the operating system before it - * may be deleted. - * $EXAMPLES$ - * DELETE FILE C:\temp\read.txt - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * CURDIR(), FILE(), FERASE(), ERASE - * $END$ + The file must be considered closed by the operating system before it + may be deleted. + $EXAMPLES$ + DELETE FILE C:\temp\read.txt + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + CURDIR(), FILE(), FERASE(), ERASE + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __TYPEFILE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * Show the content of a file on the console and/or printer - * $SYNTAX$ - * __TYPEFILE( , [] ) --> NIL - * $ARGUMENTS$ - * is a name of the file to display. If the file have an - * extension, it must be specified (there is no default value). - * - * is an optional logical value that specifies whether the - * output should go only to the screen (.F.) or to both the screen and - * printer (.T.), the default is (.F.). - * $RETURNS$ - * __TYPEFILE() always return NIL. - * $DESCRIPTION$ - * __TYPEFILE() function type the content of a text file on the screen - * with an option to send this information also to the printer. The - * file is displayed as is without any headings or formatting. - * - * If contain no path, __TYPEFILE() try to find the file first - * in the SET DEFAULT directory and then in search all of the SET PATH - * directories. If can not be found a run-time error occur. - * - * Use SET CONSOLE OFF to suppress screen output. - * You can pause the output using Ctrl-S, press any key to resume. - * - * __TYPEFILE() function is used in the preprocessing of the TYPE - * command. - * $EXAMPLES$ - * The following examples assume a file name mytext.dat exist in all - * specified paths, a run-time error would displayed if it does not - * - * // display mytext.dat file on screen - * __TYPEFILE( "mytext.dat" ) - * - * // display mytext.dat file on screen and printer - * __TYPEFILE( "mytext.dat", .T. ) - * - * // display mytext.dat file on printer only - * SET CONSOLE OFF - * __TYPEFILE( "mytext.dat", .T. ) - * SET CONSOLE ON - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * COPY FILE,SET DEFAULT,SET PATH,SET PRINTER,TYPE - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __TYPEFILE() + $CATEGORY$ + API + $SUBCATEGORY$ + Terminal + $ONELINER$ + Show the content of a file on the console and/or printer + $SYNTAX$ + __TYPEFILE( , [] ) --> NIL + $ARGUMENTS$ + is a name of the file to display. If the file have an + extension, it must be specified (there is no default value). + + is an optional logical value that specifies whether the + output should go only to the screen (.F.) or to both the screen and + printer (.T.), the default is (.F.). + $RETURNS$ + __TYPEFILE() always return NIL. + $DESCRIPTION$ + __TYPEFILE() function type the content of a text file on the screen + with an option to send this information also to the printer. The + file is displayed as is without any headings or formatting. + + If contain no path, __TYPEFILE() try to find the file first + in the SET DEFAULT directory and then in search all of the SET PATH + directories. If can not be found a run-time error occur. + + Use SET CONSOLE OFF to suppress screen output. + You can pause the output using Ctrl-S, press any key to resume. + + __TYPEFILE() function is used in the preprocessing of the TYPE + command. + $EXAMPLES$ + The following examples assume a file name mytext.dat exist in all + specified paths, a run-time error would displayed if it does not + + // display mytext.dat file on screen + __TYPEFILE( "mytext.dat" ) + + // display mytext.dat file on screen and printer + __TYPEFILE( "mytext.dat", .T. ) + + // display mytext.dat file on printer only + SET CONSOLE OFF + __TYPEFILE( "mytext.dat", .T. ) + SET CONSOLE ON + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + COPY FILE,SET DEFAULT,SET PATH,SET PRINTER,TYPE + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * TYPE - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Show the content of a file on the console, printer or file - * $SYNTAX$ - * TYPE [TO PRINTER] [TO FILE ] - * $ARGUMENTS$ - * is a name of the file to display. If the file have an - * extension, it must be specified (there is no default value). - * It can be specified as literal file name or as a character - * expression enclosed in parentheses. - * - * TO PRINTER is an optional keyword that specifies that the output - * should go to both the screen and printer. - * - * TO FILE copy the source also to a file. If no - * extension is given (.txt) is added to the output file name. - * can be specified as literal file name or as a character - * expression enclosed in parentheses. - * $DESCRIPTION$ - * TYPE command type the content of a text file on the screen - * with an option to send this information also to the printer or to - * an alternate file. The file is displayed as is without any headings - * or formatting. - * - * If contain no path, TYPE try to find the file first in the - * SET DEFAULT directory and then in search all of the SET PATH - * directories. If can not be found a run-time error occur. - * - * If contain no path it is created in the SET DEFAULT - * directory. - * - * Use SET CONSOLE OFF to suppress screen output. - * You can pause the output using Ctrl-S, press any key to resume. - * $EXAMPLES$ - * The following examples assume a file name mytext.dat exist in all - * specified paths, a run-time error would displayed if it does not - * - * // display mytext.dat file on screen - * TYPE mytext.dat - * - * // display mytext.dat file on screen and printer - * TYPE mytext.dat TO PRINTER - * - * // display mytext.dat file on printer only - * SET CONSOLE OFF - * TYPE mytext.dat TO PRINTER - * SET CONSOLE ON - * - * // display mytext.dat file on screen and into a file myreport.txt - * TYPE mytext.dat TO FILE MyReport - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * COPY FILE,SET DEFAULT,SET PATH,SET PRINTER,__TYPEFILE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + TYPE + $CATEGORY$ + Command + $SUBCATEGORY$ + FileSys + $ONELINER$ + Show the content of a file on the console, printer or file + $SYNTAX$ + TYPE [TO PRINTER] [TO FILE ] + $ARGUMENTS$ + is a name of the file to display. If the file have an + extension, it must be specified (there is no default value). + It can be specified as literal file name or as a character + expression enclosed in parentheses. + + TO PRINTER is an optional keyword that specifies that the output + should go to both the screen and printer. + + TO FILE copy the source also to a file. If no + extension is given (.txt) is added to the output file name. + can be specified as literal file name or as a character + expression enclosed in parentheses. + $DESCRIPTION$ + TYPE command type the content of a text file on the screen + with an option to send this information also to the printer or to + an alternate file. The file is displayed as is without any headings + or formatting. + + If contain no path, TYPE try to find the file first in the + SET DEFAULT directory and then in search all of the SET PATH + directories. If can not be found a run-time error occur. + + If contain no path it is created in the SET DEFAULT + directory. + + Use SET CONSOLE OFF to suppress screen output. + You can pause the output using Ctrl-S, press any key to resume. + $EXAMPLES$ + The following examples assume a file name mytext.dat exist in all + specified paths, a run-time error would displayed if it does not + + // display mytext.dat file on screen + TYPE mytext.dat + + // display mytext.dat file on screen and printer + TYPE mytext.dat TO PRINTER + + // display mytext.dat file on printer only + SET CONSOLE OFF + TYPE mytext.dat TO PRINTER + SET CONSOLE ON + + // display mytext.dat file on screen and into a file myreport.txt + TYPE mytext.dat TO FILE MyReport + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + COPY FILE,SET DEFAULT,SET PATH,SET PRINTER,__TYPEFILE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * CURDIR() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Returns the current OS directory name. - * $SYNTAX$ - * CURDIR( [] ) --> cPath - * $ARGUMENTS$ - * OS drive letter - * $RETURNS$ - * Name of directory - * $DESCRIPTION$ - * This function yields the name of the current OS directory on a - * specified drive. If is not specified, the currently logged - * drive will be used. +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + CURDIR() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Returns the current OS directory name. + $SYNTAX$ + CURDIR( [] ) --> cPath + $ARGUMENTS$ + OS drive letter + $RETURNS$ + Name of directory + $DESCRIPTION$ + This function yields the name of the current OS directory on a + specified drive. If is not specified, the currently logged + drive will be used. - * This function should not return the leading and trailing - * (back)slashes. + This function should not return the leading and trailing + (back)slashes. - * If an error has been detected by the function, or the current OS - * directory is the root, the value of the function will be a NULL - * byte. - * $EXAMPLES$ - * ? Curdir() - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * FILE() - * $END$ + If an error has been detected by the function, or the current OS + directory is the root, the value of the function will be a NULL + byte. + $EXAMPLES$ + ? Curdir() + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + FILE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * COPY FILE - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Copies a file. - * $SYNTAX$ - * COPY FILE TO - * $ARGUMENTS$ - * Filename of source file - * Filename of target file - * $DESCRIPTION$ - * This command makes an exact copy of and names it . - * Both files must have the file extension included; the drive and the - * directory names must also be specified if they are different from - * the default drive and/or director. also can refer to a OS - * device (e.g. LPT1). This command does not observe the SET PATH TO or - * SET DEFAULT TO settings. - * $EXAMPLES$ - * COPY FILE C:\harbour\tests\adirtest.prg TO C:\temp\adirtest.prg - * COPY FILE C:\harbour\tests\adirtest.prg TO LPT1 - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * ERASE,RENAME,FRENAME(),FERASE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + COPY FILE + $CATEGORY$ + Command + $SUBCATEGORY$ + FileSys + $ONELINER$ + Copies a file. + $SYNTAX$ + COPY FILE TO + $ARGUMENTS$ + Filename of source file + Filename of target file + $DESCRIPTION$ + This command makes an exact copy of and names it . + Both files must have the file extension included; the drive and the + directory names must also be specified if they are different from + the default drive and/or director. also can refer to a OS + device (e.g. LPT1). This command does not observe the SET PATH TO or + SET DEFAULT TO settings. + $EXAMPLES$ + COPY FILE C:\harbour\tests\adirtest.prg TO C:\temp\adirtest.prg + COPY FILE C:\harbour\tests\adirtest.prg TO LPT1 + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + ERASE,RENAME,FRENAME(),FERASE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_FEOF() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Check for end-of-file. - * $SYNTAX$ - * HB_FEOF( ) --> lIsEof - * $ARGUMENTS$ - * The handle of an open file. - * $RETURNS$ - * .T. if the file handle is at end-of-file, otherwise .F. - * $DESCRIPTION$ - * This function checks an open file handle to see if it is at EOF. +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_FEOF() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Check for end-of-file. + $SYNTAX$ + HB_FEOF( ) --> lIsEof + $ARGUMENTS$ + The handle of an open file. + $RETURNS$ + .T. if the file handle is at end-of-file, otherwise .F. + $DESCRIPTION$ + This function checks an open file handle to see if it is at EOF. - * If the file handle is missing, not numeric, or not open, then this - * function returns .T. and sets the value returned by FERROR() to -1 - * (FS_ERROR) or a C-compiler dependent errno value (EBADF or EINVAL). - * $EXAMPLES$ - * nH := FOpen( "file.txt" ) - * ? FReadStr( nH, 80 ) - * IF hb_FEof( nH ) - * ? "End-of-file reached." - * ELSE - * ? FReadStr( nH, 80 ) - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is rtl - * $SEEALSO$ - * FERROR() - * $END$ + If the file handle is missing, not numeric, or not open, then this + function returns .T. and sets the value returned by FERROR() to -1 + (FS_ERROR) or a C-compiler dependent errno value (EBADF or EINVAL). + $EXAMPLES$ + nH := FOpen( "file.txt" ) + ? FReadStr( nH, 80 ) + IF hb_FEof( nH ) + ? "End-of-file reached." + ELSE + ? FReadStr( nH, 80 ) + ENDIF + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is rtl + $SEEALSO$ + FERROR() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DIRREMOVE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Attempt to remove an directory - * $SYNTAX$ - * DIRREMOVE( ) --> nError - * $ARGUMENTS$ - * The name of the directory you want to remove. - * $RETURNS$ - * 0 if directory was successfully removed, otherwise - * the number of the last error. - * $DESCRIPTION$ - * This function attempt to remove the specified directory in - * If this function fails, it will return the last OS error code number. - * See FERROR() function for the description of the error. - * $EXAMPLES$ - * cDir := ".\backup" - * IF DirRemove( cDir ) == 0 - * ? "Remove of directory", cDir, "was successfull" - * ENDIF - * $TESTS$ - * See examples - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is CA-Cl*pper 5.3 compliant - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * MAKEDIR(), DIRCHANGE(), ISDISK(), DISKCHANGE(), DISKNAME(), FERROR() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DIRREMOVE() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Attempt to remove an directory + $SYNTAX$ + DIRREMOVE( ) --> nError + $ARGUMENTS$ + The name of the directory you want to remove. + $RETURNS$ + 0 if directory was successfully removed, otherwise + the number of the last error. + $DESCRIPTION$ + This function attempt to remove the specified directory in + If this function fails, it will return the last OS error code number. + See FERROR() function for the description of the error. + $EXAMPLES$ + cDir := ".\backup" + IF DirRemove( cDir ) == 0 + ? "Remove of directory", cDir, "was successfull" + ENDIF + $TESTS$ + See examples + $STATUS$ + R + $COMPLIANCE$ + This function is CA-Cl*pper 5.3 compliant + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + MAKEDIR(), DIRCHANGE(), ISDISK(), DISKCHANGE(), DISKNAME(), FERROR() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DIRCHANGE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Changes the directory - * $SYNTAX$ - * DIRCHANGE( ) --> nError - * $ARGUMENTS$ - * The name of the directory you want do change into. - * $RETURNS$ - * 0 if directory was successfully changed, otherwise - * the number of the last error. - * $DESCRIPTION$ - * This function attempt to change the current directory to the one - * specified in . If this function fails, it will return - * the last OS error code number. See FERROR() function for the - * description of the error. - * $EXAMPLES$ - * IF DirChange( "\temp" ) == 0 - * ? "Change to diretory was successfull" - * ENDIF - * $TESTS$ - * See examples - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is CA-Cl*pper 5.3 compliant - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * MAKEDIR(), DIRREMOVE(), ISDISK(), DISKCHANGE(), DISKNAME(), FERROR() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DIRCHANGE() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Changes the directory + $SYNTAX$ + DIRCHANGE( ) --> nError + $ARGUMENTS$ + The name of the directory you want do change into. + $RETURNS$ + 0 if directory was successfully changed, otherwise + the number of the last error. + $DESCRIPTION$ + This function attempt to change the current directory to the one + specified in . If this function fails, it will return + the last OS error code number. See FERROR() function for the + description of the error. + $EXAMPLES$ + IF DirChange( "\temp" ) == 0 + ? "Change to diretory was successfull" + ENDIF + $TESTS$ + See examples + $STATUS$ + R + $COMPLIANCE$ + This function is CA-Cl*pper 5.3 compliant + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + MAKEDIR(), DIRREMOVE(), ISDISK(), DISKCHANGE(), DISKNAME(), FERROR() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * MAKEDIR() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Create a new directory - * $SYNTAX$ - * MAKEDIR( ) --> nError - * $ARGUMENTS$ - * The name of the directory you want to create. - * $RETURNS$ - * 0 if directory was successfully created, otherwise - * the number of the last error. - * $DESCRIPTION$ - * This function attempt to create a new directory with the name contained - * in . If this function fails, it will return the last OS - * error code number. See FERROR() function for the description of the - * error - * $EXAMPLES$ - * cDir := "temp" - * IF MakeDir( cDir ) == 0 - * ? "Directory", cDir, "successfully created" - * ENDIF - * $TESTS$ - * See examples - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is CA-Cl*pper 5.3 compliant - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * DIRCHANGE(), DIRREMOVE(), ISDISK(), DISKCHANGE(), DISKNAME(), FERROR() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + MAKEDIR() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Create a new directory + $SYNTAX$ + MAKEDIR( ) --> nError + $ARGUMENTS$ + The name of the directory you want to create. + $RETURNS$ + 0 if directory was successfully created, otherwise + the number of the last error. + $DESCRIPTION$ + This function attempt to create a new directory with the name contained + in . If this function fails, it will return the last OS + error code number. See FERROR() function for the description of the + error + $EXAMPLES$ + cDir := "temp" + IF MakeDir( cDir ) == 0 + ? "Directory", cDir, "successfully created" + ENDIF + $TESTS$ + See examples + $STATUS$ + R + $COMPLIANCE$ + This function is CA-Cl*pper 5.3 compliant + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + DIRCHANGE(), DIRREMOVE(), ISDISK(), DISKCHANGE(), DISKNAME(), FERROR() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ISDISK() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Verify if a drive is ready - * $SYNTAX$ - * ISDISK( ) --> lSuccess - * $ARGUMENTS$ - * An valid Drive letter - * $RETURNS$ - * .T. is the drive is ready, otherwise .F. - * $DESCRIPTION$ - * This function attempts to access a drive. If the access to the drive - * was successfull, it will return true (.T.), otherwise false(.F.). This - * function is usefull for backup function, so you can determine if the - * drive that will receive the backup data is ready or not. - * $EXAMPLES$ - * IF IsDisk( "A" ) - * ? "Drive is ready " - * ENDIF - * $TESTS$ - * See Examples - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is CA-Cl*pper 5.3 compliant - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * DIRCHANGE(), MAKEDIR(), DIRREMOVE(), DISKCHANGE(), DISKNAME() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ISDISK() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Verify if a drive is ready + $SYNTAX$ + ISDISK( ) --> lSuccess + $ARGUMENTS$ + An valid Drive letter + $RETURNS$ + .T. is the drive is ready, otherwise .F. + $DESCRIPTION$ + This function attempts to access a drive. If the access to the drive + was successfull, it will return true (.T.), otherwise false(.F.). This + function is usefull for backup function, so you can determine if the + drive that will receive the backup data is ready or not. + $EXAMPLES$ + IF IsDisk( "A" ) + ? "Drive is ready " + ENDIF + $TESTS$ + See Examples + $STATUS$ + R + $COMPLIANCE$ + This function is CA-Cl*pper 5.3 compliant + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + DIRCHANGE(), MAKEDIR(), DIRREMOVE(), DISKCHANGE(), DISKNAME() + $END$ */ diff --git a/harbour/doc/en/garbage.txt b/harbour/doc/en/garbage.txt index 3c0c6507ff..65b011e8bb 100644 --- a/harbour/doc/en/garbage.txt +++ b/harbour/doc/en/garbage.txt @@ -1,283 +1,283 @@ /* * $Id$ -*/ - -/* $DOC$ - * $TEMPLATE$ - * Document - * $NAME$ - * The Garbage Collector - * $CATEGORY$ - * Document - * $ONELINER$ - * Readme for Harbour Garbage Collect Feature - * $DESCRIPTION$ - * The garbage collector uses the following logic: - * - first collect all memory allocations that can cause garbage; - * - next scan all variables if these memory blocks are still referenced. - * - * Notice that only arrays, objects and codeblocks are collected because - * these are the only datatypes that can cause self-references (a[1]:=a) - * or circular references (a[1]:=b; b[1]:=c; c[1]:=a) that cannot be - * properly deallocated by simple reference counting. - * - * Since all variables in harbour are stored inside some available tables - * (the eval stack, memvars table and array of static variables) then checking - * if the reference is still alive is quite easy and doesn't require any - * special treatment during memory allocation. Additionaly the garbage - * collector is scanning some internal data used by harbour objects - * implementation that also stores some values that can contain memory - * references. These data are used to initialize class instance variables - * and are stored in class shared variables. - * - * In special cases when the value of a harbour variable is stored internally - * in some static area (at C or assembler level), the garbage collector will - * be not able to scan such values since it doesn't know their location. This - * could cause some memory blocks to be released prematurely. To prevent the - * premature deallocation of such memory blocks the static data have to store - * a pointer to the value created with hb_itemNew() function. - * Example: - * static HB_ITEM s_item; // this item can be released by the GC - * - * static PHB_ITEM pItem; // this item will be maintained correctly - * pItem = hb_itemNew( hb_param(1, IT_BLOCK) ); - * - * However, scanning of all variables can be a time consuming operation. It - * requires that all allocated arrays have to be traversed through all their - * elements to find more arrays. Also all codeblocks are scanned for detached - * local variables they are referencing. For this reason, looking for unreferenced - * memory blocks is performed during the idle states. - * - * The idle state is a state when there is no real application code - * executed. For example, the user code is stopped for 0.1 of a second - * during INKEY(0.1) - Harbour is checking the keyboard only - * during this time. It leaves however quite enough time for - * many other background tasks. One such background task can be looking - * for unreferenced memory blocks. - * - * Allocating memory - * ----------------- - * - * The garbage collector collects memory blocks allocated with hb_gcAlloc() - * function calls. Memory allocated by hb_gcAlloc() should be released with - * hb_gcFree() function. - * - * The garbage collecting - * ---------------------- - * - * During scanning of unreferenced memory the GC is using a mark & sweep - * algorithm. This is done in three steps: - * - * 1) mark all memory blocks allocated by the GC with unused flag; - * - * 2) sweep (scan) all known places and clear unused flag for memory - * blocks that are referenced there; - * - * 3) finalize collecting by deallocation of all memory blocks that are - * still marked as unused and that are not locked. - * - * To speed things up, the mark step is simplified by swapping the meaning - * of the unused flag. After deallocation of unused blocks all still alive - * memory blocks are marked with the same 'used' flag so we can reverse - * the meaning of this flag to 'unused' state in the next collecting. - * All new or unlocked memory blocks are automatically marked as 'unused' - * using the current flag, which assures that all memory blocks are marked - * with the same flag before the sweep step will start. - * See hb_gcCollectAll() and hb_gcItemRef() - * - * Calling the garbage collector from harbour code - * ----------------------------------------------- - * - * The garbage collector can be called directly from the harbour code. - * This is usefull in situations where there is no idle states available - * or the application is working in the loop with no user interaction - * and there is many memory allocations. - * See HB_GCALL() for explanation of how to call this function from your - * harbour code. - * $SEEALSO$ - * hb_gcAlloc(),hb_gcFree(),hb_gcCollectAll(),hb_gcItemRef(),HB_GCALL(),HB_IDLESTATE() - * $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gcAlloc() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Garbage Collector - * $ONELINER$ - * Allocates memory that will be collected by the garbage collector. - * $SYNTAX$ - * #include "hbapi.h" - * void * hb_gcAlloc( HB_SIZE nSize, - * HB_GARBAGE_FUNC_PTR pCleanupFunc ); - * $ARGUMENTS$ - * Requested size of memory block - * - * Pointer to HB_GARBAGE_FUNC function that will be called - * directly before releasing the garbage memory block or NULL. This - * function should release all other memory allocated and stored inside - * the memory block. For example, it releases all items stored inside - * the array. The functions receives a single parameter: the pointer - * to memory allocated by hb_gcAlloc(). - * $RETURNS$ - * The pointer to allocated memory or it generates an internal - * unrecoverable error. - * $DESCRIPTION$ - * hb_gcAlloc() is used to allocate the memory that will be tracked - * by the garbage collector. It allows to properly release memory - * in case of self-referencing or cross-referencing harbour level - * variables. - * Memory allocated with this function should be released with - * hb_gcFree() function or it will be automatically deallocated - * by the GC if it is not locked or if it is not referenced by some - * harbour level variable. - * $STATUS$ - * C - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gcFree() - * $END$ +/* $DOC$ + $TEMPLATE$ + Document + $NAME$ + The Garbage Collector + $CATEGORY$ + Document + $ONELINER$ + Readme for Harbour Garbage Collect Feature + $DESCRIPTION$ + The garbage collector uses the following logic: + - first collect all memory allocations that can cause garbage; + - next scan all variables if these memory blocks are still referenced. + + Notice that only arrays, objects and codeblocks are collected because + these are the only datatypes that can cause self-references (a[1]:=a) + or circular references (a[1]:=b; b[1]:=c; c[1]:=a) that cannot be + properly deallocated by simple reference counting. + + Since all variables in harbour are stored inside some available tables + (the eval stack, memvars table and array of static variables) then checking + if the reference is still alive is quite easy and doesn't require any + special treatment during memory allocation. Additionaly the garbage + collector is scanning some internal data used by harbour objects + implementation that also stores some values that can contain memory + references. These data are used to initialize class instance variables + and are stored in class shared variables. + + In special cases when the value of a harbour variable is stored internally + in some static area (at C or assembler level), the garbage collector will + be not able to scan such values since it doesn't know their location. This + could cause some memory blocks to be released prematurely. To prevent the + premature deallocation of such memory blocks the static data have to store + a pointer to the value created with hb_itemNew() function. + Example: + static HB_ITEM s_item; // this item can be released by the GC + + static PHB_ITEM pItem; // this item will be maintained correctly + pItem = hb_itemNew( hb_param(1, IT_BLOCK) ); + + However, scanning of all variables can be a time consuming operation. It + requires that all allocated arrays have to be traversed through all their + elements to find more arrays. Also all codeblocks are scanned for detached + local variables they are referencing. For this reason, looking for unreferenced + memory blocks is performed during the idle states. + + The idle state is a state when there is no real application code + executed. For example, the user code is stopped for 0.1 of a second + during INKEY(0.1) - Harbour is checking the keyboard only + during this time. It leaves however quite enough time for + many other background tasks. One such background task can be looking + for unreferenced memory blocks. + + Allocating memory + ----------------- + + The garbage collector collects memory blocks allocated with hb_gcAlloc() + function calls. Memory allocated by hb_gcAlloc() should be released with + hb_gcFree() function. + + The garbage collecting + ---------------------- + + During scanning of unreferenced memory the GC is using a mark & sweep + algorithm. This is done in three steps: + + 1) mark all memory blocks allocated by the GC with unused flag; + + 2) sweep (scan) all known places and clear unused flag for memory + blocks that are referenced there; + + 3) finalize collecting by deallocation of all memory blocks that are + still marked as unused and that are not locked. + + To speed things up, the mark step is simplified by swapping the meaning + of the unused flag. After deallocation of unused blocks all still alive + memory blocks are marked with the same 'used' flag so we can reverse + the meaning of this flag to 'unused' state in the next collecting. + All new or unlocked memory blocks are automatically marked as 'unused' + using the current flag, which assures that all memory blocks are marked + with the same flag before the sweep step will start. + See hb_gcCollectAll() and hb_gcItemRef() + + Calling the garbage collector from harbour code + ----------------------------------------------- + + The garbage collector can be called directly from the harbour code. + This is usefull in situations where there is no idle states available + or the application is working in the loop with no user interaction + and there is many memory allocations. + See HB_GCALL() for explanation of how to call this function from your + harbour code. + $SEEALSO$ + hb_gcAlloc(),hb_gcFree(),hb_gcCollectAll(),hb_gcItemRef(),HB_GCALL(),HB_IDLESTATE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gcFree() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Garbage Collector - * $ONELINER$ - * Releases the memory that was allocated with hb_gcAlloc(). - * $SYNTAX$ - * void hb_gcFree( void *pMemoryPtr ); - * $ARGUMENTS$ - * The pointer to memory for release. This memory - * pointer have to be allocated with hb_gcAlloc() function. - * $RETURNS$ - * Nothing. - * $DESCRIPTION$ - * hb_gcFree() is used to deallocate the memory that was - * allocated with the hb_gcAlloc() function. - * $STATUS$ - * C - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gcAlloc() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gcAlloc() + $CATEGORY$ + API + $SUBCATEGORY$ + Garbage Collector + $ONELINER$ + Allocates memory that will be collected by the garbage collector. + $SYNTAX$ + #include "hbapi.h" + void * hb_gcAlloc( HB_SIZE nSize, + HB_GARBAGE_FUNC_PTR pCleanupFunc ); + $ARGUMENTS$ + Requested size of memory block + + Pointer to HB_GARBAGE_FUNC function that will be called + directly before releasing the garbage memory block or NULL. This + function should release all other memory allocated and stored inside + the memory block. For example, it releases all items stored inside + the array. The functions receives a single parameter: the pointer + to memory allocated by hb_gcAlloc(). + $RETURNS$ + The pointer to allocated memory or it generates an internal + unrecoverable error. + $DESCRIPTION$ + hb_gcAlloc() is used to allocate the memory that will be tracked + by the garbage collector. It allows to properly release memory + in case of self-referencing or cross-referencing harbour level + variables. + Memory allocated with this function should be released with + hb_gcFree() function or it will be automatically deallocated + by the GC if it is not locked or if it is not referenced by some + harbour level variable. + $STATUS$ + C + $COMPLIANCE$ + H + $PLATFORMS$ + All + $SEEALSO$ + hb_gcFree() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gcCollectAll() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Garbage Collector - * $ONELINER$ - * Scans all memory blocks and releases the garbage memory. - * $SYNTAX$ - * void hb_gcCollectAll( void ); - * $ARGUMENTS$ - * None. - * $RETURNS$ - * Nothing. - * $DESCRIPTION$ - * This function scans the eval stack, the memvars table, the array - * of static variables and table of created classes for referenced - * memory blocks. After scanning all unused memory blocks and blocks - * that are not locked are released. - * $STATUS$ - * C - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gcAlloc(),hb_gcFree() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gcFree() + $CATEGORY$ + API + $SUBCATEGORY$ + Garbage Collector + $ONELINER$ + Releases the memory that was allocated with hb_gcAlloc(). + $SYNTAX$ + void hb_gcFree( void *pMemoryPtr ); + $ARGUMENTS$ + The pointer to memory for release. This memory + pointer have to be allocated with hb_gcAlloc() function. + $RETURNS$ + Nothing. + $DESCRIPTION$ + hb_gcFree() is used to deallocate the memory that was + allocated with the hb_gcAlloc() function. + $STATUS$ + C + $COMPLIANCE$ + H + $PLATFORMS$ + All + $SEEALSO$ + hb_gcAlloc() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gcItemRef() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Garbage Collector - * $ONELINER$ - * Marks the memory to prevent deallocation by the garbage collector. - * $SYNTAX$ - * void hb_gcItemRef( PHB_ITEM pItem ); - * $ARGUMENTS$ - * The pointer to item structure that will be scanned. The - * passed item can be of any datatype although arrays, objects - * and codeblocks are scanned only. Other datatypes don't require - * locking so they are simply ignored. - * $RETURNS$ - * Nothing. - * $DESCRIPTION$ - * The garbage collector uses hb_gcItemRef() function during - * scanning of referenced memory pointers. This function checks the - * type of passed item and scans recursively all other memory blocks - * referenced by this item if it is an array, an object or a codeblock. - * - * NOTE: This function is reserved for the garbage collector only. It - * cannot be called from the user code - calling it can cause - * unpredicted results (memory blocks referenced by the - * passed item can be released prematurely during the closest - * garbage collection). - * $STATUS$ - * C - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gcAlloc(),hb_gcFree() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gcCollectAll() + $CATEGORY$ + API + $SUBCATEGORY$ + Garbage Collector + $ONELINER$ + Scans all memory blocks and releases the garbage memory. + $SYNTAX$ + void hb_gcCollectAll( void ); + $ARGUMENTS$ + None. + $RETURNS$ + Nothing. + $DESCRIPTION$ + This function scans the eval stack, the memvars table, the array + of static variables and table of created classes for referenced + memory blocks. After scanning all unused memory blocks and blocks + that are not locked are released. + $STATUS$ + C + $COMPLIANCE$ + H + $PLATFORMS$ + All + $SEEALSO$ + hb_gcAlloc(),hb_gcFree() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * HB_GCALL() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Garbage Collector - * $ONELINER$ - * Scans the memory and releases all garbage memory blocks. - * $SYNTAX$ - * HB_GCALL() - * $ARGUMENTS$ - * None - * $DESCRIPTION$ - * This function releases all memory blocks that are considered - * as the garbage. - * $STATUS$ - * Harbour - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gcCollectAll() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gcItemRef() + $CATEGORY$ + API + $SUBCATEGORY$ + Garbage Collector + $ONELINER$ + Marks the memory to prevent deallocation by the garbage collector. + $SYNTAX$ + void hb_gcItemRef( PHB_ITEM pItem ); + $ARGUMENTS$ + The pointer to item structure that will be scanned. The + passed item can be of any datatype although arrays, objects + and codeblocks are scanned only. Other datatypes don't require + locking so they are simply ignored. + $RETURNS$ + Nothing. + $DESCRIPTION$ + The garbage collector uses hb_gcItemRef() function during + scanning of referenced memory pointers. This function checks the + type of passed item and scans recursively all other memory blocks + referenced by this item if it is an array, an object or a codeblock. + + NOTE: This function is reserved for the garbage collector only. It + cannot be called from the user code - calling it can cause + unpredicted results (memory blocks referenced by the + passed item can be released prematurely during the closest + garbage collection). + $STATUS$ + C + $COMPLIANCE$ + H + $PLATFORMS$ + All + $SEEALSO$ + hb_gcAlloc(),hb_gcFree() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + HB_GCALL() + $CATEGORY$ + API + $SUBCATEGORY$ + Garbage Collector + $ONELINER$ + Scans the memory and releases all garbage memory blocks. + $SYNTAX$ + HB_GCALL() + $ARGUMENTS$ + None + $DESCRIPTION$ + This function releases all memory blocks that are considered + as the garbage. + $STATUS$ + Harbour + $COMPLIANCE$ + H + $PLATFORMS$ + All + $SEEALSO$ + hb_gcCollectAll() + $END$ */ diff --git a/harbour/doc/en/gnulice.txt b/harbour/doc/en/gnulice.txt index 2f3efac48f..60fbf85df8 100644 --- a/harbour/doc/en/gnulice.txt +++ b/harbour/doc/en/gnulice.txt @@ -2,399 +2,399 @@ * $Id$ */ -/* $DOC$ - * $TEMPLATE$ - * Document - * $NAME$ - * GNU License - * $CATEGORY$ - * Document - * $SUBCATEGORY$ - * License - * $ONELINER$ - * Gnu License File Part 1 - * $DESCRIPTION$ - * GNU GENERAL PUBLIC LICENSE - * Version 2, June 1991 - * Copyright (C) 1989, 1991 Free Software Foundation, Inc. - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA - * - * Everyone is permitted to copy and distribute verbatim copies - * of this license document, but changing it is not allowed. - * - * Preamble - * - * The licenses for most software are designed to take away your - * freedom to share and change it. By contrast, the GNU General Public - * License is intended to guarantee your freedom to share and change - * free software--to make sure the software is free for all its users. - * This General Public License applies to most of the Free Software - * Foundation's software and to any other program whose authors commit - * to using it. (Some other Free Software Foundation software is - * covered by the GNU Library General Public License instead.) - * You can apply it to your programs, too. - * - * When we speak of free software, we are referring to freedom, not - * price. Our General Public Licenses are designed to make sure that - * you have the freedom to distribute copies of free software (and - * charge for this service if you wish), that you receive source code - * or can get it if you want it, that you can change the software or - * use pieces of it in new free programs; and that you know you can do - * these things. - * - * To protect your rights, we need to make restrictions that forbid - * anyone to deny you these rights or to ask you to surrender the - * rights. These restrictions translate to certain responsibilities - * for you if you distribute copies of the software, or if you modify - * it. - * - * For example, if you distribute copies of such a program, whether - * gratis or for a fee, you must give the recipients all the rights - * that you have. You must make sure that they, too, receive or can - * get the source code. And you must show them these terms so they - * know their rights. - * - * We protect your rights with two steps: (1) copyright the software, - * and (2) offer you this license which gives you legal permission to - * copy, distribute and/or vmodify the software. - * - * Also, for each author's protection and ours, we want to make - * certain that everyone understands that there is no warranty for - * this free software. If the software is modified by someone else and - * passed on, we want its recipients to know that what they have is - * not the original, so that any problems introduced by others will - * not reflect on the original authors' reputations. - * - * Finally, any free program is threatened constantly by software - * patents. We wish to avoid the danger that redistributors of a free - * program will individually obtain patent licenses, in effect making - * the program proprietary. To prevent this, we have made it clear - * that any patent must be licensed for everyone's free use or not - * licensed at all. - * - * The precise terms and conditions for copying, distribution and - * modification follow. - * - * TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - * - * 0. This License applies to any program or other work which contains - * a notice placed by the copyright holder saying it may be - * distributed under the terms of this General Public License. The - * "Program", below, refers to any such program or work, and a "work - * based on the Program" means either the Program or any derivative - * work under copyright law: that is to say, a work containing the - * Program or a portion of it, either verbatim or with modifications - * and/or translated into another language. (Hereinafter, translation - * is included without limitation in the term "modification".) Each - * licensee is addressed as "you". Activities other than copying, - * distribution and modification are not covered by this License; they - * are outside its scope. The act of running the Program is not - * restricted, and the output from the Program is covered only if its - * contents constitute a work based on the Program (independent of - * having been made by running the Program). Whether that is true - * depends on what the Program does. - * - * 1. You may copy and distribute verbatim copies of the Program's - * source code as you receive it, in any medium, provided that you - * conspicuously and appropriately publish on each copy an appropriate - * copyright notice and disclaimer of warranty; keep intact all the - * notices that refer to this License and to the absence of any - * warranty; and give any other recipients of the Program a copy of - * this License along with the Program. You may charge a fee for the - * physical act of transferring a copy, and you may at your option - * offer warranty protection in exchange for a fee. - * - * 2. You may modify your copy or copies of the Program or any portion - * of it, thus forming a work based on the Program, and copy and - * distribute such modifications or work under the terms of Section 1 - * above, provided that you also meet all of these conditions: - * - * a) You must cause the modified files to carry prominent notices - * stating that you changed the files and the date of any change. - * - * b) You must cause any work that you distribute or publish, that - * in whole or in part contains or is derived from the Program or - * any part thereof, to be licensed as a whole at no charge to all - * third parties under the terms of this License. - * - * c) If the modified program normally reads commands interactively - * when run, you must cause it, when started running for such - * interactive use in the most ordinary way, to print or display an - * announcement including an appropriate copyright notice and a - * notice that there is no warranty (or else, saying that you - * provide a warranty) and that users may redistribute the program - * under these conditions, and telling the user how to view a copy - * of this License. (Exception: if the Program itself is interactive - * but does not normally print such an announcement, your work based - * on the Program is not required to print an announcement.) - * - * These requirements apply to the modified work as a whole. If - * identifiable sections of that work are not derived from the - * Program, and can be reasonably considered independent and separate - * works in themselves, then this License, and its terms, do not apply - * to those sections when you distribute them as separate works. But - * when you distribute the same sections as part of a whole which is a - * work based on the Program, the distribution of the whole must be on - * the terms of this License, whose permissions for other licensees - * extend to the entire whole, and thus to each and every part - * regardless of who wrote it. - * - * Thus, it is not the intent of this section to claim rights or - * contest your rights to work written entirely by you; rather, the - * intent is to exercise the right to control the distribution of - * derivative or collective works based on the Program. - * - * In addition, mere aggregation of another work not based on the - * Program with the Program (or with a work based on the Program) on a - * volume of a storage or distribution medium does not bring the other - * work under the scope of this License. - * - * 3. You may copy and distribute the Program (or a work based on it, - * under Section 2) in object code or executable form under the terms - * of Sections 1 and 2 above provided that you also do one of the - * following: - * - * a) Accompany it with the complete corresponding machine-readable - * source code, which must be distributed under the terms of - * Sections 1 and 2 above on a medium customarily used for software - * interchange; or, - * - * b) Accompany it with a written offer, valid for at least three - * years, to give any third party, for a charge no more than your - * cost of physically performing source distribution, a complete - * machine-readable copy of the corresponding source code, to be - * distributed under the terms of Sections 1 and 2 above on a medium - * customarily used for software interchange; or, - * - * c) Accompany it with the information you received as to the offer - * to distribute corresponding source code. (This alternative is - * allowed only for noncommercial distribution and only if you - * received the program in object code or executable form with such - * an offer, in accord with Subsection b above.) - * - * The source code for a work means the preferred form of the work for - * making modifications to it. For an executable work, complete source - * code means all the source code for all modules it contains, plus - * any associated interface definition files, plus the scripts used to - * control compilation and installation of the executable. However, as - * a special exception, the source code distributed need not include - * anything that is normally distributed (in either source or binary - * form) with the major components (compiler, kernel, and so on) of - * the operating system on which the executable runs, unless that - * component itself accompanies the executable. - * - * If distribution of executable or object code is made by offering - * access to copy from a designated place, then offering equivalent - * access to copy the source code from the same place counts as - * distribution of the source code, even though third parties are not - * compelled to copy the source along with the object code. - * - * 4. You may not copy, modify, sublicense, or distribute the Program - * except as expressly provided under this License. Any attempt - * otherwise to copy, modify, sublicense or distribute the Program is - * void, and will automatically terminate your rights under this - * License. However, parties who have received copies, or rights, from - * you under this License will not have their licenses terminated so - * long as such parties remain in full compliance. - * - * 5. You are not required to accept this License, since you have not - * signed it. However, nothing else grants you permission to modify or - * distribute the Program or its derivative works. These actions are - * prohibited by law if you do not accept this License. Therefore, by - * modifying or distributing the Program (or any work based on the - * Program), you indicate your acceptance of this License to do so, - * and all its terms and conditions for copying, distributing or - * modifying the Program or works based on it. - * - * 6. Each time you redistribute the Program (or any work based on the - * Program), the recipient automatically receives a license from the - * original licensor to copy, distribute or modify the Program subject - * to these terms and conditions. You may not impose any further - * restrictions on the recipients' exercise of the rights granted - * herein. You are not responsible for enforcing compliance by third - * parties to this License. - * - * $SEEALSO$ - * GNU License.. - * $END$ +/* $DOC$ + $TEMPLATE$ + Document + $NAME$ + GNU License + $CATEGORY$ + Document + $SUBCATEGORY$ + License + $ONELINER$ + Gnu License File Part 1 + $DESCRIPTION$ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your + freedom to share and change it. By contrast, the GNU General Public + License is intended to guarantee your freedom to share and change + free software--to make sure the software is free for all its users. + This General Public License applies to most of the Free Software + Foundation's software and to any other program whose authors commit + to using it. (Some other Free Software Foundation software is + covered by the GNU Library General Public License instead.) + You can apply it to your programs, too. + + When we speak of free software, we are referring to freedom, not + price. Our General Public Licenses are designed to make sure that + you have the freedom to distribute copies of free software (and + charge for this service if you wish), that you receive source code + or can get it if you want it, that you can change the software or + use pieces of it in new free programs; and that you know you can do + these things. + + To protect your rights, we need to make restrictions that forbid + anyone to deny you these rights or to ask you to surrender the + rights. These restrictions translate to certain responsibilities + for you if you distribute copies of the software, or if you modify + it. + + For example, if you distribute copies of such a program, whether + gratis or for a fee, you must give the recipients all the rights + that you have. You must make sure that they, too, receive or can + get the source code. And you must show them these terms so they + know their rights. + + We protect your rights with two steps: (1) copyright the software, + and (2) offer you this license which gives you legal permission to + copy, distribute and/or vmodify the software. + + Also, for each author's protection and ours, we want to make + certain that everyone understands that there is no warranty for + this free software. If the software is modified by someone else and + passed on, we want its recipients to know that what they have is + not the original, so that any problems introduced by others will + not reflect on the original authors' reputations. + + Finally, any free program is threatened constantly by software + patents. We wish to avoid the danger that redistributors of a free + program will individually obtain patent licenses, in effect making + the program proprietary. To prevent this, we have made it clear + that any patent must be licensed for everyone's free use or not + licensed at all. + + The precise terms and conditions for copying, distribution and + modification follow. + + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains + a notice placed by the copyright holder saying it may be + distributed under the terms of this General Public License. The + "Program", below, refers to any such program or work, and a "work + based on the Program" means either the Program or any derivative + work under copyright law: that is to say, a work containing the + Program or a portion of it, either verbatim or with modifications + and/or translated into another language. (Hereinafter, translation + is included without limitation in the term "modification".) Each + licensee is addressed as "you". Activities other than copying, + distribution and modification are not covered by this License; they + are outside its scope. The act of running the Program is not + restricted, and the output from the Program is covered only if its + contents constitute a work based on the Program (independent of + having been made by running the Program). Whether that is true + depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's + source code as you receive it, in any medium, provided that you + conspicuously and appropriately publish on each copy an appropriate + copyright notice and disclaimer of warranty; keep intact all the + notices that refer to this License and to the absence of any + warranty; and give any other recipients of the Program a copy of + this License along with the Program. You may charge a fee for the + physical act of transferring a copy, and you may at your option + offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion + of it, thus forming a work based on the Program, and copy and + distribute such modifications or work under the terms of Section 1 + above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that + in whole or in part contains or is derived from the Program or + any part thereof, to be licensed as a whole at no charge to all + third parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you + provide a warranty) and that users may redistribute the program + under these conditions, and telling the user how to view a copy + of this License. (Exception: if the Program itself is interactive + but does not normally print such an announcement, your work based + on the Program is not required to print an announcement.) + + These requirements apply to the modified work as a whole. If + identifiable sections of that work are not derived from the + Program, and can be reasonably considered independent and separate + works in themselves, then this License, and its terms, do not apply + to those sections when you distribute them as separate works. But + when you distribute the same sections as part of a whole which is a + work based on the Program, the distribution of the whole must be on + the terms of this License, whose permissions for other licensees + extend to the entire whole, and thus to each and every part + regardless of who wrote it. + + Thus, it is not the intent of this section to claim rights or + contest your rights to work written entirely by you; rather, the + intent is to exercise the right to control the distribution of + derivative or collective works based on the Program. + + In addition, mere aggregation of another work not based on the + Program with the Program (or with a work based on the Program) on a + volume of a storage or distribution medium does not bring the other + work under the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, + under Section 2) in object code or executable form under the terms + of Sections 1 and 2 above provided that you also do one of the + following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of + Sections 1 and 2 above on a medium customarily used for software + interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + + The source code for a work means the preferred form of the work for + making modifications to it. For an executable work, complete source + code means all the source code for all modules it contains, plus + any associated interface definition files, plus the scripts used to + control compilation and installation of the executable. However, as + a special exception, the source code distributed need not include + anything that is normally distributed (in either source or binary + form) with the major components (compiler, kernel, and so on) of + the operating system on which the executable runs, unless that + component itself accompanies the executable. + + If distribution of executable or object code is made by offering + access to copy from a designated place, then offering equivalent + access to copy the source code from the same place counts as + distribution of the source code, even though third parties are not + compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program + except as expressly provided under this License. Any attempt + otherwise to copy, modify, sublicense or distribute the Program is + void, and will automatically terminate your rights under this + License. However, parties who have received copies, or rights, from + you under this License will not have their licenses terminated so + long as such parties remain in full compliance. + + 5. You are not required to accept this License, since you have not + signed it. However, nothing else grants you permission to modify or + distribute the Program or its derivative works. These actions are + prohibited by law if you do not accept this License. Therefore, by + modifying or distributing the Program (or any work based on the + Program), you indicate your acceptance of this License to do so, + and all its terms and conditions for copying, distributing or + modifying the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the + Program), the recipient automatically receives a license from the + original licensor to copy, distribute or modify the Program subject + to these terms and conditions. You may not impose any further + restrictions on the recipients' exercise of the rights granted + herein. You are not responsible for enforcing compliance by third + parties to this License. + + $SEEALSO$ + GNU License.. + $END$ */ - /* - * $DOC$ - * $TEMPLATE$ - * Document - * $NAME$ - * GNU License.. - * $CATEGORY$ - * Document - * $SUBCATEGORY$ - * License - * $ONELINER$ - * Gnu License File Part 2 - * $DESCRIPTION$ - * 7. If, as a consequence of a court judgment or allegation of patent - * infringement or for any other reason (not limited to patent - * issues), conditions are imposed on you (whether by court order, - * agreement or otherwise) that contradict the conditions of this - * License, they do not excuse you from the conditions of this - * License. If you cannot distribute so as to satisfy simultaneously - * your obligations under this License and any other pertinent - * obligations, then as a consequence you may not distribute the - * Program at all. For example, if a patent license would not permit - * royalty-free redistribution of the Program by all those who receive - * copies directly or indirectly through you, then the only way you - * could satisfy both it and this License would be to refrain entirely - * from distribution of the Program. - * - * If any portion of this section is held invalid or unenforceable - * under any particular circumstance, the balance of the section is - * intended to apply and the section as a whole is intended to apply - * in other circumstances. - * - * It is not the purpose of this section to induce you to infringe any - * patents or other property right claims or to contest validity of - * any such claims; this section has the sole purpose of protecting - * the integrity of the free software distribution system, which is - * implemented by public license practices. Many people have made - * generous contributions to the wide range of software distributed - * through that system in reliance on consistent application of that - * system; it is up to the author/donor to decide if he or she is - * willing to distribute software through any other system and a - * licensee cannot impose that choice. - * - * This section is intended to make thoroughly clear what is believed - * to be a consequence of the rest of this License. - * - * 8. If the distribution and/or use of the Program is restricted in - * certain countries either by patents or by copyrighted interfaces, - * the original copyright holder who places the Program under this - * License may add an explicit geographical distribution limitation - * excluding those countries, so that distribution is permitted only - * in or among countries not thus excluded. In such case, this License - * incorporates the limitation as if written in the body of this - * License. - * - * 9. The Free Software Foundation may publish revised and/or new - * versions of the General Public License from time to time. Such new - * versions will be similar in spirit to the present version, but may - * differ in detail to address new problems or concerns. - * - * Each version is given a distinguishing version number. If the - * Program specifies a version number of this License which applies to - * it and "any later version", you have the option of following the - * terms and conditions either of that version or of any later version - * published by the Free Software Foundation. If the Program does not - * specify a version number of this License, you may choose any - * version ever published by the Free Software Foundation. - * - * 10. If you wish to incorporate parts of the Program into other free - * programs whose distribution conditions are different, write to the - * author to ask for permission. For software which is copyrighted by - * the Free Software Foundation, write to the Free Software - * Foundation; we sometimes make exceptions for this. Our decision - * will be guided by the two goals of preserving the free status of - * all derivatives of our free software and of promoting the sharing - * and reuse of software generally. - * - * NO WARRANTY - * - * 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO - * WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE - * LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS - * AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY - * OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS - * FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND - * PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE - * DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR - * OR CORRECTION. - * - * 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN - * WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY - * MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE - * LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, - * INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR - * INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF - * DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU - * OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY - * OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN - * ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. - * - * END OF TERMS AND CONDITIONS - * - * Appendix: How to Apply These Terms to Your New Programs - * - * If you develop a new program, and you want it to be of the greatest - * possible use to the public, the best way to achieve this is to make - * it free software which everyone can redistribute and change under - * these terms. - * - * To do so, attach the following notices to the program. It is safest - * to attach them to the start of each source file to most effectively - * convey the exclusion of warranty; and each file should have at - * least the "copyright" line and a pointer to where the full notice - * is found: - * - * - * Copyright (C) yyyy - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 - * of the License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - * - * Also add information on how to contact you by electronic and paper - * mail. If the program is interactive, make it output a short notice - * like this when it starts in an interactive mode: - * - * Gnomovision version 69, Copyright (C) year name of author - * Gnomovision comes with ABSOLUTELY NO WARRANTY; for details - * type `show w'. This is free software, and you are welcome - * to redistribute it under certain conditions; type `show c' - * for details. - * - * The hypothetical commands `show w' and `show c' should show the - * appropriate parts of the General Public License. Of course, the - * commands you use may be called something other than `show w' and - * `show c'; they could even be mouse-clicks or menu items--whatever - * suits your program. - * - * You should also get your employer (if you work as a programmer) or - * your school, if any, to sign a "copyright disclaimer" for the - * program, if necessary. Here is a sample; alter the names: - * - * Yoyodyne, Inc., hereby disclaims all copyright interest in the - * program `Gnomovision' (which makes passes at compilers) written by - * James Hacker. - * - * signature of Ty Coon, 1 April 1989 - * - * Ty Coon, President of Vice - * - * This General Public License does not permit incorporating your - * program into proprietary programs. If your program is a subroutine - * library, you may consider it more useful to permit linking - * proprietary applications with the library. If this is what you want - * to do, use the GNU Library General Public License instead of this - * License. - * - * FSF & GNU inquiries & questions to gnu@gnu.org. - * Copyright notice above. - * - * Free Software Foundation, Inc., - * 59 Temple Place - Suite 330, Boston, MA 02111, USA - * Updated: 3 Jan 2000 rms - * - * $SEEALSO$ - * License,GNU License - * $END$ + +/* $DOC$ + $TEMPLATE$ + Document + $NAME$ + GNU License.. + $CATEGORY$ + Document + $SUBCATEGORY$ + License + $ONELINER$ + Gnu License File Part 2 + $DESCRIPTION$ + 7. If, as a consequence of a court judgment or allegation of patent + infringement or for any other reason (not limited to patent + issues), conditions are imposed on you (whether by court order, + agreement or otherwise) that contradict the conditions of this + License, they do not excuse you from the conditions of this + License. If you cannot distribute so as to satisfy simultaneously + your obligations under this License and any other pertinent + obligations, then as a consequence you may not distribute the + Program at all. For example, if a patent license would not permit + royalty-free redistribution of the Program by all those who receive + copies directly or indirectly through you, then the only way you + could satisfy both it and this License would be to refrain entirely + from distribution of the Program. + + If any portion of this section is held invalid or unenforceable + under any particular circumstance, the balance of the section is + intended to apply and the section as a whole is intended to apply + in other circumstances. + + It is not the purpose of this section to induce you to infringe any + patents or other property right claims or to contest validity of + any such claims; this section has the sole purpose of protecting + the integrity of the free software distribution system, which is + implemented by public license practices. Many people have made + generous contributions to the wide range of software distributed + through that system in reliance on consistent application of that + system; it is up to the author/donor to decide if he or she is + willing to distribute software through any other system and a + licensee cannot impose that choice. + + This section is intended to make thoroughly clear what is believed + to be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in + certain countries either by patents or by copyrighted interfaces, + the original copyright holder who places the Program under this + License may add an explicit geographical distribution limitation + excluding those countries, so that distribution is permitted only + in or among countries not thus excluded. In such case, this License + incorporates the limitation as if written in the body of this + License. + + 9. The Free Software Foundation may publish revised and/or new + versions of the General Public License from time to time. Such new + versions will be similar in spirit to the present version, but may + differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the + Program specifies a version number of this License which applies to + it and "any later version", you have the option of following the + terms and conditions either of that version or of any later version + published by the Free Software Foundation. If the Program does not + specify a version number of this License, you may choose any + version ever published by the Free Software Foundation. + + 10. If you wish to incorporate parts of the Program into other free + programs whose distribution conditions are different, write to the + author to ask for permission. For software which is copyrighted by + the Free Software Foundation, write to the Free Software + Foundation; we sometimes make exceptions for this. Our decision + will be guided by the two goals of preserving the free status of + all derivatives of our free software and of promoting the sharing + and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO + WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE + LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS + AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY + OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND + PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE + DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR + OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN + WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY + MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE + LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, + INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR + INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF + DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU + OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY + OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + Appendix: How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest + possible use to the public, the best way to achieve this is to make + it free software which everyone can redistribute and change under + these terms. + + To do so, attach the following notices to the program. It is safest + to attach them to the start of each source file to most effectively + convey the exclusion of warranty; and each file should have at + least the "copyright" line and a pointer to where the full notice + is found: + + + Copyright (C) yyyy + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., + 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + + Also add information on how to contact you by electronic and paper + mail. If the program is interactive, make it output a short notice + like this when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details + type `show w'. This is free software, and you are welcome + to redistribute it under certain conditions; type `show c' + for details. + + The hypothetical commands `show w' and `show c' should show the + appropriate parts of the General Public License. Of course, the + commands you use may be called something other than `show w' and + `show c'; they could even be mouse-clicks or menu items--whatever + suits your program. + + You should also get your employer (if you work as a programmer) or + your school, if any, to sign a "copyright disclaimer" for the + program, if necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + program `Gnomovision' (which makes passes at compilers) written by + James Hacker. + + signature of Ty Coon, 1 April 1989 + + Ty Coon, President of Vice + + This General Public License does not permit incorporating your + program into proprietary programs. If your program is a subroutine + library, you may consider it more useful to permit linking + proprietary applications with the library. If this is what you want + to do, use the GNU Library General Public License instead of this + License. + + FSF & GNU inquiries & questions to gnu@gnu.org. + Copyright notice above. + + Free Software Foundation, Inc., + 59 Temple Place - Suite 330, Boston, MA 02111, USA + Updated: 3 Jan 2000 rms + + $SEEALSO$ + License,GNU License + $END$ */ diff --git a/harbour/doc/en/harbext.txt b/harbour/doc/en/harbext.txt index 937cc1abc4..f6e0bc8ba2 100644 --- a/harbour/doc/en/harbext.txt +++ b/harbour/doc/en/harbext.txt @@ -2,86 +2,86 @@ * $Id$ */ -/* $DOC$ - * $TEMPLATE$ - * Document - * $NAME$ - * Harbour Extensions - * $CATEGORY$ - * Document - * $ONELINER$ - * Harbour Extensions - * $DESCRIPTION$ - * Language extensions: - * -------------------- - * - * * Class generation and management. - * - * CA-Cl*pper only allowed creation of objects from a few standard - * classes. - * - * In Harbour, you can create your own classes--complete with - * Methods, Instance Variables, Class Variables and Inheritance. - * Entire applications can be designed and coded in Object Oriented - * style. - * - * * @() - * - * Returns the pointer (address) to a function. - * - * The returned value is not useful to application-level programming, but - * is used at a low level to implement object oriented coding. - * (Internally, a class method is a static function and there is no - * symbol for it, so it is accessed via its address). - * - * * Class HBGetList - * - * Object oriented support for GetLists management. - * - * * ProcName() support for class Method names. - * - * Class Methods can be retrieved from the call stack. - * - * * Memory() has new return values. - * - * See hbmemory.ch - * - * * Transform() --> new function in format string - * - * @0 Make a zero padded string out of the number. - * - * * SToD() --> dDate - * - * New function that converts a yyyymmdd string to a Date value. - * - * * Optional Compile Time STRONG TYPE declaration (and compile time TYPE - * MISMATCH warnings) - * - * Example: LOCAL/STATIC Var AS ... - * - * * The Harbour debugger provides new interesting classes: - * - * - Class TDbWindow could be the foundation for a generic multiplatform - * - * - Class TForm - * - * - Class TDbMenu implement both pulldown and popup menus. - * - * RTL enhanced functionality: - * --------------------------- - * - * - Directory( , , ) - * - * The 3rd parameter is a Harbour (optional) parameter and indicates that on - * those platforms that support long filenames, that you wish to receive what - * would be considered the dos equivalant 8.3 name. - * Could affect Adir() and Dir if they were modified to take advantage - * of it - currently, they will return long names if the os supports it. - * - * - HB_DiskSpace( , ) - * - * The second parameter is a Harbour (optional) parameter and indicates the - * type of diskinfo being requested. See en/diskspac.txt for info. - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Document + $NAME$ + Harbour Extensions + $CATEGORY$ + Document + $ONELINER$ + Harbour Extensions + $DESCRIPTION$ + Language extensions: + -------------------- + + * Class generation and management. + + CA-Cl*pper only allowed creation of objects from a few standard + classes. + + In Harbour, you can create your own classes--complete with + Methods, Instance Variables, Class Variables and Inheritance. + Entire applications can be designed and coded in Object Oriented + style. + + * @() + + Returns the pointer (address) to a function. + + The returned value is not useful to application-level programming, but + is used at a low level to implement object oriented coding. + (Internally, a class method is a static function and there is no + symbol for it, so it is accessed via its address). + + * Class HBGetList + + Object oriented support for GetLists management. + + * ProcName() support for class Method names. + + Class Methods can be retrieved from the call stack. + + * Memory() has new return values. + + See hbmemory.ch + + * Transform() --> new function in format string + + @0 Make a zero padded string out of the number. + + * SToD() --> dDate + + New function that converts a yyyymmdd string to a Date value. + + * Optional Compile Time STRONG TYPE declaration (and compile time TYPE + MISMATCH warnings) + + Example: LOCAL/STATIC Var AS ... + + * The Harbour debugger provides new interesting classes: + + - Class TDbWindow could be the foundation for a generic multiplatform + + - Class TForm + + - Class TDbMenu implement both pulldown and popup menus. + + RTL enhanced functionality: + --------------------------- + + - Directory( , , ) + + The 3rd parameter is a Harbour (optional) parameter and indicates that on + those platforms that support long filenames, that you wish to receive what + would be considered the dos equivalant 8.3 name. + Could affect Adir() and Dir if they were modified to take advantage + of it - currently, they will return long names if the os supports it. + + - HB_DiskSpace( , ) + + The second parameter is a Harbour (optional) parameter and indicates the + type of diskinfo being requested. See en/diskspac.txt for info. + + $END$ */ diff --git a/harbour/doc/en/hashes.txt b/harbour/doc/en/hashes.txt index 9e76e50dbe..fb528c8573 100644 --- a/harbour/doc/en/hashes.txt +++ b/harbour/doc/en/hashes.txt @@ -53,1138 +53,1138 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HASH() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Returns a hash table - * $SYNTAX$ - * HB_HASH( [ , ], [ , ], ... ) -> hsTable - * $ARGUMENTS$ - * entry key; - * can be of type: number, date, datetime, string, pointer - * - * entry value; can be of type: block, string, numeric, date/datetime, logical, nil, pointer, array, hash table - * $RETURNS$ - * A hash table built from the initial key/value pairs - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HASH() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Returns a hash table + $SYNTAX$ + HB_HASH( [ , ], [ , ], ... ) -> hsTable + $ARGUMENTS$ + entry key; + can be of type: number, date, datetime, string, pointer + + entry value; can be of type: block, string, numeric, date/datetime, logical, nil, pointer, array, hash table + $RETURNS$ + A hash table built from the initial key/value pairs + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HHASKEY() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Determines whether a hash table has an entry with a give key - * $SYNTAX$ - * HB_HHASKEY( , ) -> lExists - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * a key value to be queried for; - * can be of type: number, date, datetime, string, pointer - * $RETURNS$ - * A logical value indicating whether the key exists within the hash table - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HHASKEY() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Determines whether a hash table has an entry with a give key + $SYNTAX$ + HB_HHASKEY( , ) -> lExists + $ARGUMENTS$ + a hash table, created by HB_HASH() + + a key value to be queried for; + can be of type: number, date, datetime, string, pointer + $RETURNS$ + A logical value indicating whether the key exists within the hash table + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HPOS() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Locates the index of a key within a hash table - * $SYNTAX$ - * HB_HPOS( , ) -> nPosition - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * key for which its position is to be determined; - * can be of type: number, date, datetime, string, pointer - * $RETURNS$ - * A integer number being the index position of the key within the hash table. - * - * TODO: what is the return value if the key does not exist? zero (0)? RTE? - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HPOS() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Locates the index of a key within a hash table + $SYNTAX$ + HB_HPOS( , ) -> nPosition + $ARGUMENTS$ + a hash table, created by HB_HASH() + + key for which its position is to be determined; + can be of type: number, date, datetime, string, pointer + $RETURNS$ + A integer number being the index position of the key within the hash table. + + TODO: what is the return value if the key does not exist? zero (0)? RTE? + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HGET() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Returns a hash value - * $SYNTAX$ - * HB_HGET( , ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * key to be retrieve from the hash table; - * can be of type: number, date, datetime, string, pointer - * $RETURNS$ - * Either the value within the hash table for the given key. - * - * An array access error occurs of the key is not found - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HGET() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Returns a hash value + $SYNTAX$ + HB_HGET( , ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() + + key to be retrieve from the hash table; + can be of type: number, date, datetime, string, pointer + $RETURNS$ + Either the value within the hash table for the given key. + + An array access error occurs of the key is not found + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HGETDEF() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Returns a hash value, or a default value if the key is not present - * $SYNTAX$ - * HB_HGETDEF( , , [] ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * key to be retrieve from the hash table; - * can be of type: number, date, datetime, string, pointer - * - * a default value to be returned if the - * hash table does not contain the key - * $RETURNS$ - * Either the value within the hash table for the given key, - * or the default value. - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HGETDEF() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Returns a hash value, or a default value if the key is not present + $SYNTAX$ + HB_HGETDEF( , , [] ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() + + key to be retrieve from the hash table; + can be of type: number, date, datetime, string, pointer + + a default value to be returned if the + hash table does not contain the key + $RETURNS$ + Either the value within the hash table for the given key, + or the default value. + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HSET() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Sets a hash value - * $SYNTAX$ - * HB_HSET( , , ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * the key of the entry to be set; - * can be of type: number, date, datetime, string, pointer - * - * the entry value - * $RETURNS$ - * The hash table - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HSET() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Sets a hash value + $SYNTAX$ + HB_HSET( , , ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() + + the key of the entry to be set; + can be of type: number, date, datetime, string, pointer + + the entry value + $RETURNS$ + The hash table + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HDEL() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Removes a key/value pair from a hash table - * $SYNTAX$ - * HB_HDEL( , ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * key to be removed from the hash table; - * can be of type: number, date, datetime, string, pointer - * $RETURNS$ - * The hash table - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HDEL() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Removes a key/value pair from a hash table + $SYNTAX$ + HB_HDEL( , ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() + + key to be removed from the hash table; + can be of type: number, date, datetime, string, pointer + $RETURNS$ + The hash table + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HKEYAT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Gets a hash table key at a given position - * $SYNTAX$ - * HB_HKEYAT( , ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * the position of an entry within the hash table that will - * be returned - * $RETURNS$ - * The key at the given position of the hash table; - * the type will be one: number, date, datetime, string, pointer - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HKEYAT() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Gets a hash table key at a given position + $SYNTAX$ + HB_HKEYAT( , ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() + + the position of an entry within the hash table that will + be returned + $RETURNS$ + The key at the given position of the hash table; + the type will be one: number, date, datetime, string, pointer + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HVALUEAT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Gets/sets a hash value at a given position - * $SYNTAX$ - * HB_HVALUEAT( , , [] ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * the position of an entry within the hash table that will - * be returned - * - * a new value to be assigned to the hash table at the given - * position - * $RETURNS$ - * The existing value, or the new value if it is given - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HVALUEAT() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Gets/sets a hash value at a given position + $SYNTAX$ + HB_HVALUEAT( , , [] ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() + + the position of an entry within the hash table that will + be returned + + a new value to be assigned to the hash table at the given + position + $RETURNS$ + The existing value, or the new value if it is given + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HPAIRAT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Returns a two-dimensional array of a hash table entry key/value pair - * $SYNTAX$ - * HB_HPAIRAT( , ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * the position of an entry within the hash table that will - * be returned - * $RETURNS$ - * A two-dimensional array of the key/value pair entry of the hash table - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HPAIRAT() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Returns a two-dimensional array of a hash table entry key/value pair + $SYNTAX$ + HB_HPAIRAT( , ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() + + the position of an entry within the hash table that will + be returned + $RETURNS$ + A two-dimensional array of the key/value pair entry of the hash table + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HDELAT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Removes an entry from a hash table based on its index position - * $SYNTAX$ - * HB_HDELAT( , ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * the position of an entry within the hash table that will - * be deleted - * $RETURNS$ - * The hash table - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HDELAT() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Removes an entry from a hash table based on its index position + $SYNTAX$ + HB_HDELAT( , ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() + + the position of an entry within the hash table that will + be deleted + $RETURNS$ + The hash table + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HKEYS() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Returns an array of the keys of a hash table - * $SYNTAX$ - * HB_HKEYS( ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * $RETURNS$ - * An array of all the hash table keys - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HKEYS() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Returns an array of the keys of a hash table + $SYNTAX$ + HB_HKEYS( ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() + $RETURNS$ + An array of all the hash table keys + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HVALUES() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Returns an array of the values of a hash table - * $SYNTAX$ - * HB_HVALUES( ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * $RETURNS$ - * An array of all the hash values - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HVALUES() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Returns an array of the values of a hash table + $SYNTAX$ + HB_HVALUES( ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() + $RETURNS$ + An array of all the hash values + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HFILL() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Fills a hash table with a value - * $SYNTAX$ - * HB_HFILL( , ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * fill value; can be of type: block, string, numeric, date/datetime, logical, nil, pointer, array, hash table - * $RETURNS$ - * The hash table - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HFILL() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Fills a hash table with a value + $SYNTAX$ + HB_HFILL( , ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() + + fill value; can be of type: block, string, numeric, date/datetime, logical, nil, pointer, array, hash table + $RETURNS$ + The hash table + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HCLONE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Creates a copy of a hash table - * $SYNTAX$ - * HB_HCLONE( ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * $RETURNS$ - * A cloned copy of the hash table - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HCLONE() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Creates a copy of a hash table + $SYNTAX$ + HB_HCLONE( ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() + $RETURNS$ + A cloned copy of the hash table + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HCOPY() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Adds entries from the source hash table to the destination hash table - * $SYNTAX$ - * HB_HCOPY( , , [], [] ) -> - * $ARGUMENTS$ - * a destination hash table, created by HB_HASH() - * - * a source hash table, created by HB_HASH() - * - * starting index, defaults to 1 if omitted - * - * counter, defaults to (length) - is omitted - * $RETURNS$ - * The destination hash table - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HCOPY() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Adds entries from the source hash table to the destination hash table + $SYNTAX$ + HB_HCOPY( , , [], [] ) -> + $ARGUMENTS$ + a destination hash table, created by HB_HASH() + + a source hash table, created by HB_HASH() + + starting index, defaults to 1 if omitted + + counter, defaults to (length) - is omitted + $RETURNS$ + The destination hash table + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HMERGE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Merges a source hash table into a destination hash table - * $SYNTAX$ - * HB_HMERGE( , , | ) -> - * $ARGUMENTS$ - * a destination hash table, created by HB_HASH() - * - * a source hash table, created by HB_HASH() - * - * a code block that will be evaluated for each entry within the - * source hash table; the code block will be passed the entry key, value and - * position; if the code block returns a true value, the entry will be added to - * the destination hash table - * - * the position of an entry within the source hash table that will - * be appended to the destination hash table - * - * TODO: the source code passes either a number or HB_HASH_UNION; research this - * $RETURNS$ - * The destination hash table with the contents of the source hash table merged - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HMERGE() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Merges a source hash table into a destination hash table + $SYNTAX$ + HB_HMERGE( , , | ) -> + $ARGUMENTS$ + a destination hash table, created by HB_HASH() + + a source hash table, created by HB_HASH() + + a code block that will be evaluated for each entry within the + source hash table; the code block will be passed the entry key, value and + position; if the code block returns a true value, the entry will be added to + the destination hash table + + the position of an entry within the source hash table that will + be appended to the destination hash table + + TODO: the source code passes either a number or HB_HASH_UNION; research this + $RETURNS$ + The destination hash table with the contents of the source hash table merged + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HEVAL() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Evaluate a code block across the contents of a hash table - * $SYNTAX$ - * HB_HEVAL( , , [], [] ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * code block to be evaluated - * - * starting index, defaults to 1 if omitted - * - * counter, defaults to (length) - is omitted - * $RETURNS$ - * The hash table - * $DESCRIPTION$ - * The code block is evaluated for every hash table entry starting at - * for items. - * - * The code block is passed the entry key, value, and numeric position - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HEVAL() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Evaluate a code block across the contents of a hash table + $SYNTAX$ + HB_HEVAL( , , [], [] ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() + + code block to be evaluated + + starting index, defaults to 1 if omitted + + counter, defaults to (length) - is omitted + $RETURNS$ + The hash table + $DESCRIPTION$ + The code block is evaluated for every hash table entry starting at + for items. + + The code block is passed the entry key, value, and numeric position + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HSCAN() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Scans a hash table - * $SYNTAX$ - * HB_HSCAN( , , [], [, [] ) -> nPosition - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * to be located within the hash table - * - * starting index, defaults to 1 if omitted - * - * counter, defaults to (length) - is omitted - * - * logical valuye indicating whether the comparision - * is to be be exact or not - * $RETURNS$ - * The position of the located value within the hash table, or zero (0) if not found. - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HSCAN() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Scans a hash table + $SYNTAX$ + HB_HSCAN( , , [], [, [] ) -> nPosition + $ARGUMENTS$ + a hash table, created by HB_HASH() + + to be located within the hash table + + starting index, defaults to 1 if omitted + + counter, defaults to (length) - is omitted + + logical valuye indicating whether the comparision + is to be be exact or not + $RETURNS$ + The position of the located value within the hash table, or zero (0) if not found. + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HSORT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Reorganizes the internal list of the hash table to be sorted - * $SYNTAX$ - * HB_HSORT( ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * $RETURNS$ - * The hash table sorted - * - * TODO: is the original table altered? - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HSORT() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Reorganizes the internal list of the hash table to be sorted + $SYNTAX$ + HB_HSORT( ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() + $RETURNS$ + The hash table sorted + + TODO: is the original table altered? + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HCASEMATCH() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Sets the 'case match' flag for the hash table - * $SYNTAX$ - * HB_HCASEMATCH( , [] ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * a logical value indicating to turn on or off - * the 'case match' flag of the hash table - * $RETURNS$ - * The previous value of the 'case match' flag - * $DESCRIPTION$ - * This function is equivalent to HB_HSETCASEMATCH() but it returns - * the old flag value rather than the hash table - * $EXAMPLES$ - * LOCAL hsTable, lFlag - * hsTable := { "one" => 1, "two" => 2 } - * // turn 'case match' on for a new hash table, storing ol flag - * lFlag := hb_HCaseMatch( hsTable, .T. ) - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * HB_HSETCASEMATCH() - * $END$ - */ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HCASEMATCH() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Sets the 'case match' flag for the hash table + $SYNTAX$ + HB_HCASEMATCH( , [] ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HBINARY() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Sets the 'binary' flag for the hash table - * $SYNTAX$ - * HB_HBINARY( , [] ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * a logical value indicating to turn on or off - * the 'binary' flag of the hash table - * $RETURNS$ - * The previous value of the 'binary' flag - * $DESCRIPTION$ - * This function is equivalent to HB_HBINARY() but it returns - * the old flag value rather than the hash table - * $EXAMPLES$ - * LOCAL hsTable, lFlag - * hsTable := { "one" => 1, "two" => 2 } - * // turn 'binary' on for a new hash table, storing ol flag - * lFlag := hb_HBinary( hsTable, .T. ) - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * HB_HSETBINARY() - * $END$ + a logical value indicating to turn on or off + the 'case match' flag of the hash table + $RETURNS$ + The previous value of the 'case match' flag + $DESCRIPTION$ + This function is equivalent to HB_HSETCASEMATCH() but it returns + the old flag value rather than the hash table + $EXAMPLES$ + LOCAL hsTable, lFlag + hsTable := { "one" => 1, "two" => 2 } + // turn 'case match' on for a new hash table, storing ol flag + lFlag := hb_HCaseMatch( hsTable, .T. ) + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + HB_HSETCASEMATCH() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HAUTOADD() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Sets the 'auto add' flag for the hash table - * $SYNTAX$ - * HB_HAUTOADD( , [] ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * a logical value indicating to turn on or off - * the 'auto add' flag of the hash table - * $RETURNS$ - * The previous value of the 'auto add' flag - * $DESCRIPTION$ - * This function is equivalent to HB_HAUTOADD() but it returns - * the old flag value rather than the hash table - * $EXAMPLES$ - * LOCAL hsTable, lFlag - * hsTable := { "one" => 1, "two" => 2 } - * // turn 'auto add' on for a new hash table, storing ol flag - * lFlag := hb_HAutoAdd( hsTable, .T. ) - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * HB_HSETAUTOADD() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HBINARY() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Sets the 'binary' flag for the hash table + $SYNTAX$ + HB_HBINARY( , [] ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() + + a logical value indicating to turn on or off + the 'binary' flag of the hash table + $RETURNS$ + The previous value of the 'binary' flag + $DESCRIPTION$ + This function is equivalent to HB_HBINARY() but it returns + the old flag value rather than the hash table + $EXAMPLES$ + LOCAL hsTable, lFlag + hsTable := { "one" => 1, "two" => 2 } + // turn 'binary' on for a new hash table, storing ol flag + lFlag := hb_HBinary( hsTable, .T. ) + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + HB_HSETBINARY() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * HB_HALLOCATE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Preallocates a hash table - * $SYNTAX$ - * HB_HALLOCATE( , ) - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * number of items to preallocate in the hash table - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HAUTOADD() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Sets the 'auto add' flag for the hash table + $SYNTAX$ + HB_HAUTOADD( , [] ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() + + a logical value indicating to turn on or off + the 'auto add' flag of the hash table + $RETURNS$ + The previous value of the 'auto add' flag + $DESCRIPTION$ + This function is equivalent to HB_HAUTOADD() but it returns + the old flag value rather than the hash table + $EXAMPLES$ + LOCAL hsTable, lFlag + hsTable := { "one" => 1, "two" => 2 } + // turn 'auto add' on for a new hash table, storing ol flag + lFlag := hb_HAutoAdd( hsTable, .T. ) + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + HB_HSETAUTOADD() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HDEFAULT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Returns/sets a default value for a hash table. - * $SYNTAX$ - * HB_HDEFAULT( , ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * - * $RETURNS$ - * The previous default value assigned to the hash table - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * TODO: locate and list those methods that use this feature - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + HB_HALLOCATE() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Preallocates a hash table + $SYNTAX$ + HB_HALLOCATE( , ) + $ARGUMENTS$ + a hash table, created by HB_HASH() + + number of items to preallocate in the hash table + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HSETAUTOADD() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Sets the 'auto add' flag for the hash table - * $SYNTAX$ - * HB_HSETAUTOADD( , [] ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * a logical value indicating to turn on or off - * the 'auto add' flag of the hash table - * $RETURNS$ - * The hash table - * $DESCRIPTION$ - * This function is equivalent to HB_HAUTOADD() but it returns - * the passed hash table rather than the old flag value - * $EXAMPLES$ - * LOCAL hsTable - * // turn 'auto add' on for a new hash table - * hsTable := hb_HSetAutoAdd( { "one" => 1, "two" => 2 }, .T. ) - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * HB_HAUTOADD(),HB_HSETBINARY(),HB_HSETCASEMATCH() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HDEFAULT() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Returns/sets a default value for a hash table. + $SYNTAX$ + HB_HDEFAULT( , ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() + + + $RETURNS$ + The previous default value assigned to the hash table + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + TODO: locate and list those methods that use this feature + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HSETCASEMATCH() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Sets the 'case match' flag for the hash table - * $SYNTAX$ - * HB_HSETCASEMATCH( , [] ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * a logical value indicating to turn on or off - * the 'case match' flag of the hash table - * $RETURNS$ - * The hash table - * $DESCRIPTION$ - * This function is equivalent to HB_HCASEMATCH() but it returns - * the passed hash table rather than the old flag value - * $EXAMPLES$ - * LOCAL hsTable - * // turn 'case match' on for a new hash table - * hsTable := hb_HSetCaseMatch( { "one" => 1, "two" => 2 }, .T. ) - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * HB_HCASEMATCH(),HB_HSETAUTOADD(),HB_HSETBINARY - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HSETAUTOADD() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Sets the 'auto add' flag for the hash table + $SYNTAX$ + HB_HSETAUTOADD( , [] ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() + + a logical value indicating to turn on or off + the 'auto add' flag of the hash table + $RETURNS$ + The hash table + $DESCRIPTION$ + This function is equivalent to HB_HAUTOADD() but it returns + the passed hash table rather than the old flag value + $EXAMPLES$ + LOCAL hsTable + // turn 'auto add' on for a new hash table + hsTable := hb_HSetAutoAdd( { "one" => 1, "two" => 2 }, .T. ) + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + HB_HAUTOADD(),HB_HSETBINARY(),HB_HSETCASEMATCH() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_HSETBINARY() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Hash table - * $ONELINER$ - * Sets the 'binary' flag for the hash table - * $SYNTAX$ - * HB_HSETBINARY( , [] ) -> - * $ARGUMENTS$ - * a hash table, created by HB_HASH() - * - * a logical value indicating to turn on or off - * the 'binary' flag of the hash table - * $RETURNS$ - * The hash table - * $DESCRIPTION$ - * This function is equivalent to HB_HBINARY() but it returns - * the passed hash table rather than the old flag value - * $EXAMPLES$ - * LOCAL hsTable - * // turn 'binary' on for a new hash table - * hsTable := hb_HSetBinary( { "one" => 1, "two" => 2 }, .T. ) - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * HB_HBINARY(),HB_HSETAUTOADD(),HB_HSETCASEMATCH - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HSETCASEMATCH() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Sets the 'case match' flag for the hash table + $SYNTAX$ + HB_HSETCASEMATCH( , [] ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() + + a logical value indicating to turn on or off + the 'case match' flag of the hash table + $RETURNS$ + The hash table + $DESCRIPTION$ + This function is equivalent to HB_HCASEMATCH() but it returns + the passed hash table rather than the old flag value + $EXAMPLES$ + LOCAL hsTable + // turn 'case match' on for a new hash table + hsTable := hb_HSetCaseMatch( { "one" => 1, "two" => 2 }, .T. ) + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + HB_HCASEMATCH(),HB_HSETAUTOADD(),HB_HSETBINARY + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_HSETBINARY() + $CATEGORY$ + API + $SUBCATEGORY$ + Hash table + $ONELINER$ + Sets the 'binary' flag for the hash table + $SYNTAX$ + HB_HSETBINARY( , [] ) -> + $ARGUMENTS$ + a hash table, created by HB_HASH() + + a logical value indicating to turn on or off + the 'binary' flag of the hash table + $RETURNS$ + The hash table + $DESCRIPTION$ + This function is equivalent to HB_HBINARY() but it returns + the passed hash table rather than the old flag value + $EXAMPLES$ + LOCAL hsTable + // turn 'binary' on for a new hash table + hsTable := hb_HSetBinary( { "one" => 1, "two" => 2 }, .T. ) + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + HB_HBINARY(),HB_HSETAUTOADD(),HB_HSETCASEMATCH + $END$ */ diff --git a/harbour/doc/en/hb_api.txt b/harbour/doc/en/hb_api.txt index d659a93580..3275532e49 100644 --- a/harbour/doc/en/hb_api.txt +++ b/harbour/doc/en/hb_api.txt @@ -15,7758 +15,7758 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_parc() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve a string parameter - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_parc( int iParam, ... ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * - * <...> - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_parclen() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve a string parameter length - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_parclen( int iParam, ... ) --> ( ULONG )ulResult - * $ARGUMENTS$ - * - * - * <...> - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_parcsiz() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve a by-reference string parameter length, including terminator - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_parcsiz( int iParam, ... ) --> ( ULONG )ulResult - * $ARGUMENTS$ - * - * - * <...> - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_pards() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve a date as a string yyyymmdd - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_pards( int iParam, ... ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * - * <...> - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_pardsbuff() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve a date as a string yyyymmdd - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_pardsbuff( char * szDate, int iParam, ... ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * - * - * - * <...> - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_parinfa() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve length or element type of an array parameter - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_parinfa( int iParamNum, ULONG uiArrayIndex ) --> ( ULONG )ulResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_parinfo() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Determine the param count or data type - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_parinfo( int iParam ) --> ( int )iResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_parl() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve a logical parameter as an int - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_parl( int iParam, ... ) --> ( int )iResult - * $ARGUMENTS$ - * - * - * <...> - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_parnd() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve a numeric parameter as a double - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_parnd( int iParam, ... ) --> ( double )dResult - * $ARGUMENTS$ - * - * - * <...> - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_parni() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve a numeric parameter as a integer - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_parni( int iParam, ... ) --> ( int )iResult - * $ARGUMENTS$ - * - * - * <...> - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_parnl() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve a numeric parameter as a long - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_parnl( int iParam, ... ) --> ( long )lResult - * $ARGUMENTS$ - * - * - * <...> - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_param() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve a direct pointer to an item parameter - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_param( int iParam, int iMask ) --> ( PHB_ITEM ) pResult - * $ARGUMENTS$ - * The 1-based parameter to retrieve. - * - * - * $RETURNS$ - * hb_param() returns a direct pointer to an item on the eval stack. - * - * $DESCRIPTION$ - * This item will be removed (set to NIL) after a function cleanup, - * so if the item needs to survive the current function (e.g. copied - * to a static) you should use hb_itemParam instead. - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_itemParam() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_pcount() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns the number of supplied parameters - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_pcount( void ) --> ( int )iResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * Note that when HB_API_MACROS is defined, this function is replaced with - * a macro: hb_pcount() --> ( ( int ) hb_stack.pBase->item.asSymbol.paramcnt ) - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_ret() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Post a NIL return value - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_ret( void ) --> void - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * Note that when HB_API_MACROS is defined, this function is replaced with - * a macro: hb_ret() --> hb_itemClear( &hb_stack.Return ) - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_retc() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns a string - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_retc( char * szText ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * Note that when HB_API_MACROS is defined, this function is replaced with - * a macro: hb_retc( szText ) --> hb_itemPutC( &hb_stack.Return, szText ) - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_retclen() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns a string with a specific length - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_retclen( char * szText, ULONG ulLen ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * Note that when HB_API_MACROS is defined, this function is replaced with - * a macro: hb_retclen( szText, ulLen ) --> hb_itemPutCL( &hb_stack.Return, szText, ulLen ) - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_retds() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns a date, must use yyyymmdd format - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_retds( char * szDate ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * Note that when HB_API_MACROS is defined, this function is replaced with - * a macro: hb_retds( szDate ) --> hb_itemPutDS( &hb_stack.Return, szDate ) - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_retd() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns a date - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_retd( long lYear, long lMonth, long lDay ) - * $ARGUMENTS$ - * - * - * - * - * - * $DESCRIPTION$ - * Note that when HB_API_MACROS is defined, this function is replaced with - * a macro: hb_retd( lYear, lMonth, lDay ) --> hb_itemPutD( &hb_stack.Return, lYear, lMonth, lDay ) - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_retdl() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns a long value as a julian date - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_retdl( long lJulian ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * Note that when HB_API_MACROS is defined, this function is replaced with - * a macro: hb_retdl( lJulian ) --> hb_itemPutDL( &hb_stack.Return, lJulian ) - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_retl() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns a logical integer - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_retl( int iTrueFalse ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * Note that when HB_API_MACROS is defined, this function is replaced with - * a macro: hb_retl( iLogical ) --> hb_itemPutL( &hb_stack.Return, iLogical ? HB_TRUE : HB_FALSE ) - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_retnd() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns a double - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_retnd( double dNumber ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * Note that when HB_API_MACROS is defined, this function is replaced with - * a macro: hb_retnd( dNumber ) --> hb_itemPutND( &hb_stack.Return, dNumber ) - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_retni() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns a integer number - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_retni( int iNumber ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * Note that when HB_API_MACROS is defined, this function is replaced with - * a macro: hb_retni( iNumber ) --> hb_itemPutNI( &hb_stack.Return, iNumber ) - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_retnl() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns a long number - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_retnl( long lNumber ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * Note that when HB_API_MACROS is defined, this function is replaced with - * a macro: hb_retnl( lNumber ) --> hb_itemPutNL( &hb_stack.Return, lNumber ) - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_retnlen() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns a double, with specific width and decimals - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_retnlen( double dNumber, int iWidth, int iDec ) - * $ARGUMENTS$ - * - * - * - * - * - * $DESCRIPTION$ - * Note that when HB_API_MACROS is defined, this function is replaced with - * a macro: hb_retnlen( dNumber, iWidth, iDec ) --> hb_itemPutNLen( &hb_stack.Return, dNumber, iWidth, iDec ) - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_retndlen() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns a double, with specific width and decimals - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_retndlen( double dNumber, int iWidth, int iDec ) - * $ARGUMENTS$ - * - * - * - * - * - * $DESCRIPTION$ - * Note that when HB_API_MACROS is defined, this function is replaced with - * a macro: hb_retndlen( dNumber, iWidth, iDec ) --> hb_itemPutNDLen( &hb_stack.Return, dNumber, iWidth, iDec ) - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_retnilen() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns a integer number, with specific width - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_retnilen( int iNumber, int iWidth ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * Note that when HB_API_MACROS is defined, this function is replaced with - * a macro: hb_retnilen( iNumber, iWidth ) --> hb_itemPutNILen( &hb_stack.Return, iNumber, iWidth ) - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_retnllen() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns a long number, with specific width - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_retnllen( long lNumber, int iWidth ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * Note that when HB_API_MACROS is defined, this function is replaced with - * a macro: hb_retnllen( lNumber, iWidth ) --> hb_itemPutNLLen( &hb_stack.Return, lNumber, iWidth ) - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_reta() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns an array with a specific length - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_reta( ULONG ulLen ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * Note that when HB_API_MACROS is defined, this function is replaced with - * a macro: hb_reta( ulLen ) --> hb_arrayNew( &hb_stack.Return, ulLen ) - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_storc() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Stores a szString on a variable by reference - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_storc( char * szText, int iParam, ... ) - * $ARGUMENTS$ - * - * - * - * - * <...> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_storclen() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Stores a fixed length string on a variable by reference - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_storclen( char * szText, ULONG ulLength, int iParam, ... ) - * $ARGUMENTS$ - * - * - * - * - * - * - * <...> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_stords() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * SzDate must have yyyymmdd format - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_stords( char * szDate, int iParam, ... ) - * $ARGUMENTS$ - * - * - * - * - * <...> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_storl() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Stores a logical integer on a variable by reference - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_storl( int iLogical, int iParam, ... ) - * $ARGUMENTS$ - * - * - * - * - * <...> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_storni() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Stores an integer on a variable by reference - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_storni( int iValue, int iParam, ... ) - * $ARGUMENTS$ - * - * - * - * - * <...> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_stornl() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Stores a long on a variable by reference - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_stornl( long lValue, int iParam, ... ) - * $ARGUMENTS$ - * - * - * - * - * <...> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_stornd() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Stores a double on a variable by reference - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_stornd( double dValue, int iParam, ... ) - * $ARGUMENTS$ - * - * - * - * - * <...> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_xinit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Initialize fixed memory subsystem - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_xinit( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_xexit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Deinitialize fixed memory subsystem - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_xexit( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_xalloc() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Allocates memory, returns NULL on failure - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_xalloc( ULONG ulSize ) --> ( void * )pResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_xgrab() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Allocates memory, exits on failure - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_xgrab( ULONG ulSize ) --> ( void * )pResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_xfree() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Frees memory - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_xfree( void * pMem ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_xrealloc() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Reallocates memory - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_xrealloc( void * pMem, ULONG ulSize ) --> ( void * )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_xsize() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns the size of an allocated memory block - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_xsize( void * pMem ) --> ( ULONG )ulResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_xquery() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Query different types of memory information - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_xquery( USHORT uiMode ) --> ( ULONG )ulResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_xmemcpy() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Copy more than memcpy() can - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_xmemcpy( void * pDestArg, void * pSourceArg, ULONG ulLen ) --> ( void * )pResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * If UINT_MAX is defined as ULONG_MAX then this function is replaced - * by a macro replacement to memcpy() - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_xmemset() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Set more than memset() can - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_xmemset( void * pDestArg, int iFill, ULONG ulLen ) --> ( void * )pResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * If UINT_MAX is defined as ULONG_MAX then this function is replaced - * by a macro replacement to memset() - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayNew() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Creates a new array - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayNew( PHB_ITEM pItem, ULONG ulLen ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayLen() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrives the array len - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayLen( PHB_ITEM pArray ) --> ( ULONG )ulResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayIsObject() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrives if the array is an object - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayIsObject( PHB_ITEM pArray ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayAdd() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Add a new item to the end of an array item - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayAdd( PHB_ITEM pArray, PHB_ITEM pItemValue ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayIns() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Insert a nil item into an array, without changing the length - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayIns( PHB_ITEM pArray, ULONG ulIndex ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayDel() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Delete an array item, without changing length - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayDel( PHB_ITEM pArray, ULONG ulIndex ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arraySize() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Sets the array total length - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arraySize( PHB_ITEM pArray, ULONG ulLen ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayLast() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve last item in an array - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayLast( PHB_ITEM pArray, PHB_ITEM pResult ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayRelease() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Releases an array - don't call it - use ItemRelease() !!! - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayRelease( PHB_ITEM pArray ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arraySet() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Sets an array element - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arraySet( PHB_ITEM pArray, ULONG ulIndex, PHB_ITEM pItem ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayGet() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieves an item - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayGet( PHB_ITEM pArray, ULONG ulIndex, PHB_ITEM pItem ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayGetItemPtr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns pointer to specified element of the array - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayGetItemPtr( PHB_ITEM pArray, ULONG ulIndex ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayCopyC() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Copy a string into an array item - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayCopyC( PHB_ITEM pArray, ULONG ulIndex, char * szBuffer, ULONG ulLen ) --> ( ULONG )ulResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayGetC() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieves the string contained on an array element - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayGetC( PHB_ITEM pArray, ULONG ulIndex ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayGetCPtr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieves the string pointer on an array element - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayGetCPtr( PHB_ITEM pArray, ULONG ulIndex ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayGetCLen() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieves the string length contained on an array element - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayGetCLen( PHB_ITEM pArray, ULONG ulIndex ) --> ( ULONG )ulResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayGetL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieves the logical value contained on an array element - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayGetL( PHB_ITEM pArray, ULONG ulIndex ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayGetNI() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieves the int value contained on an array element - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayGetNI( PHB_ITEM pArray, ULONG ulIndex ) --> ( int )iResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayGetNL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieves the long numeric value contained on an array element - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayGetNL( PHB_ITEM pArray, ULONG ulIndex ) --> ( long )lResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayGetND() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieves the double value contained on an array element - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayGetND( PHB_ITEM pArray, ULONG ulIndex ) --> ( double )dResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayGetDS() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieves the date value contained in an array element - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayGetDS( PHB_ITEM pArray, ULONG ulIndex, char * szDate ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayGetDL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieves the date value contained in an array element, as a long integer - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayGetDL( PHB_ITEM pArray, ULONG ulIndex ) --> ( long )lResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayGetType() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieves the type of an array item - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayGetType( PHB_ITEM pArray, ULONG ulIndex ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayFill() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Fill an array with a given item - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayFill( PHB_ITEM pArray, PHB_ITEM pValue, ULONG * pulStart, ULONG * pulCount ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayScan() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Scan an array for a given item, or until code-block item returns TRUE - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayScan( PHB_ITEM pArray, PHB_ITEM pValue, ULONG * pulStart, ULONG * pulCount ) --> ( ULONG )ulResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayEval() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Execute a code-block for every element of an array item - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayEval( PHB_ITEM pArray, PHB_ITEM bBlock, ULONG * pulStart, ULONG * pulCount ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayCopy() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Copy items from one array to another - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayCopy( PHB_ITEM pSrcArray, PHB_ITEM pDstArray, ULONG * pulStart, ULONG * pulCount, ULONG * pulTarget ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arrayClone() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns a duplicate of an existing array, including all nested items - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayClone( PHB_ITEM pArray ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_arraySort() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Sorts an array item - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arraySort( PHB_ITEM pArray, ULONG * pulStart, ULONG * pulCount, PHB_ITEM pBlock ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_stricmp() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Compare two strings without regards to case - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_stricmp( const char * s1, const char * s2 ) --> ( int )iResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_strnicmp() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Compare two string without regards to case, limited by length - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_strnicmp( const char * s1, const char * s2, ULONG ulLen ) --> ( int )iResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_strupr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Convert a string in-place to upper-case - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_strupr( char * pszText ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_strdup() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns a pointer to a newly allocated copy of the source string - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_strdup( const char * pszText ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_strMatchRegExp() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Compare two strings using a regular expression pattern - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_strMatchRegExp( const char * szString, const char * szMask ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_strEmpty() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns whether a string contains only white space - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_strEmpty( const char * szText, ULONG ulLen ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_strDescend() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Copy a string to a buffer, inverting each character - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_strDescend( char * szStringTo, const char * szStringFrom, ULONG ulLen ) - * $ARGUMENTS$ - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_strAt() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns an index to a sub-string within another string - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_strAt( const char * szSub, ULONG ulSubLen, const char * szText, ULONG ulLen ) --> ( ULONG )ulResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_strUpper() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Convert an existing string buffer to upper case - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_strUpper( char * szText, ULONG ulLen ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_strLower() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Convert an existing string buffer to lower case - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_strLower( char * szText, ULONG ulLen ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_strncpyUpper() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Copy an existing string buffer to another buffer, as upper case - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_strncpyUpper( char * pDest, const char * pSource, ULONG ulLen ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_strVal() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Return the numeric value of a character string representation of a number - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_strVal( const char * szText, ULONG ulLen ) --> ( double )dResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_strLTrim() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Return a pointer to the first non-white space character - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_strLTrim( const char * szText, ULONG * ulLen ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_strRTrimLen() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Return length of a string, ignoring trailing white space (or true spaces) - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_strRTrimLen( const char * szText, ULONG ulLen, HB_BOOL bAnySpace ) --> ( ULONG )ulResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_numRound() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Round a number to a specific number of digits - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_numRound( double dResult, int iDec ) --> ( double )dResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_clsReleaseAll() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Releases all defined classes - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_clsReleaseAll( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_objGetClsName() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieves an object class name - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_objGetClsName( PHB_ITEM pObject ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_objGetMethod() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns the method pointer of a object class - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_objGetMethod( PHB_ITEM pObject, PHB_SYMB pSymMsg ) --> ( PHB_FUNC )hResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_objHasMsg() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns TRUE/FALSE whether szString is an existing message for object - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_objHasMsg( PHB_ITEM pObject, char * szString ) --> ( ULONG )ulResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_dynsymGet() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Finds and creates a dynamic symbol if not found - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_dynsymGet( char * szName ) --> ( PHB_DYNS )hResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_dynsymNew() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Creates a new dynamic symbol based on a local one - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_dynsymNew( PHB_SYMB pSymbol ) --> ( PHB_DYNS )hResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_dynsymFind() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Finds a dynamic symbol - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_dynsymFind( char * szName ) --> ( PHB_DYNS )hResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_dynsymFindName() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Converts to uppercase and finds a dynamic symbol - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_dynsymFindName( char * szName ) --> ( PHB_DYNS )hResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_dynsymLog() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Displays all dynamic symbols - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_dynsymLog( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_dynsymRelease() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Releases the memory of the dynamic symbol table - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_dynsymRelease( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_dynsymEval() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Enumerates all dynamic symbols - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_dynsymEval( PHB_DYNS_FUNC pFunction, void * Cargo ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_cmdargInit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Initialize command line argument API's - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_cmdargInit( int argc, char * argv[] ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_cmdargARGC() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve command line argument count - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_cmdargARGC( void ) --> ( int )iResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_cmdargARGV() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve command line argument buffer pointer - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_cmdargARGV( void ) --> ( char ** )ppszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_cmdargIsInternal() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Determine if a string is an internal setting - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_cmdargIsInternal( const char * szArg ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_cmdargCheck() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Check if a given internal switch (like //INFO) was set - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_cmdargCheck( const char * pszName ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_cmdargString() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns the string value of an internal switch (like //TEMPPATH:"C:\") - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_cmdargString( const char * pszName ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_cmdargNum() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Returns the numeric value of an internal switch (like //F:90) - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_cmdargNum( const char * pszName ) --> ( int )iResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_cmdargProcessVM() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Check for command line internal arguments - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_cmdargProcessVM( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_symbolNew() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Create a new symbol - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_symbolNew( char * szName ) --> ( PHB_SYMB )hResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_codeblockNew() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Create a code-block - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_codeblockNew( BYTE * pBuffer, USHORT uiLocals, USHORT * pLocalPosTable, PHB_SYMB pSymbols ) --> ( HB_CODEBLOCK_PTR )hResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_codeblockMacroNew() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_codeblockMacroNew( BYTE * pBuffer, USHORT usLen ) --> ( HB_CODEBLOCK_PTR )hResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_codeblockDelete() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Delete a codeblock - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_codeblockDelete( PHB_ITEM pItem ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_codeblockGetVar() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Get local variable referenced in a codeblock - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_codeblockGetVar( PHB_ITEM pItem, LONG iItemPos ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_codeblockGetRef() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Get local variable passed by reference - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_codeblockGetRef( PHB_ITEM pItem, PHB_ITEM pRefer ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_codeblockEvaluate() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Evaluate a codeblock - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_codeblockEvaluate( PHB_ITEM pItem ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_codeblockCopy() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Copy a codeblock - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_codeblockCopy( PHB_ITEM pDest, PHB_ITEM pSource ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_memvarValueNew() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Create a new global value - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_memvarValueNew( PHB_ITEM pSource, HB_BOOL bTrueMemvar ) --> ( HB_HANDLE )hResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_memvarValueBaseAddress() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve the base address of the values table - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_memvarValueBaseAddress( void ) --> ( HB_VALUE_PTR * )phResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_memvarsInit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Initialize the memvar API system - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_memvarsInit( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_memvarsRelease() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Clear all PUBLIC and PRIVATE variables - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_memvarsRelease( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_memvarsFree() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Release the memvar API system - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_memvarsFree( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_memvarValueIncRef() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Increase the reference count of a global value - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_memvarValueIncRef( HB_HANDLE hValue ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_memvarValueDecRef() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Decrease the reference count of a global value - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_memvarValueDecRef( HB_HANDLE hValue ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_memvarSetValue() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Copy an item into a symbol - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_memvarSetValue( PHB_SYMB pMemvarSymb, PHB_ITEM pItem ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_memvarGet() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Copy an symbol value into an item - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_memvarGet( PHB_ITEM pItem, PHB_SYMB pMemvarSymb ) --> ( HB_ERRCODE )hResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_memvarGetValue() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Copy an symbol value into an item, with error trapping - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_memvarGetValue( PHB_ITEM pItem, PHB_SYMB pMemvarSymb ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_memvarGetRefer() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Copy a reference to a symbol value into an item, with error trapping - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_memvarGetRefer( PHB_ITEM pItem, PHB_SYMB pMemvarSymb ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_memvarGetPrivatesBase() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve current PRIVATE variables stack base - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_memvarGetPrivatesBase( void ) --> ( ULONG )ulResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_memvarSetPrivatesBase() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Release PRIVATE variables created after specified base - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_memvarSetPrivatesBase( ULONG ulBase ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_memvarNewParameter() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_memvarNewParameter( PHB_SYMB pSymbol, PHB_ITEM pValue ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_memvarGetStrValuePtr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_memvarGetStrValuePtr( char * szVarName, ULONG *pulLen ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * - * <*pulLen> - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_memvarCreateFromItem() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_memvarCreateFromItem( PHB_ITEM pMemvar, BYTE bScope, PHB_ITEM pValue ) - * $ARGUMENTS$ - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_memvarScope() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve scope of a dynamic variable symbol - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_memvarScope( char * szVarName, ULONG ulLength ) --> ( int )iResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_conInit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Initialize the console API system - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_conInit( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_conRelease() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Release the console API system - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_conRelease( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_conNewLine() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve a pointer to a static buffer containing new-line characters - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_conNewLine( void ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_conOutStd() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Output an string to STDOUT - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_conOutStd( char * pStr, ULONG ulLen ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_conOutErr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Output an string to STDERR - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_conOutErr( char * pStr, ULONG ulLen ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_conSetCursor() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve and optionally set cursor shape - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_conSetCursor( HB_BOOL bSetCursor, USHORT usNewCursor ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_conSetColor() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve and optionally set console color - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_conSetColor( char * szColor ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_conXSaveRestRelease() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Release the save/restore API - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_conXSaveRestRelease( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_compReservedName() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Determines if a string contains a reserve word - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_compReservedName( char * szName ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_procname() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve a procedure name into a buffer - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_procname( int iLevel, char * szName ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_macroGetValue() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieve results of a macro expansion - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_macroGetValue( PHB_ITEM pItem ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_macroSetValue() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Assign a value to a macro-expression item - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_macroSetValue( PHB_ITEM pItem ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_macroTextValue() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Macro text substitution - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_macroTextValue( PHB_ITEM pItem ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_macroPushSymbol() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Handle a macro function calls, e.g. var := ¯o() - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_macroPushSymbol( PHB_ITEM pItem ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_macroRun() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Executes pcode compiled by macro compiler - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_macroRun( HB_MACRO_PTR pMacro ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_macroCompile() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Compile a string and return a pcode buffer - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_macroCompile( char * szString ) --> ( HB_MACRO_PTR )hResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_macroDelete() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Release all memory allocated for macro evaluation - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_macroDelete( HB_MACRO_PTR pMacro ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_macroTextSubst() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Substitute macro variables occurences within a given string - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_macroTextSubst( char * szString, ULONG *pulStringLen ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * - * <*pulStringLen> - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_macroIsIdent() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Determine if a string is a valid function or variable name - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_macroIsIdent( char * szString ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_macroPopAliasedValue() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Compiles and evaluates an aliased macro expression - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_macroPopAliasedValue( PHB_ITEM pAlias, PHB_ITEM pVar ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_macroPushAliasedValue() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Compiles and evaluates an aliased macro expression - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_macroPushAliasedValue( PHB_ITEM pAlias, PHB_ITEM pVar ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_macroGetType() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Determine the type of an expression - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_macroGetType( PHB_ITEM pItem ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gcAlloc() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Allocates a memory controlled by the garbage collector - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_gcAlloc( ULONG ulSize, HB_GARBAGE_FUNC_PTR pFunc ) --> ( void * )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gcFree() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Deallocates a memory allocated by the garbage collector - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_gcFree( void *pAlloc ) - * $ARGUMENTS$ - * <*pAlloc> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gcLock() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Do not release passed memory block - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_gcLock( void *pAlloc ) --> ( void * )pResult - * $ARGUMENTS$ - * <*pAlloc> - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gcUnlock() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Passed block is allowed to be released - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_gcUnlock( void *pAlloc ) --> ( void * )pResult - * $ARGUMENTS$ - * <*pAlloc> - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gcLockItem() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Do not release a memory block stored inside an item - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_gcLockItem( PHB_ITEM pItem ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gcUnlockItem() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Allow to release the item - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_gcUnlockItem( PHB_ITEM pItem ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gcCollect() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Checks if a single memory block can be released - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_gcCollect( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gcCollectAll() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Checks if all memory blocks can be released - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_gcCollectAll( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gcItemRef() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Checks if passed item refers passed memory block pointer - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_gcItemRef( PHB_ITEM pItem ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmIsLocalRef() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * hvm.c - mark all local variables as used - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_vmIsLocalRef( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmIsStaticRef() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * hvm.c - mark all static variables as used - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_vmIsStaticRef( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_memvarsIsMemvarRef() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * memvars.c - mark all memvar variables as used - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_memvarsIsMemvarRef( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_clsIsClassRef() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * classes.c - mark all class internals as used - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_clsIsClassRef( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_codeblockDeleteGarbage() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Clear a codeblock before releasing by the GC - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_codeblockDeleteGarbage( void * Cargo ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_arrayReleaseGarbage() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Clear an array before releasing by the GC - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_arrayReleaseGarbage( void * Cargo ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_idleState() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Services a single idle state - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_idleState( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_idleReset() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Services a single idle state - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_idleReset( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_idleShutDown() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Closes all background tasks - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_idleShutDown( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_verPlatform() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieves a newly allocated buffer containing platform version - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_verPlatform( void ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_verCompiler() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieves a newly allocated buffer containing compiler version - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_verCompiler( void ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_verHarbour() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Retrieves a newly allocated buffer containing harbour version - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_verHarbour( void ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_verBuildInfo() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Display harbour, compiler, and platform versions to standard console - * $SYNTAX$ - * C Prototype - * - * #include "hbapi.h" - * hb_verBuildInfo( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_IS_OF_TYPE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * HB_IS_OF_TYPE( p, t ) --> type & ~HB_IT_BYREF ) == t )> - * $ARGUMENTS$ - *

- * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_IS_BYREF() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * HB_IS_BYREF( p ) --> type & HB_IT_BYREF )> - * $ARGUMENTS$ - *

- * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_IS_ARRAY() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * HB_IS_ARRAY( p ) --> - * $ARGUMENTS$ - *

- * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_IS_NIL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * HB_IS_NIL( p ) --> - * $ARGUMENTS$ - *

- * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_IS_BLOCK() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * HB_IS_BLOCK( p ) --> - * $ARGUMENTS$ - *

- * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_IS_DATE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * HB_IS_DATE( p ) --> - * $ARGUMENTS$ - *

- * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_IS_DOUBLE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * HB_IS_DOUBLE( p ) --> - * $ARGUMENTS$ - *

- * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_IS_INTEGER() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * HB_IS_INTEGER( p ) --> - * $ARGUMENTS$ - *

- * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_IS_LOGICAL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * HB_IS_LOGICAL( p ) --> - * $ARGUMENTS$ - *

- * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_IS_LONG() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * HB_IS_LONG( p ) --> - * $ARGUMENTS$ - *

- * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_IS_NUMERIC() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * HB_IS_NUMERIC( p ) --> type & HB_IT_NUMERIC )> - * $ARGUMENTS$ - *

- * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_IS_OBJECT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * HB_IS_OBJECT( p ) --> - * $ARGUMENTS$ - *

- * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_IS_STRING() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * HB_IS_STRING( p ) --> type & ~( HB_IT_BYREF | HB_IT_MEMOFLAG ) ) == HB_IT_STRING )> - * $ARGUMENTS$ - *

- * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_IS_MEMO() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * HB_IS_MEMO( p ) --> - * $ARGUMENTS$ - *

- * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_IS_SYMBOL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * HB_IS_SYMBOL( p ) --> - * $ARGUMENTS$ - *

- * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_IS_MEMVAR() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * HB_IS_MEMVAR( p ) --> - * $ARGUMENTS$ - *

- * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_IS_POINTER() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * HB_IS_POINTER( p ) --> - * $ARGUMENTS$ - *

- * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ISNIL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * NOTE: Intentionally using a different method - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * ISNIL( n ) --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ISCHAR() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * ISCHAR( n ) --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ISNUM() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * ISNUM( n ) --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ISLOG() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * ISLOG( n ) --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ISDATE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * ISDATE( n ) --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ISMEMO() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * ISMEMO( n ) --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ISBYREF() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * NOTE: Intentionally using a different method - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * ISBYREF( n ) --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ISARRAY() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * ISARRAY( n ) --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ISOBJECT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * ISOBJECT( n ) --> asArray.value->uiClass != 0 )> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ISBLOCK() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Not available in CA-Cl*pper. - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * ISBLOCK( n ) --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ISPOINTER() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * Not available in CA-Cl*pper. - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * ISPOINTER( n ) --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_ISSPACE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapi.h" - * HB_ISSPACE( c ) --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapi.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_parc() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve a string parameter + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_parc( int iParam, ... ) --> ( char * )pszResult + $ARGUMENTS$ + + + <...> + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_parclen() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve a string parameter length + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_parclen( int iParam, ... ) --> ( ULONG )ulResult + $ARGUMENTS$ + + + <...> + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_parcsiz() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve a by-reference string parameter length, including terminator + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_parcsiz( int iParam, ... ) --> ( ULONG )ulResult + $ARGUMENTS$ + + + <...> + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_pards() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve a date as a string yyyymmdd + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_pards( int iParam, ... ) --> ( char * )pszResult + $ARGUMENTS$ + + + <...> + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_pardsbuff() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve a date as a string yyyymmdd + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_pardsbuff( char * szDate, int iParam, ... ) --> ( char * )pszResult + $ARGUMENTS$ + + + + + <...> + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_parinfa() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve length or element type of an array parameter + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_parinfa( int iParamNum, ULONG uiArrayIndex ) --> ( ULONG )ulResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_parinfo() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Determine the param count or data type + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_parinfo( int iParam ) --> ( int )iResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_parl() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve a logical parameter as an int + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_parl( int iParam, ... ) --> ( int )iResult + $ARGUMENTS$ + + + <...> + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_parnd() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve a numeric parameter as a double + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_parnd( int iParam, ... ) --> ( double )dResult + $ARGUMENTS$ + + + <...> + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_parni() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve a numeric parameter as a integer + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_parni( int iParam, ... ) --> ( int )iResult + $ARGUMENTS$ + + + <...> + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_parnl() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve a numeric parameter as a long + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_parnl( int iParam, ... ) --> ( long )lResult + $ARGUMENTS$ + + + <...> + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_param() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve a direct pointer to an item parameter + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_param( int iParam, int iMask ) --> ( PHB_ITEM ) pResult + $ARGUMENTS$ + The 1-based parameter to retrieve. + + + $RETURNS$ + hb_param() returns a direct pointer to an item on the eval stack. + + $DESCRIPTION$ + This item will be removed (set to NIL) after a function cleanup, + so if the item needs to survive the current function (e.g. copied + to a static) you should use hb_itemParam instead. + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + hb_itemParam() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_pcount() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns the number of supplied parameters + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_pcount( void ) --> ( int )iResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + Note that when HB_API_MACROS is defined, this function is replaced with + a macro: hb_pcount() --> ( ( int ) hb_stack.pBase->item.asSymbol.paramcnt ) + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_ret() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Post a NIL return value + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_ret( void ) --> void + $ARGUMENTS$ + + $DESCRIPTION$ + Note that when HB_API_MACROS is defined, this function is replaced with + a macro: hb_ret() --> hb_itemClear( &hb_stack.Return ) + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_retc() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns a string + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_retc( char * szText ) + $ARGUMENTS$ + + $DESCRIPTION$ + Note that when HB_API_MACROS is defined, this function is replaced with + a macro: hb_retc( szText ) --> hb_itemPutC( &hb_stack.Return, szText ) + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_retclen() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns a string with a specific length + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_retclen( char * szText, ULONG ulLen ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + Note that when HB_API_MACROS is defined, this function is replaced with + a macro: hb_retclen( szText, ulLen ) --> hb_itemPutCL( &hb_stack.Return, szText, ulLen ) + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_retds() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns a date, must use yyyymmdd format + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_retds( char * szDate ) + $ARGUMENTS$ + + $DESCRIPTION$ + Note that when HB_API_MACROS is defined, this function is replaced with + a macro: hb_retds( szDate ) --> hb_itemPutDS( &hb_stack.Return, szDate ) + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_retd() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns a date + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_retd( long lYear, long lMonth, long lDay ) + $ARGUMENTS$ + + + + + + $DESCRIPTION$ + Note that when HB_API_MACROS is defined, this function is replaced with + a macro: hb_retd( lYear, lMonth, lDay ) --> hb_itemPutD( &hb_stack.Return, lYear, lMonth, lDay ) + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_retdl() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns a long value as a julian date + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_retdl( long lJulian ) + $ARGUMENTS$ + + $DESCRIPTION$ + Note that when HB_API_MACROS is defined, this function is replaced with + a macro: hb_retdl( lJulian ) --> hb_itemPutDL( &hb_stack.Return, lJulian ) + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_retl() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns a logical integer + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_retl( int iTrueFalse ) + $ARGUMENTS$ + + $DESCRIPTION$ + Note that when HB_API_MACROS is defined, this function is replaced with + a macro: hb_retl( iLogical ) --> hb_itemPutL( &hb_stack.Return, iLogical ? HB_TRUE : HB_FALSE ) + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_retnd() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns a double + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_retnd( double dNumber ) + $ARGUMENTS$ + + $DESCRIPTION$ + Note that when HB_API_MACROS is defined, this function is replaced with + a macro: hb_retnd( dNumber ) --> hb_itemPutND( &hb_stack.Return, dNumber ) + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_retni() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns a integer number + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_retni( int iNumber ) + $ARGUMENTS$ + + $DESCRIPTION$ + Note that when HB_API_MACROS is defined, this function is replaced with + a macro: hb_retni( iNumber ) --> hb_itemPutNI( &hb_stack.Return, iNumber ) + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_retnl() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns a long number + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_retnl( long lNumber ) + $ARGUMENTS$ + + $DESCRIPTION$ + Note that when HB_API_MACROS is defined, this function is replaced with + a macro: hb_retnl( lNumber ) --> hb_itemPutNL( &hb_stack.Return, lNumber ) + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_retnlen() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns a double, with specific width and decimals + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_retnlen( double dNumber, int iWidth, int iDec ) + $ARGUMENTS$ + + + + + + $DESCRIPTION$ + Note that when HB_API_MACROS is defined, this function is replaced with + a macro: hb_retnlen( dNumber, iWidth, iDec ) --> hb_itemPutNLen( &hb_stack.Return, dNumber, iWidth, iDec ) + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_retndlen() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns a double, with specific width and decimals + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_retndlen( double dNumber, int iWidth, int iDec ) + $ARGUMENTS$ + + + + + + $DESCRIPTION$ + Note that when HB_API_MACROS is defined, this function is replaced with + a macro: hb_retndlen( dNumber, iWidth, iDec ) --> hb_itemPutNDLen( &hb_stack.Return, dNumber, iWidth, iDec ) + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_retnilen() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns a integer number, with specific width + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_retnilen( int iNumber, int iWidth ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + Note that when HB_API_MACROS is defined, this function is replaced with + a macro: hb_retnilen( iNumber, iWidth ) --> hb_itemPutNILen( &hb_stack.Return, iNumber, iWidth ) + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_retnllen() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns a long number, with specific width + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_retnllen( long lNumber, int iWidth ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + Note that when HB_API_MACROS is defined, this function is replaced with + a macro: hb_retnllen( lNumber, iWidth ) --> hb_itemPutNLLen( &hb_stack.Return, lNumber, iWidth ) + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_reta() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns an array with a specific length + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_reta( ULONG ulLen ) + $ARGUMENTS$ + + $DESCRIPTION$ + Note that when HB_API_MACROS is defined, this function is replaced with + a macro: hb_reta( ulLen ) --> hb_arrayNew( &hb_stack.Return, ulLen ) + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_storc() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Stores a szString on a variable by reference + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_storc( char * szText, int iParam, ... ) + $ARGUMENTS$ + + + + + <...> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_storclen() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Stores a fixed length string on a variable by reference + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_storclen( char * szText, ULONG ulLength, int iParam, ... ) + $ARGUMENTS$ + + + + + + + <...> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_stords() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + SzDate must have yyyymmdd format + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_stords( char * szDate, int iParam, ... ) + $ARGUMENTS$ + + + + + <...> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_storl() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Stores a logical integer on a variable by reference + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_storl( int iLogical, int iParam, ... ) + $ARGUMENTS$ + + + + + <...> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_storni() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Stores an integer on a variable by reference + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_storni( int iValue, int iParam, ... ) + $ARGUMENTS$ + + + + + <...> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_stornl() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Stores a long on a variable by reference + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_stornl( long lValue, int iParam, ... ) + $ARGUMENTS$ + + + + + <...> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_stornd() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Stores a double on a variable by reference + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_stornd( double dValue, int iParam, ... ) + $ARGUMENTS$ + + + + + <...> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_xinit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Initialize fixed memory subsystem + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_xinit( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_xexit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Deinitialize fixed memory subsystem + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_xexit( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_xalloc() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Allocates memory, returns NULL on failure + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_xalloc( ULONG ulSize ) --> ( void * )pResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_xgrab() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Allocates memory, exits on failure + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_xgrab( ULONG ulSize ) --> ( void * )pResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_xfree() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Frees memory + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_xfree( void * pMem ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_xrealloc() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Reallocates memory + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_xrealloc( void * pMem, ULONG ulSize ) --> ( void * )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_xsize() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns the size of an allocated memory block + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_xsize( void * pMem ) --> ( ULONG )ulResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_xquery() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Query different types of memory information + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_xquery( USHORT uiMode ) --> ( ULONG )ulResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_xmemcpy() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Copy more than memcpy() can + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_xmemcpy( void * pDestArg, void * pSourceArg, ULONG ulLen ) --> ( void * )pResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + If UINT_MAX is defined as ULONG_MAX then this function is replaced + by a macro replacement to memcpy() + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_xmemset() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Set more than memset() can + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_xmemset( void * pDestArg, int iFill, ULONG ulLen ) --> ( void * )pResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + If UINT_MAX is defined as ULONG_MAX then this function is replaced + by a macro replacement to memset() + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayNew() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Creates a new array + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayNew( PHB_ITEM pItem, ULONG ulLen ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayLen() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrives the array len + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayLen( PHB_ITEM pArray ) --> ( ULONG )ulResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayIsObject() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrives if the array is an object + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayIsObject( PHB_ITEM pArray ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayAdd() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Add a new item to the end of an array item + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayAdd( PHB_ITEM pArray, PHB_ITEM pItemValue ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayIns() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Insert a nil item into an array, without changing the length + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayIns( PHB_ITEM pArray, ULONG ulIndex ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayDel() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Delete an array item, without changing length + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayDel( PHB_ITEM pArray, ULONG ulIndex ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arraySize() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Sets the array total length + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arraySize( PHB_ITEM pArray, ULONG ulLen ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayLast() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve last item in an array + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayLast( PHB_ITEM pArray, PHB_ITEM pResult ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayRelease() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Releases an array - don't call it - use ItemRelease() !!! + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayRelease( PHB_ITEM pArray ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arraySet() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Sets an array element + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arraySet( PHB_ITEM pArray, ULONG ulIndex, PHB_ITEM pItem ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayGet() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieves an item + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayGet( PHB_ITEM pArray, ULONG ulIndex, PHB_ITEM pItem ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayGetItemPtr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns pointer to specified element of the array + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayGetItemPtr( PHB_ITEM pArray, ULONG ulIndex ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayCopyC() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Copy a string into an array item + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayCopyC( PHB_ITEM pArray, ULONG ulIndex, char * szBuffer, ULONG ulLen ) --> ( ULONG )ulResult + $ARGUMENTS$ + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayGetC() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieves the string contained on an array element + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayGetC( PHB_ITEM pArray, ULONG ulIndex ) --> ( char * )pszResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayGetCPtr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieves the string pointer on an array element + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayGetCPtr( PHB_ITEM pArray, ULONG ulIndex ) --> ( char * )pszResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayGetCLen() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieves the string length contained on an array element + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayGetCLen( PHB_ITEM pArray, ULONG ulIndex ) --> ( ULONG )ulResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayGetL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieves the logical value contained on an array element + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayGetL( PHB_ITEM pArray, ULONG ulIndex ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayGetNI() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieves the int value contained on an array element + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayGetNI( PHB_ITEM pArray, ULONG ulIndex ) --> ( int )iResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayGetNL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieves the long numeric value contained on an array element + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayGetNL( PHB_ITEM pArray, ULONG ulIndex ) --> ( long )lResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayGetND() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieves the double value contained on an array element + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayGetND( PHB_ITEM pArray, ULONG ulIndex ) --> ( double )dResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayGetDS() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieves the date value contained in an array element + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayGetDS( PHB_ITEM pArray, ULONG ulIndex, char * szDate ) --> ( char * )pszResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayGetDL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieves the date value contained in an array element, as a long integer + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayGetDL( PHB_ITEM pArray, ULONG ulIndex ) --> ( long )lResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayGetType() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieves the type of an array item + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayGetType( PHB_ITEM pArray, ULONG ulIndex ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayFill() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Fill an array with a given item + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayFill( PHB_ITEM pArray, PHB_ITEM pValue, ULONG * pulStart, ULONG * pulCount ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayScan() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Scan an array for a given item, or until code-block item returns TRUE + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayScan( PHB_ITEM pArray, PHB_ITEM pValue, ULONG * pulStart, ULONG * pulCount ) --> ( ULONG )ulResult + $ARGUMENTS$ + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayEval() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Execute a code-block for every element of an array item + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayEval( PHB_ITEM pArray, PHB_ITEM bBlock, ULONG * pulStart, ULONG * pulCount ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayCopy() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Copy items from one array to another + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayCopy( PHB_ITEM pSrcArray, PHB_ITEM pDstArray, ULONG * pulStart, ULONG * pulCount, ULONG * pulTarget ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arrayClone() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns a duplicate of an existing array, including all nested items + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayClone( PHB_ITEM pArray ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_arraySort() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Sorts an array item + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arraySort( PHB_ITEM pArray, ULONG * pulStart, ULONG * pulCount, PHB_ITEM pBlock ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_stricmp() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Compare two strings without regards to case + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_stricmp( const char * s1, const char * s2 ) --> ( int )iResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_strnicmp() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Compare two string without regards to case, limited by length + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_strnicmp( const char * s1, const char * s2, ULONG ulLen ) --> ( int )iResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_strupr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Convert a string in-place to upper-case + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_strupr( char * pszText ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_strdup() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns a pointer to a newly allocated copy of the source string + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_strdup( const char * pszText ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_strMatchRegExp() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Compare two strings using a regular expression pattern + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_strMatchRegExp( const char * szString, const char * szMask ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_strEmpty() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns whether a string contains only white space + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_strEmpty( const char * szText, ULONG ulLen ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_strDescend() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Copy a string to a buffer, inverting each character + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_strDescend( char * szStringTo, const char * szStringFrom, ULONG ulLen ) + $ARGUMENTS$ + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_strAt() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns an index to a sub-string within another string + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_strAt( const char * szSub, ULONG ulSubLen, const char * szText, ULONG ulLen ) --> ( ULONG )ulResult + $ARGUMENTS$ + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_strUpper() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Convert an existing string buffer to upper case + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_strUpper( char * szText, ULONG ulLen ) --> ( char * )pszResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_strLower() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Convert an existing string buffer to lower case + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_strLower( char * szText, ULONG ulLen ) --> ( char * )pszResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_strncpyUpper() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Copy an existing string buffer to another buffer, as upper case + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_strncpyUpper( char * pDest, const char * pSource, ULONG ulLen ) --> ( char * )pszResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_strVal() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Return the numeric value of a character string representation of a number + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_strVal( const char * szText, ULONG ulLen ) --> ( double )dResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_strLTrim() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Return a pointer to the first non-white space character + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_strLTrim( const char * szText, ULONG * ulLen ) --> ( char * )pszResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_strRTrimLen() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Return length of a string, ignoring trailing white space (or true spaces) + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_strRTrimLen( const char * szText, ULONG ulLen, HB_BOOL bAnySpace ) --> ( ULONG )ulResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_numRound() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Round a number to a specific number of digits + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_numRound( double dResult, int iDec ) --> ( double )dResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_clsReleaseAll() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Releases all defined classes + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_clsReleaseAll( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_objGetClsName() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieves an object class name + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_objGetClsName( PHB_ITEM pObject ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_objGetMethod() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns the method pointer of a object class + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_objGetMethod( PHB_ITEM pObject, PHB_SYMB pSymMsg ) --> ( PHB_FUNC )hResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_objHasMsg() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns TRUE/FALSE whether szString is an existing message for object + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_objHasMsg( PHB_ITEM pObject, char * szString ) --> ( ULONG )ulResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_dynsymGet() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Finds and creates a dynamic symbol if not found + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_dynsymGet( char * szName ) --> ( PHB_DYNS )hResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_dynsymNew() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Creates a new dynamic symbol based on a local one + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_dynsymNew( PHB_SYMB pSymbol ) --> ( PHB_DYNS )hResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_dynsymFind() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Finds a dynamic symbol + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_dynsymFind( char * szName ) --> ( PHB_DYNS )hResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_dynsymFindName() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Converts to uppercase and finds a dynamic symbol + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_dynsymFindName( char * szName ) --> ( PHB_DYNS )hResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_dynsymLog() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Displays all dynamic symbols + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_dynsymLog( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_dynsymRelease() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Releases the memory of the dynamic symbol table + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_dynsymRelease( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_dynsymEval() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Enumerates all dynamic symbols + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_dynsymEval( PHB_DYNS_FUNC pFunction, void * Cargo ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_cmdargInit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Initialize command line argument API's + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_cmdargInit( int argc, char * argv[] ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_cmdargARGC() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve command line argument count + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_cmdargARGC( void ) --> ( int )iResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_cmdargARGV() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve command line argument buffer pointer + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_cmdargARGV( void ) --> ( char ** )ppszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_cmdargIsInternal() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Determine if a string is an internal setting + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_cmdargIsInternal( const char * szArg ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_cmdargCheck() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Check if a given internal switch (like //INFO) was set + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_cmdargCheck( const char * pszName ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_cmdargString() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns the string value of an internal switch (like //TEMPPATH:"C:\") + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_cmdargString( const char * pszName ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_cmdargNum() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Returns the numeric value of an internal switch (like //F:90) + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_cmdargNum( const char * pszName ) --> ( int )iResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_cmdargProcessVM() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Check for command line internal arguments + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_cmdargProcessVM( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_symbolNew() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Create a new symbol + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_symbolNew( char * szName ) --> ( PHB_SYMB )hResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_codeblockNew() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Create a code-block + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_codeblockNew( BYTE * pBuffer, USHORT uiLocals, USHORT * pLocalPosTable, PHB_SYMB pSymbols ) --> ( HB_CODEBLOCK_PTR )hResult + $ARGUMENTS$ + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_codeblockMacroNew() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_codeblockMacroNew( BYTE * pBuffer, USHORT usLen ) --> ( HB_CODEBLOCK_PTR )hResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_codeblockDelete() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Delete a codeblock + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_codeblockDelete( PHB_ITEM pItem ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_codeblockGetVar() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Get local variable referenced in a codeblock + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_codeblockGetVar( PHB_ITEM pItem, LONG iItemPos ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_codeblockGetRef() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Get local variable passed by reference + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_codeblockGetRef( PHB_ITEM pItem, PHB_ITEM pRefer ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_codeblockEvaluate() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Evaluate a codeblock + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_codeblockEvaluate( PHB_ITEM pItem ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_codeblockCopy() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Copy a codeblock + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_codeblockCopy( PHB_ITEM pDest, PHB_ITEM pSource ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_memvarValueNew() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Create a new global value + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_memvarValueNew( PHB_ITEM pSource, HB_BOOL bTrueMemvar ) --> ( HB_HANDLE )hResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_memvarValueBaseAddress() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve the base address of the values table + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_memvarValueBaseAddress( void ) --> ( HB_VALUE_PTR * )phResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_memvarsInit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Initialize the memvar API system + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_memvarsInit( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_memvarsRelease() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Clear all PUBLIC and PRIVATE variables + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_memvarsRelease( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_memvarsFree() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Release the memvar API system + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_memvarsFree( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_memvarValueIncRef() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Increase the reference count of a global value + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_memvarValueIncRef( HB_HANDLE hValue ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_memvarValueDecRef() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Decrease the reference count of a global value + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_memvarValueDecRef( HB_HANDLE hValue ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_memvarSetValue() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Copy an item into a symbol + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_memvarSetValue( PHB_SYMB pMemvarSymb, PHB_ITEM pItem ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_memvarGet() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Copy an symbol value into an item + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_memvarGet( PHB_ITEM pItem, PHB_SYMB pMemvarSymb ) --> ( HB_ERRCODE )hResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_memvarGetValue() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Copy an symbol value into an item, with error trapping + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_memvarGetValue( PHB_ITEM pItem, PHB_SYMB pMemvarSymb ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_memvarGetRefer() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Copy a reference to a symbol value into an item, with error trapping + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_memvarGetRefer( PHB_ITEM pItem, PHB_SYMB pMemvarSymb ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_memvarGetPrivatesBase() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve current PRIVATE variables stack base + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_memvarGetPrivatesBase( void ) --> ( ULONG )ulResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_memvarSetPrivatesBase() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Release PRIVATE variables created after specified base + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_memvarSetPrivatesBase( ULONG ulBase ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_memvarNewParameter() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_memvarNewParameter( PHB_SYMB pSymbol, PHB_ITEM pValue ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_memvarGetStrValuePtr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_memvarGetStrValuePtr( char * szVarName, ULONG *pulLen ) --> ( char * )pszResult + $ARGUMENTS$ + + + <*pulLen> + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_memvarCreateFromItem() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_memvarCreateFromItem( PHB_ITEM pMemvar, BYTE bScope, PHB_ITEM pValue ) + $ARGUMENTS$ + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_memvarScope() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve scope of a dynamic variable symbol + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_memvarScope( char * szVarName, ULONG ulLength ) --> ( int )iResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_conInit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Initialize the console API system + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_conInit( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_conRelease() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Release the console API system + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_conRelease( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_conNewLine() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve a pointer to a static buffer containing new-line characters + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_conNewLine( void ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_conOutStd() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Output an string to STDOUT + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_conOutStd( char * pStr, ULONG ulLen ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_conOutErr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Output an string to STDERR + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_conOutErr( char * pStr, ULONG ulLen ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_conSetCursor() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve and optionally set cursor shape + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_conSetCursor( HB_BOOL bSetCursor, USHORT usNewCursor ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_conSetColor() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve and optionally set console color + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_conSetColor( char * szColor ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_conXSaveRestRelease() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Release the save/restore API + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_conXSaveRestRelease( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_compReservedName() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Determines if a string contains a reserve word + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_compReservedName( char * szName ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_procname() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve a procedure name into a buffer + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_procname( int iLevel, char * szName ) --> ( char * )pszResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_macroGetValue() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieve results of a macro expansion + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_macroGetValue( PHB_ITEM pItem ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_macroSetValue() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Assign a value to a macro-expression item + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_macroSetValue( PHB_ITEM pItem ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_macroTextValue() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Macro text substitution + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_macroTextValue( PHB_ITEM pItem ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_macroPushSymbol() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Handle a macro function calls, e.g. var := ¯o() + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_macroPushSymbol( PHB_ITEM pItem ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_macroRun() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Executes pcode compiled by macro compiler + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_macroRun( HB_MACRO_PTR pMacro ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_macroCompile() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Compile a string and return a pcode buffer + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_macroCompile( char * szString ) --> ( HB_MACRO_PTR )hResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_macroDelete() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Release all memory allocated for macro evaluation + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_macroDelete( HB_MACRO_PTR pMacro ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_macroTextSubst() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Substitute macro variables occurences within a given string + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_macroTextSubst( char * szString, ULONG *pulStringLen ) --> ( char * )pszResult + $ARGUMENTS$ + + + <*pulStringLen> + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_macroIsIdent() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Determine if a string is a valid function or variable name + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_macroIsIdent( char * szString ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_macroPopAliasedValue() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Compiles and evaluates an aliased macro expression + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_macroPopAliasedValue( PHB_ITEM pAlias, PHB_ITEM pVar ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_macroPushAliasedValue() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Compiles and evaluates an aliased macro expression + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_macroPushAliasedValue( PHB_ITEM pAlias, PHB_ITEM pVar ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_macroGetType() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Determine the type of an expression + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_macroGetType( PHB_ITEM pItem ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gcAlloc() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Allocates a memory controlled by the garbage collector + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_gcAlloc( ULONG ulSize, HB_GARBAGE_FUNC_PTR pFunc ) --> ( void * )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gcFree() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Deallocates a memory allocated by the garbage collector + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_gcFree( void *pAlloc ) + $ARGUMENTS$ + <*pAlloc> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gcLock() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Do not release passed memory block + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_gcLock( void *pAlloc ) --> ( void * )pResult + $ARGUMENTS$ + <*pAlloc> + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gcUnlock() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Passed block is allowed to be released + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_gcUnlock( void *pAlloc ) --> ( void * )pResult + $ARGUMENTS$ + <*pAlloc> + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gcLockItem() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Do not release a memory block stored inside an item + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_gcLockItem( PHB_ITEM pItem ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gcUnlockItem() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Allow to release the item + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_gcUnlockItem( PHB_ITEM pItem ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gcCollect() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Checks if a single memory block can be released + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_gcCollect( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gcCollectAll() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Checks if all memory blocks can be released + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_gcCollectAll( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gcItemRef() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Checks if passed item refers passed memory block pointer + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_gcItemRef( PHB_ITEM pItem ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmIsLocalRef() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + hvm.c - mark all local variables as used + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_vmIsLocalRef( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmIsStaticRef() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + hvm.c - mark all static variables as used + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_vmIsStaticRef( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_memvarsIsMemvarRef() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + memvars.c - mark all memvar variables as used + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_memvarsIsMemvarRef( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_clsIsClassRef() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + classes.c - mark all class internals as used + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_clsIsClassRef( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_codeblockDeleteGarbage() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Clear a codeblock before releasing by the GC + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_codeblockDeleteGarbage( void * Cargo ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_arrayReleaseGarbage() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Clear an array before releasing by the GC + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_arrayReleaseGarbage( void * Cargo ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_idleState() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Services a single idle state + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_idleState( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_idleReset() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Services a single idle state + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_idleReset( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_idleShutDown() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Closes all background tasks + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_idleShutDown( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_verPlatform() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieves a newly allocated buffer containing platform version + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_verPlatform( void ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_verCompiler() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieves a newly allocated buffer containing compiler version + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_verCompiler( void ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_verHarbour() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Retrieves a newly allocated buffer containing harbour version + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_verHarbour( void ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_verBuildInfo() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Display harbour, compiler, and platform versions to standard console + $SYNTAX$ + C Prototype + + #include "hbapi.h" + hb_verBuildInfo( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_IS_OF_TYPE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + HB_IS_OF_TYPE( p, t ) --> type & ~HB_IT_BYREF ) == t )> + $ARGUMENTS$ +

+ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_IS_BYREF() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + HB_IS_BYREF( p ) --> type & HB_IT_BYREF )> + $ARGUMENTS$ +

+ $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_IS_ARRAY() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + HB_IS_ARRAY( p ) --> + $ARGUMENTS$ +

+ $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_IS_NIL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + HB_IS_NIL( p ) --> + $ARGUMENTS$ +

+ $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_IS_BLOCK() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + HB_IS_BLOCK( p ) --> + $ARGUMENTS$ +

+ $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_IS_DATE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + HB_IS_DATE( p ) --> + $ARGUMENTS$ +

+ $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_IS_DOUBLE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + HB_IS_DOUBLE( p ) --> + $ARGUMENTS$ +

+ $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_IS_INTEGER() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + HB_IS_INTEGER( p ) --> + $ARGUMENTS$ +

+ $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_IS_LOGICAL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + HB_IS_LOGICAL( p ) --> + $ARGUMENTS$ +

+ $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_IS_LONG() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + HB_IS_LONG( p ) --> + $ARGUMENTS$ +

+ $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_IS_NUMERIC() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + HB_IS_NUMERIC( p ) --> type & HB_IT_NUMERIC )> + $ARGUMENTS$ +

+ $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_IS_OBJECT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + HB_IS_OBJECT( p ) --> + $ARGUMENTS$ +

+ $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_IS_STRING() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + HB_IS_STRING( p ) --> type & ~( HB_IT_BYREF | HB_IT_MEMOFLAG ) ) == HB_IT_STRING )> + $ARGUMENTS$ +

+ $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_IS_MEMO() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + HB_IS_MEMO( p ) --> + $ARGUMENTS$ +

+ $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_IS_SYMBOL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + HB_IS_SYMBOL( p ) --> + $ARGUMENTS$ +

+ $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_IS_MEMVAR() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + HB_IS_MEMVAR( p ) --> + $ARGUMENTS$ +

+ $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_IS_POINTER() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + HB_IS_POINTER( p ) --> + $ARGUMENTS$ +

+ $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ISNIL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + NOTE: Intentionally using a different method + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + ISNIL( n ) --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ISCHAR() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + ISCHAR( n ) --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ISNUM() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + ISNUM( n ) --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ISLOG() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + ISLOG( n ) --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ISDATE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + ISDATE( n ) --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ISMEMO() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + ISMEMO( n ) --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ISBYREF() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + NOTE: Intentionally using a different method + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + ISBYREF( n ) --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ISARRAY() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + ISARRAY( n ) --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ISOBJECT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + ISOBJECT( n ) --> asArray.value->uiClass != 0 )> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ISBLOCK() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Not available in CA-Cl*pper. + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + ISBLOCK( n ) --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ISPOINTER() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + Not available in CA-Cl*pper. + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + ISPOINTER( n ) --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_ISSPACE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapi.h" + HB_ISSPACE( c ) --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapi.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ diff --git a/harbour/doc/en/hb_apier.txt b/harbour/doc/en/hb_apier.txt index f2f0cd82e3..3038a0a6f2 100644 --- a/harbour/doc/en/hb_apier.txt +++ b/harbour/doc/en/hb_apier.txt @@ -15,1506 +15,1506 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errGetDescription() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errGetDescription( PHB_ITEM pError ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errGetDescription() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errGetDescription( PHB_ITEM pError ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errGetFileName() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errGetFileName( PHB_ITEM pError ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errGetFileName() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errGetFileName( PHB_ITEM pError ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errGetFlags() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errGetFlags( PHB_ITEM pError ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errGetFlags() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errGetFlags( PHB_ITEM pError ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errGetGenCode() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errGetGenCode( PHB_ITEM pError ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errGetGenCode() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errGetGenCode( PHB_ITEM pError ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errGetOperation() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errGetOperation( PHB_ITEM pError ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errGetOperation() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errGetOperation( PHB_ITEM pError ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errGetOsCode() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errGetOsCode( PHB_ITEM pError ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errGetOsCode() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errGetOsCode( PHB_ITEM pError ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errGetSeverity() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errGetSeverity( PHB_ITEM pError ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errGetSeverity() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errGetSeverity( PHB_ITEM pError ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errGetSubCode() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errGetSubCode( PHB_ITEM pError ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errGetSubCode() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errGetSubCode( PHB_ITEM pError ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errGetSubSystem() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errGetSubSystem( PHB_ITEM pError ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errGetSubSystem() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errGetSubSystem( PHB_ITEM pError ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errGetTries() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errGetTries( PHB_ITEM pError ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errGetTries() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errGetTries( PHB_ITEM pError ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errLaunch() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errLaunch( PHB_ITEM pError ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errLaunch() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errLaunch( PHB_ITEM pError ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errNew() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errNew( void ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errNew() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errNew( void ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errPutArgs() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errPutArgs( PHB_ITEM pError, USHORT uiArgCount, ... ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * - * <...> - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errPutArgs() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errPutArgs( PHB_ITEM pError, USHORT uiArgCount, ... ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + + <...> + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errPutDescription() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errPutDescription( PHB_ITEM pError, char * szDescription ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errPutDescription() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errPutDescription( PHB_ITEM pError, char * szDescription ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errPutFileName() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errPutFileName( PHB_ITEM pError, char * szFileName ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errPutFileName() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errPutFileName( PHB_ITEM pError, char * szFileName ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errPutFlags() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errPutFlags( PHB_ITEM pError, USHORT uiFlags ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errPutFlags() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errPutFlags( PHB_ITEM pError, USHORT uiFlags ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errPutGenCode() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errPutGenCode( PHB_ITEM pError, USHORT uiGenCode ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errPutGenCode() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errPutGenCode( PHB_ITEM pError, USHORT uiGenCode ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errPutOperation() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errPutOperation( PHB_ITEM pError, char * szOperation ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errPutOperation() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errPutOperation( PHB_ITEM pError, char * szOperation ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errPutOsCode() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errPutOsCode( PHB_ITEM pError, USHORT uiOsCode ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errPutOsCode() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errPutOsCode( PHB_ITEM pError, USHORT uiOsCode ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errPutSeverity() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errPutSeverity( PHB_ITEM pError, USHORT uiSeverity ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errPutSeverity() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errPutSeverity( PHB_ITEM pError, USHORT uiSeverity ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errPutSubCode() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errPutSubCode( PHB_ITEM pError, USHORT uiSubCode ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errPutSubCode() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errPutSubCode( PHB_ITEM pError, USHORT uiSubCode ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errPutSubSystem() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errPutSubSystem( PHB_ITEM pError, char * szSubSystem ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errPutSubSystem() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errPutSubSystem( PHB_ITEM pError, char * szSubSystem ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errPutTries() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errPutTries( PHB_ITEM pError, USHORT uiTries ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errPutTries() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errPutTries( PHB_ITEM pError, USHORT uiTries ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_errRelease() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errRelease( PHB_ITEM pError ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_errRelease() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errRelease( PHB_ITEM pError ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_errInit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errInit( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_errInit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errInit( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_errExit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errExit( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_errExit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errExit( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errLaunchSubst() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errLaunchSubst( PHB_ITEM pError ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errLaunchSubst() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errLaunchSubst( PHB_ITEM pError ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errRT_New() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errRT_New( USHORT uiSeverity, char * szSubSystem, ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation, USHORT uiOsCode, USHORT uiFlags ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errRT_New() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errRT_New( USHORT uiSeverity, char * szSubSystem, ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation, USHORT uiOsCode, USHORT uiFlags ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + + + + + + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errRT_New_Subst() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errRT_New_Subst( USHORT uiSeverity, char * szSubSystem, ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation, USHORT uiOsCode, USHORT uiFlags ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errRT_New_Subst() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errRT_New_Subst( USHORT uiSeverity, char * szSubSystem, ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation, USHORT uiOsCode, USHORT uiFlags ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + + + + + + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errRT_BASE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errRT_BASE( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errRT_BASE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errRT_BASE( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errRT_BASE_Ext1() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errRT_BASE_Ext1( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation, USHORT uiOsCode, USHORT uiFlags ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errRT_BASE_Ext1() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errRT_BASE_Ext1( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation, USHORT uiOsCode, USHORT uiFlags ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errRT_BASE_Subst() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errRT_BASE_Subst( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errRT_BASE_Subst() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errRT_BASE_Subst( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_errRT_BASE_SubstR() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errRT_BASE_SubstR( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation ) - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_errRT_BASE_SubstR() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errRT_BASE_SubstR( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation ) + $ARGUMENTS$ + + + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errRT_TERM() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errRT_TERM( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation, USHORT uiOSCode, USHORT uiFlags ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errRT_TERM() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errRT_TERM( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation, USHORT uiOSCode, USHORT uiFlags ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errRT_DBCMD() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errRT_DBCMD( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errRT_DBCMD() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errRT_DBCMD( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errRT_TOOLS() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errRT_TOOLS( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errRT_TOOLS() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errRT_TOOLS( ULONG ulGenCode, ULONG ulSubCode, char * szDescription, char * szOperation ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_errInternal() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errInternal( ULONG ulIntCode, char * szText, char * szPar1, char * szPar2 ) - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_errInternal() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errInternal( ULONG ulIntCode, char * szText, char * szPar1, char * szPar2 ) + $ARGUMENTS$ + + + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_errorHandler() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapierr.h" - * hb_errorHandler( HB_ERROR_INFO_PTR pNewHandler ) --> ( HB_ERROR_INFO_PTR )hParam - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_errorHandler() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapierr.h" + hb_errorHandler( HB_ERROR_INFO_PTR pNewHandler ) --> ( HB_ERROR_INFO_PTR )hParam + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ diff --git a/harbour/doc/en/hb_apifs.txt b/harbour/doc/en/hb_apifs.txt index 94b868a4a5..066c8973ac 100644 --- a/harbour/doc/en/hb_apifs.txt +++ b/harbour/doc/en/hb_apifs.txt @@ -15,1425 +15,1425 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsChDir() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Change working directory - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsChDir( BYTE * pszDirName ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsChDir() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Change working directory + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsChDir( BYTE * pszDirName ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsChDrv() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Change working drive - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsChDrv( BYTE nDrive ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsChDrv() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Change working drive + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsChDrv( BYTE nDrive ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_fsClose() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Close a file - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsClose( HB_FHANDLE hFileHandle ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_fsClose() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Close a file + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsClose( HB_FHANDLE hFileHandle ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_fsCommit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Commit updates of a file - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsCommit( HB_FHANDLE hFileHandle ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_fsCommit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Commit updates of a file + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsCommit( HB_FHANDLE hFileHandle ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsCreate() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Create a file - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsCreate( BYTE * pszFileName, USHORT uiAttribute ) --> ( HB_FHANDLE )hResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsCreate() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Create a file + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsCreate( BYTE * pszFileName, USHORT uiAttribute ) --> ( HB_FHANDLE )hResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsCreateTemp() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Create a temporary file from components - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsCreateTemp( const BYTE * pszDir, const BYTE * pszPrefix, USHORT uiAttribute ) --> ( HB_FHANDLE )hResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsCreateTemp() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Create a temporary file from components + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsCreateTemp( const BYTE * pszDir, const BYTE * pszPrefix, USHORT uiAttribute ) --> ( HB_FHANDLE )hResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsCurDir() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Retrieve a static pointer containing current directory for specified drive - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsCurDir( USHORT uiDrive ) --> ( BYTE * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsCurDir() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Retrieve a static pointer containing current directory for specified drive + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsCurDir( USHORT uiDrive ) --> ( BYTE * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsCurDirBuff() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Copy current directory for given drive into a buffer - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsCurDirBuff( USHORT uiDrive, BYTE * pbyBuffer, HB_SIZE ulLen ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsCurDirBuff() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Copy current directory for given drive into a buffer + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsCurDirBuff( USHORT uiDrive, BYTE * pbyBuffer, HB_SIZE ulLen ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsCurDrv() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Retrieve current drive number - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsCurDrv( void ) --> ( BYTE )cResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsCurDrv() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Retrieve current drive number + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsCurDrv( void ) --> ( BYTE )cResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsDelete() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Delete a file - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsDelete( BYTE * pszFileName ) --> ( int )iResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsDelete() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Delete a file + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsDelete( BYTE * pszFileName ) --> ( int )iResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsEof() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Determine if an open file is position at end-of-file - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsEof( HB_FHANDLE hFileHandle ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsEof() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Determine if an open file is position at end-of-file + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsEof( HB_FHANDLE hFileHandle ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsError() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Retrieve file system error - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsError( void ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsError() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Retrieve file system error + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsError( void ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsFile() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Determine if a file exists - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsFile( BYTE * pszFileName ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsFile() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Determine if a file exists + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsFile( BYTE * pszFileName ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsFSize() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Determine the size of a file - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsFSize( BYTE * pszFileName, HB_BOOL bUseDirEntry ) --> ( HB_FOFFSET )ulResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsFSize() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Determine the size of a file + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsFSize( BYTE * pszFileName, HB_BOOL bUseDirEntry ) --> ( HB_FOFFSET )ulResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsExtOpen() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Open a file using default extension and a list of paths - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsExtOpen( BYTE * pszFileName, BYTE * pDefExt, USHORT uiFlags, BYTE * pPaths, PHB_ITEM pError ) --> ( HB_FHANDLE )hResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsExtOpen() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Open a file using default extension and a list of paths + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsExtOpen( BYTE * pszFileName, BYTE * pDefExt, USHORT uiFlags, BYTE * pPaths, PHB_ITEM pError ) --> ( HB_FHANDLE )hResult + $ARGUMENTS$ + + + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsIsDrv() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Determine if a drive number is a valid drive - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsIsDrv( BYTE nDrive ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsIsDrv() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Determine if a drive number is a valid drive + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsIsDrv( BYTE nDrive ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsIsDevice() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Determine if a file is attached to a device (console?) - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsIsDevice( HB_FHANDLE hFileHandle ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsIsDevice() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Determine if a file is attached to a device (console?) + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsIsDevice( HB_FHANDLE hFileHandle ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsLock() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Request a lock on a portion of a file - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsLock( HB_FHANDLE hFileHandle, HB_SIZE ulStart, HB_SIZE ulLength, USHORT uiMode ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsLock() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Request a lock on a portion of a file + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsLock( HB_FHANDLE hFileHandle, HB_SIZE ulStart, HB_SIZE ulLength, USHORT uiMode ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsMkDir() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Create a directory - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsMkDir( BYTE * pszDirName ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsMkDir() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Create a directory + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsMkDir( BYTE * pszDirName ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsOpen() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Open a file - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsOpen( BYTE * pszFileName, USHORT uiFlags ) --> ( HB_FHANDLE )hResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsOpen() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Open a file + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsOpen( BYTE * pszFileName, USHORT uiFlags ) --> ( HB_FHANDLE )hResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsRead() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Read contents of a file into a buffer (<=64K) - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsRead( HB_FHANDLE hFileHandle, BYTE * pBuff, USHORT ulCount ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsRead() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Read contents of a file into a buffer (<=64K) + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsRead( HB_FHANDLE hFileHandle, BYTE * pBuff, USHORT ulCount ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsReadLarge() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Read contents of a file into a buffer (>64K) - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsReadLarge( HB_FHANDLE hFileHandle, BYTE * pBuff, HB_SIZE ulCount ) --> ( HB_SIZE )ulResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsReadLarge() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Read contents of a file into a buffer (>64K) + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsReadLarge( HB_FHANDLE hFileHandle, BYTE * pBuff, HB_SIZE ulCount ) --> ( HB_SIZE )ulResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsRmDir() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Remove a directory - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsRmDir( BYTE * pszDirName ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsRmDir() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Remove a directory + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsRmDir( BYTE * pszDirName ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsRename() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Rename a file - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsRename( BYTE * pszOldName, BYTE * pszNewName ) --> ( int )iResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsRename() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Rename a file + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsRename( BYTE * pszOldName, BYTE * pszNewName ) --> ( int )iResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsSeekLarge() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Reposition an open file - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsSeekLarge( HB_FHANDLE hFileHandle, HB_FOFFSET lOffset, USHORT uiMode ) --> ( HB_FOFFSET )ulResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsSeekLarge() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Reposition an open file + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsSeekLarge( HB_FHANDLE hFileHandle, HB_FOFFSET lOffset, USHORT uiMode ) --> ( HB_FOFFSET )ulResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsTell() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Retrieve the current position of a file - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsTell( HB_FHANDLE hFileHandle ) --> ( HB_FOFFSET )ulResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsTell() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Retrieve the current position of a file + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsTell( HB_FHANDLE hFileHandle ) --> ( HB_FOFFSET )ulResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_fsTempName() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Create a temporary file name in a buffer - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsTempName( BYTE * pszBuffer, const BYTE * pszDir, const BYTE * pszPrefix ) - * $ARGUMENTS$ - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_fsTempName() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Create a temporary file name in a buffer + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsTempName( BYTE * pszBuffer, const BYTE * pszDir, const BYTE * pszPrefix ) + $ARGUMENTS$ + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsSetDevMode() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Change the device mode of a file (text/binary) - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsSetDevMode( HB_FHANDLE hFileHandle, int iDevMode ) --> int - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * previous mode or -1 on error - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsSetDevMode() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Change the device mode of a file (text/binary) + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsSetDevMode( HB_FHANDLE hFileHandle, int iDevMode ) --> int + $ARGUMENTS$ + + + + $RETURNS$ + previous mode or -1 on error + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_fsSetDevRaw() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Change the device mode of a file to raw (binary) - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsSetDevRaw( HB_FHANDLE hFileHandle ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_fsSetDevRaw() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Change the device mode of a file to raw (binary) + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsSetDevRaw( HB_FHANDLE hFileHandle ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_fsSetDevText() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Change the device mode of a file to text - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsSetDevText( HB_FHANDLE hFileHandle ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_fsSetDevText() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Change the device mode of a file to text + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsSetDevText( HB_FHANDLE hFileHandle ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_fsSetError() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Set the file system error number - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsSetError( USHORT uiError ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_fsSetError() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Set the file system error number + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsSetError( USHORT uiError ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsWrite() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Write to an open file from a buffer (<=64K) - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsWrite( HB_FHANDLE hFileHandle, BYTE * pBuff, USHORT ulCount ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsWrite() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Write to an open file from a buffer (<=64K) + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsWrite( HB_FHANDLE hFileHandle, BYTE * pBuff, USHORT ulCount ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsWriteLarge() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Write to an open file from a buffer (>64K) - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsWriteLarge( HB_FHANDLE hFileHandle, BYTE * pBuff, HB_SIZE ulCount ) --> ( HB_SIZE )ulResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsWriteLarge() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Write to an open file from a buffer (>64K) + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsWriteLarge( HB_FHANDLE hFileHandle, BYTE * pBuff, HB_SIZE ulCount ) --> ( HB_SIZE )ulResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsFNameSplit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Split given filename into path, name and extension - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsFNameSplit( char * pszFileName ) --> ( PHB_FNAME )hResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsFNameSplit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Split given filename into path, name and extension + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsFNameSplit( char * pszFileName ) --> ( PHB_FNAME )hResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsFNameMerge() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * This function joins path, name and extension into a string with a filename - * $SYNTAX$ - * C Prototype - * - * #include "hbapifs.h" - * hb_fsFNameMerge( char * pszFileName, PHB_FNAME pFileName ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsFNameMerge() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + This function joins path, name and extension into a string with a filename + $SYNTAX$ + C Prototype + + #include "hbapifs.h" + hb_fsFNameMerge( char * pszFileName, PHB_FNAME pFileName ) --> ( char * )pszResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsFLock() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapifs.h" - * hb_fsFLock( h, s, l ) --> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapifs.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsFLock() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapifs.h" + hb_fsFLock( h, s, l ) --> + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapifs.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_fsFUnlock() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapifs.h" - * hb_fsFUnlock( h, s, l ) --> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapifs.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_fsFUnlock() + $CATEGORY$ + C level API + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapifs.h" + hb_fsFUnlock( h, s, l ) --> + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapifs.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ diff --git a/harbour/doc/en/hb_apigt.txt b/harbour/doc/en/hb_apigt.txt index 0afe545ced..fedc055752 100644 --- a/harbour/doc/en/hb_apigt.txt +++ b/harbour/doc/en/hb_apigt.txt @@ -2,4777 +2,4764 @@ * $Id$ */ -/* - * The following parts are Copyright of the individual authors. - * www - http://harbour-project.org - * - * Copyright 1999 {list of individual authors and e-mail addresses} - * Header file for the API - * $SUBCATEGORY$ - * Terminal - * - * See COPYING for licensing terms. - * +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gtInit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtInit( int iFilenoStdin, int iFilenoStdout, int iFilenoStderr ) + $ARGUMENTS$ + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gtInit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtInit( int iFilenoStdin, int iFilenoStdout, int iFilenoStderr ) - * $ARGUMENTS$ - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gtExit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtExit( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gtExit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtExit( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gtAdjustPos() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtAdjustPos( int iHandle, char * pStr, ULONG ulLen ) + $ARGUMENTS$ + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gtAdjustPos() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtAdjustPos( int iHandle, char * pStr, ULONG ulLen ) - * $ARGUMENTS$ - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtBox() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtBox( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE * pbyFrame ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtBox() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtBox( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE * pbyFrame ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtBoxD() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtBoxD( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtBoxD() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtBoxD( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtBoxS() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtBoxS( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtBoxS() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtBoxS( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtColorSelect() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtColorSelect( USHORT uiColorIndex ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtColorSelect() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtColorSelect( USHORT uiColorIndex ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtColorToN() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtColorToN( char * szColorString ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtColorToN() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtColorToN( char * szColorString ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtDispBegin() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtDispBegin( void ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtDispBegin() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtDispBegin( void ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtDispCount() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtDispCount( void ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtDispCount() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtDispCount( void ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtDispEnd() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtDispEnd( void ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtDispEnd() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtDispEnd( void ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtDrawShadow() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtDrawShadow( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE byAttr ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtDrawShadow() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtDrawShadow( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE byAttr ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtGetBlink() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtGetBlink( HB_BOOL * pbBlink ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtGetBlink() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtGetBlink( HB_BOOL * pbBlink ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtGetColorStr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtGetColorStr( char * pszColorString ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtGetColorStr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtGetColorStr( char * pszColorString ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtGetCursor() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtGetCursor( USHORT * puiCursorShape ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtGetCursor() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtGetCursor( USHORT * puiCursorShape ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtGetPos() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtGetPos( SHORT * piRow, SHORT * piCol ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtGetPos() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtGetPos( SHORT * piRow, SHORT * piCol ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtIsColor() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtIsColor( void ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtIsColor() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtIsColor( void ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtMaxCol() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtMaxCol( void ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtMaxCol() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtMaxCol( void ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtMaxRow() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtMaxRow( void ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtMaxRow() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtMaxRow( void ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtPostExt() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtPostExt( void ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtPostExt() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtPostExt( void ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtPreExt() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtPreExt( void ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtPreExt() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtPreExt( void ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtSuspend() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + Prepare the reminal for shell output + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtSuspend( void ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtSuspend() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * Prepare the reminal for shell output - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtSuspend( void ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtResume() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + Resume the terminal after the shell output + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtResume( void ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtResume() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * Resume the terminal after the shell output - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtResume( void ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtReadKey() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtReadKey( HB_inkey_enum eventmask ) --> ( int )iResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtReadKey() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtReadKey( HB_inkey_enum eventmask ) --> ( int )iResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtRectSize() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtRectSize( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, USHORT * puiBuffSize ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtRectSize() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtRectSize( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, USHORT * puiBuffSize ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtRepChar() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtRepChar( USHORT uiRow, USHORT uiCol, BYTE byChar, USHORT uiCount ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtRepChar() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtRepChar( USHORT uiRow, USHORT uiCol, BYTE byChar, USHORT uiCount ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtRest() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtRest( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, void * pScrBuff ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtRest() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtRest( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, void * pScrBuff ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtSave() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtSave( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, void * pScrBuff ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtSave() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtSave( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, void * pScrBuff ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtScrDim() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtScrDim( USHORT * puiHeight, USHORT * puiWidth ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtScrDim() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtScrDim( USHORT * puiHeight, USHORT * puiWidth ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtScroll() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtScroll( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, SHORT iRows, SHORT iCols ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtScroll() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtScroll( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, SHORT iRows, SHORT iCols ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtSetBlink() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtSetBlink( HB_BOOL bBlink ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtSetBlink() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtSetBlink( HB_BOOL bBlink ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtSetColorStr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtSetColorStr( char * pszColorString ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtSetColorStr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtSetColorStr( char * pszColorString ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtSetCursor() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtSetCursor( USHORT uiCursorShape ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtSetCursor() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtSetCursor( USHORT uiCursorShape ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtSetMode() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtSetMode( USHORT uiRows, USHORT uiCols ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtSetMode() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtSetMode( USHORT uiRows, USHORT uiCols ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtSetPos() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtSetPos( SHORT iRow, SHORT iCol ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtSetPos() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtSetPos( SHORT iRow, SHORT iCol ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtSetPosContext() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtSetPosContext( SHORT iRow, SHORT iCol, SHORT iMode ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtSetPosContext() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtSetPosContext( SHORT iRow, SHORT iCol, SHORT iMode ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtSetSnowFlag() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtSetSnowFlag( HB_BOOL bNoSnow ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtSetSnowFlag() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtSetSnowFlag( HB_BOOL bNoSnow ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gtTone() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtTone( double dFrequency, double dDuration ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gtTone() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtTone( double dFrequency, double dDuration ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtWrite() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtWrite( BYTE * pbyStr, ULONG ulLen ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtWrite() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtWrite( BYTE * pbyStr, ULONG ulLen ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtWriteAt() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtWriteAt( USHORT uiRow, USHORT uiCol, BYTE * pbyStr, ULONG ulLen ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtWriteAt() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtWriteAt( USHORT uiRow, USHORT uiCol, BYTE * pbyStr, ULONG ulLen ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtWriteCon() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtWriteCon( BYTE * pbyStr, ULONG ulLen ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtWriteCon() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtWriteCon( BYTE * pbyStr, ULONG ulLen ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtVersion() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtVersion( void ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtVersion() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtVersion( void ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gtWCreate() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtWCreate( HB_GT_RECT * rect, HB_GT_WND ** wnd ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gtWCreate() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtWCreate( HB_GT_RECT * rect, HB_GT_WND ** wnd ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gtWDestroy() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtWDestroy( HB_GT_WND * wnd ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gtWDestroy() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtWDestroy( HB_GT_WND * wnd ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtWFlash() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtWFlash( void ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtWFlash() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtWFlash( void ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gtWApp() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtWApp( HB_GT_WND ** wnd ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gtWApp() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtWApp( HB_GT_WND ** wnd ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gtWCurrent() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtWCurrent( HB_GT_WND * wnd ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gtWCurrent() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtWCurrent( HB_GT_WND * wnd ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gtWPos() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtWPos( HB_GT_WND * wnd, HB_GT_RECT * rect ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gtWPos() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtWPos( HB_GT_WND * wnd, HB_GT_RECT * rect ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtWVis() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtWVis( HB_GT_WND * wnd, USHORT uiStatus ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtWVis() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtWVis( HB_GT_WND * wnd, USHORT uiStatus ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtSLR() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + System Level Request + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtSLR( HB_GT_SLR * pSLR ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtSLR() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * System Level Request - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtSLR( HB_GT_SLR * pSLR ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtModalRead() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtModalRead( void * ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtModalRead() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtModalRead( void * ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtBeginWrite() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtBeginWrite( void ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtBeginWrite() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtBeginWrite( void ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtEndWrite() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtEndWrite( void ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtEndWrite() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtEndWrite( void ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtFlushCursor() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtFlushCursor( void ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtFlushCursor() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtFlushCursor( void ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtSetColor() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtSetColor( HB_GT_RGB * color ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtSetColor() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtSetColor( HB_GT_RGB * color ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtGetColor() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtGetColor( HB_GT_RGB * color ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtGetColor() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtGetColor( HB_GT_RGB * color ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gtSetBorder() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gtSetBorder( HB_GT_RGB * color ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gtSetBorder() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gtSetBorder( HB_GT_RGB * color ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gt_Init() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_Init( int iFilenoStdin, int iFilenoStdout, int iFilenoStderr ) + $ARGUMENTS$ + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gt_Init() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_Init( int iFilenoStdin, int iFilenoStdout, int iFilenoStderr ) - * $ARGUMENTS$ - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gt_Exit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_Exit( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gt_Exit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_Exit( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_AdjustPos() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_AdjustPos( BYTE * pStr, ULONG ulLen ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_AdjustPos() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_AdjustPos( BYTE * pStr, ULONG ulLen ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_Box() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_Box( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE * pbyFrame, BYTE byAttr ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_Box() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_Box( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE * pbyFrame, BYTE byAttr ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_BoxD() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_BoxD( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE * pbyFrame, BYTE byAttr ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_BoxD() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_BoxD( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE * pbyFrame, BYTE byAttr ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_BoxS() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_BoxS( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE * pbyFrame, BYTE byAttr ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_BoxS() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_BoxS( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE * pbyFrame, BYTE byAttr ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_Col() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_Col( void ) --> ( SHORT )sResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_Col() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_Col( void ) --> ( SHORT )sResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gt_DispBegin() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_DispBegin( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gt_DispBegin() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_DispBegin( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_DispCount() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_DispCount( void ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_DispCount() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_DispCount( void ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gt_DispEnd() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_DispEnd( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gt_DispEnd() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_DispEnd( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_GetBlink() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_GetBlink( void ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_GetBlink() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_GetBlink( void ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_GetCursorStyle() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_GetCursorStyle( void ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_GetCursorStyle() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_GetCursorStyle( void ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_GetScreenHeight() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_GetScreenHeight( void ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_GetScreenHeight() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_GetScreenHeight( void ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_GetScreenWidth() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_GetScreenWidth( void ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_GetScreenWidth() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_GetScreenWidth( void ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gt_GetText() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_GetText( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE * pbyDst ) + $ARGUMENTS$ + + + + + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gt_GetText() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_GetText( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE * pbyDst ) - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_HorizLine() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_HorizLine( USHORT uiRow, USHORT uiLeft, USHORT uiRight, BYTE byChar, BYTE byAttr ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_HorizLine() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_HorizLine( USHORT uiRow, USHORT uiLeft, USHORT uiRight, BYTE byChar, BYTE byAttr ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_IsColor() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_IsColor( void ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_IsColor() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_IsColor( void ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_PreExt() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_PreExt( void ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_PreExt() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_PreExt( void ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_PostExt() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_PostExt( void ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_PostExt() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_PostExt( void ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_Suspend() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + Suspend the terminal before the shell call + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_Suspend( void ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_Suspend() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * Suspend the terminal before the shell call - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_Suspend( void ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_Resume() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + Resume the terminal after the shell call + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_Resume( void ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_Resume() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * Resume the terminal after the shell call - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_Resume( void ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gt_Puts() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_Puts( USHORT uiRow, USHORT uiCol, BYTE byAttr, BYTE * pbyStr, ULONG ulLen ) + $ARGUMENTS$ + + + + + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gt_Puts() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_Puts( USHORT uiRow, USHORT uiCol, BYTE byAttr, BYTE * pbyStr, ULONG ulLen ) - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gt_PutText() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_PutText( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE * pbySrc ) + $ARGUMENTS$ + + + + + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gt_PutText() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_PutText( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE * pbySrc ) - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_ReadKey() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_ReadKey( HB_inkey_enum eventmask ) --> ( int )iResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_ReadKey() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_ReadKey( HB_inkey_enum eventmask ) --> ( int )iResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_RectSize() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_RectSize( USHORT rows, USHORT cols ) --> ( int )iResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_RectSize() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_RectSize( USHORT rows, USHORT cols ) --> ( int )iResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gt_Replicate() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_Replicate( USHORT uiTop, USHORT uiLeft, BYTE byAttr, BYTE byChar, ULONG ulLen ) + $ARGUMENTS$ + + + + + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gt_Replicate() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_Replicate( USHORT uiTop, USHORT uiLeft, BYTE byAttr, BYTE byChar, ULONG ulLen ) - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_Row() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_Row( void ) --> ( SHORT )sResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_Row() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_Row( void ) --> ( SHORT )sResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gt_Scroll() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_Scroll( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE byAttr, SHORT iRows, SHORT iCols ) + $ARGUMENTS$ + + + + + + + + + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gt_Scroll() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_Scroll( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE byAttr, SHORT iRows, SHORT iCols ) - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gt_SetAttribute() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_SetAttribute( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE byAttr ) + $ARGUMENTS$ + + + + + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gt_SetAttribute() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_SetAttribute( USHORT uiTop, USHORT uiLeft, USHORT uiBottom, USHORT uiRight, BYTE byAttr ) - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gt_SetBlink() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_SetBlink( HB_BOOL bBlink ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gt_SetBlink() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_SetBlink( HB_BOOL bBlink ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gt_SetCursorStyle() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_SetCursorStyle( USHORT uiCursorShape ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gt_SetCursorStyle() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_SetCursorStyle( USHORT uiCursorShape ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_SetMode() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_SetMode( USHORT uiRows, USHORT uiCols ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_SetMode() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_SetMode( USHORT uiRows, USHORT uiCols ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gt_SetPos() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_SetPos( SHORT iRow, SHORT iCol, SHORT iMethod ) + $ARGUMENTS$ + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gt_SetPos() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_SetPos( SHORT iRow, SHORT iCol, SHORT iMethod ) - * $ARGUMENTS$ - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_gt_Tone() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_Tone( double dFrequency, double dDuration ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_gt_Tone() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_Tone( double dFrequency, double dDuration ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_Version() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_Version( void ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_Version() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_Version( void ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_gt_VertLine() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_gt_VertLine( USHORT uiCol, USHORT uiTop, USHORT uiBottom, BYTE byChar, BYTE byAttr ) --> ( USHORT )usResult + $ARGUMENTS$ + + + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_gt_VertLine() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_gt_VertLine( USHORT uiCol, USHORT uiTop, USHORT uiBottom, BYTE byChar, BYTE byAttr ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_inkey() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + Wait for keyboard input + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_inkey( HB_BOOL bWait, double dSeconds, HB_inkey_enum event_mask ) --> ( int )iResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_inkey() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * Wait for keyboard input - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_inkey( HB_BOOL bWait, double dSeconds, HB_inkey_enum event_mask ) --> ( int )iResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_inkeyGet() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + Extract the next key from the Harbour keyboard buffer + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_inkeyGet( void ) --> ( int )iResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_inkeyGet() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * Extract the next key from the Harbour keyboard buffer - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_inkeyGet( void ) --> ( int )iResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_inkeyPut() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + Inserts an inkey code into the keyboard buffer + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_inkeyPut( int ch ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_inkeyPut() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * Inserts an inkey code into the keyboard buffer - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_inkeyPut( int ch ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_inkeyLast() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + Return the value of the last key that was extracted + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_inkeyLast( void ) --> ( int )iResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_inkeyLast() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * Return the value of the last key that was extracted - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_inkeyLast( void ) --> ( int )iResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_inkeyNext() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + Return the next key without extracting it + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_inkeyNext( void ) --> ( int )iResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_inkeyNext() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * Return the next key without extracting it - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_inkeyNext( void ) --> ( int )iResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_inkeyPoll() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + Poll the console keyboard to stuff the Harbour buffer + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_inkeyPoll( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_inkeyPoll() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * Poll the console keyboard to stuff the Harbour buffer - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_inkeyPoll( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_inkeyReset() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + Reset the Harbour keyboard buffer + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_inkeyReset( HB_BOOL allocate ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_inkeyReset() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * Reset the Harbour keyboard buffer - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_inkeyReset( HB_BOOL allocate ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_mouseIsPresent() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouseIsPresent( void ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_mouseIsPresent() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouseIsPresent( void ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_mouseGetCursor() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouseGetCursor( void ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_mouseGetCursor() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouseGetCursor( void ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_mouseSetCursor() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouseSetCursor( HB_BOOL bVisible ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_mouseSetCursor() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouseSetCursor( HB_BOOL bVisible ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_mouseCol() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouseCol( void ) --> ( int )iResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_mouseCol() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouseCol( void ) --> ( int )iResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_mouseRow() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouseRow( void ) --> ( int )iResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_mouseRow() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouseRow( void ) --> ( int )iResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_mouseSetPos() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouseSetPos( int iRow, int iCol ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_mouseSetPos() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouseSetPos( int iRow, int iCol ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_mouseIsButtonPressed() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouseIsButtonPressed( int iButton ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_mouseIsButtonPressed() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouseIsButtonPressed( int iButton ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_mouseCountButton() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouseCountButton( void ) --> ( int )iResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_mouseCountButton() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouseCountButton( void ) --> ( int )iResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_mouseSetBounds() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouseSetBounds( int iTop, int iLeft, int iBottom, int iRight ) + $ARGUMENTS$ + + + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_mouseSetBounds() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouseSetBounds( int iTop, int iLeft, int iBottom, int iRight ) - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_mouseGetBounds() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouseGetBounds( int * piTop, int * piLeft, int * piBottom, int * piRight ) + $ARGUMENTS$ + + + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_mouseGetBounds() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouseGetBounds( int * piTop, int * piLeft, int * piBottom, int * piRight ) - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_mouse_Init() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouse_Init( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_mouse_Init() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouse_Init( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_mouse_Exit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouse_Exit( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_mouse_Exit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouse_Exit( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_mouse_IsPresent() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouse_IsPresent( void ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_mouse_IsPresent() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouse_IsPresent( void ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_mouse_Show() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouse_Show( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_mouse_Show() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouse_Show( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_mouse_Hide() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouse_Hide( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_mouse_Hide() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouse_Hide( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_mouse_Col() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouse_Col( void ) --> ( int )iResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_mouse_Col() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouse_Col( void ) --> ( int )iResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_mouse_Row() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouse_Row( void ) --> ( int )iResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_mouse_Row() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouse_Row( void ) --> ( int )iResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_mouse_SetPos() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouse_SetPos( int iRow, int iCol ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_mouse_SetPos() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouse_SetPos( int iRow, int iCol ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_mouse_IsButtonPressed() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouse_IsButtonPressed( int iButton ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_mouse_IsButtonPressed() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouse_IsButtonPressed( int iButton ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_mouse_CountButton() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouse_CountButton( void ) --> ( int )iResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_mouse_CountButton() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouse_CountButton( void ) --> ( int )iResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_mouse_SetBounds() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouse_SetBounds( int iTop, int iLeft, int iBottom, int iRight ) + $ARGUMENTS$ + + + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_mouse_SetBounds() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouse_SetBounds( int iTop, int iLeft, int iBottom, int iRight ) - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_mouse_GetBounds() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_mouse_GetBounds( int * piTop, int * piLeft, int * piBottom, int * piRight ) + $ARGUMENTS$ + + + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_mouse_GetBounds() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_mouse_GetBounds( int * piTop, int * piLeft, int * piBottom, int * piRight ) - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_setkeyInit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_setkeyInit( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_setkeyInit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_setkeyInit( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_setkeyExit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapigt.h" - * hb_setkeyExit( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is gt* (ie. gtdos) - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_setkeyExit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapigt.h" + hb_setkeyExit( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is gt* (ie. gtdos) + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ diff --git a/harbour/doc/en/hb_apiit.txt b/harbour/doc/en/hb_apiit.txt index b2a2e8c9a2..41e17f8836 100644 --- a/harbour/doc/en/hb_apiit.txt +++ b/harbour/doc/en/hb_apiit.txt @@ -15,2288 +15,2288 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_evalLaunch() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_evalLaunch( PHB_EVALINFO pEvalInfo ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_evalLaunch() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_evalLaunch( PHB_EVALINFO pEvalInfo ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_evalNew() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_evalNew( PHB_EVALINFO pEvalInfo, PHB_ITEM pItem ) --> ( HB_BOOL ) bResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_evalNew() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_evalNew( PHB_EVALINFO pEvalInfo, PHB_ITEM pItem ) --> ( HB_BOOL ) bResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_evalPutParam() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_evalPutParam( PHB_EVALINFO pEvalInfo, PHB_ITEM pItem ) --> ( HB_BOOL ) bResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_evalPutParam() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_evalPutParam( PHB_EVALINFO pEvalInfo, PHB_ITEM pItem ) --> ( HB_BOOL ) bResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_evalRelease() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_evalRelease( PHB_EVALINFO pEvalInfo ) --> ( HB_BOOL ) bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_evalRelease() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_evalRelease( PHB_EVALINFO pEvalInfo ) --> ( HB_BOOL ) bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemDo() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemDo( PHB_ITEM pItem, USHORT uiPCount, PHB_ITEM pItemArg1, ... ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * - * - * - * <...> - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemDo() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemDo( PHB_ITEM pItem, USHORT uiPCount, PHB_ITEM pItemArg1, ... ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + + + + <...> + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemDoC() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemDoC( char * szFunc, USHORT uiPCount, PHB_ITEM pItemArg1, ... ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * - * - * - * <...> - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemDoC() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemDoC( char * szFunc, USHORT uiPCount, PHB_ITEM pItemArg1, ... ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + + + + <...> + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemArrayGet() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemArrayGet( PHB_ITEM pArray, ULONG ulIndex ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemArrayGet() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemArrayGet( PHB_ITEM pArray, ULONG ulIndex ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemArrayNew() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemArrayNew( ULONG ulLen ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemArrayNew() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemArrayNew( ULONG ulLen ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemArrayPut() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemArrayPut( PHB_ITEM pArray, ULONG ulIndex, PHB_ITEM pItem ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemArrayPut() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemArrayPut( PHB_ITEM pArray, ULONG ulIndex, PHB_ITEM pItem ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemCopyC() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemCopyC( PHB_ITEM pItem, char * szBuffer, ULONG ulLen ) --> ( ULONG )ulResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemCopyC() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemCopyC( PHB_ITEM pItem, char * szBuffer, ULONG ulLen ) --> ( ULONG )ulResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemFreeC() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemFreeC( char * szText ) --> ( HB_BOOL ) bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemFreeC() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemFreeC( char * szText ) --> ( HB_BOOL ) bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemGetC() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemGetC( PHB_ITEM pItem ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemGetC() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemGetC( PHB_ITEM pItem ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemGetCPtr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemGetCPtr( PHB_ITEM pItem ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemGetCPtr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemGetCPtr( PHB_ITEM pItem ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemGetCLen() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemGetCLen( PHB_ITEM pItem ) --> ( ULONG )ulResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemGetCLen() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemGetCLen( PHB_ITEM pItem ) --> ( ULONG )ulResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemGetDS() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemGetDS( PHB_ITEM pItem, char * szDate ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemGetDS() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemGetDS( PHB_ITEM pItem, char * szDate ) --> ( char * )pszResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemGetDL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemGetDL( PHB_ITEM pItem ) --> ( long )lResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemGetDL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemGetDL( PHB_ITEM pItem ) --> ( long )lResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemGetL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemGetL( PHB_ITEM pItem ) --> ( HB_BOOL ) bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemGetL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemGetL( PHB_ITEM pItem ) --> ( HB_BOOL ) bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemGetND() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemGetND( PHB_ITEM pItem ) --> ( double )dResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemGetND() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemGetND( PHB_ITEM pItem ) --> ( double )dResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemGetNI() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemGetNI( PHB_ITEM pItem ) --> ( int )iResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemGetNI() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemGetNI( PHB_ITEM pItem ) --> ( int )iResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemGetNL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemGetNL( PHB_ITEM pItem ) --> ( long )lResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemGetNL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemGetNL( PHB_ITEM pItem ) --> ( long )lResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_itemGetNLen() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemGetNLen( PHB_ITEM pItem, int * piWidth, int * piDec ) - * $ARGUMENTS$ - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_itemGetNLen() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemGetNLen( PHB_ITEM pItem, int * piWidth, int * piDec ) + $ARGUMENTS$ + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemGetPtr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemGetPtr( PHB_ITEM pItem ) --> ( void * )pResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemGetPtr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemGetPtr( PHB_ITEM pItem ) --> ( void * )pResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemNew() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemNew( PHB_ITEM pNull ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemNew() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemNew( PHB_ITEM pNull ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_itemInit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemInit( PHB_ITEM pItem ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_itemInit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemInit( PHB_ITEM pItem ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemPCount() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemPCount( void ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemPCount() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemPCount( void ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemParam() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * Creates a copy of an item parameter (outside the eval stack) - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemParam( USHORT uiParam ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * The 1-based parameter to copy and retrieve. - * $RETURNS$ - * A pointer to a new copy of the specified item parameter. - * - * $DESCRIPTION$ - * Use this function whenever the pointer needs to be accessed after - * the current function returns; for example, if the pointer is to - * be copied to a static variable or structure member for later access. +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemParam() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + Creates a copy of an item parameter (outside the eval stack) + $SYNTAX$ + C Prototype - * Compare to hb_param(), which simply gets a direct pointer to the - * item on the stack. + #include "hbapiitm.h" + hb_itemParam( USHORT uiParam ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + The 1-based parameter to copy and retrieve. + $RETURNS$ + A pointer to a new copy of the specified item parameter. - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_param() - * $END$ + $DESCRIPTION$ + Use this function whenever the pointer needs to be accessed after + the current function returns; for example, if the pointer is to + be copied to a static variable or structure member for later access. + + Compare to hb_param(), which simply gets a direct pointer to the + item on the stack. + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + hb_param() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemPutC() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemPutC( PHB_ITEM pItem, char * szText ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemPutC() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemPutC( PHB_ITEM pItem, char * szText ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemPutCPtr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemPutCPtr( PHB_ITEM pItem, char * szText ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemPutCPtr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemPutCPtr( PHB_ITEM pItem, char * szText ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemPutCLPtr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemPutCLPtr( PHB_ITEM pItem, char * szText, ULONG ulLen ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemPutCLPtr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemPutCLPtr( PHB_ITEM pItem, char * szText, ULONG ulLen ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemPutCL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemPutCL( PHB_ITEM pItem, char * szText, ULONG ulLen ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemPutCL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemPutCL( PHB_ITEM pItem, char * szText, ULONG ulLen ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_itemSetCMemo() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemSetCMemo( PHB_ITEM pItem ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_itemSetCMemo() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemSetCMemo( PHB_ITEM pItem ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemPutD() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemPutD( PHB_ITEM pItem, long lYear, long lMonth, long lDay ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemPutD() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemPutD( PHB_ITEM pItem, long lYear, long lMonth, long lDay ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemPutDS() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemPutDS( PHB_ITEM pItem, char * szDate ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemPutDS() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemPutDS( PHB_ITEM pItem, char * szDate ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemPutDL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemPutDL( PHB_ITEM pItem, long lJulian ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemPutDL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemPutDL( PHB_ITEM pItem, long lJulian ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemPutL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemPutL( PHB_ITEM pItem, HB_BOOL bValue ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemPutL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemPutL( PHB_ITEM pItem, HB_BOOL bValue ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemPutND() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemPutND( PHB_ITEM pItem, double dNumber ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemPutND() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemPutND( PHB_ITEM pItem, double dNumber ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemPutNI() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemPutNI( PHB_ITEM pItem, int iNumber ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemPutNI() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemPutNI( PHB_ITEM pItem, int iNumber ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemPutNL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemPutNL( PHB_ITEM pItem, long lNumber ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemPutNL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemPutNL( PHB_ITEM pItem, long lNumber ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemPutNLen() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemPutNLen( PHB_ITEM pItem, double dNumber, int iWidth, int iDec ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemPutNLen() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemPutNLen( PHB_ITEM pItem, double dNumber, int iWidth, int iDec ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemPutNDLen() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemPutNDLen( PHB_ITEM pItem, double dNumber, int iWidth, int iDec ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemPutNDLen() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemPutNDLen( PHB_ITEM pItem, double dNumber, int iWidth, int iDec ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemPutNILen() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemPutNILen( PHB_ITEM pItem, int iNumber, int iWidth ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemPutNILen() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemPutNILen( PHB_ITEM pItem, int iNumber, int iWidth ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemPutNLLen() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemPutNLLen( PHB_ITEM pItem, long lNumber, int iWidth ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemPutNLLen() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemPutNLLen( PHB_ITEM pItem, long lNumber, int iWidth ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemPutPtr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemPutPtr( PHB_ITEM pItem, void * pValue ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemPutPtr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemPutPtr( PHB_ITEM pItem, void * pValue ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemRelease() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemRelease( PHB_ITEM pItem ) --> ( HB_BOOL ) bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemRelease() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemRelease( PHB_ITEM pItem ) --> ( HB_BOOL ) bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemReturn() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemReturn( PHB_ITEM pItem ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemReturn() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemReturn( PHB_ITEM pItem ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemSize() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemSize( PHB_ITEM pItem ) --> ( ULONG )ulResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemSize() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemSize( PHB_ITEM pItem ) --> ( ULONG )ulResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemType() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemType( PHB_ITEM pItem ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemType() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemType( PHB_ITEM pItem ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemTypeStr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemTypeStr( PHB_ITEM pItem ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemTypeStr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemTypeStr( PHB_ITEM pItem ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemParamPtr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemParamPtr( USHORT uiParam, int iMask ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemParamPtr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemParamPtr( USHORT uiParam, int iMask ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemReturnPtr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemReturnPtr( void ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemReturnPtr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemReturnPtr( void ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemStrCmp() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * Our string compare - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemStrCmp( PHB_ITEM pFirst, PHB_ITEM pSecond, HB_BOOL bForceExact ) --> ( int )iResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemStrCmp() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + Our string compare + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemStrCmp( PHB_ITEM pFirst, PHB_ITEM pSecond, HB_BOOL bForceExact ) --> ( int )iResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_itemCopy() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * Copies an item to one place to another respecting its containts - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemCopy( PHB_ITEM pDest, PHB_ITEM pSource ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_itemCopy() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + Copies an item to one place to another respecting its containts + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemCopy( PHB_ITEM pDest, PHB_ITEM pSource ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_itemClear() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemClear( PHB_ITEM pItem ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_itemClear() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemClear( PHB_ITEM pItem ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemUnRef() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * De-references passed variable - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemUnRef( PHB_ITEM pItem ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemUnRef() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + De-references passed variable + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemUnRef( PHB_ITEM pItem ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemStr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * Convert a number to a string - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemStr( PHB_ITEM pNumber, PHB_ITEM pWidth, PHB_ITEM pDec ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemStr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + Convert a number to a string + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemStr( PHB_ITEM pNumber, PHB_ITEM pWidth, PHB_ITEM pDec ) --> ( char * )pszResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemString() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * Convert any scalar to a string - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemString( PHB_ITEM pItem, ULONG * ulLen, HB_BOOL * bFreeReq ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemString() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + Convert any scalar to a string + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemString( PHB_ITEM pItem, ULONG * ulLen, HB_BOOL * bFreeReq ) --> ( char * )pszResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemValToStr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * Convert any scalar to a string - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemValToStr( PHB_ITEM pItem ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemValToStr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + Convert any scalar to a string + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemValToStr( PHB_ITEM pItem ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_itemPadConv() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemPadConv( PHB_ITEM pItem, char * buffer, ULONG * pulSize ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_itemPadConv() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemPadConv( PHB_ITEM pItem, char * buffer, ULONG * pulSize ) --> ( char * )pszResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_itemSwap() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapiitm.h" - * hb_itemSwap( PHB_ITEM pItem1, PHB_ITEM pItem2 ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_itemSwap() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapiitm.h" + hb_itemSwap( PHB_ITEM pItem1, PHB_ITEM pItem2 ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ diff --git a/harbour/doc/en/hb_apiln.txt b/harbour/doc/en/hb_apiln.txt index f1c1534027..fb899509fa 100644 --- a/harbour/doc/en/hb_apiln.txt +++ b/harbour/doc/en/hb_apiln.txt @@ -15,372 +15,372 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_langRegister() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Language and Nation - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapilng.h" - * hb_langRegister( PHB_LANG lang ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is lang - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_langRegister() + $CATEGORY$ + API + $SUBCATEGORY$ + Language and Nation + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapilng.h" + hb_langRegister( PHB_LANG lang ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is lang + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_langDeRegister() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Language and Nation - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapilng.h" - * hb_langDeRegister( char * pszID ) --> ( HB_BOOL )bResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is lang - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_langDeRegister() + $CATEGORY$ + API + $SUBCATEGORY$ + Language and Nation + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapilng.h" + hb_langDeRegister( char * pszID ) --> ( HB_BOOL )bResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is lang + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_langFind() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Language and Nation - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapilng.h" - * hb_langFind( char * pszID ) --> ( PHB_LANG )pResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is lang - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_langFind() + $CATEGORY$ + API + $SUBCATEGORY$ + Language and Nation + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapilng.h" + hb_langFind( char * pszID ) --> ( PHB_LANG )pResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is lang + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_langSelect() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Language and Nation - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapilng.h" - * hb_langSelect( PHB_LANG lang ) --> ( PHB_LANG )pResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is lang - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_langSelect() + $CATEGORY$ + API + $SUBCATEGORY$ + Language and Nation + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapilng.h" + hb_langSelect( PHB_LANG lang ) --> ( PHB_LANG )pResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is lang + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_langSelectID() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Language and Nation - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapilng.h" - * hb_langSelectID( char * pszID ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is lang - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_langSelectID() + $CATEGORY$ + API + $SUBCATEGORY$ + Language and Nation + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapilng.h" + hb_langSelectID( char * pszID ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is lang + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_langDGetItem() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Language and Nation - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapilng.h" - * hb_langDGetItem( int iIndex ) --> ( void * )pResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is lang - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_langDGetItem() + $CATEGORY$ + API + $SUBCATEGORY$ + Language and Nation + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapilng.h" + hb_langDGetItem( int iIndex ) --> ( void * )pResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is lang + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_langID() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Language and Nation - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapilng.h" - * hb_langID( void ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is lang - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_langID() + $CATEGORY$ + API + $SUBCATEGORY$ + Language and Nation + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapilng.h" + hb_langID( void ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is lang + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_langName() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Language and Nation - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapilng.h" - * hb_langName( void ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is lang - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_langName() + $CATEGORY$ + API + $SUBCATEGORY$ + Language and Nation + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapilng.h" + hb_langName( void ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is lang + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_langDGetErrorDesc() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Language and Nation - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapilng.h" - * hb_langDGetErrorDesc( ULONG ulIndex ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is lang - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_langDGetErrorDesc() + $CATEGORY$ + API + $SUBCATEGORY$ + Language and Nation + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapilng.h" + hb_langDGetErrorDesc( ULONG ulIndex ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is lang + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_LANG_REQUEST() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Language and Nation - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapilng.h" - * HB_LANG_REQUEST( id ) --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapilng.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_LANG_REQUEST() + $CATEGORY$ + API + $SUBCATEGORY$ + Language and Nation + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapilng.h" + HB_LANG_REQUEST( id ) --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapilng.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ diff --git a/harbour/doc/en/hb_apird.txt b/harbour/doc/en/hb_apird.txt index a87cc132e3..2b48240e45 100644 --- a/harbour/doc/en/hb_apird.txt +++ b/harbour/doc/en/hb_apird.txt @@ -2,8838 +2,8827 @@ * $Id$ */ -/* - * The following parts are Copyright of the individual authors. - * www - http://harbour-project.org - * - * Copyright 1999 {list of individual authors and e-mail addresses} - * Header file for the API - * - * See COPYING for licensing terms. - * - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_rddInsertAreaNode() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapirdd.h" - * hb_rddInsertAreaNode( char *szDriver ) --> ( USHORT )usResult - * $ARGUMENTS$ - * <*szDriver> - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rdd, nulsys, dbfntx, dbfcdx - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_rddGetCurrentWorkAreaNumber() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapirdd.h" - * hb_rddGetCurrentWorkAreaNumber( void ) --> ( int )iResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rdd, nulsys, dbfntx, dbfcdx - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_rddGetCurrentWorkAreaPointer() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapirdd.h" - * hb_rddGetCurrentWorkAreaPointer( void ) --> ( void * )pResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rdd, nulsys, dbfntx, dbfcdx - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_rddSelectWorkAreaAlias() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapirdd.h" - * hb_rddSelectWorkAreaAlias( char * szAlias ) --> ( HB_ERRCODE )hResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rdd, nulsys, dbfntx, dbfcdx - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_rddSelectWorkAreaNumber() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapirdd.h" - * hb_rddSelectWorkAreaNumber( int iArea ) --> ( HB_ERRCODE )hResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rdd, nulsys, dbfntx, dbfcdx - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_rddSelectWorkAreaSymbol() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapirdd.h" - * hb_rddSelectWorkAreaSymbol( PHB_SYMB pSymAlias ) --> ( HB_ERRCODE )hResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rdd, nulsys, dbfntx, dbfcdx - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_rddGetFieldValue() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapirdd.h" - * hb_rddGetFieldValue( PHB_ITEM pItem, PHB_SYMB pFieldSymbol ) --> ( HB_ERRCODE )hResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rdd, nulsys, dbfntx, dbfcdx - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_rddPutFieldValue() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapirdd.h" - * hb_rddPutFieldValue( PHB_ITEM pItem, PHB_SYMB pFieldSymbol ) --> ( HB_ERRCODE )hResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rdd, nulsys, dbfntx, dbfcdx - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_rddFieldGet() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapirdd.h" - * hb_rddFieldGet( PHB_ITEM pItem, PHB_SYMB pFieldSymbol ) --> ( HB_ERRCODE )hResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rdd, nulsys, dbfntx, dbfcdx - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_rddFieldPut() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapirdd.h" - * hb_rddFieldPut( PHB_ITEM pItem, PHB_SYMB pFieldSymbol ) --> ( HB_ERRCODE )hResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rdd, nulsys, dbfntx, dbfcdx - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_rddShutDown() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapirdd.h" - * hb_rddShutDown( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rdd, nulsys, dbfntx, dbfcdx - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_rddInherit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapirdd.h" - * hb_rddInherit( PRDDFUNCS pTable, PRDDFUNCS pSubTable, PRDDFUNCS pSuperTable, BYTE * szDrvName ) --> ( HB_ERRCODE )hResult - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rdd, nulsys, dbfntx, dbfcdx - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_rddDisinherit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapirdd.h" - * hb_rddDisinherit( BYTE * drvName ) --> ( HB_ERRCODE )hResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rdd, nulsys, dbfntx, dbfcdx - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_rddExtendType() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapirdd.h" - * hb_rddExtendType( USHORT fieldType ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rdd, nulsys, dbfntx, dbfcdx - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_rddFieldType() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbapirdd.h" - * hb_rddFieldType( USHORT extendType ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rdd, nulsys, dbfntx, dbfcdx - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_BOF() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_BOF( w, sp ) --> lprfsHost->bof )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->bof )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_EOF() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_EOF( w, sp ) --> lprfsHost->eof )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->eof )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_FOUND() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_FOUND( w, sp ) --> lprfsHost->found )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->found )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_GOTO() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_GOTO( w, l ) --> lprfsHost->go )( w, l ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->go )( w, l ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_GOTOID() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_GOTOID( w, sp ) --> lprfsHost->goToId )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->goToId )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_GOBOTTOM() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_GOBOTTOM( w ) --> lprfsHost->goBottom )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->goBottom )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_GOTOP() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_GOTOP( w ) --> lprfsHost->goTop )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->goTop )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_SEEK() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_SEEK( w, i1, v, i2 ) --> lprfsHost->seek )( w, i1, v, i2 ) )> - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * lprfsHost->seek )( w, i1, v, i2 ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_SKIP() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_SKIP( w, l ) --> lprfsHost->skip )( w, l ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->skip )( w, l ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_SKIPFILTER() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_SKIPFILTER( w, l ) --> lprfsHost->skipFilter )( w, l ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->skipFilter )( w, l ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_SKIPRAW() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_SKIPRAW( w, l ) --> lprfsHost->skipRaw )( w, l ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->skipRaw )( w, l ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ADDFIELD() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ADDFIELD( w, ip ) --> lprfsHost->addField )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->addField )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_APPEND() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_APPEND( w, l ) --> lprfsHost->append )( w, l ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->append )( w, l ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_CREATEFIELDS() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_CREATEFIELDS( w, v ) --> lprfsHost->createFields )( w, v ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->createFields )( w, v ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_DELETE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_DELETE( w ) --> lprfsHost->deleterec )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->deleterec )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_DELETED() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_DELETED( w, sp ) --> lprfsHost->deleted )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->deleted )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_FIELDCOUNT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_FIELDCOUNT( w, sp ) --> lprfsHost->fieldCount )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->fieldCount )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_FIELDDISPLAY() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_FIELDDISPLAY( w, sp ) --> lprfsHost->fieldDisplay )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->fieldDisplay )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_FIELDINFO() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_FIELDINFO( w, s1, s2, v ) --> lprfsHost->fieldInfo )( w, s1, s2, v ) )> - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * lprfsHost->fieldInfo )( w, s1, s2, v ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_FIELDNAME() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_FIELDNAME( w, i, bp ) --> lprfsHost->fieldName )( w, i, bp ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * lprfsHost->fieldName )( w, i, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_FLUSH() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_FLUSH( w ) --> lprfsHost->flush )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->flush )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_GETREC() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_GETREC( w, bpp ) --> lprfsHost->getRec )( w, bpp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->getRec )( w, bpp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_GETVALUE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_GETVALUE( w, i, v ) --> lprfsHost->getValue )( w, i, v ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * lprfsHost->getValue )( w, i, v ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_GETVARLEN() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_GETVARLEN( w, i, lp ) --> lprfsHost->getVarLen )( w, i, lp ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * lprfsHost->getVarLen )( w, i, lp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_GOCOLD() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_GOCOLD( w ) --> lprfsHost->goCold )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->goCold )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_GOHOT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_GOHOT( w ) --> lprfsHost->goHot )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->goHot )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_PUTVALUE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_PUTVALUE( w, i, v ) --> lprfsHost->putValue )( w, i, v ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * lprfsHost->putValue )( w, i, v ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_PUTREC() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_PUTREC( w, bp ) --> lprfsHost->putRec )( w, bp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->putRec )( w, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_RECALL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_RECALL( w ) --> lprfsHost->recall )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->recall )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_RECCOUNT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_RECCOUNT( w, sp ) --> lprfsHost->reccount )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->reccount )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_RECINFO() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_RECINFO( w, v1, i, v2 ) --> lprfsHost->recInfo )( w, v1, i, v2 ) )> - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * lprfsHost->recInfo )( w, v1, i, v2 ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_RECNO() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_RECNO( w, i ) --> lprfsHost->recno )( w, i ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->recno )( w, i ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_SETFIELDEXTENT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_SETFIELDEXTENT( w, s ) --> lprfsHost->setFieldExtent )( w, s ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->setFieldExtent )( w, s ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ALIAS() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ALIAS( w, bp ) --> lprfsHost->alias )( w, bp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->alias )( w, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_CLOSE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_CLOSE( w ) --> lprfsHost->close )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->close )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_CREATE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_CREATE( w, ip ) --> lprfsHost->create )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->create )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_INFO() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_INFO( w, i, g ) --> lprfsHost->info )( w, i, g ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * lprfsHost->info )( w, i, g ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_NEW() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_NEW( w ) --> lprfsHost->newarea )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->newarea )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_OPEN() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_OPEN( w, ip ) --> lprfsHost->open )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->open )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_RELEASE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_RELEASE( w ) --> lprfsHost->release )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->release )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_STRUCTSIZE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_STRUCTSIZE( w, sp ) --> lprfsHost->structSize )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->structSize )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_SYSNAME() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_SYSNAME( w, bp ) --> lprfsHost->sysName )( w, bp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->sysName )( w, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_DBEVAL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_DBEVAL( w, ip ) --> lprfsHost->dbEval )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->dbEval )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_PACK() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_PACK( w ) --> lprfsHost->pack )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->pack )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_PACKREC() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_PACKREC( w, l, sp ) --> lprfsHost->packRec )( w, l, sp ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * lprfsHost->packRec )( w, l, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_SORT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_SORT( w, ip ) --> lprfsHost->sort )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->sort )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_TRANS() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_TRANS( w, ip ) --> lprfsHost->trans )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->trans )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_TRANSREC() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_TRANSREC( w, ip ) --> lprfsHost->transRec )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->transRec )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ZAP() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ZAP( w ) --> lprfsHost->zap )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->zap )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_CHILDEND() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_CHILDEND( w, ip ) --> lprfsHost->childEnd )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->childEnd )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_CHILDSTART() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_CHILDSTART( w, ip ) --> lprfsHost->childStart )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->childStart )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_CHILDSYNC() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_CHILDSYNC( w, ip ) --> lprfsHost->childSync )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->childSync )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_SYNCCHILDREN() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_SYNCCHILDREN( w ) --> lprfsHost->syncChildren )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->syncChildren )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_CLEARREL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_CLEARREL( w ) --> lprfsHost->clearRel )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->clearRel )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_FORCEREL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_FORCEREL( w ) --> lprfsHost->forceRel )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->forceRel )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_RELAREA() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_RELAREA( w, s, sp ) --> lprfsHost->relArea )( w, s, sp ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * lprfsHost->relArea )( w, s, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_RELEVAL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_RELEVAL( w, ip ) --> lprfsHost->relEval )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->relEval )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_RELTEXT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_RELTEXT( w, s, bp ) --> lprfsHost->relText )( w, s, bp ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * lprfsHost->relText )( w, s, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_SETREL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_SETREL( w, ip ) --> lprfsHost->setRel )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->setRel )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ORDLSTADD() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ORDLSTADD( w, lp ) --> lprfsHost->orderListAdd )( w, lp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->orderListAdd )( w, lp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ORDLSTDELETE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ORDLSTDELETE( w, lp ) --> lprfsHost->orderListDelete )( w, lp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->orderListDelete )( w, lp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ORDLSTFOCUS() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ORDLSTFOCUS( w, lp ) --> lprfsHost->orderListFocus )( w, lp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->orderListFocus )( w, lp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ORDLSTREBUILD() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ORDLSTREBUILD( w ) --> lprfsHost->orderListRebuild )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->orderListRebuild )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ORDLSTCLEAR() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ORDLSTCLEAR( w ) --> lprfsHost->orderListClear )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->orderListClear )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ORDSETCOND() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ORDSETCOND( w, ip ) --> lprfsHost->orderCondition )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->orderCondition )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ORDCREATE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ORDCREATE( w, ip ) --> lprfsHost->orderCreate )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->orderCreate )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ORDDESTROY() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ORDDESTROY( w, p ) --> lprfsHost->orderDestroy )( w, p ) )> - * $ARGUMENTS$ - * - * - *

- * $RETURNS$ - * lprfsHost->orderDestroy )( w, p ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ORDINFO() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ORDINFO( w, i, p ) --> lprfsHost->orderInfo )( w, i, p ) )> - * $ARGUMENTS$ - * - * - * - * - *

- * $RETURNS$ - * lprfsHost->orderInfo )( w, i, p ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ORDEXPR() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ORDEXPR( w, p ) --> lprfsHost->orderInfo )( w, DBOI_EXPRESSION, p ) )> - * $ARGUMENTS$ - * - * - *

- * $RETURNS$ - * lprfsHost->orderInfo )( w, DBOI_EXPRESSION, p ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ORDCOND() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ORDCOND( w, p ) --> lprfsHost->orderInfo )( w, DBOI_CONDITION, p ) )> - * $ARGUMENTS$ - * - * - *

- * $RETURNS$ - * lprfsHost->orderInfo )( w, DBOI_CONDITION, p ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ORDRECNO() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ORDRECNO( w, p ) --> lprfsHost->orderInfo )( w, DBOI_RECNO, p ) )> - * $ARGUMENTS$ - * - * - *

- * $RETURNS$ - * lprfsHost->orderInfo )( w, DBOI_RECNO, p ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ORDPOS() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ORDPOS( w, p ) --> lprfsHost->orderInfo )( w, DBOI_POSITION, p ) )> - * $ARGUMENTS$ - * - * - *

- * $RETURNS$ - * lprfsHost->orderInfo )( w, DBOI_POSITION, p ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ORDNUMBER() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ORDNUMBER( w, p ) --> lprfsHost->orderInfo )( w, DBOI_NUMBER, p ) )> - * $ARGUMENTS$ - * - * - *

- * $RETURNS$ - * lprfsHost->orderInfo )( w, DBOI_NUMBER, p ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ORDNAME() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ORDNAME( w, p ) --> lprfsHost->orderInfo )( w, DBOI_NAME, p ) )> - * $ARGUMENTS$ - * - * - *

- * $RETURNS$ - * lprfsHost->orderInfo )( w, DBOI_NAME, p ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ORDBAGNAME() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ORDBAGNAME( w, p ) --> lprfsHost->orderInfo )( w, DBOI_BAGNAME, p ) )> - * $ARGUMENTS$ - * - * - *

- * $RETURNS$ - * lprfsHost->orderInfo )( w, DBOI_BAGNAME, p ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ORDBAGEXT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ORDBAGEXT( w, p ) --> lprfsHost->orderInfo )( w, DBOI_BAGEXT, p ) )> - * $ARGUMENTS$ - * - * - *

- * $RETURNS$ - * lprfsHost->orderInfo )( w, DBOI_BAGEXT, p ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_CLEARFILTER() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_CLEARFILTER( w ) --> lprfsHost->clearFilter )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->clearFilter )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_CLEARLOCATE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_CLEARLOCATE( w ) --> lprfsHost->clearLocate )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->clearLocate )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_CLEARSCOPE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_CLEARSCOPE( w ) --> lprfsHost->clearScope )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->clearScope )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_COUNTSCOPE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_COUNTSCOPE( w, ip, lp ) --> lprfsHost->countScope )( w, ip, lp ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * lprfsHost->countScope )( w, ip, lp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_FILTERTEXT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_FILTERTEXT( w, bp ) --> lprfsHost->filterText )( w, bp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->filterText )( w, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_SCOPEINFO() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_SCOPEINFO( w, i, v ) --> lprfsHost->scopeInfo )( w, i, v ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * lprfsHost->scopeInfo )( w, i, v ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_SETFILTER() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_SETFILTER( w, ip ) --> lprfsHost->setFilter )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->setFilter )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_SETLOCATE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_SETLOCATE( w, ip ) --> lprfsHost->setLocate )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->setLocate )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_SETSCOPE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_SETSCOPE( w, ip ) --> lprfsHost->setScope )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->setScope )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_SKIPSCOPE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_SKIPSCOPE( w, bp, l ) --> lprfsHost->skipScope )( w, bp, l ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * lprfsHost->skipScope )( w, bp, l ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_COMPILE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_COMPILE( w, bp ) --> lprfsHost->compile )( w, bp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->compile )( w, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_ERROR() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_ERROR( w, ip ) --> lprfsHost->error )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->error )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_EVALBLOCK() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_EVALBLOCK( w, v ) --> lprfsHost->evalBlock )( w, v ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->evalBlock )( w, v ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_GETLOCKS() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_GETLOCKS( w, g ) --> lprfsHost->info )( w, DBI_GETLOCKARRAY, g ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->info )( w, DBI_GETLOCKARRAY, g ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_RAWLOCK() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_RAWLOCK( w, i, l ) --> lprfsHost->rawlock )( w, i, l ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * lprfsHost->rawlock )( w, i, l ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_LOCK() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_LOCK( w, sp ) --> lprfsHost->lock )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->lock )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_UNLOCK() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_UNLOCK( w, l ) --> lprfsHost->unlock )( w, l ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->unlock )( w, l ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_CLOSEMEMFILE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_CLOSEMEMFILE( w ) --> lprfsHost->closeMemFile )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->closeMemFile )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_CREATEMEMFILE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_CREATEMEMFILE( w, bp ) --> lprfsHost->createMemFile )( w, bp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->createMemFile )( w, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_GETVALUEFILE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_GETVALUEFILE( w, i, bp ) --> lprfsHost->getValueFile )( w, i, bp ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * lprfsHost->getValueFile )( w, i, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_OPENMEMFILE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_OPENMEMFILE( w, bp ) --> lprfsHost->openMemFile )( w, bp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->openMemFile )( w, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_PUTVALUEFILE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_PUTVALUEFILE( w, i, bp ) --> lprfsHost->putValueFile )( w, i, bp ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * lprfsHost->putValueFile )( w, i, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_READDBHEADER() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_READDBHEADER( w ) --> lprfsHost->readDBHeader )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->readDBHeader )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_WRITEDBHEADER() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_WRITEDBHEADER( w ) --> lprfsHost->writeDBHeader )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * lprfsHost->writeDBHeader )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_RECSIZE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_RECSIZE( w, lp ) --> lprfsHost->info )( w, DBI_GETRECSIZE, lp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->info )( w, DBI_GETRECSIZE, lp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_HEADERSIZE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_HEADERSIZE( w, fp ) --> lprfsHost->info )( w, DBI_GETHEADERSIZE, fp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->info )( w, DBI_GETHEADERSIZE, fp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_LUPDATE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_LUPDATE( w, fp ) --> lprfsHost->info )( w, DBI_LASTUPDATE, fp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->info )( w, DBI_LASTUPDATE, fp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_SETDELIM() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_SETDELIM( w, fp ) --> lprfsHost->info )( w, DBI_SETDELIMITER, fp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->info )( w, DBI_SETDELIMITER, fp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_GETDELIM() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_GETDELIM( w, fp ) --> lprfsHost->info )( w, DBI_GETDELIMITER, fp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->info )( w, DBI_GETDELIMITER, fp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELF_TABLEEXT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SELF_TABLEEXT( w, fp ) --> lprfsHost->info )( w, DBI_TABLEEXT, fp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lprfsHost->info )( w, DBI_TABLEEXT, fp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_BOF() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_BOF( w, sp ) --> bof )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * bof )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_EOF() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_EOF( w, sp ) --> eof )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * eof )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_FOUND() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_FOUND( w, sp ) --> found )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * found )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_GOTO() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_GOTO( w, l ) --> go )( w, l ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * go )( w, l ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_GOTOID() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_GOTOID( w, sp ) --> goToId )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * goToId )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_GOBOTTOM() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_GOBOTTOM( w ) --> goBottom )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * goBottom )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_GOTOP() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_GOTOP( w ) --> goTop )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * goTop )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_SEEK() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_SEEK( w, i1, v, i2 ) --> seek )( w, i1, v, i2 ) )> - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * seek )( w, i1, v, i2 ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_SKIP() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_SKIP( w, l ) --> skip )( w, l ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * skip )( w, l ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_SKIPFILTER() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_SKIPFILTER( w, l ) --> skipFilter )( w, l ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * skipFilter )( w, l ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_SKIPRAW() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_SKIPRAW( w, l ) --> skipRaw )( w, l ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * skipRaw )( w, l ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ADDFIELD() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ADDFIELD( w, ip ) --> addField )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * addField )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_APPEND() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_APPEND( w, l ) --> append )( w, l ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * append )( w, l ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_CREATEFIELDS() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_CREATEFIELDS( w, v ) --> createFields )( w, v ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * createFields )( w, v ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_DELETE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_DELETE( w ) --> deleterec )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * deleterec )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_DELETED() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_DELETED( w, sp ) --> deleted )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * deleted )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_FIELDCOUNT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_FIELDCOUNT( w, sp ) --> fieldCount )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * fieldCount )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_FIELDDISPLAY() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_FIELDDISPLAY( w, sp ) --> fieldDisplay )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * fieldDisplay )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_FIELDINFO() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_FIELDINFO( w, s1, s2, v ) --> fieldInfo )( w, s1, s2, v ) )> - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * fieldInfo )( w, s1, s2, v ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_FIELDNAME() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_FIELDNAME( w, i, bp ) --> fieldName )( w, i, bp ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * fieldName )( w, i, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_FLUSH() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_FLUSH( w ) --> flush )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * flush )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_GETREC() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_GETREC( w, bpp ) --> getRec )( w, bpp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * getRec )( w, bpp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_GETVALUE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_GETVALUE( w, i, v ) --> getValue )( w, i, v ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * getValue )( w, i, v ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_GETVARLEN() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_GETVARLEN( w, i, lp ) --> getVarLen )( w, i, lp ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * getVarLen )( w, i, lp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_GOCOLD() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_GOCOLD( w ) --> goCold )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * goCold )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_GOHOT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_GOHOT( w ) --> goHot )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * goHot )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_PUTVALUE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_PUTVALUE( w, i, v ) --> putValue )( w, i, v ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * putValue )( w, i, v ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_PUTREC() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_PUTREC( w, bp ) --> putRec )( w, bp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * putRec )( w, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_RECALL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_RECALL( w ) --> recall )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * recall )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_RECCOUNT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_RECCOUNT( w, sp ) --> reccount )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * reccount )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_RECINFO() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_RECINFO( w, v1, i, v2 ) --> recInfo )( w, v1, i, v2 ) )> - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $RETURNS$ - * recInfo )( w, v1, i, v2 ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_RECNO() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_RECNO( w, sp ) --> recno )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * recno )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_SETFIELDEXTENT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_SETFIELDEXTENT( w, s ) --> setFieldExtent )( w, s ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * setFieldExtent )( w, s ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ALIAS() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ALIAS( w, bp ) --> alias )( w, bp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * alias )( w, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_CLOSE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_CLOSE( w ) --> close )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * close )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_CREATE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_CREATE( w, ip ) --> create )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * create )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_INFO() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_INFO( w, i, g ) --> info )( w, i, g ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * info )( w, i, g ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_NEW() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_NEW( w ) --> newarea )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * newarea )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_OPEN() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_OPEN( w, ip ) --> open )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * open )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_RELEASE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_RELEASE( w ) --> release )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * release )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_STRUCTSIZE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_STRUCTSIZE( w, sp ) --> structSize )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * structSize )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_SYSNAME() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_SYSNAME( w, bp ) --> sysName )( w, bp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * sysName )( w, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_DBEVAL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_DBEVAL( w, ip ) --> dbEval )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * dbEval )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_PACK() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_PACK( w ) --> pack )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * pack )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_PACKREC() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_PACKREC( w, l, sp ) --> packRec )( w, l, sp ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * packRec )( w, l, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_SORT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_SORT( w, ip ) --> sort )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * sort )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_TRANS() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_TRANS( w, ip ) --> trans )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * trans )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_TRANSREC() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_TRANSREC( w, ip ) --> transRec )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * transRec )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ZAP() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ZAP( w ) --> zap )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * zap )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_CHILDEND() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_CHILDEND( w, ip ) --> childEnd )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * childEnd )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_CHILDSTART() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_CHILDSTART( w, ip ) --> childStart )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * childStart )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_CHILDSYNC() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_CHILDSYNC( w, ip ) --> childSync )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * childSync )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_SYNCCHILDREN() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_SYNCCHILDREN( w ) --> syncChildren )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * syncChildren )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_CLEARREL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_CLEARREL( w ) --> clearRel )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * clearRel )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_FORCEREL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_FORCEREL( w ) --> forceRel )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * forceRel )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_RELAREA() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_RELAREA( w, s, sp ) --> relArea )( w, s, sp ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * relArea )( w, s, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_RELEVAL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_RELEVAL( w, ip ) --> relEval )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * relEval )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_RELTEXT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_RELTEXT( w, s, bp ) --> relText )( w, s, bp ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * relText )( w, s, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_SETREL() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_SETREL( w, ip ) --> setRel )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * setRel )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ORDLSTADD() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ORDLSTADD( w, lp ) --> orderListAdd )( w, lp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * orderListAdd )( w, lp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ORDLSTDELETE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ORDLSTDELETE( w, lp ) --> orderListDelete )( w, lp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * orderListDelete )( w, lp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ORDLSTFOCUS() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ORDLSTFOCUS( w, lp ) --> orderListFocus )( w, lp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * orderListFocus )( w, lp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ORDLSTREBUILD() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ORDLSTREBUILD( w ) --> orderListRebuild )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * orderListRebuild )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ORDLSTCLEAR() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ORDLSTCLEAR( w ) --> orderListClear )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * orderListClear )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ORDSETCOND() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ORDSETCOND( w, ip ) --> orderCondition )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * orderCondition )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ORDCREATE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ORDCREATE( w, ip ) --> orderCreate )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * orderCreate )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ORDDELETE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ORDDELETE( w, ip ) --> orderDelete )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * orderDelete )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ORDINFO() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ORDINFO( w, i, p ) --> orderInfo )( w, i, p ) )> - * $ARGUMENTS$ - * - * - * - * - *

- * $RETURNS$ - * orderInfo )( w, i, p ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ORDEXPR() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ORDEXPR( w, p ) --> orderInfo )( w, DBOI_EXPRESSION, p ) )> - * $ARGUMENTS$ - * - * - *

- * $RETURNS$ - * orderInfo )( w, DBOI_EXPRESSION, p ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ORDCOND() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ORDCOND( w, p ) --> orderInfo )( w, DBOI_CONDITION, p ) )> - * $ARGUMENTS$ - * - * - *

- * $RETURNS$ - * orderInfo )( w, DBOI_CONDITION, p ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ORDRECNO() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ORDRECNO( w, p ) --> orderInfo )( w, DBOI_RECNO, p ) )> - * $ARGUMENTS$ - * - * - *

- * $RETURNS$ - * orderInfo )( w, DBOI_RECNO, p ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ORDPOS() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ORDPOS( w, p ) --> orderInfo )( w, DBOI_POSITION, p ) )> - * $ARGUMENTS$ - * - * - *

- * $RETURNS$ - * orderInfo )( w, DBOI_POSITION, p ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ORDNUMBER() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ORDNUMBER( w, p ) --> orderInfo )( w, DBOI_NUMBER, p ) )> - * $ARGUMENTS$ - * - * - *

- * $RETURNS$ - * orderInfo )( w, DBOI_NUMBER, p ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ORDNAME() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ORDNAME( w, p ) --> orderInfo )( w, DBOI_NAME, p ) )> - * $ARGUMENTS$ - * - * - *

- * $RETURNS$ - * orderInfo )( w, DBOI_NAME, p ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ORDBAGNAME() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ORDBAGNAME( w, p ) --> orderInfo )( w, DBOI_BAGNAME, p ) )> - * $ARGUMENTS$ - * - * - *

- * $RETURNS$ - * orderInfo )( w, DBOI_BAGNAME, p ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ORDBAGEXT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ORDBAGEXT( w, p ) --> orderInfo )( w, DBOI_BAGEXT, p ) )> - * $ARGUMENTS$ - * - * - *

- * $RETURNS$ - * orderInfo )( w, DBOI_BAGEXT, p ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_CLEARFILTER() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_CLEARFILTER( w ) --> clearFilter )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * clearFilter )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_CLEARLOCATE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_CLEARLOCATE( w ) --> clearLocate )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * clearLocate )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_CLEARSCOPE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_CLEARSCOPE( w ) --> clearScope )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * clearScope )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_COUNTSCOPE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_COUNTSCOPE( w, ip, lp ) --> countScope )( w, ip, lp ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * countScope )( w, ip, lp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_FILTERTEXT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_FILTERTEXT( w, bp ) --> filterText )( w, bp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * filterText )( w, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_SCOPEINFO() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_SCOPEINFO( w, i, v ) --> scopeInfo )( w, i, v ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * scopeInfo )( w, i, v ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_SETFILTER() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_SETFILTER( w, ip ) --> setFilter )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * setFilter )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_SETLOCATE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_SETLOCATE( w, ip ) --> setLocate )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * setLocate )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_SETSCOPE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_SETSCOPE( w, ip ) --> setScope )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * setScope )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_SKIPSCOPE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_SKIPSCOPE( w, bp, l ) --> skipScope )( w, bp, l ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * skipScope )( w, bp, l ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_COMPILE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_COMPILE( w, bp ) --> compile )( w, bp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * compile )( w, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_ERROR() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_ERROR( w, ip ) --> error )( w, ip ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * error )( w, ip ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_EVALBLOCK() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_EVALBLOCK( w, v ) --> evalBlock )( w, v ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * evalBlock )( w, v ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_GETLOCKS() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_GETLOCKS( w, g ) --> info )( w, DBI_GETLOCKARRAY, g ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * info )( w, DBI_GETLOCKARRAY, g ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_RAWLOCK() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_RAWLOCK( w, i, l ) --> rawlock )( w, i, l ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * rawlock )( w, i, l ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_LOCK() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_LOCK( w, sp ) --> lock )( w, sp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * lock )( w, sp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_UNLOCK() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_UNLOCK( w ) --> unlock )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * unlock )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_CLOSEMEMFILE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_CLOSEMEMFILE( w ) --> closeMemFile )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * closeMemFile )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_CREATEMEMFILE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_CREATEMEMFILE( w, bp ) --> createMemFile )( w, bp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * createMemFile )( w, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_GETVALUEFILE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_GETVALUEFILE( w, i, bp ) --> getValueFile )( w, i, bp ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * getValueFile )( w, i, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_OPENMEMFILE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_OPENMEMFILE( w, bp ) --> openMemFile )( w, bp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * openMemFile )( w, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_PUTVALUEFILE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_PUTVALUEFILE( w, i, bp ) --> putValueFile )( w, i, bp ) )> - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * putValueFile )( w, i, bp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_READDBHEADER() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_READDBHEADER( w ) --> readDBHeader )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * readDBHeader )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_WRITEDBHEADER() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_WRITEDBHEADER( w ) --> writeDBHeader )( w ) )> - * $ARGUMENTS$ - * - * $RETURNS$ - * writeDBHeader )( w ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_RECSIZE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_RECSIZE( w, lp ) --> info )( w, DBI_GETRECSIZE, lp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * info )( w, DBI_GETRECSIZE, lp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_HEADERSIZE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_HEADERSIZE( w, fp ) --> info )( w, DBI_GETHEADERSIZE, fp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * info )( w, DBI_GETHEADERSIZE, fp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_LUPDATE() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_LUPDATE( w, fp ) --> info )( w, DBI_LASTUPDATE, fp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * info )( w, DBI_LASTUPDATE, fp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_SETDELIM() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_SETDELIM( w, fp ) --> info )( w, DBI_SETDELIMITER, fp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * info )( w, DBI_SETDELIMITER, fp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_GETDELIM() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_GETDELIM( w, fp ) --> info )( w, DBI_GETDELIMITER, fp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * info )( w, DBI_GETDELIMITER, fp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUPER_TABLEEXT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "hbapirdd.h" - * SUPER_TABLEEXT( w, fp ) --> info )( w, DBI_TABLEEXT, fp ) )> - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * info )( w, DBI_TABLEEXT, fp ) )> - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbapirdd.h - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_rddInsertAreaNode() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapirdd.h" + hb_rddInsertAreaNode( char *szDriver ) --> ( USHORT )usResult + $ARGUMENTS$ + <*szDriver> + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rdd, nulsys, dbfntx, dbfcdx + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_rddGetCurrentWorkAreaNumber() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapirdd.h" + hb_rddGetCurrentWorkAreaNumber( void ) --> ( int )iResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rdd, nulsys, dbfntx, dbfcdx + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_rddGetCurrentWorkAreaPointer() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapirdd.h" + hb_rddGetCurrentWorkAreaPointer( void ) --> ( void * )pResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rdd, nulsys, dbfntx, dbfcdx + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_rddSelectWorkAreaAlias() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapirdd.h" + hb_rddSelectWorkAreaAlias( char * szAlias ) --> ( HB_ERRCODE )hResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rdd, nulsys, dbfntx, dbfcdx + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_rddSelectWorkAreaNumber() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapirdd.h" + hb_rddSelectWorkAreaNumber( int iArea ) --> ( HB_ERRCODE )hResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rdd, nulsys, dbfntx, dbfcdx + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_rddSelectWorkAreaSymbol() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapirdd.h" + hb_rddSelectWorkAreaSymbol( PHB_SYMB pSymAlias ) --> ( HB_ERRCODE )hResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rdd, nulsys, dbfntx, dbfcdx + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_rddGetFieldValue() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapirdd.h" + hb_rddGetFieldValue( PHB_ITEM pItem, PHB_SYMB pFieldSymbol ) --> ( HB_ERRCODE )hResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rdd, nulsys, dbfntx, dbfcdx + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_rddPutFieldValue() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapirdd.h" + hb_rddPutFieldValue( PHB_ITEM pItem, PHB_SYMB pFieldSymbol ) --> ( HB_ERRCODE )hResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rdd, nulsys, dbfntx, dbfcdx + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_rddFieldGet() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapirdd.h" + hb_rddFieldGet( PHB_ITEM pItem, PHB_SYMB pFieldSymbol ) --> ( HB_ERRCODE )hResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rdd, nulsys, dbfntx, dbfcdx + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_rddFieldPut() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapirdd.h" + hb_rddFieldPut( PHB_ITEM pItem, PHB_SYMB pFieldSymbol ) --> ( HB_ERRCODE )hResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rdd, nulsys, dbfntx, dbfcdx + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_rddShutDown() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapirdd.h" + hb_rddShutDown( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rdd, nulsys, dbfntx, dbfcdx + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_rddInherit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapirdd.h" + hb_rddInherit( PRDDFUNCS pTable, PRDDFUNCS pSubTable, PRDDFUNCS pSuperTable, BYTE * szDrvName ) --> ( HB_ERRCODE )hResult + $ARGUMENTS$ + + + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rdd, nulsys, dbfntx, dbfcdx + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_rddDisinherit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapirdd.h" + hb_rddDisinherit( BYTE * drvName ) --> ( HB_ERRCODE )hResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rdd, nulsys, dbfntx, dbfcdx + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_rddExtendType() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapirdd.h" + hb_rddExtendType( USHORT fieldType ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rdd, nulsys, dbfntx, dbfcdx + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_rddFieldType() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbapirdd.h" + hb_rddFieldType( USHORT extendType ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rdd, nulsys, dbfntx, dbfcdx + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_BOF() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_BOF( w, sp ) --> lprfsHost->bof )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->bof )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_EOF() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_EOF( w, sp ) --> lprfsHost->eof )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->eof )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_FOUND() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_FOUND( w, sp ) --> lprfsHost->found )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->found )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_GOTO() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_GOTO( w, l ) --> lprfsHost->go )( w, l ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->go )( w, l ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_GOTOID() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_GOTOID( w, sp ) --> lprfsHost->goToId )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->goToId )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_GOBOTTOM() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_GOBOTTOM( w ) --> lprfsHost->goBottom )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->goBottom )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_GOTOP() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_GOTOP( w ) --> lprfsHost->goTop )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->goTop )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_SEEK() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_SEEK( w, i1, v, i2 ) --> lprfsHost->seek )( w, i1, v, i2 ) )> + $ARGUMENTS$ + + + + + + + + $RETURNS$ + lprfsHost->seek )( w, i1, v, i2 ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_SKIP() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_SKIP( w, l ) --> lprfsHost->skip )( w, l ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->skip )( w, l ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_SKIPFILTER() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_SKIPFILTER( w, l ) --> lprfsHost->skipFilter )( w, l ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->skipFilter )( w, l ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_SKIPRAW() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_SKIPRAW( w, l ) --> lprfsHost->skipRaw )( w, l ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->skipRaw )( w, l ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ADDFIELD() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ADDFIELD( w, ip ) --> lprfsHost->addField )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->addField )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_APPEND() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_APPEND( w, l ) --> lprfsHost->append )( w, l ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->append )( w, l ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_CREATEFIELDS() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_CREATEFIELDS( w, v ) --> lprfsHost->createFields )( w, v ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->createFields )( w, v ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_DELETE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_DELETE( w ) --> lprfsHost->deleterec )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->deleterec )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_DELETED() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_DELETED( w, sp ) --> lprfsHost->deleted )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->deleted )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_FIELDCOUNT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_FIELDCOUNT( w, sp ) --> lprfsHost->fieldCount )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->fieldCount )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_FIELDDISPLAY() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_FIELDDISPLAY( w, sp ) --> lprfsHost->fieldDisplay )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->fieldDisplay )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_FIELDINFO() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_FIELDINFO( w, s1, s2, v ) --> lprfsHost->fieldInfo )( w, s1, s2, v ) )> + $ARGUMENTS$ + + + + + + + + $RETURNS$ + lprfsHost->fieldInfo )( w, s1, s2, v ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_FIELDNAME() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_FIELDNAME( w, i, bp ) --> lprfsHost->fieldName )( w, i, bp ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + lprfsHost->fieldName )( w, i, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_FLUSH() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_FLUSH( w ) --> lprfsHost->flush )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->flush )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_GETREC() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_GETREC( w, bpp ) --> lprfsHost->getRec )( w, bpp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->getRec )( w, bpp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_GETVALUE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_GETVALUE( w, i, v ) --> lprfsHost->getValue )( w, i, v ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + lprfsHost->getValue )( w, i, v ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_GETVARLEN() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_GETVARLEN( w, i, lp ) --> lprfsHost->getVarLen )( w, i, lp ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + lprfsHost->getVarLen )( w, i, lp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_GOCOLD() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_GOCOLD( w ) --> lprfsHost->goCold )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->goCold )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_GOHOT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_GOHOT( w ) --> lprfsHost->goHot )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->goHot )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_PUTVALUE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_PUTVALUE( w, i, v ) --> lprfsHost->putValue )( w, i, v ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + lprfsHost->putValue )( w, i, v ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_PUTREC() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_PUTREC( w, bp ) --> lprfsHost->putRec )( w, bp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->putRec )( w, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_RECALL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_RECALL( w ) --> lprfsHost->recall )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->recall )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_RECCOUNT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_RECCOUNT( w, sp ) --> lprfsHost->reccount )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->reccount )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_RECINFO() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_RECINFO( w, v1, i, v2 ) --> lprfsHost->recInfo )( w, v1, i, v2 ) )> + $ARGUMENTS$ + + + + + + + + $RETURNS$ + lprfsHost->recInfo )( w, v1, i, v2 ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_RECNO() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_RECNO( w, i ) --> lprfsHost->recno )( w, i ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->recno )( w, i ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_SETFIELDEXTENT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_SETFIELDEXTENT( w, s ) --> lprfsHost->setFieldExtent )( w, s ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->setFieldExtent )( w, s ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ALIAS() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ALIAS( w, bp ) --> lprfsHost->alias )( w, bp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->alias )( w, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_CLOSE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_CLOSE( w ) --> lprfsHost->close )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->close )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_CREATE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_CREATE( w, ip ) --> lprfsHost->create )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->create )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_INFO() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_INFO( w, i, g ) --> lprfsHost->info )( w, i, g ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + lprfsHost->info )( w, i, g ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_NEW() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_NEW( w ) --> lprfsHost->newarea )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->newarea )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_OPEN() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_OPEN( w, ip ) --> lprfsHost->open )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->open )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_RELEASE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_RELEASE( w ) --> lprfsHost->release )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->release )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_STRUCTSIZE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_STRUCTSIZE( w, sp ) --> lprfsHost->structSize )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->structSize )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_SYSNAME() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_SYSNAME( w, bp ) --> lprfsHost->sysName )( w, bp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->sysName )( w, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_DBEVAL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_DBEVAL( w, ip ) --> lprfsHost->dbEval )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->dbEval )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_PACK() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_PACK( w ) --> lprfsHost->pack )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->pack )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_PACKREC() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_PACKREC( w, l, sp ) --> lprfsHost->packRec )( w, l, sp ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + lprfsHost->packRec )( w, l, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_SORT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_SORT( w, ip ) --> lprfsHost->sort )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->sort )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_TRANS() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_TRANS( w, ip ) --> lprfsHost->trans )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->trans )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_TRANSREC() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_TRANSREC( w, ip ) --> lprfsHost->transRec )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->transRec )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ZAP() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ZAP( w ) --> lprfsHost->zap )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->zap )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_CHILDEND() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_CHILDEND( w, ip ) --> lprfsHost->childEnd )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->childEnd )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_CHILDSTART() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_CHILDSTART( w, ip ) --> lprfsHost->childStart )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->childStart )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_CHILDSYNC() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_CHILDSYNC( w, ip ) --> lprfsHost->childSync )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->childSync )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_SYNCCHILDREN() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_SYNCCHILDREN( w ) --> lprfsHost->syncChildren )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->syncChildren )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_CLEARREL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_CLEARREL( w ) --> lprfsHost->clearRel )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->clearRel )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_FORCEREL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_FORCEREL( w ) --> lprfsHost->forceRel )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->forceRel )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_RELAREA() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_RELAREA( w, s, sp ) --> lprfsHost->relArea )( w, s, sp ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + lprfsHost->relArea )( w, s, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_RELEVAL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_RELEVAL( w, ip ) --> lprfsHost->relEval )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->relEval )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_RELTEXT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_RELTEXT( w, s, bp ) --> lprfsHost->relText )( w, s, bp ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + lprfsHost->relText )( w, s, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_SETREL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_SETREL( w, ip ) --> lprfsHost->setRel )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->setRel )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ORDLSTADD() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ORDLSTADD( w, lp ) --> lprfsHost->orderListAdd )( w, lp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->orderListAdd )( w, lp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ORDLSTDELETE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ORDLSTDELETE( w, lp ) --> lprfsHost->orderListDelete )( w, lp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->orderListDelete )( w, lp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ORDLSTFOCUS() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ORDLSTFOCUS( w, lp ) --> lprfsHost->orderListFocus )( w, lp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->orderListFocus )( w, lp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ORDLSTREBUILD() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ORDLSTREBUILD( w ) --> lprfsHost->orderListRebuild )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->orderListRebuild )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ORDLSTCLEAR() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ORDLSTCLEAR( w ) --> lprfsHost->orderListClear )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->orderListClear )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ORDSETCOND() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ORDSETCOND( w, ip ) --> lprfsHost->orderCondition )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->orderCondition )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ORDCREATE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ORDCREATE( w, ip ) --> lprfsHost->orderCreate )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->orderCreate )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ORDDESTROY() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ORDDESTROY( w, p ) --> lprfsHost->orderDestroy )( w, p ) )> + $ARGUMENTS$ + + +

+ $RETURNS$ + lprfsHost->orderDestroy )( w, p ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ORDINFO() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ORDINFO( w, i, p ) --> lprfsHost->orderInfo )( w, i, p ) )> + $ARGUMENTS$ + + + + +

+ $RETURNS$ + lprfsHost->orderInfo )( w, i, p ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ORDEXPR() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ORDEXPR( w, p ) --> lprfsHost->orderInfo )( w, DBOI_EXPRESSION, p ) )> + $ARGUMENTS$ + + +

+ $RETURNS$ + lprfsHost->orderInfo )( w, DBOI_EXPRESSION, p ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ORDCOND() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ORDCOND( w, p ) --> lprfsHost->orderInfo )( w, DBOI_CONDITION, p ) )> + $ARGUMENTS$ + + +

+ $RETURNS$ + lprfsHost->orderInfo )( w, DBOI_CONDITION, p ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ORDRECNO() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ORDRECNO( w, p ) --> lprfsHost->orderInfo )( w, DBOI_RECNO, p ) )> + $ARGUMENTS$ + + +

+ $RETURNS$ + lprfsHost->orderInfo )( w, DBOI_RECNO, p ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ORDPOS() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ORDPOS( w, p ) --> lprfsHost->orderInfo )( w, DBOI_POSITION, p ) )> + $ARGUMENTS$ + + +

+ $RETURNS$ + lprfsHost->orderInfo )( w, DBOI_POSITION, p ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ORDNUMBER() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ORDNUMBER( w, p ) --> lprfsHost->orderInfo )( w, DBOI_NUMBER, p ) )> + $ARGUMENTS$ + + +

+ $RETURNS$ + lprfsHost->orderInfo )( w, DBOI_NUMBER, p ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ORDNAME() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ORDNAME( w, p ) --> lprfsHost->orderInfo )( w, DBOI_NAME, p ) )> + $ARGUMENTS$ + + +

+ $RETURNS$ + lprfsHost->orderInfo )( w, DBOI_NAME, p ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ORDBAGNAME() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ORDBAGNAME( w, p ) --> lprfsHost->orderInfo )( w, DBOI_BAGNAME, p ) )> + $ARGUMENTS$ + + +

+ $RETURNS$ + lprfsHost->orderInfo )( w, DBOI_BAGNAME, p ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ORDBAGEXT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ORDBAGEXT( w, p ) --> lprfsHost->orderInfo )( w, DBOI_BAGEXT, p ) )> + $ARGUMENTS$ + + +

+ $RETURNS$ + lprfsHost->orderInfo )( w, DBOI_BAGEXT, p ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_CLEARFILTER() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_CLEARFILTER( w ) --> lprfsHost->clearFilter )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->clearFilter )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_CLEARLOCATE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_CLEARLOCATE( w ) --> lprfsHost->clearLocate )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->clearLocate )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_CLEARSCOPE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_CLEARSCOPE( w ) --> lprfsHost->clearScope )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->clearScope )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_COUNTSCOPE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_COUNTSCOPE( w, ip, lp ) --> lprfsHost->countScope )( w, ip, lp ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + lprfsHost->countScope )( w, ip, lp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_FILTERTEXT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_FILTERTEXT( w, bp ) --> lprfsHost->filterText )( w, bp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->filterText )( w, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_SCOPEINFO() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_SCOPEINFO( w, i, v ) --> lprfsHost->scopeInfo )( w, i, v ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + lprfsHost->scopeInfo )( w, i, v ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_SETFILTER() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_SETFILTER( w, ip ) --> lprfsHost->setFilter )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->setFilter )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_SETLOCATE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_SETLOCATE( w, ip ) --> lprfsHost->setLocate )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->setLocate )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_SETSCOPE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_SETSCOPE( w, ip ) --> lprfsHost->setScope )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->setScope )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_SKIPSCOPE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_SKIPSCOPE( w, bp, l ) --> lprfsHost->skipScope )( w, bp, l ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + lprfsHost->skipScope )( w, bp, l ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_COMPILE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_COMPILE( w, bp ) --> lprfsHost->compile )( w, bp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->compile )( w, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_ERROR() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_ERROR( w, ip ) --> lprfsHost->error )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->error )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_EVALBLOCK() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_EVALBLOCK( w, v ) --> lprfsHost->evalBlock )( w, v ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->evalBlock )( w, v ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_GETLOCKS() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_GETLOCKS( w, g ) --> lprfsHost->info )( w, DBI_GETLOCKARRAY, g ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->info )( w, DBI_GETLOCKARRAY, g ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_RAWLOCK() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_RAWLOCK( w, i, l ) --> lprfsHost->rawlock )( w, i, l ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + lprfsHost->rawlock )( w, i, l ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_LOCK() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_LOCK( w, sp ) --> lprfsHost->lock )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->lock )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_UNLOCK() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_UNLOCK( w, l ) --> lprfsHost->unlock )( w, l ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->unlock )( w, l ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_CLOSEMEMFILE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_CLOSEMEMFILE( w ) --> lprfsHost->closeMemFile )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->closeMemFile )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_CREATEMEMFILE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_CREATEMEMFILE( w, bp ) --> lprfsHost->createMemFile )( w, bp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->createMemFile )( w, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_GETVALUEFILE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_GETVALUEFILE( w, i, bp ) --> lprfsHost->getValueFile )( w, i, bp ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + lprfsHost->getValueFile )( w, i, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_OPENMEMFILE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_OPENMEMFILE( w, bp ) --> lprfsHost->openMemFile )( w, bp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->openMemFile )( w, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_PUTVALUEFILE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_PUTVALUEFILE( w, i, bp ) --> lprfsHost->putValueFile )( w, i, bp ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + lprfsHost->putValueFile )( w, i, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_READDBHEADER() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_READDBHEADER( w ) --> lprfsHost->readDBHeader )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->readDBHeader )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_WRITEDBHEADER() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_WRITEDBHEADER( w ) --> lprfsHost->writeDBHeader )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + lprfsHost->writeDBHeader )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_RECSIZE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_RECSIZE( w, lp ) --> lprfsHost->info )( w, DBI_GETRECSIZE, lp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->info )( w, DBI_GETRECSIZE, lp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_HEADERSIZE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_HEADERSIZE( w, fp ) --> lprfsHost->info )( w, DBI_GETHEADERSIZE, fp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->info )( w, DBI_GETHEADERSIZE, fp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_LUPDATE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_LUPDATE( w, fp ) --> lprfsHost->info )( w, DBI_LASTUPDATE, fp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->info )( w, DBI_LASTUPDATE, fp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_SETDELIM() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_SETDELIM( w, fp ) --> lprfsHost->info )( w, DBI_SETDELIMITER, fp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->info )( w, DBI_SETDELIMITER, fp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_GETDELIM() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_GETDELIM( w, fp ) --> lprfsHost->info )( w, DBI_GETDELIMITER, fp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->info )( w, DBI_GETDELIMITER, fp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELF_TABLEEXT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SELF_TABLEEXT( w, fp ) --> lprfsHost->info )( w, DBI_TABLEEXT, fp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lprfsHost->info )( w, DBI_TABLEEXT, fp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_BOF() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_BOF( w, sp ) --> bof )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + bof )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_EOF() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_EOF( w, sp ) --> eof )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + eof )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_FOUND() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_FOUND( w, sp ) --> found )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + found )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_GOTO() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_GOTO( w, l ) --> go )( w, l ) )> + $ARGUMENTS$ + + + + $RETURNS$ + go )( w, l ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_GOTOID() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_GOTOID( w, sp ) --> goToId )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + goToId )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_GOBOTTOM() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_GOBOTTOM( w ) --> goBottom )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + goBottom )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_GOTOP() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_GOTOP( w ) --> goTop )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + goTop )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_SEEK() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_SEEK( w, i1, v, i2 ) --> seek )( w, i1, v, i2 ) )> + $ARGUMENTS$ + + + + + + + + $RETURNS$ + seek )( w, i1, v, i2 ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_SKIP() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_SKIP( w, l ) --> skip )( w, l ) )> + $ARGUMENTS$ + + + + $RETURNS$ + skip )( w, l ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_SKIPFILTER() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_SKIPFILTER( w, l ) --> skipFilter )( w, l ) )> + $ARGUMENTS$ + + + + $RETURNS$ + skipFilter )( w, l ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_SKIPRAW() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_SKIPRAW( w, l ) --> skipRaw )( w, l ) )> + $ARGUMENTS$ + + + + $RETURNS$ + skipRaw )( w, l ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ADDFIELD() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ADDFIELD( w, ip ) --> addField )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + addField )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_APPEND() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_APPEND( w, l ) --> append )( w, l ) )> + $ARGUMENTS$ + + + + $RETURNS$ + append )( w, l ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_CREATEFIELDS() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_CREATEFIELDS( w, v ) --> createFields )( w, v ) )> + $ARGUMENTS$ + + + + $RETURNS$ + createFields )( w, v ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_DELETE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_DELETE( w ) --> deleterec )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + deleterec )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_DELETED() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_DELETED( w, sp ) --> deleted )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + deleted )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_FIELDCOUNT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_FIELDCOUNT( w, sp ) --> fieldCount )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + fieldCount )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_FIELDDISPLAY() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_FIELDDISPLAY( w, sp ) --> fieldDisplay )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + fieldDisplay )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_FIELDINFO() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_FIELDINFO( w, s1, s2, v ) --> fieldInfo )( w, s1, s2, v ) )> + $ARGUMENTS$ + + + + + + + + $RETURNS$ + fieldInfo )( w, s1, s2, v ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_FIELDNAME() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_FIELDNAME( w, i, bp ) --> fieldName )( w, i, bp ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + fieldName )( w, i, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_FLUSH() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_FLUSH( w ) --> flush )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + flush )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_GETREC() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_GETREC( w, bpp ) --> getRec )( w, bpp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + getRec )( w, bpp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_GETVALUE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_GETVALUE( w, i, v ) --> getValue )( w, i, v ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + getValue )( w, i, v ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_GETVARLEN() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_GETVARLEN( w, i, lp ) --> getVarLen )( w, i, lp ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + getVarLen )( w, i, lp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_GOCOLD() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_GOCOLD( w ) --> goCold )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + goCold )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_GOHOT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_GOHOT( w ) --> goHot )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + goHot )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_PUTVALUE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_PUTVALUE( w, i, v ) --> putValue )( w, i, v ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + putValue )( w, i, v ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_PUTREC() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_PUTREC( w, bp ) --> putRec )( w, bp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + putRec )( w, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_RECALL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_RECALL( w ) --> recall )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + recall )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_RECCOUNT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_RECCOUNT( w, sp ) --> reccount )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + reccount )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_RECINFO() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_RECINFO( w, v1, i, v2 ) --> recInfo )( w, v1, i, v2 ) )> + $ARGUMENTS$ + + + + + + + + $RETURNS$ + recInfo )( w, v1, i, v2 ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_RECNO() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_RECNO( w, sp ) --> recno )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + recno )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_SETFIELDEXTENT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_SETFIELDEXTENT( w, s ) --> setFieldExtent )( w, s ) )> + $ARGUMENTS$ + + + + $RETURNS$ + setFieldExtent )( w, s ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ALIAS() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ALIAS( w, bp ) --> alias )( w, bp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + alias )( w, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_CLOSE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_CLOSE( w ) --> close )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + close )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_CREATE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_CREATE( w, ip ) --> create )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + create )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_INFO() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_INFO( w, i, g ) --> info )( w, i, g ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + info )( w, i, g ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_NEW() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_NEW( w ) --> newarea )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + newarea )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_OPEN() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_OPEN( w, ip ) --> open )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + open )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_RELEASE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_RELEASE( w ) --> release )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + release )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_STRUCTSIZE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_STRUCTSIZE( w, sp ) --> structSize )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + structSize )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_SYSNAME() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_SYSNAME( w, bp ) --> sysName )( w, bp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + sysName )( w, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_DBEVAL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_DBEVAL( w, ip ) --> dbEval )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + dbEval )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_PACK() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_PACK( w ) --> pack )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + pack )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_PACKREC() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_PACKREC( w, l, sp ) --> packRec )( w, l, sp ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + packRec )( w, l, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_SORT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_SORT( w, ip ) --> sort )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + sort )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_TRANS() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_TRANS( w, ip ) --> trans )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + trans )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_TRANSREC() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_TRANSREC( w, ip ) --> transRec )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + transRec )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ZAP() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ZAP( w ) --> zap )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + zap )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_CHILDEND() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_CHILDEND( w, ip ) --> childEnd )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + childEnd )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_CHILDSTART() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_CHILDSTART( w, ip ) --> childStart )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + childStart )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_CHILDSYNC() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_CHILDSYNC( w, ip ) --> childSync )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + childSync )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_SYNCCHILDREN() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_SYNCCHILDREN( w ) --> syncChildren )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + syncChildren )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_CLEARREL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_CLEARREL( w ) --> clearRel )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + clearRel )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_FORCEREL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_FORCEREL( w ) --> forceRel )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + forceRel )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_RELAREA() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_RELAREA( w, s, sp ) --> relArea )( w, s, sp ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + relArea )( w, s, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_RELEVAL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_RELEVAL( w, ip ) --> relEval )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + relEval )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_RELTEXT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_RELTEXT( w, s, bp ) --> relText )( w, s, bp ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + relText )( w, s, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_SETREL() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_SETREL( w, ip ) --> setRel )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + setRel )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ORDLSTADD() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ORDLSTADD( w, lp ) --> orderListAdd )( w, lp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + orderListAdd )( w, lp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ORDLSTDELETE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ORDLSTDELETE( w, lp ) --> orderListDelete )( w, lp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + orderListDelete )( w, lp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ORDLSTFOCUS() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ORDLSTFOCUS( w, lp ) --> orderListFocus )( w, lp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + orderListFocus )( w, lp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ORDLSTREBUILD() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ORDLSTREBUILD( w ) --> orderListRebuild )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + orderListRebuild )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ORDLSTCLEAR() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ORDLSTCLEAR( w ) --> orderListClear )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + orderListClear )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ORDSETCOND() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ORDSETCOND( w, ip ) --> orderCondition )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + orderCondition )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ORDCREATE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ORDCREATE( w, ip ) --> orderCreate )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + orderCreate )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ORDDELETE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ORDDELETE( w, ip ) --> orderDelete )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + orderDelete )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ORDINFO() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ORDINFO( w, i, p ) --> orderInfo )( w, i, p ) )> + $ARGUMENTS$ + + + + +

+ $RETURNS$ + orderInfo )( w, i, p ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ORDEXPR() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ORDEXPR( w, p ) --> orderInfo )( w, DBOI_EXPRESSION, p ) )> + $ARGUMENTS$ + + +

+ $RETURNS$ + orderInfo )( w, DBOI_EXPRESSION, p ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ORDCOND() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ORDCOND( w, p ) --> orderInfo )( w, DBOI_CONDITION, p ) )> + $ARGUMENTS$ + + +

+ $RETURNS$ + orderInfo )( w, DBOI_CONDITION, p ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ORDRECNO() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ORDRECNO( w, p ) --> orderInfo )( w, DBOI_RECNO, p ) )> + $ARGUMENTS$ + + +

+ $RETURNS$ + orderInfo )( w, DBOI_RECNO, p ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ORDPOS() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ORDPOS( w, p ) --> orderInfo )( w, DBOI_POSITION, p ) )> + $ARGUMENTS$ + + +

+ $RETURNS$ + orderInfo )( w, DBOI_POSITION, p ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ORDNUMBER() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ORDNUMBER( w, p ) --> orderInfo )( w, DBOI_NUMBER, p ) )> + $ARGUMENTS$ + + +

+ $RETURNS$ + orderInfo )( w, DBOI_NUMBER, p ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ORDNAME() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ORDNAME( w, p ) --> orderInfo )( w, DBOI_NAME, p ) )> + $ARGUMENTS$ + + +

+ $RETURNS$ + orderInfo )( w, DBOI_NAME, p ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ORDBAGNAME() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ORDBAGNAME( w, p ) --> orderInfo )( w, DBOI_BAGNAME, p ) )> + $ARGUMENTS$ + + +

+ $RETURNS$ + orderInfo )( w, DBOI_BAGNAME, p ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ORDBAGEXT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ORDBAGEXT( w, p ) --> orderInfo )( w, DBOI_BAGEXT, p ) )> + $ARGUMENTS$ + + +

+ $RETURNS$ + orderInfo )( w, DBOI_BAGEXT, p ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_CLEARFILTER() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_CLEARFILTER( w ) --> clearFilter )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + clearFilter )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_CLEARLOCATE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_CLEARLOCATE( w ) --> clearLocate )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + clearLocate )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_CLEARSCOPE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_CLEARSCOPE( w ) --> clearScope )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + clearScope )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_COUNTSCOPE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_COUNTSCOPE( w, ip, lp ) --> countScope )( w, ip, lp ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + countScope )( w, ip, lp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_FILTERTEXT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_FILTERTEXT( w, bp ) --> filterText )( w, bp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + filterText )( w, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_SCOPEINFO() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_SCOPEINFO( w, i, v ) --> scopeInfo )( w, i, v ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + scopeInfo )( w, i, v ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_SETFILTER() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_SETFILTER( w, ip ) --> setFilter )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + setFilter )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_SETLOCATE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_SETLOCATE( w, ip ) --> setLocate )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + setLocate )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_SETSCOPE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_SETSCOPE( w, ip ) --> setScope )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + setScope )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_SKIPSCOPE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_SKIPSCOPE( w, bp, l ) --> skipScope )( w, bp, l ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + skipScope )( w, bp, l ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_COMPILE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_COMPILE( w, bp ) --> compile )( w, bp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + compile )( w, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_ERROR() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_ERROR( w, ip ) --> error )( w, ip ) )> + $ARGUMENTS$ + + + + $RETURNS$ + error )( w, ip ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_EVALBLOCK() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_EVALBLOCK( w, v ) --> evalBlock )( w, v ) )> + $ARGUMENTS$ + + + + $RETURNS$ + evalBlock )( w, v ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_GETLOCKS() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_GETLOCKS( w, g ) --> info )( w, DBI_GETLOCKARRAY, g ) )> + $ARGUMENTS$ + + + + $RETURNS$ + info )( w, DBI_GETLOCKARRAY, g ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_RAWLOCK() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_RAWLOCK( w, i, l ) --> rawlock )( w, i, l ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + rawlock )( w, i, l ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_LOCK() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_LOCK( w, sp ) --> lock )( w, sp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + lock )( w, sp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_UNLOCK() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_UNLOCK( w ) --> unlock )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + unlock )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_CLOSEMEMFILE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_CLOSEMEMFILE( w ) --> closeMemFile )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + closeMemFile )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_CREATEMEMFILE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_CREATEMEMFILE( w, bp ) --> createMemFile )( w, bp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + createMemFile )( w, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_GETVALUEFILE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_GETVALUEFILE( w, i, bp ) --> getValueFile )( w, i, bp ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + getValueFile )( w, i, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_OPENMEMFILE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_OPENMEMFILE( w, bp ) --> openMemFile )( w, bp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + openMemFile )( w, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_PUTVALUEFILE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_PUTVALUEFILE( w, i, bp ) --> putValueFile )( w, i, bp ) )> + $ARGUMENTS$ + + + + + + $RETURNS$ + putValueFile )( w, i, bp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_READDBHEADER() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_READDBHEADER( w ) --> readDBHeader )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + readDBHeader )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_WRITEDBHEADER() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_WRITEDBHEADER( w ) --> writeDBHeader )( w ) )> + $ARGUMENTS$ + + $RETURNS$ + writeDBHeader )( w ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_RECSIZE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_RECSIZE( w, lp ) --> info )( w, DBI_GETRECSIZE, lp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + info )( w, DBI_GETRECSIZE, lp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_HEADERSIZE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_HEADERSIZE( w, fp ) --> info )( w, DBI_GETHEADERSIZE, fp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + info )( w, DBI_GETHEADERSIZE, fp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_LUPDATE() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_LUPDATE( w, fp ) --> info )( w, DBI_LASTUPDATE, fp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + info )( w, DBI_LASTUPDATE, fp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_SETDELIM() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_SETDELIM( w, fp ) --> info )( w, DBI_SETDELIMITER, fp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + info )( w, DBI_SETDELIMITER, fp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_GETDELIM() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_GETDELIM( w, fp ) --> info )( w, DBI_GETDELIMITER, fp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + info )( w, DBI_GETDELIMITER, fp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUPER_TABLEEXT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + RDD + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "hbapirdd.h" + SUPER_TABLEEXT( w, fp ) --> info )( w, DBI_TABLEEXT, fp ) )> + $ARGUMENTS$ + + + + $RETURNS$ + info )( w, DBI_TABLEEXT, fp ) )> + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbapirdd.h + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ diff --git a/harbour/doc/en/hb_compa.txt b/harbour/doc/en/hb_compa.txt index 8aa343fbfd..0303758a9d 100644 --- a/harbour/doc/en/hb_compa.txt +++ b/harbour/doc/en/hb_compa.txt @@ -13,5737 +13,5737 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _evalLaunch() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "item.api" - * _evalLaunch --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is item.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_evalLaunch() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _evalNew() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "item.api" - * _evalNew --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is item.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_evalNew() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _evalPutParam() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "item.api" - * _evalPutParam --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is item.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_evalPutParam() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _evalRelease() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "item.api" - * _evalRelease --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is item.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_evalRelease() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _itemArrayGet() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "item.api" - * _itemArrayGet --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is item.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_itemArrayGet() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _itemArrayNew() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "item.api" - * _itemArrayNew --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is item.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_itemArrayNew() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _itemArrayPut() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "item.api" - * _itemArrayPut --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is item.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_itemArrayPut() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _itemNew() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "item.api" - * _itemNew --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is item.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_itemNew() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _itemParam() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "item.api" - * _itemParam --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is item.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_itemParam() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _itemRelease() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "item.api" - * _itemRelease --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is item.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_itemRelease() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _itemReturn() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "item.api" - * _itemReturn --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is item.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_itemReturn() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _itemSize() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "item.api" - * _itemSize --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is item.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_itemSize() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _itemType() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Item - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "item.api" - * _itemType --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is item.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_itemType() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _reta() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _reta --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_reta() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _pcount() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _pcount --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_pcount() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _tchdir() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _tchdir --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsChDir() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _tchdrv() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _tchdrv --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsChDrv() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _tclose() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _tclose --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsClose() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _tcommit() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _tcommit --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsCommit() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _tcreat() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _tcreat --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsCreate() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _tcurdir() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _tcurdir --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsCurDir() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _tcurdrv() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _tcurdrv --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsCurDrv() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _tdevraw() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _tdevraw --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsSetDevRaw() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _terror() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _terror --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsError() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _tisdevice() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _tisdevice --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsIsDevice() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _tisdrv() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _tisdrv --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsIsDrv() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _tlock() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _tlock --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsLock() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _tlseek() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _tlseek --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsSeek() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _tmkdir() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _tmkdir --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsMkDir() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _topen() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _topen --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsOpen() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _tread() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _tread --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsRead() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _trename() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _trename --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsRename() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _trmdir() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _trmdir --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsRmDir() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _tunlink() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _tunlink --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsDelete() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _twrite() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _twrite --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsWrite() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _bset() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _bset --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * memset() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _bmove() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _bmove --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * memmove() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _bcopy() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _bcopy --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * memcpy() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _bcmp() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Undocumented - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "hbundoc.api" - * _bcmp --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is hbundoc.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * memcmp() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtBox() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtBox --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtBox() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtColorSelect() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtColorSelect --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtColorSelect() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtDispBegin() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtDispBegin --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtDispBegin() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtDispCount() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtDispCount --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtDispCount() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtDispEnd() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtDispEnd --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtDispEnd() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtGetColorStr() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtGetColorStr --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtGetColorStr() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtGetCursor() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtGetCursor --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtGetCursor() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtGetPos() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtGetPos --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtGetPos() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtIsColor() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtIsColor --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtIsColor() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtMaxCol() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtMaxCol --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtMaxCol() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtMaxRow() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtMaxRow --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtMaxRow() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtPostExt() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtPostExt --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtPostExt() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtPreExt() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtPreExt --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtPreExt() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtRectSize() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtRectSize --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtRectSize() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtRepChar() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtRepChar --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtRepChar() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtRest() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtRest --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtRest() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtSave() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtSave --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtSave() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtScrDim() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtScrDim --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtScrDim() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtScroll() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtScroll --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtScroll() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtSetBlink() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtSetBlink --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtSetBlink() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtSetColorStr() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtSetColorStr --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtSetColorStr() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtSetCursor() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtSetCursor --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtSetCursor() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtSetMode() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtSetMode --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtSetMode() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtSetPos() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtSetPos --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtSetPos() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtSetSnowFlag() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtSetSnowFlag --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtSetSnowFlag() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtWrite() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtWrite --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtWrite() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtWriteAt() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtWriteAt --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtWriteAt() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtWriteCon() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtWriteCon --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtWriteCon() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtInit() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtInit --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtInit() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtExit() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtExit --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtExit() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtWCreate() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtWCreate --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtWCreate() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtWDestroy() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtWDestroy --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtWDestroy() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtWFlash() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtWFlash --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtWFlash() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtWApp() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtWApp --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtWApp() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtWCurrent() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtWCurrent --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtWCurrent() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtWPos() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtWPos --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtWPos() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtWVis() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtWVis --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtWVis() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtModalRead() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtModalRead --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtModalRead() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtBeginWrite() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtBeginWrite --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtBeginWrite() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtEndWrite() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtEndWrite --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtEndWrite() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtFlushCursor() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtFlushCursor --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtFlushCursor() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtSetColor() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtSetColor --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtSetColor() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtGetColor() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtGetColor --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtGetColor() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _gtSetBorder() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "gt.api" - * _gtSetBorder --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is gt.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_gtSetBorder() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _xalloc() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Fixed memory - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "fm.api" - * _xalloc --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is fm.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_xalloc() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _xgrab() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Fixed memory - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "fm.api" - * _xgrab --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is fm.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_xgrab() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _xfree() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Fixed memory - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "fm.api" - * _xfree --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is fm.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_xfree() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _exmgrab() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Fixed memory - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "fm.api" - * _exmgrab --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is fm.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_xgrab() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _fsChDir() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "filesys.api" - * _fsChDir --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is filesys.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsChDir() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _fsChDrv() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "filesys.api" - * _fsChDrv --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is filesys.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsChDrv() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _fsClose() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "filesys.api" - * _fsClose --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is filesys.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsClose() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _fsCommit() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "filesys.api" - * _fsCommit --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is filesys.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsCommit() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _fsCreate() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "filesys.api" - * _fsCreate --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is filesys.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsCreate() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _fsCurDir() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "filesys.api" - * _fsCurDir --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is filesys.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsCurDir() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _fsCurDrv() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "filesys.api" - * _fsCurDrv --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is filesys.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsCurDrv() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _fsDelete() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "filesys.api" - * _fsDelete --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is filesys.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsDelete() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _fsError() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "filesys.api" - * _fsError --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is filesys.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsError() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _fsExtOpen() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "filesys.api" - * _fsExtOpen --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is filesys.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsExtOpen() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _fsIsDrv() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "filesys.api" - * _fsIsDrv --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is filesys.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsIsDrv() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _fsLock() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "filesys.api" - * _fsLock --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is filesys.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsLock() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _fsMkDir() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "filesys.api" - * _fsMkDir --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is filesys.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsMkDir() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _fsOpen() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "filesys.api" - * _fsOpen --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is filesys.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsOpen() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _fsRead() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "filesys.api" - * _fsRead --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is filesys.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsRead() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _fsRmDir() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "filesys.api" - * _fsRmDir --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is filesys.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsRmDir() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _fsRename() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "filesys.api" - * _fsRename --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is filesys.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsRename() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _fsSeek() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "filesys.api" - * _fsSeek --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is filesys.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsSeek() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _fsWrite() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "filesys.api" - * _fsWrite --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is filesys.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_fsWrite() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ALENGTH - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro definition) - * - * #include "extend.api" - * ALENGTH( n ) --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _parc() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _parc --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_parc() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _parclen() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _parclen --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_parclen() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _parcsiz() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _parcsiz --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_parcsiz() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _pards() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _pards --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_pards() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _parinfa() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _parinfa --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_parinfa() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _parinfo() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _parinfo --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_parinfo() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _parl() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _parl --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_parl() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _parnd() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _parnd --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_parnd() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _parni() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _parni --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_parni() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _parnl() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _parnl --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_parnl() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _ret() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _ret --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_ret() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _retc() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _retc --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_retc() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _retclen() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _retclen --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_retclen() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _retds() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _retds --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_retds() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _retl() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _retl --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_retl() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _retnd() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _retnd --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_retnd() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _retni() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _retni --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_retni() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _retnl() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _retnl --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_retnl() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _storc() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _storc --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_storc() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _storclen() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _storclen --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_storclen() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _stords() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _stords --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_stords() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _storl() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _storl --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_storl() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _stornd() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _stornd --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_stornd() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _storni() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _storni --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_storni() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _stornl() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Extend - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "extend.api" - * _stornl --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is extend.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_stornl() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errGetDescription() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errGetDescription --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errGetDescription() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errGetFileName() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errGetFileName --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errGetFileName() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errGetFlags() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errGetFlags --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errGetFlags() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errGetGenCode() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errGetGenCode --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errGetGenCode() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errGetOperation() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errGetOperation --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errGetOperation() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errGetOsCode() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errGetOsCode --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errGetOsCode() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errGetSeverity() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errGetSeverity --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errGetSeverity() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errGetSubCode() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errGetSubCode --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errGetSubCode() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errGetSubSystem() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errGetSubSystem --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errGetSubSystem() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errGetTries() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errGetTries --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errGetTries() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errLaunch() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errLaunch --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errLaunch() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errNew() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errNew --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errNew() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errPutDescription() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errPutDescription --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errPutDescription() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errPutFileName() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errPutFileName --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errPutFileName() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errPutFlags() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errPutFlags --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errPutGenCode() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errPutOperation() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errPutOperation --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errPutOperation() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errPutOsCode() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errPutOsCode --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errPutOsCode() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errPutSeverity() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errPutSeverity --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errPutSeverity() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errPutSubCode() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errPutSubCode --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errPutSubCode() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errPutSubSystem() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errPutSubSystem --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errPutSubSystem() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errPutTries() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errPutTries --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errPutTries() - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * _errRelease() - * $CATEGORY$ - * C level API compatability - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype (macro replacement) - * - * #include "error.api" - * _errRelease --> - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $FILES$ - * Header file is error.api - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_errRelease() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _evalLaunch() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "item.api" + _evalLaunch --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is item.api + $PLATFORMS$ + All + $SEEALSO$ + hb_evalLaunch() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _evalNew() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "item.api" + _evalNew --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is item.api + $PLATFORMS$ + All + $SEEALSO$ + hb_evalNew() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _evalPutParam() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "item.api" + _evalPutParam --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is item.api + $PLATFORMS$ + All + $SEEALSO$ + hb_evalPutParam() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _evalRelease() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "item.api" + _evalRelease --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is item.api + $PLATFORMS$ + All + $SEEALSO$ + hb_evalRelease() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _itemArrayGet() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "item.api" + _itemArrayGet --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is item.api + $PLATFORMS$ + All + $SEEALSO$ + hb_itemArrayGet() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _itemArrayNew() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "item.api" + _itemArrayNew --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is item.api + $PLATFORMS$ + All + $SEEALSO$ + hb_itemArrayNew() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _itemArrayPut() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "item.api" + _itemArrayPut --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is item.api + $PLATFORMS$ + All + $SEEALSO$ + hb_itemArrayPut() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _itemNew() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "item.api" + _itemNew --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is item.api + $PLATFORMS$ + All + $SEEALSO$ + hb_itemNew() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _itemParam() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "item.api" + _itemParam --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is item.api + $PLATFORMS$ + All + $SEEALSO$ + hb_itemParam() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _itemRelease() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "item.api" + _itemRelease --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is item.api + $PLATFORMS$ + All + $SEEALSO$ + hb_itemRelease() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _itemReturn() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "item.api" + _itemReturn --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is item.api + $PLATFORMS$ + All + $SEEALSO$ + hb_itemReturn() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _itemSize() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "item.api" + _itemSize --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is item.api + $PLATFORMS$ + All + $SEEALSO$ + hb_itemSize() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _itemType() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Item + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "item.api" + _itemType --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is item.api + $PLATFORMS$ + All + $SEEALSO$ + hb_itemType() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _reta() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _reta --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_reta() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _pcount() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _pcount --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_pcount() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _tchdir() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _tchdir --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsChDir() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _tchdrv() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _tchdrv --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsChDrv() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _tclose() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _tclose --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsClose() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _tcommit() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _tcommit --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsCommit() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _tcreat() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _tcreat --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsCreate() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _tcurdir() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _tcurdir --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsCurDir() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _tcurdrv() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _tcurdrv --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsCurDrv() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _tdevraw() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _tdevraw --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsSetDevRaw() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _terror() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _terror --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsError() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _tisdevice() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _tisdevice --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsIsDevice() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _tisdrv() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _tisdrv --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsIsDrv() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _tlock() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _tlock --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsLock() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _tlseek() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _tlseek --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsSeek() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _tmkdir() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _tmkdir --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsMkDir() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _topen() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _topen --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsOpen() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _tread() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _tread --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsRead() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _trename() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _trename --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsRename() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _trmdir() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _trmdir --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsRmDir() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _tunlink() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _tunlink --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsDelete() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _twrite() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _twrite --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsWrite() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _bset() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _bset --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + memset() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _bmove() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _bmove --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + memmove() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _bcopy() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _bcopy --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + memcpy() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _bcmp() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Undocumented + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "hbundoc.api" + _bcmp --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is hbundoc.api + $PLATFORMS$ + All + $SEEALSO$ + memcmp() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtBox() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtBox --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtBox() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtColorSelect() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtColorSelect --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtColorSelect() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtDispBegin() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtDispBegin --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtDispBegin() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtDispCount() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtDispCount --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtDispCount() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtDispEnd() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtDispEnd --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtDispEnd() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtGetColorStr() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtGetColorStr --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtGetColorStr() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtGetCursor() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtGetCursor --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtGetCursor() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtGetPos() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtGetPos --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtGetPos() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtIsColor() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtIsColor --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtIsColor() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtMaxCol() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtMaxCol --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtMaxCol() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtMaxRow() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtMaxRow --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtMaxRow() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtPostExt() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtPostExt --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtPostExt() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtPreExt() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtPreExt --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtPreExt() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtRectSize() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtRectSize --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtRectSize() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtRepChar() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtRepChar --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtRepChar() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtRest() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtRest --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtRest() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtSave() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtSave --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtSave() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtScrDim() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtScrDim --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtScrDim() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtScroll() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtScroll --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtScroll() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtSetBlink() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtSetBlink --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtSetBlink() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtSetColorStr() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtSetColorStr --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtSetColorStr() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtSetCursor() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtSetCursor --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtSetCursor() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtSetMode() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtSetMode --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtSetMode() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtSetPos() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtSetPos --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtSetPos() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtSetSnowFlag() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtSetSnowFlag --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtSetSnowFlag() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtWrite() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtWrite --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtWrite() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtWriteAt() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtWriteAt --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtWriteAt() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtWriteCon() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtWriteCon --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtWriteCon() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtInit() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtInit --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtInit() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtExit() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtExit --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtExit() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtWCreate() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtWCreate --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtWCreate() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtWDestroy() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtWDestroy --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtWDestroy() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtWFlash() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtWFlash --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtWFlash() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtWApp() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtWApp --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtWApp() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtWCurrent() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtWCurrent --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtWCurrent() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtWPos() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtWPos --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtWPos() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtWVis() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtWVis --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtWVis() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtModalRead() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtModalRead --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtModalRead() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtBeginWrite() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtBeginWrite --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtBeginWrite() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtEndWrite() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtEndWrite --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtEndWrite() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtFlushCursor() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtFlushCursor --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtFlushCursor() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtSetColor() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtSetColor --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtSetColor() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtGetColor() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtGetColor --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtGetColor() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _gtSetBorder() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Terminal + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "gt.api" + _gtSetBorder --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is gt.api + $PLATFORMS$ + All + $SEEALSO$ + hb_gtSetBorder() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _xalloc() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Fixed memory + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "fm.api" + _xalloc --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is fm.api + $PLATFORMS$ + All + $SEEALSO$ + hb_xalloc() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _xgrab() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Fixed memory + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "fm.api" + _xgrab --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is fm.api + $PLATFORMS$ + All + $SEEALSO$ + hb_xgrab() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _xfree() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Fixed memory + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "fm.api" + _xfree --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is fm.api + $PLATFORMS$ + All + $SEEALSO$ + hb_xfree() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _exmgrab() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Fixed memory + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "fm.api" + _exmgrab --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is fm.api + $PLATFORMS$ + All + $SEEALSO$ + hb_xgrab() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _fsChDir() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "filesys.api" + _fsChDir --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is filesys.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsChDir() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _fsChDrv() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "filesys.api" + _fsChDrv --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is filesys.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsChDrv() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _fsClose() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "filesys.api" + _fsClose --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is filesys.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsClose() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _fsCommit() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "filesys.api" + _fsCommit --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is filesys.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsCommit() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _fsCreate() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "filesys.api" + _fsCreate --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is filesys.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsCreate() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _fsCurDir() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "filesys.api" + _fsCurDir --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is filesys.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsCurDir() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _fsCurDrv() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "filesys.api" + _fsCurDrv --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is filesys.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsCurDrv() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _fsDelete() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "filesys.api" + _fsDelete --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is filesys.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsDelete() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _fsError() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "filesys.api" + _fsError --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is filesys.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsError() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _fsExtOpen() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "filesys.api" + _fsExtOpen --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is filesys.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsExtOpen() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _fsIsDrv() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "filesys.api" + _fsIsDrv --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is filesys.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsIsDrv() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _fsLock() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "filesys.api" + _fsLock --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is filesys.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsLock() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _fsMkDir() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "filesys.api" + _fsMkDir --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is filesys.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsMkDir() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _fsOpen() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "filesys.api" + _fsOpen --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is filesys.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsOpen() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _fsRead() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "filesys.api" + _fsRead --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is filesys.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsRead() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _fsRmDir() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "filesys.api" + _fsRmDir --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is filesys.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsRmDir() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _fsRename() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "filesys.api" + _fsRename --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is filesys.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsRename() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _fsSeek() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "filesys.api" + _fsSeek --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is filesys.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsSeek() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _fsWrite() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + FileSys + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "filesys.api" + _fsWrite --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is filesys.api + $PLATFORMS$ + All + $SEEALSO$ + hb_fsWrite() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ALENGTH + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro definition) + + #include "extend.api" + ALENGTH( n ) --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _parc() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _parc --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_parc() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _parclen() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _parclen --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_parclen() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _parcsiz() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _parcsiz --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_parcsiz() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _pards() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _pards --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_pards() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _parinfa() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _parinfa --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_parinfa() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _parinfo() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _parinfo --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_parinfo() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _parl() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _parl --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_parl() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _parnd() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _parnd --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_parnd() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _parni() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _parni --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_parni() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _parnl() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _parnl --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_parnl() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _ret() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _ret --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_ret() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _retc() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _retc --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_retc() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _retclen() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _retclen --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_retclen() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _retds() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _retds --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_retds() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _retl() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _retl --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_retl() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _retnd() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _retnd --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_retnd() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _retni() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _retni --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_retni() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _retnl() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _retnl --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_retnl() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _storc() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _storc --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_storc() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _storclen() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _storclen --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_storclen() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _stords() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _stords --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_stords() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _storl() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _storl --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_storl() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _stornd() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _stornd --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_stornd() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _storni() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _storni --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_storni() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _stornl() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Extend + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "extend.api" + _stornl --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is extend.api + $PLATFORMS$ + All + $SEEALSO$ + hb_stornl() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errGetDescription() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errGetDescription --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errGetDescription() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errGetFileName() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errGetFileName --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errGetFileName() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errGetFlags() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errGetFlags --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errGetFlags() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errGetGenCode() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errGetGenCode --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errGetGenCode() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errGetOperation() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errGetOperation --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errGetOperation() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errGetOsCode() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errGetOsCode --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errGetOsCode() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errGetSeverity() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errGetSeverity --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errGetSeverity() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errGetSubCode() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errGetSubCode --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errGetSubCode() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errGetSubSystem() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errGetSubSystem --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errGetSubSystem() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errGetTries() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errGetTries --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errGetTries() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errLaunch() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errLaunch --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errLaunch() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errNew() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errNew --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errNew() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errPutDescription() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errPutDescription --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errPutDescription() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errPutFileName() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errPutFileName --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errPutFileName() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errPutFlags() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errPutFlags --> + $ARGUMENTS$ + + $RETURNS$ + + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errPutGenCode() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errPutOperation() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errPutOperation --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errPutOperation() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errPutOsCode() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errPutOsCode --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errPutOsCode() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errPutSeverity() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errPutSeverity --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errPutSeverity() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errPutSubCode() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errPutSubCode --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errPutSubCode() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errPutSubSystem() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errPutSubSystem --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errPutSubSystem() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errPutTries() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errPutTries --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errPutTries() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + _errRelease() + $CATEGORY$ + C level API compatability + $SUBCATEGORY$ + Error + $ONELINER$ + + $SYNTAX$ + C Prototype (macro replacement) + + #include "error.api" + _errRelease --> + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $FILES$ + Header file is error.api + $PLATFORMS$ + All + $SEEALSO$ + hb_errRelease() + $END$ */ diff --git a/harbour/doc/en/hb_date.txt b/harbour/doc/en/hb_date.txt index 628bcc4036..7e78b1435a 100644 --- a/harbour/doc/en/hb_date.txt +++ b/harbour/doc/en/hb_date.txt @@ -13,510 +13,510 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_dateSeconds() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbdate.h" - * hb_dateSeconds( void ) --> ( double )dResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_dateSeconds() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbdate.h" + hb_dateSeconds( void ) --> ( double )dResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_dateToday() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbdate.h" - * hb_dateToday( long * plYear, long * plMonth, long * plDay ) - * $ARGUMENTS$ - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_dateToday() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbdate.h" + hb_dateToday( long * plYear, long * plMonth, long * plDay ) + $ARGUMENTS$ + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_dateTimeStr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * Get the current workstation time - * $SYNTAX$ - * C Prototype - * - * #include "hbdate.h" - * hb_dateTimeStr( char * pszTime ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * The current workstation time is stored into the buffer pointed - * to by pszTime. This buffer must be at least nine characters long. - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_dateTimeStr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + Get the current workstation time + $SYNTAX$ + C Prototype + + #include "hbdate.h" + hb_dateTimeStr( char * pszTime ) + $ARGUMENTS$ + + $DESCRIPTION$ + The current workstation time is stored into the buffer pointed + to by pszTime. This buffer must be at least nine characters long. + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_dateCMonth() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbdate.h" - * hb_dateCMonth( int iMonth ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_dateCMonth() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbdate.h" + hb_dateCMonth( int iMonth ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_dateCDOW() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbdate.h" - * hb_dateCDOW( int iDay ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_dateCDOW() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbdate.h" + hb_dateCDOW( int iDay ) --> ( char * )pszResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_dateDOW() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbdate.h" - * hb_dateDOW( long lYear, long lMonth, long lDay ) --> ( long )lResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_dateDOW() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbdate.h" + hb_dateDOW( long lYear, long lMonth, long lDay ) --> ( long )lResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_dateFormat() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbdate.h" - * hb_dateFormat( const char * szDate, char * szFormattedDate, const char * szDateFormat ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_dateFormat() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbdate.h" + hb_dateFormat( const char * szDate, char * szFormattedDate, const char * szDateFormat ) --> ( char * )pszResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_dateEncode() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbdate.h" - * hb_dateEncode( long lYear, long lMonth, long lDay ) --> ( long )lResult - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_dateEncode() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbdate.h" + hb_dateEncode( long lYear, long lMonth, long lDay ) --> ( long )lResult + $ARGUMENTS$ + + + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_dateDecode() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbdate.h" - * hb_dateDecode( long julian, long * plYear, long * plMonth, long * plDay ) - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_dateDecode() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbdate.h" + hb_dateDecode( long julian, long * plYear, long * plMonth, long * plDay ) + $ARGUMENTS$ + + + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_dateStrPut() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbdate.h" - * hb_dateStrPut( char * szDate, long lYear, long lMonth, long lDay ) - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_dateStrPut() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbdate.h" + hb_dateStrPut( char * szDate, long lYear, long lMonth, long lDay ) + $ARGUMENTS$ + + + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_dateStrGet() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbdate.h" - * hb_dateStrGet( const char * szDate, long * plYear, long * plMonth, long * plDay ) - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_dateStrGet() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbdate.h" + hb_dateStrGet( const char * szDate, long * plYear, long * plMonth, long * plDay ) + $ARGUMENTS$ + + + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_dateDecStr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbdate.h" - * hb_dateDecStr( char * szDate, long lJulian ) --> ( char * )pszResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_dateDecStr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbdate.h" + hb_dateDecStr( char * szDate, long lJulian ) --> ( char * )pszResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_dateEncStr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Date/Time - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbdate.h" - * hb_dateEncStr( char * szDate ) --> ( long ) lResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_dateEncStr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Date/Time + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbdate.h" + hb_dateEncStr( char * szDate ) --> ( long ) lResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ diff --git a/harbour/doc/en/hb_macro.txt b/harbour/doc/en/hb_macro.txt index b9e4d85239..ab58ab044b 100644 --- a/harbour/doc/en/hb_macro.txt +++ b/harbour/doc/en/hb_macro.txt @@ -13,1117 +13,1117 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_macroError() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_macroError( int iError, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_macroError() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_macroError( int iError, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_macroYYParse() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_macroYYParse( HB_MACRO_PTR pMacro ) --> ( int )iResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_macroYYParse() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_macroYYParse( HB_MACRO_PTR pMacro ) --> ( int )iResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compGenPCode1() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenPCode1( BYTE byte, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compGenPCode1() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenPCode1( BYTE byte, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compGenPCode2() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenPCode2( BYTE byte1, BYTE byte2, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compGenPCode2() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenPCode2( BYTE byte1, BYTE byte2, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compGenPCode3() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenPCode3( BYTE byte1, BYTE byte2, BYTE byte3, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compGenPCode3() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenPCode3( BYTE byte1, BYTE byte2, BYTE byte3, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compGenPCode4() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenPCode4( BYTE byte1, BYTE byte2, BYTE byte3, BYTE byte4, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compGenPCode4() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenPCode4( BYTE byte1, BYTE byte2, BYTE byte3, BYTE byte4, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compGenPCodeN() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenPCodeN( BYTE * pBuffer, ULONG ulSize, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compGenPCodeN() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenPCodeN( BYTE * pBuffer, ULONG ulSize, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_compLocalVarGetPos() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compLocalVarGetPos( char * szVarName, HB_BISON_PTR pMacro ) --> ( int )iResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_compLocalVarGetPos() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compLocalVarGetPos( char * szVarName, HB_BISON_PTR pMacro ) --> ( int )iResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_compGenJump() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenJump( LONG lOffset, HB_BISON_PTR pMacro ) --> ( ULONG )ulResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_compGenJump() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenJump( LONG lOffset, HB_BISON_PTR pMacro ) --> ( ULONG )ulResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_compGenJumpFalse() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenJumpFalse( LONG lOffset, HB_BISON_PTR pMacro ) --> ( ULONG )ulResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_compGenJumpFalse() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenJumpFalse( LONG lOffset, HB_BISON_PTR pMacro ) --> ( ULONG )ulResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compGenJumpThere() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenJumpThere( ULONG ulFrom, ULONG ulTo, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compGenJumpThere() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenJumpThere( ULONG ulFrom, ULONG ulTo, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compGenJumpHere() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenJumpHere( ULONG ulOffset, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compGenJumpHere() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenJumpHere( ULONG ulOffset, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_compGenJumpTrue() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenJumpTrue( LONG lOffset, HB_BISON_PTR pMacro ) --> ( ULONG )ulResult - * $ARGUMENTS$ - * - * - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_compGenJumpTrue() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenJumpTrue( LONG lOffset, HB_BISON_PTR pMacro ) --> ( ULONG )ulResult + $ARGUMENTS$ + + + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compMemvarGenPCode() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compMemvarGenPCode( BYTE bPCode, char * szVarName, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compMemvarGenPCode() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compMemvarGenPCode( BYTE bPCode, char * szVarName, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compGenPushSymbol() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenPushSymbol( char * szSymbolName, int isFunction, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compGenPushSymbol() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenPushSymbol( char * szSymbolName, int isFunction, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compGenPushLong() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenPushLong( long lNumber, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compGenPushLong() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenPushLong( long lNumber, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compGenMessage() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenMessage( char * szMsgName, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compGenMessage() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenMessage( char * szMsgName, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compGenMessageData() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenMessageData( char * szMsg, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compGenMessageData() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenMessageData( char * szMsg, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compGenPopVar() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenPopVar( char * szVarName, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compGenPopVar() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenPopVar( char * szVarName, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compGenPopAliasedVar() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenPopAliasedVar( char * szVarName, HB_BOOL bPushAliasValue, char * szAlias, long lWorkarea, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compGenPopAliasedVar() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenPopAliasedVar( char * szVarName, HB_BOOL bPushAliasValue, char * szAlias, long lWorkarea, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compGenPushVar() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenPushVar( char * szVarName, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compGenPushVar() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenPushVar( char * szVarName, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compGenPushVarRef() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenPushVarRef( char * szVarName, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compGenPushVarRef() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenPushVarRef( char * szVarName, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compGenPushAliasedVar() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenPushAliasedVar( char * szVarName, HB_BOOL bPushAliasValue, char * szAlias, long lWorkarea, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compGenPushAliasedVar() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenPushAliasedVar( char * szVarName, HB_BOOL bPushAliasValue, char * szAlias, long lWorkarea, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compGenPushLogical() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenPushLogical( int iTrueFalse, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compGenPushLogical() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenPushLogical( int iTrueFalse, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compGenPushDouble() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenPushDouble( double dNumber, BYTE bWidth, BYTE bDec, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compGenPushDouble() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenPushDouble( double dNumber, BYTE bWidth, BYTE bDec, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compGenPushFunCall() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenPushFunCall( char * szFunName, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compGenPushFunCall() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenPushFunCall( char * szFunName, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compGenPushString() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compGenPushString( char * szText, ULONG ulStrLen, HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compGenPushString() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compGenPushString( char * szText, ULONG ulStrLen, HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compCodeBlockStart() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compCodeBlockStart( HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compCodeBlockStart() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compCodeBlockStart( HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_compCodeBlockEnd() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbmacro.h" - * hb_compCodeBlockEnd( HB_BISON_PTR pMacro ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is macro - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_compCodeBlockEnd() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Macro + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbmacro.h" + hb_compCodeBlockEnd( HB_BISON_PTR pMacro ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is macro + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ diff --git a/harbour/doc/en/hb_set.txt b/harbour/doc/en/hb_set.txt index 609bcce3ee..bfd70426dc 100644 --- a/harbour/doc/en/hb_set.txt +++ b/harbour/doc/en/hb_set.txt @@ -13,216 +13,215 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_setInitialize() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbset.h" - * hb_setInitialize( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_setInitialize() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Environment + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbset.h" + hb_setInitialize( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_setRelease() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbset.h" - * hb_setRelease( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_setRelease() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Environment + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbset.h" + hb_setRelease( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_setListenerAdd() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbset.h" - * hb_setListenerAdd( PHB_SET_LISTENER_CALLBACK callback ) --> int - * $ARGUMENTS$ - * - * A pointer to a function taking two enum parameters and returning - * no value. The first parameter identifies the SET parameter that is - * to be changed and the second parameter identifies whether the call - * is from before or after the value is changed. The callback function - * will be called twice whenever a SET parameter is changed using the - * Harbour SET function. The first call takes place before the SET - * value is changed and the second one is after the SET parameter has - * been changed. - * $RETURNS$ - * An integer value representing the callback handle, in case the - * caller needs to deactivate the callback function. - * $DESCRIPTION$ - * This function allows a subsystem that needs to track the status - * of some SET parameters to be notified whenever a SET parameter gets - * changed. - * $EXAMPLES$ - * void callback_function( HB_set_enum set, HB_set_listener_enum when ) - * { - * printf("\nCalled for SET parameter %d %s changing.", - * set, (when ? "after" : "before")); - * } - * int handle = hb_setListenerAdd( callback_function ); - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_setListenerRemove() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_setListenerAdd() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Environment + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbset.h" + hb_setListenerAdd( PHB_SET_LISTENER_CALLBACK callback ) --> int + $ARGUMENTS$ + + A pointer to a function taking two enum parameters and returning + no value. The first parameter identifies the SET parameter that is + to be changed and the second parameter identifies whether the call + is from before or after the value is changed. The callback function + will be called twice whenever a SET parameter is changed using the + Harbour SET function. The first call takes place before the SET + value is changed and the second one is after the SET parameter has + been changed. + $RETURNS$ + An integer value representing the callback handle, in case the + caller needs to deactivate the callback function. + $DESCRIPTION$ + This function allows a subsystem that needs to track the status + of some SET parameters to be notified whenever a SET parameter gets + changed. + $EXAMPLES$ + void callback_function( HB_set_enum set, HB_set_listener_enum when ) + { + printf("\nCalled for SET parameter %d %s changing.", + set, (when ? "after" : "before")); + } + int handle = hb_setListenerAdd( callback_function ); + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + hb_setListenerRemove() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_setListenerNotify() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbset.h" - * hb_setListenerNotify( HB_set_enum set, HB_set_listener_enum - * when ) --> int - * $ARGUMENTS$ - * - * The number of the SET parameter that is to be or was changed. - * - * - * Set to HB_SET_LISTENER_BEFORE when called before the SET parameter - * is to be changed and set to HB_SET_LISTENER_AFTER when called - * after the SET parameter has been changed. - * $RETURNS$ - * - * $DESCRIPTION$ - * This function notifies all SET listener callback functions. It - * must be called any time you change the value of a SET parameter - * directly instead of using the Harbour SET function. Both before - * and after the change. - * $EXAMPLES$ - * hb_setListenerNotify( HB_SET_DECIMALS, HB_SET_LISTENER_BEFORE ); - * hb_set.HB_SET_DECIMALS = 3; - * hb_setListenerNotify( HB_SET_DECIMALS, HB_SET_LISTENER_AFTER ); - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_setListenerAdd() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_setListenerNotify() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Environment + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbset.h" + hb_setListenerNotify( HB_set_enum set, HB_set_listener_enum + when ) --> int + $ARGUMENTS$ + + The number of the SET parameter that is to be or was changed. + + + Set to HB_SET_LISTENER_BEFORE when called before the SET parameter + is to be changed and set to HB_SET_LISTENER_AFTER when called + after the SET parameter has been changed. + $RETURNS$ + + $DESCRIPTION$ + This function notifies all SET listener callback functions. It + must be called any time you change the value of a SET parameter + directly instead of using the Harbour SET function. Both before + and after the change. + $EXAMPLES$ + hb_setListenerNotify( HB_SET_DECIMALS, HB_SET_LISTENER_BEFORE ); + hb_set.HB_SET_DECIMALS = 3; + hb_setListenerNotify( HB_SET_DECIMALS, HB_SET_LISTENER_AFTER ); + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + hb_setListenerAdd() + $END$ */ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_setListenerRemove() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Environment + $ONELINER$ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_setListenerRemove() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbset.h" - * hb_setListenerRemove( int handle ) --> int - * $ARGUMENTS$ - * - * The handle for the SET listener callback function to be removed. - * $RETURNS$ - * The handle if the callback function could not be located or the - * negative value of the handle if the callback function was removed. - * $DESCRIPTION$ - * This function removes a SET listener callback function. - * $EXAMPLES$ - * int handle = hb_setListenerAdd( callback_function ); - * ... - * hb_setListenerRemove( handle ); - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_setListenerAdd() - * $END$ + $SYNTAX$ + C Prototype + + #include "hbset.h" + hb_setListenerRemove( int handle ) --> int + $ARGUMENTS$ + + The handle for the SET listener callback function to be removed. + $RETURNS$ + The handle if the callback function could not be located or the + negative value of the handle if the callback function was removed. + $DESCRIPTION$ + This function removes a SET listener callback function. + $EXAMPLES$ + int handle = hb_setListenerAdd( callback_function ); + ... + hb_setListenerRemove( handle ); + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + hb_setListenerAdd() + $END$ */ diff --git a/harbour/doc/en/hb_vm.txt b/harbour/doc/en/hb_vm.txt index c9ae5f8074..054edbe392 100644 --- a/harbour/doc/en/hb_vm.txt +++ b/harbour/doc/en/hb_vm.txt @@ -15,1039 +15,1039 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmInit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmInit( HB_BOOL bStartMainProc ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmInit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmInit( HB_BOOL bStartMainProc ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_vmQuit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * Immediately quits the virtual machine - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmQuit( void ) --> int - * $ARGUMENTS$ - * - * $RETURNS$ - * ERRORLEVEL code - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_vmQuit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + Immediately quits the virtual machine + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmQuit( void ) --> int + $ARGUMENTS$ + + $RETURNS$ + ERRORLEVEL code + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmExecute() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * Invokes the virtual machine - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmExecute( const BYTE * pCode, PHB_SYMB pSymbols ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmExecute() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + Invokes the virtual machine + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmExecute( const BYTE * pCode, PHB_SYMB pSymbols ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmProcessSymbols() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * Statics symbols initialization - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmProcessSymbols( PHB_SYMB pSymbols, USHORT uiSymbols ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmProcessSymbols() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + Statics symbols initialization + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmProcessSymbols( PHB_SYMB pSymbols, USHORT uiSymbols ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmSymbolInit_RT() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * Initialization of runtime support symbols - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmSymbolInit_RT( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmSymbolInit_RT() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + Initialization of runtime support symbols + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmSymbolInit_RT( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmRequestQuit() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmRequestQuit( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmRequestQuit() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmRequestQuit( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmRequestEndProc() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmRequestEndProc( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmRequestEndProc() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmRequestEndProc( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmRequestCancel() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmRequestCancel( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmRequestCancel() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmRequestCancel( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmRequestBreak() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmRequestBreak( PHB_ITEM pItem ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmRequestBreak() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmRequestBreak( PHB_ITEM pItem ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_vmRequestQuery() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmRequestQuery( void ) --> ( USHORT )usResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_vmRequestQuery() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmRequestQuery( void ) --> ( USHORT )usResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmMessage() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * Sends a message to an object - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmMessage( PHB_SYMB pSymMsg ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmMessage() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + Sends a message to an object + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmMessage( PHB_SYMB pSymMsg ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmDo() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * Invoke the virtual machine - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmDo( USHORT uiParams ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmDo() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + Invoke the virtual machine + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmDo( USHORT uiParams ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmFunction() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * Executes a function saving its result - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmFunction( USHORT uiParams ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmFunction() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + Executes a function saving its result + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmFunction( USHORT uiParams ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmSend() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * Sends a message to an object - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmSend( USHORT uiParams ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmSend() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + Sends a message to an object + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmSend( USHORT uiParams ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_vmEvalBlock() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * Executes passed codeblock with no arguments - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmEvalBlock( PHB_ITEM pBlockItem ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_vmEvalBlock() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + Executes passed codeblock with no arguments + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmEvalBlock( PHB_ITEM pBlockItem ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_vmEvalBlockV() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmEvalBlockV( PHB_ITEM pBlockItem, USHORT uiArgCount, ... ) --> ( PHB_ITEM )pResult - * $ARGUMENTS$ - * - * - * - * - * <...> - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_vmEvalBlockV() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmEvalBlockV( PHB_ITEM pBlockItem, USHORT uiArgCount, ... ) --> ( PHB_ITEM )pResult + $ARGUMENTS$ + + + + + <...> + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmPush() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * Pushes a generic item onto the stack - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmPush( PHB_ITEM pItem ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmPush() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + Pushes a generic item onto the stack + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmPush( PHB_ITEM pItem ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmPushNil() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * In this case it places nil at self - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmPushNil( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmPushNil() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + In this case it places nil at self + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmPushNil( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmPushNumber() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * Pushes a number on to the stack and decides if it is integer, long or double - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmPushNumber( double dNumber, int iDec ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmPushNumber() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + Pushes a number on to the stack and decides if it is integer, long or double + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmPushNumber( double dNumber, int iDec ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmPushInteger() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * Pushes a integer number onto the stack - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmPushInteger( int iNumber ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmPushInteger() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + Pushes a integer number onto the stack + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmPushInteger( int iNumber ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmPushLong() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * Pushes a long number onto the stack - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmPushLong( long lNumber ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmPushLong() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + Pushes a long number onto the stack + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmPushLong( long lNumber ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmPushDouble() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * Pushes a double number onto the stack - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmPushDouble( double lNumber, int iDec ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmPushDouble() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + Pushes a double number onto the stack + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmPushDouble( double lNumber, int iDec ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmPushLogical() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * Pushes a logical value onto the stack - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmPushLogical( HB_BOOL bValue ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmPushLogical() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + Pushes a logical value onto the stack + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmPushLogical( HB_BOOL bValue ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmPushString() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * Pushes a string on to the stack - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmPushString( char * szText, ULONG length ) - * $ARGUMENTS$ - * - * - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmPushString() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + Pushes a string on to the stack + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmPushString( char * szText, ULONG length ) + $ARGUMENTS$ + + + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmPushDate() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * Pushes a long date onto the stack - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmPushDate( long lDate ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmPushDate() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + Pushes a long date onto the stack + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmPushDate( long lDate ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmPushSymbol() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * Pushes a function pointer onto the stack - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmPushSymbol( PHB_SYMB pSym ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmPushSymbol() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + Pushes a function pointer onto the stack + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmPushSymbol( PHB_SYMB pSym ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_vmPushPointer() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * Push an item of HB_IT_POINTER type - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_vmPushPointer( void * ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_vmPushPointer() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + Push an item of HB_IT_POINTER type + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_vmPushPointer( void * ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_stackDispCall() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_stackDispCall( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_stackDispCall() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_stackDispCall( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_stackPop() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Virtual machine - * $ONELINER$ - * Pops an item from the stack - * $SYNTAX$ - * C Prototype - * - * #include "hbvm.h" - * hb_stackPop( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Library is vm - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_stackPop() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Virtual machine + $ONELINER$ + Pops an item from the stack + $SYNTAX$ + C Prototype + + #include "hbvm.h" + hb_stackPop( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Library is vm + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ diff --git a/harbour/doc/en/hbflock.txt b/harbour/doc/en/hbflock.txt index 904cecded1..c05cff980a 100644 --- a/harbour/doc/en/hbflock.txt +++ b/harbour/doc/en/hbflock.txt @@ -2,111 +2,111 @@ * $Id$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_FLOCK() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Locks part or all of any file - * $SYNTAX$ - * HB_FLOCK( , , [, - * $ARGUMENTS$ - * Dos file handle - - * Offset of the first byte of the region to be locked. - - * Number of bytes to be locked. - - * The type (read or write) of lock requested. - * $RETURNS$ - * .T. if the lock was obtained, else .F. - * $DESCRIPTION$ - * This function attempts to lock a region of the file whose file handle - * is . This is a low level file function. To lock Harbour - * data files use either the FLOCK() or RLOCK() function. - - * The value of is obtained from either a call to the FOPEN() - * or the FCREATE() function. - - * is the offset (from the beginning of the file) to the first - * byte of the region to be locked. (Offsets from the current position - * and end of file are not currently supported.) - - * is the length of the region to be locked in bytes. - - * is the type of lock requested. There are two types of locks: - * exclusive write locks ( = 0x0000 ) - the default, and shared - * read locks( = 0x0100 ). Additionally you can specify a - * blocking version of this function (that is it won't return until - * either an error has occurred or the lock has been obtained) by - * adding Ox0200 to the above values. - * $EXAMPLES$ - * refer to tfl.prg - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All(64K) - * $FILES$ - * Library is rtl - * $SEEALSO$ - * HB_FUNLOCK(),FOPEN(),FCREATE(),FERROR(),FCLOSE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_FLOCK() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Locks part or all of any file + $SYNTAX$ + HB_FLOCK( , , [, + $ARGUMENTS$ + Dos file handle + + set> Offset of the first byte of the region to be locked. + + Number of bytes to be locked. + + e> The type (read or write) of lock requested. + $RETURNS$ + .T. if the lock was obtained, else .F. + $DESCRIPTION$ + This function attempts to lock a region of the file whose file handle + is . This is a low level file function. To lock Harbour + data files use either the FLOCK() or RLOCK() function. + + The value of is obtained from either a call to the FOPEN() + or the FCREATE() function. + + is the offset (from the beginning of the file) to the first + of the region to be locked. (Offsets from the current position + nd of file are not currently supported.) + + is the length of the region to be locked in bytes. + + e> is the type of lock requested. There are two types of locks: + sive write locks ( = 0x0000 ) - the default, and shared + locks( = 0x0100 ). Additionally you can specify a + ing version of this function (that is it won't return until + r an error has occurred or the lock has been obtained) by + g Ox0200 to the above values. + $EXAMPLES$ + refer to tfl.prg + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + All(64K) + $FILES$ + Library is rtl + $SEEALSO$ + HB_FUNLOCK(),FOPEN(),FCREATE(),FERROR(),FCLOSE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_FUNLOCK() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * FileSys - * $ONELINER$ - * Unlocks part or all of any file - * $SYNTAX$ - * HB_FUNLOCK( , , ) --> - - * $ARGUMENTS$ - * Dos file handle - - * Offset of the first byte of the region to be locked. - - * Number of bytes to be locked. - * $RETURNS$ - * .T. if the lock was removed, else .F. - * $DESCRIPTION$ - * This function attempts to unlock a region of the file whose file - * handle is . This is a low level file function. To - * unlock Harbour data files use the DBUNLOCK() function. - - * The value of is obtained from either a call to the FOPEN() - * or the FCREATE() function. - - * is the offset (from the beginning of the file) to the first - * byte of the region to be unlocked. (Offsets from the current position - * and end of file are not currently supported.) - - * is the length of the region to be unlocked in bytes. - * $EXAMPLES$ - * refer to tfl.prg - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All(64K) - * $FILES$ - * Library is rtl - * $SEEALSO$ - * HB_FLOCK(),FOPEN(),FCREATE(),FERROR(),FCLOSE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_FUNLOCK() + $CATEGORY$ + API + $SUBCATEGORY$ + FileSys + $ONELINER$ + Unlocks part or all of any file + $SYNTAX$ + HB_FUNLOCK( , , ) --> + + $ARGUMENTS$ + Dos file handle + + set> Offset of the first byte of the region to be locked. + + Number of bytes to be locked. + $RETURNS$ + .T. if the lock was removed, else .F. + $DESCRIPTION$ + This function attempts to unlock a region of the file whose file + handle is . This is a low level file function. To + unlock Harbour data files use the DBUNLOCK() function. + + The value of is obtained from either a call to the FOPEN() + or the FCREATE() function. + + is the offset (from the beginning of the file) to the first + of the region to be unlocked. (Offsets from the current position + nd of file are not currently supported.) + + is the length of the region to be unlocked in bytes. + $EXAMPLES$ + refer to tfl.prg + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + All(64K) + $FILES$ + Library is rtl + $SEEALSO$ + HB_FLOCK(),FOPEN(),FCREATE(),FERROR(),FCLOSE() + $END$ */ diff --git a/harbour/doc/en/hbinet.txt b/harbour/doc/en/hbinet.txt index 1e37250c6a..02328bf2a4 100644 --- a/harbour/doc/en/hbinet.txt +++ b/harbour/doc/en/hbinet.txt @@ -50,1779 +50,1779 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETINIT - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Activate Harbour INET support - * $SYNTAX$ - * HB_INETINIT() -> lResult - * $ARGUMENTS$ - * (This function has no arguments) - * $RETURNS$ - * Returns .T. or .F. whether the internal INET system was successfully initialized - * $DESCRIPTION$ - * Activates inet support; mainly used for winsock start up at the moment, but - * could be used in the future for many other purpose. Put it at the beginning - * of every program using INET functions. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETINIT + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Activate Harbour INET support + $SYNTAX$ + HB_INETINIT() -> lResult + $ARGUMENTS$ + (This function has no arguments) + $RETURNS$ + Returns .T. or .F. whether the internal INET system was successfully initialized + $DESCRIPTION$ + Activates inet support; mainly used for winsock start up at the moment, but + could be used in the future for many other purpose. Put it at the beginning + of every program using INET functions. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * HB_INETCLEANUP - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Terminate Harbour INET support - * $SYNTAX$ - * HB_INETCLEANUP() - * $ARGUMENTS$ - * (This function has no arguments) - * $DESCRIPTION$ - * Closes inet support; mainly used for Windows. Put it at the end of any program - * using Inet functions, just before the program exits. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + HB_INETCLEANUP + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Terminate Harbour INET support + $SYNTAX$ + HB_INETCLEANUP() + $ARGUMENTS$ + (This function has no arguments) + $DESCRIPTION$ + Closes inet support; mainly used for Windows. Put it at the end of any program + using Inet functions, just before the program exits. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETCREATE - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Create an INET socket - * $SYNTAX$ - * HB_INETCREATE( [ ] ) -> SOCKET - * $ARGUMENTS$ - * Socket timeout (optional) TODO: what is the scale (seconds, milliseconds?) - * $RETURNS$ - * An INET socket - * $DESCRIPTION$ - * Creates the raw data of the socket, that can be passed to a asynchronous - * connection function (hb_InetConnect or hb_InetConnectIP). This will prevent the - * connection function from allocating some data that could be never used in - * certain cases, i.e. an asynchronously detected timeout. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETCREATE + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Create an INET socket + $SYNTAX$ + HB_INETCREATE( [ ] ) -> SOCKET + $ARGUMENTS$ + Socket timeout (optional) TODO: what is the scale (seconds, milliseconds?) + $RETURNS$ + An INET socket + $DESCRIPTION$ + Creates the raw data of the socket, that can be passed to a asynchronous + connection function (hb_InetConnect or hb_InetConnectIP). This will prevent the + connection function from allocating some data that could be never used in + certain cases, i.e. an asynchronously detected timeout. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETCLOSE - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Close an INET socket - * $SYNTAX$ - * HB_INETCLOSE( ) -> nResult - * $ARGUMENTS$ - * a socket previously created / opened - * $RETURNS$ - * Returns 0 on success or -1 on error; on error, the error code is set; - * (actually, on success the socket error code is set to 1 -- socket closed ) - * $DESCRIPTION$ - * Closes the socket, notifiying both ends of the communication pipe that the - * connection is over. - * - * If you have threads waiting for data to be read from - * this socket, this method will make them stop waiting and return an error - * (socket closed) to their callers. - * - * The method does not destroy the socket, which can be used by subordinate - * threads to check that the socket is closed, and so they should stop as soon - * as they can. Don't destroy the socket unless you are sure that no other - * thread is using it. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETCLOSE + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Close an INET socket + $SYNTAX$ + HB_INETCLOSE( ) -> nResult + $ARGUMENTS$ + a socket previously created / opened + $RETURNS$ + Returns 0 on success or -1 on error; on error, the error code is set; + (actually, on success the socket error code is set to 1 -- socket closed ) + $DESCRIPTION$ + Closes the socket, notifiying both ends of the communication pipe that the + connection is over. + + If you have threads waiting for data to be read from + this socket, this method will make them stop waiting and return an error + (socket closed) to their callers. + + The method does not destroy the socket, which can be used by subordinate + threads to check that the socket is closed, and so they should stop as soon + as they can. Don't destroy the socket unless you are sure that no other + thread is using it. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETFD - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * ? - * $SYNTAX$ - * HB_INETFD( [, ] ) -> nResult - * $ARGUMENTS$ - * a socket previously created / opened - * - * - * $RETURNS$ - * ? - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETFD + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + ? + $SYNTAX$ + HB_INETFD( [, ] ) -> nResult + $ARGUMENTS$ + a socket previously created / opened + + + $RETURNS$ + ? + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETSTATUS - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Get the status of a socket - * $SYNTAX$ - * HB_INETSTATUS( ) -> nResult - * $ARGUMENTS$ - * a socket previously created / opened - * $RETURNS$ - * Returns 1 (one) if the socket exists, -1 if it does not - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETSTATUS + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Get the status of a socket + $SYNTAX$ + HB_INETSTATUS( ) -> nResult + $ARGUMENTS$ + a socket previously created / opened + $RETURNS$ + Returns 1 (one) if the socket exists, -1 if it does not + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETERRORCODE - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Get the last INET error code - * $SYNTAX$ - * HB_INETERRORCODE( ) -> nResult - * $ARGUMENTS$ - * a socket previously created / opened - * $RETURNS$ - * Last error code - * $DESCRIPTION$ - * Returns the last error code that has been provoked by a network operation, - * or 0 if none. - * - * Error codes are the ones used for winsock or UnixSockets (they - * are the same); 1 is reserved for "connection closed" message. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETERRORCODE + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Get the last INET error code + $SYNTAX$ + HB_INETERRORCODE( ) -> nResult + $ARGUMENTS$ + a socket previously created / opened + $RETURNS$ + Last error code + $DESCRIPTION$ + Returns the last error code that has been provoked by a network operation, + or 0 if none. + + Error codes are the ones used for winsock or UnixSockets (they + are the same); 1 is reserved for "connection closed" message. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETERRORDESC - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Get the last INET error code description - * $SYNTAX$ - * HB_INETERRORDESC( ) -> cResult - * $ARGUMENTS$ - * a socket previously created / opened - * $RETURNS$ - * System-dependant error string - * $DESCRIPTION$ - * Returns a string describing the last error that occurred in the socket; - * the string is system dependent, and should be used only for debugging - * purposes. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETERRORDESC + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Get the last INET error code description + $SYNTAX$ + HB_INETERRORDESC( ) -> cResult + $ARGUMENTS$ + a socket previously created / opened + $RETURNS$ + System-dependant error string + $DESCRIPTION$ + Returns a string describing the last error that occurred in the socket; + the string is system dependent, and should be used only for debugging + purposes. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * HB_INETCLEARERROR - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Clear the socket error value - * $SYNTAX$ - * HB_INETCLEARERROR( ) - * $ARGUMENTS$ - * a socket previously created / opened - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + HB_INETCLEARERROR + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Clear the socket error value + $SYNTAX$ + HB_INETCLEARERROR( ) + $ARGUMENTS$ + a socket previously created / opened + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETCOUNT - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Get the number of bytes last read or sent - * $SYNTAX$ - * HB_INETCOUNT( ) -> nResult - * $ARGUMENTS$ - * a socket previously created / opened - * $RETURNS$ - * Last socket operation character count - * $DESCRIPTION$ - * Returns the amount of characters read or written in the latest socket - * operation. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETCOUNT + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Get the number of bytes last read or sent + $SYNTAX$ + HB_INETCOUNT( ) -> nResult + $ARGUMENTS$ + a socket previously created / opened + $RETURNS$ + Last socket operation character count + $DESCRIPTION$ + Returns the amount of characters read or written in the latest socket + operation. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETADDRESS - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Get a remote server address - * $SYNTAX$ - * HB_INETADDRESS( ) -> cResult - * $ARGUMENTS$ - * a socket previously created / opened - * $RETURNS$ - * Server address - * $DESCRIPTION$ - * Returns a string representing the remote server address in quad dot notation, - * e.g. "192.168.1.1", or the local server address if the socket is server - * side. - * - * TODO: have a version that returns a vector of 4 numbers. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETADDRESS + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Get a remote server address + $SYNTAX$ + HB_INETADDRESS( ) -> cResult + $ARGUMENTS$ + a socket previously created / opened + $RETURNS$ + Server address + $DESCRIPTION$ + Returns a string representing the remote server address in quad dot notation, + e.g. "192.168.1.1", or the local server address if the socket is server + side. + + TODO: have a version that returns a vector of 4 numbers. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETPORT - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Get the port a socket is bound to. - * $SYNTAX$ - * HB_INETPORT( ) -> cResult - * $ARGUMENTS$ - * a socket previously created / opened - * $RETURNS$ - * Port name the socket is bound to. - * $DESCRIPTION$ - * Returns the port to which this socket is bound, or the remote port if this - * socket is connected with a remote host or client - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETPORT + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Get the port a socket is bound to. + $SYNTAX$ + HB_INETPORT( ) -> cResult + $ARGUMENTS$ + a socket previously created / opened + $RETURNS$ + Port name the socket is bound to. + $DESCRIPTION$ + Returns the port to which this socket is bound, or the remote port if this + socket is connected with a remote host or client + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETTIMEOUT - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Get or change the timeout value of a socket - * $SYNTAX$ - * HB_INETTIMEOUT( [, ] ) -> nPreviousTimeout - * $ARGUMENTS$ - * a socket previously created / opened - * - * is the new socket timeout value - * $RETURNS$ - * Returns the previous timeout value of the socket - * $DESCRIPTION$ - * Sets or changes the timeout value of the socket. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETTIMEOUT + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Get or change the timeout value of a socket + $SYNTAX$ + HB_INETTIMEOUT( [, ] ) -> nPreviousTimeout + $ARGUMENTS$ + a socket previously created / opened + + is the new socket timeout value + $RETURNS$ + Returns the previous timeout value of the socket + $DESCRIPTION$ + Sets or changes the timeout value of the socket. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * HB_INETCLEARTIMEOUT - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Clear the timeout value of a socket - * $SYNTAX$ - * HB_INETCLEARTIMEOUT( ) - * $ARGUMENTS$ - * a socket previously created / opened - * $DESCRIPTION$ - * Clears the default timeout of the given socket. Default timeout is used in all - * blocking operations. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + HB_INETCLEARTIMEOUT + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Clear the timeout value of a socket + $SYNTAX$ + HB_INETCLEARTIMEOUT( ) + $ARGUMENTS$ + a socket previously created / opened + $DESCRIPTION$ + Clears the default timeout of the given socket. Default timeout is used in all + blocking operations. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETTIMELIMIT - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Get or change the time limit value of a socket - * $SYNTAX$ - * HB_INETTIMELIMIT( [, ) -> NIL - * $ARGUMENTS$ - * a socket previously created / opened - * - * - * $RETURNS$ - * Returns the previous time limit value of the socket - * $DESCRIPTION$ - * Sets or changes the time limit value of the socket. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETTIMELIMIT + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Get or change the time limit value of a socket + $SYNTAX$ + HB_INETTIMELIMIT( [, ) -> NIL + $ARGUMENTS$ + a socket previously created / opened + + + $RETURNS$ + Returns the previous time limit value of the socket + $DESCRIPTION$ + Sets or changes the time limit value of the socket. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * HB_INETCLEARTIMELIMIT - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Clear the time limit value of a socket - * $SYNTAX$ - * HB_INETCLEARTIMELIMIT( ) - * $ARGUMENTS$ - * a socket previously created / opened - * $DESCRIPTION$ - * Clears the default time limit of the given socket. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + HB_INETCLEARTIMELIMIT + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Clear the time limit value of a socket + $SYNTAX$ + HB_INETCLEARTIMELIMIT( ) + $ARGUMENTS$ + a socket previously created / opened + $DESCRIPTION$ + Clears the default time limit of the given socket. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETPERIODCALLBACK - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Get or change the periodic callback value of a socket - * $SYNTAX$ - * HB_INETPERIODCALLBACK( [, ] ) -> xPreviousCallback - * $ARGUMENTS$ - * a socket previously created / opened - * - * xCallback a new periodic callback - * $RETURNS$ - * The previous periodic callback value - * $DESCRIPTION$ - * Sets or returns the socket periodic callback value - * - * xCallback can be one of: a codeblock, an array of (...), or a (symbol) - * TODO: describe these better - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETPERIODCALLBACK + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Get or change the periodic callback value of a socket + $SYNTAX$ + HB_INETPERIODCALLBACK( [, ] ) -> xPreviousCallback + $ARGUMENTS$ + a socket previously created / opened + + xCallback a new periodic callback + $RETURNS$ + The previous periodic callback value + $DESCRIPTION$ + Sets or returns the socket periodic callback value + + xCallback can be one of: a codeblock, an array of (...), or a (symbol) + TODO: describe these better + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * HB_INETCLEARPERIODCALLBACK - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Clear the periodic callback value of a socket - * $SYNTAX$ - * HB_INETCLEARPERIODCALLBACK( ) - * $ARGUMENTS$ - * a socket previously created / opened - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + HB_INETCLEARPERIODCALLBACK + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Clear the periodic callback value of a socket + $SYNTAX$ + HB_INETCLEARPERIODCALLBACK( ) + $ARGUMENTS$ + a socket previously created / opened + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETGETSNDBUFSIZE - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Get the socket send buffer size - * $SYNTAX$ - * HB_INETGETSNDBUFSIZE( ) -> nResult - * $ARGUMENTS$ - * a socket previously created / opened - * $RETURNS$ - * Returns the socket send buffer size or -1 if the socket is closed or an error occurs - * $DESCRIPTION$ - * Returns the socket send buffer size or -1 if the socket is closed or an error occurs - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETGETSNDBUFSIZE + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Get the socket send buffer size + $SYNTAX$ + HB_INETGETSNDBUFSIZE( ) -> nResult + $ARGUMENTS$ + a socket previously created / opened + $RETURNS$ + Returns the socket send buffer size or -1 if the socket is closed or an error occurs + $DESCRIPTION$ + Returns the socket send buffer size or -1 if the socket is closed or an error occurs + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETGETRCVBUFSIZE - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Get the socket receive buffer size - * $SYNTAX$ - * HB_INETGETRCVBUFSIZE( ) -> nResult - * $ARGUMENTS$ - * a socket previously created / opened - * $RETURNS$ - * Returns the socket receive buffer size or -1 if the socket is closed or an error occurs - * $DESCRIPTION$ - * Returns the socket receive buffer size or -1 if the socket is closed or an error occurs - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETGETRCVBUFSIZE + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Get the socket receive buffer size + $SYNTAX$ + HB_INETGETRCVBUFSIZE( ) -> nResult + $ARGUMENTS$ + a socket previously created / opened + $RETURNS$ + Returns the socket receive buffer size or -1 if the socket is closed or an error occurs + $DESCRIPTION$ + Returns the socket receive buffer size or -1 if the socket is closed or an error occurs + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETSETSNDBUFSIZE - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Set the send buffer size of a socket - * $SYNTAX$ - * HB_INETSETSNDBUFSIZE( , ) -> nSize - * $ARGUMENTS$ - * a socket previously created / opened - * - * nSize - * $RETURNS$ - * Returns the passed nSize or -1 on error - * $DESCRIPTION$ - * Sets the send buffer size of a socket - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETSETSNDBUFSIZE + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Set the send buffer size of a socket + $SYNTAX$ + HB_INETSETSNDBUFSIZE( , ) -> nSize + $ARGUMENTS$ + a socket previously created / opened + + nSize + $RETURNS$ + Returns the passed nSize or -1 on error + $DESCRIPTION$ + Sets the send buffer size of a socket + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETSETRCVBUFSIZE - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Set the receive buffer size of a socket - * $SYNTAX$ - * HB_INETSETRCVBUFSIZE( , nSize ) -> nSize - * $ARGUMENTS$ - * a socket previously created / opened - * - * nSize - * $RETURNS$ - * Returns the passed nSize or -1 on error - * $DESCRIPTION$ - * Sets the receive buffer size of a socket - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETSETRCVBUFSIZE + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Set the receive buffer size of a socket + $SYNTAX$ + HB_INETSETRCVBUFSIZE( , nSize ) -> nSize + $ARGUMENTS$ + a socket previously created / opened + + nSize + $RETURNS$ + Returns the passed nSize or -1 on error + $DESCRIPTION$ + Sets the receive buffer size of a socket + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETRECV - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Read from a socket - * $SYNTAX$ - * HB_INETRECV( , @, [ ] ) -> nResult - * $ARGUMENTS$ - * a socket previously created / opened - * - * is the target buffer and must be passed by reference - * - * is the upper limit of characters to be read from the socket. - * If not passed this defaults to the length of cResult - * $RETURNS$ - * The number of the characters read from the socket. - * $DESCRIPTION$ - * Reads from the socket into a buffer. - * - * The parameter cString must be preallocated so that it has enough - * space to receive the data. The routine will block the thread until some - * bytes are read from the socket, the socket is closed (either from the - * receiver or the sender side) or a network error occurs, whichever comes - * first. In the latter cases, an error is set, and only the characters - * received until premature end of communications are returned. - * - * Notice that there is no guarantee that all the available bytes will be - * read before the function returns, in fact, hb_InetRecv returns as soon it - * is able to fill cString with one or more bytes. To block the current - * process until the whole cString is filled (or nAmount bytes are read), - * use the hb_InetRecvALL(). - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETRECV + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Read from a socket + $SYNTAX$ + HB_INETRECV( , @, [ ] ) -> nResult + $ARGUMENTS$ + a socket previously created / opened + + is the target buffer and must be passed by reference + + is the upper limit of characters to be read from the socket. + If not passed this defaults to the length of cResult + $RETURNS$ + The number of the characters read from the socket. + $DESCRIPTION$ + Reads from the socket into a buffer. + + The parameter cString must be preallocated so that it has enough + space to receive the data. The routine will block the thread until some + bytes are read from the socket, the socket is closed (either from the + receiver or the sender side) or a network error occurs, whichever comes + first. In the latter cases, an error is set, and only the characters + received until premature end of communications are returned. + + Notice that there is no guarantee that all the available bytes will be + read before the function returns, in fact, hb_InetRecv returns as soon it + is able to fill cString with one or more bytes. To block the current + process until the whole cString is filled (or nAmount bytes are read), + use the hb_InetRecvALL(). + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETRECVALL - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Read from a socket without blocking - * $SYNTAX$ - * HB_INETRECVALL( , @, [ ] ) -> nResult - * $ARGUMENTS$ - * a socket previously created / opened - * - * is the target buffer and must be passed by reference - * - * is the upper limit of characters to be read from the socket. - * If not passed this defaults to the length of cResult - * $RETURNS$ - * The number of the characters read from the socket. Might be - * less than nAmount on premature socket closing or on network error. - * $DESCRIPTION$ - * This function works exactly as hb_InetRecv except that it - * blocks until nAmount bytes are read, if nAmount is given, or - * cString is filled for its whole length. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETRECVALL + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Read from a socket without blocking + $SYNTAX$ + HB_INETRECVALL( , @, [ ] ) -> nResult + $ARGUMENTS$ + a socket previously created / opened + + is the target buffer and must be passed by reference + + is the upper limit of characters to be read from the socket. + If not passed this defaults to the length of cResult + $RETURNS$ + The number of the characters read from the socket. Might be + less than nAmount on premature socket closing or on network error. + $DESCRIPTION$ + This function works exactly as hb_InetRecv except that it + blocks until nAmount bytes are read, if nAmount is given, or + cString is filled for its whole length. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETRECVLINE - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Read a line from a socket - * $SYNTAX$ - * HB_INETRECVLINE( [, @, [, [, ]]] ) -> cResult - * $ARGUMENTS$ - * a socket previously created / opened - * - * must be passed by reference - * - * - * - * - * $RETURNS$ - * Line read - * $DESCRIPTION$ - * Blocks the calling thread until a sequence CRLF is read from the socket. - * Incremental allocation and end-of-line checking are done in an efficient - * way. - * - * If an error occurs, or if the stream is closed before a CRLF is read, - * the function returns nothing and sets the socket error. - * - * The returned string does not contain the trailing CRLF sequence, so an - * empty line is effectively returned as an empty string. - * - * If the nBytesRead parameter is given, it will contain the number of bytes - * read from the socket, including the CRLF sequence, so that in normal - * conditions, nResult will report a count equal to the length of the - * returned string plus 2. nBytesRead will be 0 if stream is closed before - * a CRLF sequence is read, and will be -1 on error. - * - * An optional nMaxLength parameter can be given to allow a maximum character - * count before the data is returned anyway. If this number is reached before - * a CRLF sequence is encountered, nBytesRead will contain the value one. - * - * Finally, a nBufSize parameter can be given. If not, memory allocation - * will be increased by discrete amounts of 80 bytes. The programmer - * can provide here a different allocation strategy (e.g. setting nBufSize - * equal to nMaxLength, memory for reading the line will be allocated only - * once, at the beginning of the function). - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETRECVLINE + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Read a line from a socket + $SYNTAX$ + HB_INETRECVLINE( [, @, [, [, ]]] ) -> cResult + $ARGUMENTS$ + a socket previously created / opened + + must be passed by reference + + + + + $RETURNS$ + Line read + $DESCRIPTION$ + Blocks the calling thread until a sequence CRLF is read from the socket. + Incremental allocation and end-of-line checking are done in an efficient + way. + + If an error occurs, or if the stream is closed before a CRLF is read, + the function returns nothing and sets the socket error. + + The returned string does not contain the trailing CRLF sequence, so an + empty line is effectively returned as an empty string. + + If the nBytesRead parameter is given, it will contain the number of bytes + read from the socket, including the CRLF sequence, so that in normal + conditions, nResult will report a count equal to the length of the + returned string plus 2. nBytesRead will be 0 if stream is closed before + a CRLF sequence is read, and will be -1 on error. + + An optional nMaxLength parameter can be given to allow a maximum character + count before the data is returned anyway. If this number is reached before + a CRLF sequence is encountered, nBytesRead will contain the value one. + + Finally, a nBufSize parameter can be given. If not, memory allocation + will be increased by discrete amounts of 80 bytes. The programmer + can provide here a different allocation strategy (e.g. setting nBufSize + equal to nMaxLength, memory for reading the line will be allocated only + once, at the beginning of the function). + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETRECVENDBLOCK - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Read a block from a socket - * $SYNTAX$ - * HB_INETRECVENDBLOCK( [, [, @ [, [, ]]]] ) -> cResult - * $ARGUMENTS$ - * a socket previously created / opened - * - * - * - * - * - * - * - * - * $RETURNS$ - * Block read - * $DESCRIPTION$ - * This function operates exactly the same way as hb_InetRecvLine, but - * the "record termination" is customizable through the cBlock parameter. - * If not given, this parameter defaults to the CRLF sequence. - * Provided by: Marcelo Lombardo - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETRECVENDBLOCK + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Read a block from a socket + $SYNTAX$ + HB_INETRECVENDBLOCK( [, [, @ [, [, ]]]] ) -> cResult + $ARGUMENTS$ + a socket previously created / opened + + + + + + + + + $RETURNS$ + Block read + $DESCRIPTION$ + This function operates exactly the same way as hb_InetRecvLine, but + the "record termination" is customizable through the cBlock parameter. + If not given, this parameter defaults to the CRLF sequence. + Provided by: Marcelo Lombardo + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETDATAREADY - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Get whether there is data ready in a socket - * $SYNTAX$ - * HB_INETDATAREADY( , [ ] ) -> nResult - * $ARGUMENTS$ - * a socket previously created / opened - * - * - * $RETURNS$ - * If there is data available 1 (one) is returned, 0 (zero) if there is no data - * and -1 if there is an error. - * $DESCRIPTION$ - * Verifies if some data is available to be read in the socket without blocking - * execution of the caller. - * - * If nMillisecs is not given, the function returns - * immediately 1 if there is some data to be read, 0 if there isn't any data and - * -1 in case of error. - * - * If nMillisecs is given, the functon will wait up to that - * amount of milliseconds for data to be available; if some data arrives in the - * meanwhile, the wait is immediately interrupted. - * - * The next hb_InetRecv() function will read all the available data (up to the - * required length) without blocking. - * - * On error, hb_InetErrorCode and hb_InetErrorDesc can be use to determine what kind - * of error happened. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETDATAREADY + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Get whether there is data ready in a socket + $SYNTAX$ + HB_INETDATAREADY( , [ ] ) -> nResult + $ARGUMENTS$ + a socket previously created / opened + + + $RETURNS$ + If there is data available 1 (one) is returned, 0 (zero) if there is no data + and -1 if there is an error. + $DESCRIPTION$ + Verifies if some data is available to be read in the socket without blocking + execution of the caller. + + If nMillisecs is not given, the function returns + immediately 1 if there is some data to be read, 0 if there isn't any data and + -1 in case of error. + + If nMillisecs is given, the functon will wait up to that + amount of milliseconds for data to be available; if some data arrives in the + meanwhile, the wait is immediately interrupted. + + The next hb_InetRecv() function will read all the available data (up to the + required length) without blocking. + + On error, hb_InetErrorCode and hb_InetErrorDesc can be use to determine what kind + of error happened. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETSEND - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Sent data through a socket - * $SYNTAX$ - * HB_INETSEND( , [, ] ) -> nResult - * $ARGUMENTS$ - * a socket previously created / opened - * - * - * - * - * $RETURNS$ - * The amount of data written, 0 (zero) if the socket is closed, or -1 on an error - * $DESCRIPTION$ - * Send data being stored in a string over the socket. - * - * The nLength parameter can be given to allow writing only a part of - * the string. - * - * There is no guarantee that all of cBuffer will be - * sent, as this is a decision that is up to the OS; this function does not - * take care to ensure that the data is really sent; check - * the returned number and send the part that has not been sent. - * - * To ensure that all the data is sent before the function returns, use the - * hb_InetSendAll() function. - * - * On error, the error in the socket is set. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETSEND + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Sent data through a socket + $SYNTAX$ + HB_INETSEND( , [, ] ) -> nResult + $ARGUMENTS$ + a socket previously created / opened + + + + + $RETURNS$ + The amount of data written, 0 (zero) if the socket is closed, or -1 on an error + $DESCRIPTION$ + Send data being stored in a string over the socket. + + The nLength parameter can be given to allow writing only a part of + the string. + + There is no guarantee that all of cBuffer will be + sent, as this is a decision that is up to the OS; this function does not + take care to ensure that the data is really sent; check + the returned number and send the part that has not been sent. + + To ensure that all the data is sent before the function returns, use the + hb_InetSendAll() function. + + On error, the error in the socket is set. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETSENDALL - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Send data through a socket with blocking - * $SYNTAX$ - * HB_INETSENDALL( , [, ] ) -> nResult - * $ARGUMENTS$ - * a socket previously created / opened - * - * - * - * - * $RETURNS$ - * The amount of data written, 0 (zero) if the socket is closed, or -1 on an error - * $DESCRIPTION$ - * This function works exactly as hb_InetSend() but it ensures that all the - * data to be sent is written before returning. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETSENDALL + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Send data through a socket with blocking + $SYNTAX$ + HB_INETSENDALL( , [, ] ) -> nResult + $ARGUMENTS$ + a socket previously created / opened + + + + + $RETURNS$ + The amount of data written, 0 (zero) if the socket is closed, or -1 on an error + $DESCRIPTION$ + This function works exactly as hb_InetSend() but it ensures that all the + data to be sent is written before returning. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETGETHOSTS - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Get an array of IP addresses of a host - * $SYNTAX$ - * HB_INETGETHOSTS( ) -> aHosts - * $ARGUMENTS$ - * - * $RETURNS$ - * An array of IP addresses - * $DESCRIPTION$ - * Returns an array containing all the IP addresses associated with a given - * host name. The IP addressess returned by this funtion are strings in - * quad dot notations, eg "192.168.1.1", and can be directly used into - * hb_InetConnectIP(). - * - * cName can be any string: valid DNS names (eg. - * "www.myserver.com"), locally available names (e.g. "localhost" or - * windows Network Neighborhood names), or even IP addresses in quad - * dot notation. - * - * NOTE: This function is not thread safe (by design), and programmers - * must be sure not to use it at the same time in two different threads, - * or not to use it together with a hb_InetConnect(). If this kind of situation - * should ever arise, you are advised to use a thread MUTEX. - * - * On error, and if the server can't be found, the function returns NIL. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETGETHOSTS + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Get an array of IP addresses of a host + $SYNTAX$ + HB_INETGETHOSTS( ) -> aHosts + $ARGUMENTS$ + + $RETURNS$ + An array of IP addresses + $DESCRIPTION$ + Returns an array containing all the IP addresses associated with a given + host name. The IP addressess returned by this funtion are strings in + quad dot notations, eg "192.168.1.1", and can be directly used into + hb_InetConnectIP(). + + cName can be any string: valid DNS names (eg. + "www.myserver.com"), locally available names (e.g. "localhost" or + windows Network Neighborhood names), or even IP addresses in quad + dot notation. + + NOTE: This function is not thread safe (by design), and programmers + must be sure not to use it at the same time in two different threads, + or not to use it together with a hb_InetConnect(). If this kind of situation + should ever arise, you are advised to use a thread MUTEX. + + On error, and if the server can't be found, the function returns NIL. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETGETALIAS - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Get an array of aliases of a server - * $SYNTAX$ - * HB_INETGETALIAS( ) -> aHosts - * $ARGUMENTS$ - * - * $RETURNS$ - * Array of server aliases - * $DESCRIPTION$ - * Returns an array containing the aliases ( CNAME DNS records ) by - * which the server is currently known. - * - * Whether this function is able - * to have the complete list of aliases or not depends on the verbosity - * of the DNS server. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETGETALIAS + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Get an array of aliases of a server + $SYNTAX$ + HB_INETGETALIAS( ) -> aHosts + $ARGUMENTS$ + + $RETURNS$ + Array of server aliases + $DESCRIPTION$ + Returns an array containing the aliases ( CNAME DNS records ) by + which the server is currently known. + + Whether this function is able + to have the complete list of aliases or not depends on the verbosity + of the DNS server. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETSERVER - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Create a socket bound to a port - * $SYNTAX$ - * HB_INETSERVER( [, [, ]] ) -> SOCKET - * $ARGUMENTS$ - * - * - * - * - * is an internal parameter and rarely needs to be passed, defaults to 10 - * $RETURNS$ - * An INET socket - * $DESCRIPTION$ - * Creates a server that can accept connections from client on a certain port. - * - * If the computer on which hb_InetServer is called has more than one logical - * interface (e.g. one network card, one loopback and one PPP address), - * cBindAddr can be specified to select only one of these interfaces to accept - * connections for this process. This is useful when a server is present on - * two networks, and the service is to be available only in one of them. Also, - * the same port on other addresses is left free to be used, so you can have - * different server programs running for different networks but managing - * the same service. For example, an FTP server available to the internal - * network could be radically different from an FTP server available for - * the internet. - * - * nListenLimit is the number of incoming connections accepted by kernel before the - * kernel has the chance to report them to the application program. If - * the sockets receive nListenLimit connections before accepting them - * all, the nListenLimit + 1 connection will be notified to be "busy" by - * the kernel. The default value of 10 is enough for even - * a heavy duty server. - * - * On error, sets error description in the newly returned socket. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETSERVER + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Create a socket bound to a port + $SYNTAX$ + HB_INETSERVER( [, [, ]] ) -> SOCKET + $ARGUMENTS$ + + + + + is an internal parameter and rarely needs to be passed, defaults to 10 + $RETURNS$ + An INET socket + $DESCRIPTION$ + Creates a server that can accept connections from client on a certain port. + + If the computer on which hb_InetServer is called has more than one logical + interface (e.g. one network card, one loopback and one PPP address), + cBindAddr can be specified to select only one of these interfaces to accept + connections for this process. This is useful when a server is present on + two networks, and the service is to be available only in one of them. Also, + the same port on other addresses is left free to be used, so you can have + different server programs running for different networks but managing + the same service. For example, an FTP server available to the internal + network could be radically different from an FTP server available for + the internet. + + nListenLimit is the number of incoming connections accepted by kernel before the + kernel has the chance to report them to the application program. If + the sockets receive nListenLimit connections before accepting them + all, the nListenLimit + 1 connection will be notified to be "busy" by + the kernel. The default value of 10 is enough for even + a heavy duty server. + + On error, sets error description in the newly returned socket. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETACCEPT - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Wait until a socket is ready - * $SYNTAX$ - * HB_INETACCEPT( ) -> SOCKET - * $ARGUMENTS$ - * An INET socket - * $RETURNS$ - * a socket previously created / opened - * $DESCRIPTION$ - * Waits until a connection is available on a socket created with hb_InetServer, - * returns a socket that can be used to communicate with the incoming client. - * - * On error, NIL is returned and error code sets in the passed SOCKET. - * - * This error can be accessed using hb_InetErrorCode() function. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETACCEPT + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Wait until a socket is ready + $SYNTAX$ + HB_INETACCEPT( ) -> SOCKET + $ARGUMENTS$ + An INET socket + $RETURNS$ + a socket previously created / opened + $DESCRIPTION$ + Waits until a connection is available on a socket created with hb_InetServer, + returns a socket that can be used to communicate with the incoming client. + + On error, NIL is returned and error code sets in the passed SOCKET. + + This error can be accessed using hb_InetErrorCode() function. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETCONNECT - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Connect a socket to a remote server by IP address or name - * $SYNTAX$ - * HB_INETCONNECT( , ) -> SOCKET - * - * HB_INETCONNECT( , , ) -> NIL - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * (First form) INET socket - * - * (Second form has no return value) - * $DESCRIPTION$ - * Connects to a remote server described by cAddress, that can be in - * quad dot notation (e.g. "192.168.1.1") or in DNS name (e.g. - * "www.xharbour.org"), using the desired port. - * - * hb_InetConnect uses "gethostbyname" C system call to - * find the network address of the specified server; this means that - * this call is an hybrid function doing both a DNS scan and a TCP/IP - * connection. hb_InetConnect is not thread safe, and the - * program must take care that two hb_InetConnect functions are never - * called at the same moment from two different threads (or that - * hb_InetGetHosts is not called in the same moment as an hb_InetConnect). - * - * The second version of this function accepts a pre-built socket - * as a parameter. This allows to kill asyncronously a thread waiting - * for hb_InetConnect to connect, and then cleaning up the leftover - * socket data. Also, it is possible to give timeout to the given SOCKET, - * but this timeout will be used only in the connection phase, after that - * the network address resolution is completed. Use GetHosts() and - * hb_InetConnectIP for a finer timeout control. - * On error, the error of the returned socket is set. The error could - * be due to unavailable name resolving service, host name not valid, - * host address not reachable and host reachable but port not open. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETCONNECT + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Connect a socket to a remote server by IP address or name + $SYNTAX$ + HB_INETCONNECT( , ) -> SOCKET + + HB_INETCONNECT( , , ) -> NIL + $ARGUMENTS$ + + + + + + $RETURNS$ + (First form) INET socket + + (Second form has no return value) + $DESCRIPTION$ + Connects to a remote server described by cAddress, that can be in + quad dot notation (e.g. "192.168.1.1") or in DNS name (e.g. + "www.xharbour.org"), using the desired port. + + hb_InetConnect uses "gethostbyname" C system call to + find the network address of the specified server; this means that + this call is an hybrid function doing both a DNS scan and a TCP/IP + connection. hb_InetConnect is not thread safe, and the + program must take care that two hb_InetConnect functions are never + called at the same moment from two different threads (or that + hb_InetGetHosts is not called in the same moment as an hb_InetConnect). + + The second version of this function accepts a pre-built socket + as a parameter. This allows to kill asyncronously a thread waiting + for hb_InetConnect to connect, and then cleaning up the leftover + socket data. Also, it is possible to give timeout to the given SOCKET, + but this timeout will be used only in the connection phase, after that + the network address resolution is completed. Use GetHosts() and + hb_InetConnectIP for a finer timeout control. + On error, the error of the returned socket is set. The error could + be due to unavailable name resolving service, host name not valid, + host address not reachable and host reachable but port not open. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETCONNECTIP - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Connect to a remote server by IP address - * $SYNTAX$ - * HB_INETCONNECTIP( , ) -> SOCKET - * - * HB_INETCONNECTIP( , , ) -> NIL - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * (First form) INET socket - * - * (Second form has no return value) - * $DESCRIPTION$ - * Connects to a remote server described by cAddress, that can be specified - * only in quad dot IPV4 notation (e.g. "127.0.0.1"), using the desired port. - * This version of hb_InetConnect does not use gethostbyname, and thus is thread - * safe and can be used in combination with hb_InetGetHosts to have a finer - * timeout control while connecting to a server, and a finer error control. - * - * The second version of this function accepts a pre-built socket - * as a parameter. This allows to kill asyncronously a thread waiting - * for hb_InetConnectIP to connect, and then cleaning up the leftover - * socket data. Also, it is possible to give timeout at the given SOCKET. - * - * On error, the error of the returned socket is set. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETCONNECTIP + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Connect to a remote server by IP address + $SYNTAX$ + HB_INETCONNECTIP( , ) -> SOCKET + + HB_INETCONNECTIP( , , ) -> NIL + $ARGUMENTS$ + + + + + + $RETURNS$ + (First form) INET socket + + (Second form has no return value) + $DESCRIPTION$ + Connects to a remote server described by cAddress, that can be specified + only in quad dot IPV4 notation (e.g. "127.0.0.1"), using the desired port. + This version of hb_InetConnect does not use gethostbyname, and thus is thread + safe and can be used in combination with hb_InetGetHosts to have a finer + timeout control while connecting to a server, and a finer error control. + + The second version of this function accepts a pre-built socket + as a parameter. This allows to kill asyncronously a thread waiting + for hb_InetConnectIP to connect, and then cleaning up the leftover + socket data. Also, it is possible to give timeout at the given SOCKET. + + On error, the error of the returned socket is set. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETDGRAM - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Create a datagram socket - * $SYNTAX$ - * HB_INETDGRAM( [] ) -> SOCKET - * $ARGUMENTS$ - * lBroadcast - * $RETURNS$ - * An INET socket - * $DESCRIPTION$ - * Creates a datagram-oriented socket that will be able to send data and - * eventually receive data. Since the socket is not bound, the program can't - * retrieve the address at which this socket appaers to be, but a second - * socket receiving a message sent from this one would be able to reply - * correctly with a datagram that can be read from a non-bound socket. - * - * If lBroadcast is set to .T., the routine creates a broadcast capable socket: - * it will be able to receive and send broadcast messages. On most systems this - * requires special user privileges. - * - * Returns the socket, and if an error occurs, the socket error message - * and code are set. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETDGRAM + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Create a datagram socket + $SYNTAX$ + HB_INETDGRAM( [] ) -> SOCKET + $ARGUMENTS$ + lBroadcast + $RETURNS$ + An INET socket + $DESCRIPTION$ + Creates a datagram-oriented socket that will be able to send data and + eventually receive data. Since the socket is not bound, the program can't + retrieve the address at which this socket appaers to be, but a second + socket receiving a message sent from this one would be able to reply + correctly with a datagram that can be read from a non-bound socket. + + If lBroadcast is set to .T., the routine creates a broadcast capable socket: + it will be able to receive and send broadcast messages. On most systems this + requires special user privileges. + + Returns the socket, and if an error occurs, the socket error message + and code are set. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETDGRAMBIND - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Create a bound datagram socket - * $SYNTAX$ - * HB_INETDGRAMBIND( , [ [, ] ] ) -> SOCKET - * $ARGUMENTS$ - * - * - * - * - * - * $RETURNS$ - * An INET socket - * $DESCRIPTION$ - * Creates a datagram-oriented socket and binds it to a particular port, and - * eventually to a certain interface if cAddress is given and not NIL. - * - * If lBroadcast is set to .T., the routine creates a broadcast capable socket: - * it will be able to receive and send broadcast messages. On most systems this - * requires special user privileges. - * - * Returns the socket - * - * If an error occurs, the socket error message - * and code are set. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETDGRAMBIND + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Create a bound datagram socket + $SYNTAX$ + HB_INETDGRAMBIND( , [ [, ] ] ) -> SOCKET + $ARGUMENTS$ + + + + + + $RETURNS$ + An INET socket + $DESCRIPTION$ + Creates a datagram-oriented socket and binds it to a particular port, and + eventually to a certain interface if cAddress is given and not NIL. + + If lBroadcast is set to .T., the routine creates a broadcast capable socket: + it will be able to receive and send broadcast messages. On most systems this + requires special user privileges. + + Returns the socket + + If an error occurs, the socket error message + and code are set. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETDGRAMSEND - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Send data to a datagram socket - * $SYNTAX$ - * HB_INETDGRAMSEND( , , , [, ] ) -> nBytesSent - * $ARGUMENTS$ - * a socket previously created / opened - * - * - * - * - * - * - * - * - * $RETURNS$ - * Returns number of bytes sent, or -1 on error - * $DESCRIPTION$ - * Sends a datagram (a fixed length data) to a determined ip address (cAddress, - * to be specified in quad-dot notation) and port. - * - * If nSize is not specified, - * all the data in cBuffer will be sent; if nSize is specified, only - * the first nSize bytes of cBuffer will be sent. - * - * There isn't any guarantee that all the data required to be written is - * really sent to the socket: the calling program should check for the - * numeric return and send iteratively the unsent data to complete - * the message. - * - * Anyway, the raw datagram is sent and received as once, and any data - * less than the system datagram size will be sent and received - * as a single item. - * - * If the socket is created in broadcast mode, the cAddress element - * can be a broadcast address. - * - * Returns -1 on error, or the number of bytes actually sent on success. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETDGRAMSEND + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Send data to a datagram socket + $SYNTAX$ + HB_INETDGRAMSEND( , , , [, ] ) -> nBytesSent + $ARGUMENTS$ + a socket previously created / opened + + + + + + + + + $RETURNS$ + Returns number of bytes sent, or -1 on error + $DESCRIPTION$ + Sends a datagram (a fixed length data) to a determined ip address (cAddress, + to be specified in quad-dot notation) and port. + + If nSize is not specified, + all the data in cBuffer will be sent; if nSize is specified, only + the first nSize bytes of cBuffer will be sent. + + There isn't any guarantee that all the data required to be written is + really sent to the socket: the calling program should check for the + numeric return and send iteratively the unsent data to complete + the message. + + Anyway, the raw datagram is sent and received as once, and any data + less than the system datagram size will be sent and received + as a single item. + + If the socket is created in broadcast mode, the cAddress element + can be a broadcast address. + + Returns -1 on error, or the number of bytes actually sent on success. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETDGRAMRECV - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Get data from a datagram socket - * $SYNTAX$ - * HB_INETDGRAMRECV( , @ [, ] ) -> nBytesRead - * $ARGUMENTS$ - * a socket previously created / opened - * - * is the target buffer and must be passed by reference - * - * - * $RETURNS$ - * Returns number of bytes read, or -1 on error - * $DESCRIPTION$ - * Reads at maximum nSize bytes incoming from a UDP socket, if nSize is - * given, or reads at maximum cBuffer length if nSize is not given. - * - * There isn't any guarantee that all the data required to be read is - * really sent from the kernel to the application: the kernel should - * just return the last complete datagram that has been received, up - * to nSize bytes. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETDGRAMRECV + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Get data from a datagram socket + $SYNTAX$ + HB_INETDGRAMRECV( , @ [, ] ) -> nBytesRead + $ARGUMENTS$ + a socket previously created / opened + + is the target buffer and must be passed by reference + + + $RETURNS$ + Returns number of bytes read, or -1 on error + $DESCRIPTION$ + Reads at maximum nSize bytes incoming from a UDP socket, if nSize is + given, or reads at maximum cBuffer length if nSize is not given. + + There isn't any guarantee that all the data required to be read is + really sent from the kernel to the application: the kernel should + just return the last complete datagram that has been received, up + to nSize bytes. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETCRLF - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Get a CRLF sequence for internet protocols - * $SYNTAX$ - * HB_INETCRLF() -> cResult - * $ARGUMENTS$ - * (This function has no arguments) - * $RETURNS$ - * Internet CRLF sequence - * $DESCRIPTION$ - * Returns a CRLF sequence used in many internet protocols. - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETCRLF + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Get a CRLF sequence for internet protocols + $SYNTAX$ + HB_INETCRLF() -> cResult + $ARGUMENTS$ + (This function has no arguments) + $RETURNS$ + Internet CRLF sequence + $DESCRIPTION$ + Returns a CRLF sequence used in many internet protocols. + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_INETISSOCKET - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * INET - * $ONELINER$ - * Get whether a variable is a socket - * $SYNTAX$ - * HB_INETISSOCKET( ) -> lResult - * $ARGUMENTS$ - * a socket previously created / opened - * $RETURNS$ - * Returns whether the passed parameter is a socket - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * - * $FILES$ - * - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_INETISSOCKET + $CATEGORY$ + API + $SUBCATEGORY$ + INET + $ONELINER$ + Get whether a variable is a socket + $SYNTAX$ + HB_INETISSOCKET( ) -> lResult + $ARGUMENTS$ + a socket previously created / opened + $RETURNS$ + Returns whether the passed parameter is a socket + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + + $COMPLIANCE$ + H + $PLATFORMS$ + + $FILES$ + + $SEEALSO$ + + $END$ */ diff --git a/harbour/doc/en/hvm.txt b/harbour/doc/en/hvm.txt index 73fbc12881..f9169d815f 100644 --- a/harbour/doc/en/hvm.txt +++ b/harbour/doc/en/hvm.txt @@ -22,386 +22,386 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * PROCNAME() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Application - * $ONELINER$ - * Gets the name of the current function on the stack - * $SYNTAX$ - * PROCNAME( ) --> - * $ARGUMENTS$ - * is the function level required. - * $RETURNS$ - * The name of the function that it is being executed. - * $DESCRIPTION$ - * This function looks at the top of the stack and gets the current - * executed function if no arguments are passed. Otherwise it returns - * the name of the function or procedure at . - * $EXAMPLES$ - * See Test - * $TESTS$ - * This test will show the functions and procedures in stack. - * before executing it. - * PROCEDURE Main() - * LOCAL n := 1 - * DO WHILE ! Empty( ProcName( n ) ) - * ? ProcName( n++ ) - * ENDDO - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is vm - * $SEEALSO$ - * PROCLINE(),PROCFILE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + PROCNAME() + $CATEGORY$ + API + $SUBCATEGORY$ + Application + $ONELINER$ + Gets the name of the current function on the stack + $SYNTAX$ + PROCNAME( ) --> + $ARGUMENTS$ + is the function level required. + $RETURNS$ + The name of the function that it is being executed. + $DESCRIPTION$ + This function looks at the top of the stack and gets the current + executed function if no arguments are passed. Otherwise it returns + the name of the function or procedure at . + $EXAMPLES$ + See Test + $TESTS$ + This test will show the functions and procedures in stack. + before executing it. + PROCEDURE Main() + LOCAL n := 1 + DO WHILE ! Empty( ProcName( n ) ) + ? ProcName( n++ ) + ENDDO + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is vm + $SEEALSO$ + PROCLINE(),PROCFILE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * PROCLINE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Application - * $ONELINER$ - * Gets the line number of the current function on the stack. - * $SYNTAX$ - * PROCLINE( ) --> - * $ARGUMENTS$ - * is the function level required. - * $RETURNS$ - * The line number of the function that it is being executed. - * $DESCRIPTION$ - * This function looks at the top of the stack and gets the current - * line number of the executed function if no arguments are passed. - * Otherwise it returns the line number of the function or procedure - * at . - * $EXAMPLES$ - * See Test - * $TESTS$ - * PROCEDURE Main() - * ? ProcLine( 0 ) - * ? ProcName( 2 ) - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is vm - * $SEEALSO$ - * PROCNAME(),PROCFILE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + PROCLINE() + $CATEGORY$ + API + $SUBCATEGORY$ + Application + $ONELINER$ + Gets the line number of the current function on the stack. + $SYNTAX$ + PROCLINE( ) --> + $ARGUMENTS$ + is the function level required. + $RETURNS$ + The line number of the function that it is being executed. + $DESCRIPTION$ + This function looks at the top of the stack and gets the current + line number of the executed function if no arguments are passed. + Otherwise it returns the line number of the function or procedure + at . + $EXAMPLES$ + See Test + $TESTS$ + PROCEDURE Main() + ? ProcLine( 0 ) + ? ProcName( 2 ) + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is vm + $SEEALSO$ + PROCNAME(),PROCFILE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * PROCFILE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Application - * $ONELINER$ - * This function allways returns an empty string. - * $SYNTAX$ - * PROCFILE( ) --> - * $ARGUMENTS$ - * is any valid type. - * $RETURNS$ - * Return an empty string - * $DESCRIPTION$ - * This function is added to the RTL for full compatibility. It - * always returns an empty string. - * $EXAMPLES$ - * ? ProcFile() - * $TESTS$ - * PROCEDURE Main() - * ? ProcFile() - * ? ProcFile( NIL ) - * ? ProcFile( 2 ) - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is vm - * $SEEALSO$ - * PROCNAME(),PROCLINE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + PROCFILE() + $CATEGORY$ + API + $SUBCATEGORY$ + Application + $ONELINER$ + This function allways returns an empty string. + $SYNTAX$ + PROCFILE( ) --> + $ARGUMENTS$ + is any valid type. + $RETURNS$ + Return an empty string + $DESCRIPTION$ + This function is added to the RTL for full compatibility. It + always returns an empty string. + $EXAMPLES$ + ? ProcFile() + $TESTS$ + PROCEDURE Main() + ? ProcFile() + ? ProcFile( NIL ) + ? ProcFile( 2 ) + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is vm + $SEEALSO$ + PROCNAME(),PROCLINE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_PVALUE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Application - * $ONELINER$ - * Retrieves the value of an argument. - * $SYNTAX$ - * HB_PVALUE( ) --> - * $ARGUMENTS$ - * A number that indicates the argument to check. - * $RETURNS$ - * Returns the value stored by an argument. - * $DESCRIPTION$ - * This function is useful to check the value stored in an argument. - * $EXAMPLES$ - * See Test - * $TESTS$ - * PROCEDURE Test( nValue, cString ) - * IF PCount() == 2 - * ? hb_PValue( 1 ), nValue - * ? hb_PValue( 2 ), cString - * ENDIF - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is vm - * $SEEALSO$ - * PCOUNT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_PVALUE() + $CATEGORY$ + API + $SUBCATEGORY$ + Application + $ONELINER$ + Retrieves the value of an argument. + $SYNTAX$ + HB_PVALUE( ) --> + $ARGUMENTS$ + A number that indicates the argument to check. + $RETURNS$ + Returns the value stored by an argument. + $DESCRIPTION$ + This function is useful to check the value stored in an argument. + $EXAMPLES$ + See Test + $TESTS$ + PROCEDURE Test( nValue, cString ) + IF PCount() == 2 + ? hb_PValue( 1 ), nValue + ? hb_PValue( 2 ), cString + ENDIF + RETURN + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is vm + $SEEALSO$ + PCOUNT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * PCOUNT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Application - * $ONELINER$ - * Retrieves the number of arguments passed to a function. - * $SYNTAX$ - * PCOUNT() --> - * $ARGUMENTS$ - * None - * $RETURNS$ - * A number that indicates the number of arguments - * passed to a function or procedure. - * $DESCRIPTION$ - * This function is useful to check if a function or procedure - * has received the required number of arguments. - * $EXAMPLES$ - * See Test - * $TESTS$ - * PROCEDURE Test( xExp ) - * IF PCount() == 0 - * ? "This function needs a parameter" - * ELS - * ? xExp - * ENDIF - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is vm - * $SEEALSO$ - * HB_PVALUE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + PCOUNT() + $CATEGORY$ + API + $SUBCATEGORY$ + Application + $ONELINER$ + Retrieves the number of arguments passed to a function. + $SYNTAX$ + PCOUNT() --> + $ARGUMENTS$ + None + $RETURNS$ + A number that indicates the number of arguments + passed to a function or procedure. + $DESCRIPTION$ + This function is useful to check if a function or procedure + has received the required number of arguments. + $EXAMPLES$ + See Test + $TESTS$ + PROCEDURE Test( xExp ) + IF PCount() == 0 + ? "This function needs a parameter" + ELS + ? xExp + ENDIF + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is vm + $SEEALSO$ + HB_PVALUE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * __QUIT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Events - * $ONELINER$ - * Terminates an application. - * $SYNTAX$ - * __QUIT() - * $ARGUMENTS$ - * None - * $DESCRIPTION$ - * This function terminates the current application and returns - * to the system. - * $EXAMPLES$ - * See Test - * $TESTS$ - * PROCEDURE EndApp( lYesNo ) - * IF lYesNo - * __Quit() - * ENDIF - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is vm - * $SEEALSO$ - * QUIT - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + __QUIT() + $CATEGORY$ + API + $SUBCATEGORY$ + Events + $ONELINER$ + Terminates an application. + $SYNTAX$ + __QUIT() + $ARGUMENTS$ + None + $DESCRIPTION$ + This function terminates the current application and returns + to the system. + $EXAMPLES$ + See Test + $TESTS$ + PROCEDURE EndApp( lYesNo ) + IF lYesNo + __Quit() + ENDIF + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is vm + $SEEALSO$ + QUIT + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * CLIPINIT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Internal - * $ONELINER$ - * Initialize various Harbour sub-systems - * $SYNTAX$ - * CLIPINIT() --> NIL - * $ARGUMENTS$ - * none. - * $RETURNS$ - * CLIPINIT() always return NIL. - * $DESCRIPTION$ - * CLIPINIT() is one of the pre-defined INIT PROCEDURE and is executed - * at program startup. It declare an empty MEMVAR PUBLIC array called - * GetList that is going to be used by the Get system. It activates the - * default error handler, and (at least for the moment) calls the - * function that sets the default help key. - * $STATUS$ - * R - * $COMPLIANCE$ - * It is said that CLIPINIT() should not call the function that sets - * the default help key since CA-Cl*pper does it in some other place. - * $PLATFORMS$ - * All - * $SEEALSO$ - * INIT PROCEDURE - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + CLIPINIT() + $CATEGORY$ + API + $SUBCATEGORY$ + Internal + $ONELINER$ + Initialize various Harbour sub-systems + $SYNTAX$ + CLIPINIT() --> NIL + $ARGUMENTS$ + none. + $RETURNS$ + CLIPINIT() always return NIL. + $DESCRIPTION$ + CLIPINIT() is one of the pre-defined INIT PROCEDURE and is executed + at program startup. It declare an empty MEMVAR PUBLIC array called + GetList that is going to be used by the Get system. It activates the + default error handler, and (at least for the moment) calls the + function that sets the default help key. + $STATUS$ + R + $COMPLIANCE$ + It is said that CLIPINIT() should not call the function that sets + the default help key since CA-Cl*pper does it in some other place. + $PLATFORMS$ + All + $SEEALSO$ + INIT PROCEDURE + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * __SetHelpK() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Internal - * $ONELINER$ - * Set F1 as the default help key - * $SYNTAX$ - * __SetHelpK() - * $ARGUMENTS$ - * None. - * $DESCRIPTION$ - * Set F1 to execute a function called HELP if such a function is - * linked into the program. - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is vm - * $SEEALSO$ - * __XHelp(),SET KEY,SETKEY() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + __SetHelpK() + $CATEGORY$ + API + $SUBCATEGORY$ + Internal + $ONELINER$ + Set F1 as the default help key + $SYNTAX$ + __SetHelpK() + $ARGUMENTS$ + None. + $DESCRIPTION$ + Set F1 to execute a function called HELP if such a function is + linked into the program. + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is vm + $SEEALSO$ + __XHelp(),SET KEY,SETKEY() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * BREAK() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Error - * $ONELINER$ - * Exits from a BEGIN SEQUENCE block - * $SYNTAX$ - * BREAK( ) - * $ARGUMENTS$ - * is any valid expression. It is always required. - * If do not want to pass any argument, just use NIL. - * $DESCRIPTION$ - * This function passes control to the RECOVER statement in a - * BEGIN SEQUENCE block. - * $EXAMPLES$ - * Break( NIL ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is vm - * $SEEALSO$ - * BEGIN SEQUENCE - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + BREAK() + $CATEGORY$ + API + $SUBCATEGORY$ + Error + $ONELINER$ + Exits from a BEGIN SEQUENCE block + $SYNTAX$ + BREAK( ) + $ARGUMENTS$ + is any valid expression. It is always required. + If do not want to pass any argument, just use NIL. + $DESCRIPTION$ + This function passes control to the RECOVER statement in a + BEGIN SEQUENCE block. + $EXAMPLES$ + Break( NIL ) + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is vm + $SEEALSO$ + BEGIN SEQUENCE + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DO() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Application - * $ONELINER$ - * Calls a procedure or a function - * $SYNTAX$ - * DO( [, ] ) --> - * $ARGUMENTS$ - * = Either a string with a function/procedure name to be called - * or a codeblock to evaluate. - * - * = arguments passed to a called function/procedure or to - * a codeblock. - * $RETURNS$ - * A value that was returned from called function. - * $DESCRIPTION$ - * This function can be called either by the harbour compiler or by user. - * The compiler always passes the item of IT_SYMBOL type that stores the - * name of procedure specified in DO WITH ... statement. - * - * If called procedure/function doesn't exist then a runtime error - * is generated. - * - * This function can be used as replacement of macro operator. - * It is also used internally to implement DO WITH - * In this case is of type HB_SYMB. - * $EXAMPLES$ - * cbCode := {| x | MyFunc( x ) } - * Do( cbCode, 1 ) - * - * cFunction := "MyFunc" - * xRetVal := Do( cFunction, 2 ) - * - * // Old style (slower): - * DO &cFunction WITH 3 - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DO() + $CATEGORY$ + API + $SUBCATEGORY$ + Application + $ONELINER$ + Calls a procedure or a function + $SYNTAX$ + DO( [, ] ) --> + $ARGUMENTS$ + = Either a string with a function/procedure name to be called + or a codeblock to evaluate. + + = arguments passed to a called function/procedure or to + a codeblock. + $RETURNS$ + A value that was returned from called function. + $DESCRIPTION$ + This function can be called either by the harbour compiler or by user. + The compiler always passes the item of IT_SYMBOL type that stores the + name of procedure specified in DO WITH ... statement. + + If called procedure/function doesn't exist then a runtime error + is generated. + + This function can be used as replacement of macro operator. + It is also used internally to implement DO WITH + In this case is of type HB_SYMB. + $EXAMPLES$ + cbCode := {| x | MyFunc( x ) } + Do( cbCode, 1 ) + + cFunction := "MyFunc" + xRetVal := Do( cFunction, 2 ) + + // Old style (slower): + DO &cFunction WITH 3 + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $END$ */ diff --git a/harbour/doc/en/idle.txt b/harbour/doc/en/idle.txt index 51341ed641..dbb76d736e 100644 --- a/harbour/doc/en/idle.txt +++ b/harbour/doc/en/idle.txt @@ -1,199 +1,199 @@ /* * $Id$ -*/ - -/* $DOC$ - * $TEMPLATE$ - * Document - * $NAME$ - * The idle states - * $CATEGORY$ - * Document - * $ONELINER$ - * Read me file for Idle States - * $DESCRIPTION$ - * The idle state is the state of the harbour virtual machine when it - * waits for the user input from the keyboard or the mouse. The idle - * state is entered during INKEY() calls currently. All applications - * that don't use INKEY() function call can signal the idle states with - * the call of HB_IDLESTATE() function (or hb_idleState() on C level). - * - * During idle states the virtual machine calls the garbage collector and - * it can call user defined actions (background tasks). It also releases - * the CPU time slices for some poor platforms that are not smart enough - * to detect it automatically. - * - * For defining the background tasks see the HB_IDLEADD() and HB_IDLEDEL() - * functions. - * - * For direct call for background actions see HB_IDLESTATE() function. - * - * For signaling the idle state from C code see the hb_idleState() - * API function. - * $SEEALSO$ - * HB_IDLEADD(),HB_IDLEDEL() - * $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_IDLEADD() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Idle states - * $ONELINER$ - * Adds the background task. - * $SYNTAX$ - * HB_IDLEADD( ) --> nHandle - * $ARGUMENTS$ - * is a codeblock that will be executed during idle states. - * There are no arguments passed to this codeblock during evaluation. - * $RETURNS$ - * The handle (an integer value) that identifies the task. This - * handle can be used for deleting the task. - * $DESCRIPTION$ - * HB_IDLEADD() adds a passed codeblock to the list of background - * tasks that will be evaluated during the idle states. There is no - * limit for the number of tasks. - * $EXAMPLES$ - * nTask := hb_idleAdd( {|| SayTime() } ) - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension similar to FT_ONIDLE() function available - * in NanForum library. - * $PLATFORMS$ - * All - * $SEEALSO$ - * HB_IDLEDEL(),HB_IDLESTATE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Document + $NAME$ + The idle states + $CATEGORY$ + Document + $ONELINER$ + Read me file for Idle States + $DESCRIPTION$ + The idle state is the state of the harbour virtual machine when it + waits for the user input from the keyboard or the mouse. The idle + state is entered during INKEY() calls currently. All applications + that don't use INKEY() function call can signal the idle states with + the call of HB_IDLESTATE() function (or hb_idleState() on C level). + + During idle states the virtual machine calls the garbage collector and + it can call user defined actions (background tasks). It also releases + the CPU time slices for some poor platforms that are not smart enough + to detect it automatically. + + For defining the background tasks see the HB_IDLEADD() and HB_IDLEDEL() + functions. + + For direct call for background actions see HB_IDLESTATE() function. + + For signaling the idle state from C code see the hb_idleState() + API function. + $SEEALSO$ + HB_IDLEADD(),HB_IDLEDEL() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_IDLEDEL() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Idle states - * $ONELINER$ - * Removes the background task from the list of tasks. - * $SYNTAX$ - * HB_IDLEDEL( ) --> - * $ARGUMENTS$ - * is the identifier of the task returned by the - * HB_IDLEADD() function. - * $RETURNS$ - * NIL if invalid handle is passed or a codeblock that was - * passed to HB_IDLEADD() function - * $DESCRIPTION$ - * HB_IDLEDEL() removes the action associated with passed identifier - * from the list of background tasks. The identifer should be the - * value returned by the previous call of HB_IDLEADD() function. - * - * If specified task is defined then the codeblock is returned - * otherwise the NIL value is returned. - * $EXAMPLES$ - * nTask := hb_idleAdd( {|| SayTime() } ) - * Inkey( 10 ) - * bAction := hb_idleDel( nTask ) - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $SEEALSO$ - * HB_IDLEADD(),HB_IDLESTATE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_IDLEADD() + $CATEGORY$ + API + $SUBCATEGORY$ + Idle states + $ONELINER$ + Adds the background task. + $SYNTAX$ + HB_IDLEADD( ) --> nHandle + $ARGUMENTS$ + is a codeblock that will be executed during idle states. + There are no arguments passed to this codeblock during evaluation. + $RETURNS$ + The handle (an integer value) that identifies the task. This + handle can be used for deleting the task. + $DESCRIPTION$ + HB_IDLEADD() adds a passed codeblock to the list of background + tasks that will be evaluated during the idle states. There is no + limit for the number of tasks. + $EXAMPLES$ + nTask := hb_idleAdd( {|| SayTime() } ) + $STATUS$ + R + $COMPLIANCE$ + Harbour extension similar to FT_ONIDLE() function available + in NanForum library. + $PLATFORMS$ + All + $SEEALSO$ + HB_IDLEDEL(),HB_IDLESTATE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * HB_IdleState() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Idle states - * $ONELINER$ - * Evaluates a single background task and calls the garbage collector. - * $SYNTAX$ - * HB_IDLESTATE() - * $ARGUMENTS$ - * None - * $DESCRIPTION$ - * HB_IDLESTATE() requests the garbage collection and executes a - * single background task defined by the codeblock passed with - * HB_IDLEADD() function. Every call to this function evaluates a - * different task in the order of task creation. There are no - * arguments passed during a codeblock evaluation. - * - * This function can be safely called even if there are no background - * tasks defined. - * $EXAMPLES$ - * nTask1 := hb_idleAdd( {|| SayTime() } ) - * nTask2 := hb_idleAdd( {|| SaveScreen() } ) - * DO WHILE ! bFinished - * bFinished := DoSomethingVeryImportant() - * hb_idleState() - * ENDDO - * cbAction := hb_idleDel( nTask1 ) - * hb_idleDel( nTask2 ) - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour extension similar to FT_IAMIDLE() function available - * in NanForum library. - * $PLATFORMS$ - * All - * $SEEALSO$ - * HB_IDLEADD(),HB_IDLEDEL() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_IDLEDEL() + $CATEGORY$ + API + $SUBCATEGORY$ + Idle states + $ONELINER$ + Removes the background task from the list of tasks. + $SYNTAX$ + HB_IDLEDEL( ) --> + $ARGUMENTS$ + is the identifier of the task returned by the + HB_IDLEADD() function. + $RETURNS$ + NIL if invalid handle is passed or a codeblock that was + passed to HB_IDLEADD() function + $DESCRIPTION$ + HB_IDLEDEL() removes the action associated with passed identifier + from the list of background tasks. The identifer should be the + value returned by the previous call of HB_IDLEADD() function. + + If specified task is defined then the codeblock is returned + otherwise the NIL value is returned. + $EXAMPLES$ + nTask := hb_idleAdd( {|| SayTime() } ) + Inkey( 10 ) + bAction := hb_idleDel( nTask ) + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + All + $SEEALSO$ + HB_IDLEADD(),HB_IDLESTATE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_idleState() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Idle states - * $ONELINER$ - * Evaluates a single background task and calls the garbage collector. - * $SYNTAX$ - * void hb_idleState( void ); - * $ARGUMENTS$ - * None - * $DESCRIPTION$ - * hb_idleState() is a C function that requests garbage collection and - * executes a single background task defined by the codeblock passed - * with HB_IDLEADD() function. It also releases the CPU time slices for - * platforms that require it. - * - * Every call for this function evaluates different task in the - * order of task creation. There are no arguments passed during - * codeblock evaluation. - * - * This function can be safely called even if there are no background - * tasks defined. - * - * This function is automatically called from the INKEY() function. - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $SEEALSO$ - * HB_IDLEADD(),HB_IDLEDEL(),HB_IDLESTATE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + HB_IdleState() + $CATEGORY$ + API + $SUBCATEGORY$ + Idle states + $ONELINER$ + Evaluates a single background task and calls the garbage collector. + $SYNTAX$ + HB_IDLESTATE() + $ARGUMENTS$ + None + $DESCRIPTION$ + HB_IDLESTATE() requests the garbage collection and executes a + single background task defined by the codeblock passed with + HB_IDLEADD() function. Every call to this function evaluates a + different task in the order of task creation. There are no + arguments passed during a codeblock evaluation. + + This function can be safely called even if there are no background + tasks defined. + $EXAMPLES$ + nTask1 := hb_idleAdd( {|| SayTime() } ) + nTask2 := hb_idleAdd( {|| SaveScreen() } ) + DO WHILE ! bFinished + bFinished := DoSomethingVeryImportant() + hb_idleState() + ENDDO + cbAction := hb_idleDel( nTask1 ) + hb_idleDel( nTask2 ) + $STATUS$ + R + $COMPLIANCE$ + Harbour extension similar to FT_IAMIDLE() function available + in NanForum library. + $PLATFORMS$ + All + $SEEALSO$ + HB_IDLEADD(),HB_IDLEDEL() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_idleState() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Idle states + $ONELINER$ + Evaluates a single background task and calls the garbage collector. + $SYNTAX$ + void hb_idleState( void ); + $ARGUMENTS$ + None + $DESCRIPTION$ + hb_idleState() is a C function that requests garbage collection and + executes a single background task defined by the codeblock passed + with HB_IDLEADD() function. It also releases the CPU time slices for + platforms that require it. + + Every call for this function evaluates different task in the + order of task creation. There are no arguments passed during + codeblock evaluation. + + This function can be safely called even if there are no background + tasks defined. + + This function is automatically called from the INKEY() function. + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + All + $SEEALSO$ + HB_IDLEADD(),HB_IDLEDEL(),HB_IDLESTATE() + $END$ */ diff --git a/harbour/doc/en/input.txt b/harbour/doc/en/input.txt index 3322394b09..2420665a4f 100644 --- a/harbour/doc/en/input.txt +++ b/harbour/doc/en/input.txt @@ -13,464 +13,463 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * INKEY() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Extracts the next key code from the Harbour keyboard buffer. - * $SYNTAX$ - * INKEY( [] [,] ) --> nKey - * $ARGUMENTS$ - * is an optional timeout value in seconds, with a granularity - * of 1/10th of a second. If omitted, INKEY() returns immediately. If set - * to 0, INKEY() waits until an input event occurs. If set to any other - * value, INKEY() will return either when an input event occurs or when - * the timeout period has elapsed. If only this parameter is specified - * and it is not numeric, it will be treated as if it were 0. But if both - * parameters are specified and this parameter is not numeric, it will be - * treated as if it were not present. - * - * is an optional mask of input events that are to be enabled. - * If omitted, defaults to hb_set.HB_SET_EVENTMASK. Valid input masks are - * in inkey.ch and are explained below. It is recommended that the mask - * names be used rather than their numeric values, in case the numeric - * values change in future releases of Harbour. To allow more than one - * type of input event, simply add the various mask names together. - * - * - * inkey.ch Meaning - * - * INKEY_MOVE Mouse motion events are allowed - * INKEY_LDOWN The mouse left click down event is allowed - * INKEY_LUP The mouse left click up event is allowed - * INKEY_RDOWN The mouse right click down event is allowed - * INKEY_RUP The mouse right click up event is allowed - * INKEY_KEYBOARD All keyboard events are allowed - * INKEY_ALL All mouse and keyboard events are allowed - * HB_INKEY_EXTENDED Extended keyboard codes are used. - *
- * - * If the parameter is not numeric, it will be treated as if it were set - * to hb_set.HB_SET_EVENTMASK. - * $RETURNS$ - * 0 in case of timeout with no input event, otherwise returns a value - * in the range -47 to 386 for keyboard events or the range 1001 to 1007 - * for mouse events. Mouse events and non-printable keyboard events are - * represented by the K_ values listed in inkey.ch. Keyboard - * event return codes in the range 32 through 127 are equivalent to the - * printable ASCII character set. Keyboard event return codes in the - * range 128 through 255 are assumed to be printable, but results may - * vary based on hardware and nationality. If HB_INKEY_EXTENDED mode is - * used, then the return value for keyboard events ranges from 1 through - * 767 and 1077 through 1491, although not all codes are used. - * - * Extended key codes consist of the PC keyboard scan code and one - * or more offset values. If no keyboard modifier was used, then - * HB_INKEY_NONE is added. The Alt key adds HB_INKEY_ALT, the Ctrl - * key adds HB_INKEY_CTRL, the Shift key adds HB_INKEY_SHIFT, and - * enhanced keys (KeyPad+/ and CursorPad keys) add HB_INKEY_ENHANCED. - * For example, F1 is scan code 59, so if you just press F1, you get - * key code 315, but Alt+F1 gives 443, Ctrl+F1 gives 571, and Shift+ - * F1 gives 699. And NumPad+/ gives 1077, 1205, 1333, and 1461. At - * this time, the only value that can combine with other values is - * HB_INKEY_ENHANCED (i.e., there are no Alt+Ctl combinations, etc.) - * - * Note: The extended key code set is larger than the normal key code - * set. As a result, if you switch between the normal and extended - * modes, you need to be aware that some codes get translated into a - * zero in normal mode (because there is no corresponding code in - * normal mode) and that these codes get removed from the keyboard - * input buffer in normal mode and you won't be able to go back and - * fetch them later in extended mode. - * $DESCRIPTION$ - * INKEY() can be used to detect input events, such as keypress, mouse - * movement, or mouse key clicks (up and/or down). - * $EXAMPLES$ - * // Wait for the user to press the Esc key - * ? "Please press the ESC key." - * DO WHILE Inkey( 0.1 ) != K_ESC - * ENDDO - * $TESTS$ - * KEYBOARD "AB"; ? Inkey(), Inkey() ==> 65 66 - * $STATUS$ - * S - * $COMPLIANCE$ - * INKEY() is compliant with the CA-Cl*pper 5.3 INKEY() function with one - * exception: The Harbour INKEY() function will raise an argument error - * if the first parameter is less than or equal to 0 and the second - * parameter (or the default mask) is not valid, because otherwise INKEY - * would never return, because it was, in effect, asked to wait forever - * for no events (Note: In CA-Cl*pper, this also blocks SET KEY events). - * $FILES$ - * Library is rtl - * $SEEALSO$ - * inkey.ch - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + INKEY() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Extracts the next key code from the Harbour keyboard buffer. + $SYNTAX$ + INKEY( [] [,] ) --> nKey + $ARGUMENTS$ + is an optional timeout value in seconds, with a granularity + of 1/10th of a second. If omitted, INKEY() returns immediately. If set + to 0, INKEY() waits until an input event occurs. If set to any other + value, INKEY() will return either when an input event occurs or when + the timeout period has elapsed. If only this parameter is specified + and it is not numeric, it will be treated as if it were 0. But if both + parameters are specified and this parameter is not numeric, it will be + treated as if it were not present. + + is an optional mask of input events that are to be enabled. + If omitted, defaults to hb_set.HB_SET_EVENTMASK. Valid input masks are + in inkey.ch and are explained below. It is recommended that the mask + names be used rather than their numeric values, in case the numeric + values change in future releases of Harbour. To allow more than one + type of input event, simply add the various mask names together. + + + inkey.ch Meaning + + INKEY_MOVE Mouse motion events are allowed + INKEY_LDOWN The mouse left click down event is allowed + INKEY_LUP The mouse left click up event is allowed + INKEY_RDOWN The mouse right click down event is allowed + INKEY_RUP The mouse right click up event is allowed + INKEY_KEYBOARD All keyboard events are allowed + INKEY_ALL All mouse and keyboard events are allowed + HB_INKEY_EXTENDED Extended keyboard codes are used. +
+ + If the parameter is not numeric, it will be treated as if it were set + to hb_set.HB_SET_EVENTMASK. + $RETURNS$ + 0 in case of timeout with no input event, otherwise returns a value + in the range -47 to 386 for keyboard events or the range 1001 to 1007 + for mouse events. Mouse events and non-printable keyboard events are + represented by the K_ values listed in inkey.ch. Keyboard + event return codes in the range 32 through 127 are equivalent to the + printable ASCII character set. Keyboard event return codes in the + range 128 through 255 are assumed to be printable, but results may + vary based on hardware and nationality. If HB_INKEY_EXTENDED mode is + used, then the return value for keyboard events ranges from 1 through + 767 and 1077 through 1491, although not all codes are used. + + Extended key codes consist of the PC keyboard scan code and one + or more offset values. If no keyboard modifier was used, then + HB_INKEY_NONE is added. The Alt key adds HB_INKEY_ALT, the Ctrl + key adds HB_INKEY_CTRL, the Shift key adds HB_INKEY_SHIFT, and + enhanced keys (KeyPad+/ and CursorPad keys) add HB_INKEY_ENHANCED. + For example, F1 is scan code 59, so if you just press F1, you get + key code 315, but Alt+F1 gives 443, Ctrl+F1 gives 571, and Shift+ + F1 gives 699. And NumPad+/ gives 1077, 1205, 1333, and 1461. At + this time, the only value that can combine with other values is + HB_INKEY_ENHANCED (i.e., there are no Alt+Ctl combinations, etc.) + + Note: The extended key code set is larger than the normal key code + set. As a result, if you switch between the normal and extended + modes, you need to be aware that some codes get translated into a + zero in normal mode (because there is no corresponding code in + normal mode) and that these codes get removed from the keyboard + input buffer in normal mode and you won't be able to go back and + fetch them later in extended mode. + $DESCRIPTION$ + INKEY() can be used to detect input events, such as keypress, mouse + movement, or mouse key clicks (up and/or down). + $EXAMPLES$ + // Wait for the user to press the Esc key + ? "Please press the ESC key." + DO WHILE Inkey( 0.1 ) != K_ESC + ENDDO + $TESTS$ + KEYBOARD "AB"; ? Inkey(), Inkey() ==> 65 66 + $STATUS$ + S + $COMPLIANCE$ + INKEY() is compliant with the CA-Cl*pper 5.3 INKEY() function with one + exception: The Harbour INKEY() function will raise an argument error + if the first parameter is less than or equal to 0 and the second + parameter (or the default mask) is not valid, because otherwise INKEY + would never return, because it was, in effect, asked to wait forever + for no events (Note: In CA-Cl*pper, this also blocks SET KEY events). + $FILES$ + Library is rtl + $SEEALSO$ + inkey.ch + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * __KEYBOARD() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * DO NOT CALL THIS FUNCTION DIRECTLY! - * $SYNTAX$ - * KEYBOARD - * CLEAR TYPEAHEAD - * $ARGUMENTS$ - * is the optional string to stuff into the Harbour keyboard - * buffer after clearing it first. - * - * Note: The character ";" is converted - * to Chr( 13 ) (this is an undocumented CA-Cl*pper feature). - * $DESCRIPTION$ - * Clears the Harbour keyboard typeahead buffer and then inserts an - * optional string into it. - * $EXAMPLES$ - * // Stuff an Enter key into the keyboard buffer - * KEYBOARD Chr( 13 ) - * // Clear the keyboard buffer - * CLEAR TYPEAHEAD - * $TESTS$ - * KEYBOARD Chr( 13 ); ? Inkey() ==> 13 - * KEYBOARD ";" ? Inkey() ==> 13 - * KEYBOARD "HELLO"; CLEAR TYPEAHEAD; ? Inkey() ==> 0 - * $STATUS$ - * R - * $COMPLIANCE$ - * __KEYBOARD() is compliant with CA-Cl*pper 5.3 - * $FILES$ - * Library is rtl - * $SEEALSO$ - * CLEAR TYPEAHEAD,KEYBOARD - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + __KEYBOARD() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + DO NOT CALL THIS FUNCTION DIRECTLY! + $SYNTAX$ + KEYBOARD + CLEAR TYPEAHEAD + $ARGUMENTS$ + is the optional string to stuff into the Harbour keyboard + buffer after clearing it first. + + Note: The character ";" is converted + to Chr( 13 ) (this is an undocumented CA-Cl*pper feature). + $DESCRIPTION$ + Clears the Harbour keyboard typeahead buffer and then inserts an + optional string into it. + $EXAMPLES$ + // Stuff an Enter key into the keyboard buffer + KEYBOARD Chr( 13 ) + // Clear the keyboard buffer + CLEAR TYPEAHEAD + $TESTS$ + KEYBOARD Chr( 13 ); ? Inkey() ==> 13 + KEYBOARD ";" ? Inkey() ==> 13 + KEYBOARD "HELLO"; CLEAR TYPEAHEAD; ? Inkey() ==> 0 + $STATUS$ + R + $COMPLIANCE$ + __KEYBOARD() is compliant with CA-Cl*pper 5.3 + $FILES$ + Library is rtl + $SEEALSO$ + CLEAR TYPEAHEAD,KEYBOARD + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_KEYPUT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Put an inkey code to the keyboard buffer. - * $SYNTAX$ - * HB_KEYPUT( ) - * $ARGUMENTS$ - * is the inkey code, which should be inserted into the - * keyboard buffer. - * $RETURNS$ - * There is no return value. - * $DESCRIPTION$ - * Inserts an inkey code to the string buffer. The buffer is *not* - * cleared in this operation. This function allows to insert such - * inkey codes which are not in the range of 0 to 255. To insert more - * than one code, call the function repeatedly. The zero code cannot - * be inserted. - * $EXAMPLES$ - * // Stuff an Alt+PgDn key into the keyboard buffer - * hb_keyPut( K_ALT_PGDN ) - * $TESTS$ - * hb_keyPut( K_ALT_PGDN ) ; ? INKEY() ==> 417 - * hb_keyPut( K_F11 ) ; ? INKEY() ==> -40 - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is rtl - * $SEEALSO$ - * KEYBOARD,CLEAR TYPEAHEAD,INKEY() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_KEYPUT() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Put an inkey code to the keyboard buffer. + $SYNTAX$ + HB_KEYPUT( ) + $ARGUMENTS$ + is the inkey code, which should be inserted into the + keyboard buffer. + $RETURNS$ + There is no return value. + $DESCRIPTION$ + Inserts an inkey code to the string buffer. The buffer is *not* + cleared in this operation. This function allows to insert such + inkey codes which are not in the range of 0 to 255. To insert more + than one code, call the function repeatedly. The zero code cannot + be inserted. + $EXAMPLES$ + // Stuff an Alt+PgDn key into the keyboard buffer + hb_keyPut( K_ALT_PGDN ) + $TESTS$ + hb_keyPut( K_ALT_PGDN ) ; ? INKEY() ==> 417 + hb_keyPut( K_F11 ) ; ? INKEY() ==> -40 + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is rtl + $SEEALSO$ + KEYBOARD,CLEAR TYPEAHEAD,INKEY() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * NEXTKEY() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Get the next key code in the buffer without extracting it. - * $SYNTAX$ - * NEXTKEY( [] ) --> nKey - * $ARGUMENTS$ - * nInputMask is an optional integer value composed of one or more - * INKEY_ or HB_INKEY_ constants. The sole purpose of this argument - * is to allow switching between using HB_INKEY_EXTENDED key codes - * and using the normal CA-Cl*pper-compatible key codes - * $RETURNS$ - * The value of the next key in the Harbour keyboard buffer. - * $DESCRIPTION$ - * Returns the value of the next key in the Harbour keyboard buffer - * without extracting it. - * $EXAMPLES$ - * // Use NEXTKEY() with INKEY() to change display characters, or by - * // itself to exit the loop, so that the caller can detect the Esc. - * LOCAL nKey, cChar := "+" - * DO WHILE .T. - * ?? cChar - * nKey := NextKey() - * IF nKey == K_ESC - * EXIT - * ELSE - * IF nKey != 0 - * cChar := Chr( nKey ) - * ENDIF - * ENDIF - * ENDDO - * $TESTS$ - * KEYBOARD "AB"; ? NextKey(), NextKey() ==> 65 65 - * $STATUS$ - * R - * $COMPLIANCE$ - * NEXTKEY() is compliant with CA-Cl*pper 5.3, but has been extended - * for Harbour. - * $FILES$ - * Library is rtl - * $SEEALSO$ - * INKEY(),LASTKEY() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + NEXTKEY() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Get the next key code in the buffer without extracting it. + $SYNTAX$ + NEXTKEY( [] ) --> nKey + $ARGUMENTS$ + nInputMask is an optional integer value composed of one or more + INKEY_ or HB_INKEY_ constants. The sole purpose of this argument + is to allow switching between using HB_INKEY_EXTENDED key codes + and using the normal CA-Cl*pper-compatible key codes + $RETURNS$ + The value of the next key in the Harbour keyboard buffer. + $DESCRIPTION$ + Returns the value of the next key in the Harbour keyboard buffer + without extracting it. + $EXAMPLES$ + // Use NEXTKEY() with INKEY() to change display characters, or by + // itself to exit the loop, so that the caller can detect the Esc. + LOCAL nKey, cChar := "+" + DO WHILE .T. + ?? cChar + nKey := NextKey() + IF nKey == K_ESC + EXIT + ELSE + IF nKey != 0 + cChar := Chr( nKey ) + ENDIF + ENDIF + ENDDO + $TESTS$ + KEYBOARD "AB"; ? NextKey(), NextKey() ==> 65 65 + $STATUS$ + R + $COMPLIANCE$ + NEXTKEY() is compliant with CA-Cl*pper 5.3, but has been extended + for Harbour. + $FILES$ + Library is rtl + $SEEALSO$ + INKEY(),LASTKEY() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * LASTKEY() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Get the last key extracted from the keyboard buffer. - * $SYNTAX$ - * LASTKEY( [] ) --> nKey - * $ARGUMENTS$ - * nInputMask is an optional integer value composed of one or more - * INKEY_ or HB_INKEY_ constants. The sole purpose of this argument - * is to allow switching between using HB_INKEY_EXTENDED key codes - * and using the normal CA-Cl*pper-compatible key codes - * $RETURNS$ - * The last key extracted from the keyboard buffer. - * $DESCRIPTION$ - * Returns the value of the last key exttracted from the Harbour - * keyboard buffer - * $EXAMPLES$ - * // Continue looping unless the ESC key was pressed in MainFunc() - * DO WHILE .T. - * MainFunc() - * IF LastKey() == K_ESC - * EXIT - * ENDIF - * ENDDO - * $TESTS$ - * KEYBOARD "AB"; ? INKEY(), LASTKEY() ==> 65 65 - * $STATUS$ - * R - * $COMPLIANCE$ - * LASTKEY() is compliant with CA-Cl*pper 5.3, but has been extended - * for Harbour. - * $FILES$ - * Library is rtl - * $SEEALSO$ - * INKEY(),LASTKEY() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + LASTKEY() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Get the last key extracted from the keyboard buffer. + $SYNTAX$ + LASTKEY( [] ) --> nKey + $ARGUMENTS$ + nInputMask is an optional integer value composed of one or more + INKEY_ or HB_INKEY_ constants. The sole purpose of this argument + is to allow switching between using HB_INKEY_EXTENDED key codes + and using the normal CA-Cl*pper-compatible key codes + $RETURNS$ + The last key extracted from the keyboard buffer. + $DESCRIPTION$ + Returns the value of the last key exttracted from the Harbour + keyboard buffer + $EXAMPLES$ + // Continue looping unless the ESC key was pressed in MainFunc() + DO WHILE .T. + MainFunc() + IF LastKey() == K_ESC + EXIT + ENDIF + ENDDO + $TESTS$ + KEYBOARD "AB"; ? INKEY(), LASTKEY() ==> 65 65 + $STATUS$ + R + $COMPLIANCE$ + LASTKEY() is compliant with CA-Cl*pper 5.3, but has been extended + for Harbour. + $FILES$ + Library is rtl + $SEEALSO$ + INKEY(),LASTKEY() + $END$ */ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + KEYBOARD + $CATEGORY$ + Command + $SUBCATEGORY$ + User interface + $ONELINER$ + Stuffs the keyboard with a string. + $SYNTAX$ + KEYBOARD + $ARGUMENTS$ + String to be processed, one character at a time, + by the Harbour keyboard processor + $DESCRIPTION$ + This command stuffs the input buffer with . -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * KEYBOARD - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Stuffs the keyboard with a string. - * $SYNTAX$ - * KEYBOARD - * $ARGUMENTS$ - * String to be processed, one character at a time, - * by the Harbour keyboard processor - * $DESCRIPTION$ - * This command stuffs the input buffer with . - * - * The number of characters that can be stuffed into the keyboard - * buffer is controlled by the SET TYPEAHEAD command and may range - * from 0 to 32,622, with each character being in the ASCII - * range of 0 to 255. - * - * None of the extended keys may be stuffed into the keyboard buffer. - * - * Issuing a KEYBOARD " " will clear the keyboard buffer. - * $EXAMPLES$ - * // Stuff an Enter key into the keyboard buffer - * KEYBOARD Chr( 13 ) - * // Clear the keyboard buffer - * CLEAR TYPEAHEAD - * $TESTS$ - * KEYBOARD Chr( 13 ); ? Inkey() ==> 13 - * KEYBOARD "HELLO"; CLEAR TYPEAHEAD; ? Inkey() ==> 0 - * $STATUS$ - * R - * $COMPLIANCE$ - * KEYBOARD is compliant with CA-Cl*pper 5.3 - * $SEEALSO$ - * CLEAR TYPEAHEAD,__KEYBOARD() - * $END$ + The number of characters that can be stuffed into the keyboard + buffer is controlled by the SET TYPEAHEAD command and may range + from 0 to 32,622, with each character being in the ASCII + range of 0 to 255. + + None of the extended keys may be stuffed into the keyboard buffer. + + Issuing a KEYBOARD " " will clear the keyboard buffer. + $EXAMPLES$ + // Stuff an Enter key into the keyboard buffer + KEYBOARD Chr( 13 ) + // Clear the keyboard buffer + CLEAR TYPEAHEAD + $TESTS$ + KEYBOARD Chr( 13 ); ? Inkey() ==> 13 + KEYBOARD "HELLO"; CLEAR TYPEAHEAD; ? Inkey() ==> 0 + $STATUS$ + R + $COMPLIANCE$ + KEYBOARD is compliant with CA-Cl*pper 5.3 + $SEEALSO$ + CLEAR TYPEAHEAD,__KEYBOARD() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * READKEY()* - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Determine which key terminated a READ. - * $SYNTAX$ - * READKEY() --> nKeyCode - * $ARGUMENTS$ - * None. - * $RETURNS$ - * READKEY() returns a numeric code representing the key that caused READ - * to terminate. - * $DESCRIPTION$ - * READKEY() is used after a READ was terminated to determine the exit - * key pressed. If the GET buffer was updated during READ, 256 is added - * to the return code. - * - * - * Exit Return code Return code - * Key (not updated) (updated) +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + READKEY()* + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Determine which key terminated a READ. + $SYNTAX$ + READKEY() --> nKeyCode + $ARGUMENTS$ + None. + $RETURNS$ + READKEY() returns a numeric code representing the key that caused READ + to terminate. + $DESCRIPTION$ + READKEY() is used after a READ was terminated to determine the exit + key pressed. If the GET buffer was updated during READ, 256 is added + to the return code. - * Up 4 260 - * Down 5 261 - * Page-Up 6 262 - * Page-Down 7 263 - * Ctrl Page-Up 34 290 - * Ctrl Page-Down 35 291 - * Esc 12 268 - * Ctrl End 14 270 - * Enter 15 271 - * Key >= 32 15 271 - * otherwise 0 0 - *
- * - * READKEY() is a compatibility function so try not to use it. - * READKEY() is superseded by LASTKEY() which returns the INKEY() - * code for that key. UPDATED() could be used to find if the - * GET buffer was changed during the READ. - * $STATUS$ - * R - * $COMPLIANCE$ - * READKEY() is compliant with CA-Cl*pper 5.3 - * $FILES$ - * Library is rtl - * $SEEALSO$ - * @...GET,INKEY(),LASTKEY(),READ,READEXIT(),UPDATED() - * $END$ + + Exit Return code Return code + Key (not updated) (updated) + + Up 4 260 + Down 5 261 + Page-Up 6 262 + Page-Down 7 263 + Ctrl Page-Up 34 290 + Ctrl Page-Down 35 291 + Esc 12 268 + Ctrl End 14 270 + Enter 15 271 + Key >= 32 15 271 + otherwise 0 0 +
+ + READKEY() is a compatibility function so try not to use it. + READKEY() is superseded by LASTKEY() which returns the INKEY() + code for that key. UPDATED() could be used to find if the + GET buffer was changed during the READ. + $STATUS$ + R + $COMPLIANCE$ + READKEY() is compliant with CA-Cl*pper 5.3 + $FILES$ + Library is rtl + $SEEALSO$ + @...GET,INKEY(),LASTKEY(),READ,READEXIT(),UPDATED() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * MROW() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Returns the mouse cursor row position. - * $SYNTAX$ - * MRow() --> nMouseRow - * $ARGUMENTS$ - * None - * $RETURNS$ - * The mouse cursor row position. - * $DESCRIPTION$ - * This function returns the current mouse row cursor position. - * On graphical systems the value represents pixel rows. - * On character-based systems the value represents character - * rows as in CA-Cl*pper. - * $EXAMPLES$ - * IF MRow() < 1 - * ? "Mouse is on top row!" - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * MROW() is compliant with CA-Cl*pper 5.3, but has been extended - * to work on graphical systems as well as character-based systems. - * $PLATFORMS$ - * - * $FILES$ - * Library is rtl - * $SEEALSO$ - * MCOL() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + MROW() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Returns the mouse cursor row position. + $SYNTAX$ + MRow() --> nMouseRow + $ARGUMENTS$ + None + $RETURNS$ + The mouse cursor row position. + $DESCRIPTION$ + This function returns the current mouse row cursor position. + On graphical systems the value represents pixel rows. + On character-based systems the value represents character + rows as in CA-Cl*pper. + $EXAMPLES$ + IF MRow() < 1 + ? "Mouse is on top row!" + ENDIF + $STATUS$ + R + $COMPLIANCE$ + MROW() is compliant with CA-Cl*pper 5.3, but has been extended + to work on graphical systems as well as character-based systems. + $PLATFORMS$ + + $FILES$ + Library is rtl + $SEEALSO$ + MCOL() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * MCOL() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Returns the mouse cursor column position. - * $SYNTAX$ - * MCol() --> nMouseColumn - * $ARGUMENTS$ - * None - * $RETURNS$ - * The mouse cursor column position. - * $DESCRIPTION$ - * This function returns the column position of the mouse cursor. - * On graphical systems the value represents pixels. - * On character-based systems the value represents character - * columns as in CA-Cl*pper. - * $EXAMPLES$ - * IF MCol() < 1 - * ? "Mouse is on left edge!" - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * MCOL() is compliant with CA-Cl*pper 5.3, but has been extended - * to work on graphical systems as well as character-based systems. - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * MROW() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + MCOL() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Returns the mouse cursor column position. + $SYNTAX$ + MCol() --> nMouseColumn + $ARGUMENTS$ + None + $RETURNS$ + The mouse cursor column position. + $DESCRIPTION$ + This function returns the column position of the mouse cursor. + On graphical systems the value represents pixels. + On character-based systems the value represents character + columns as in CA-Cl*pper. + $EXAMPLES$ + IF MCol() < 1 + ? "Mouse is on left edge!" + ENDIF + $STATUS$ + R + $COMPLIANCE$ + MCOL() is compliant with CA-Cl*pper 5.3, but has been extended + to work on graphical systems as well as character-based systems. + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + MROW() + $END$ */ diff --git a/harbour/doc/en/lang.txt b/harbour/doc/en/lang.txt index d5133e5c5e..f0669fa84c 100644 --- a/harbour/doc/en/lang.txt +++ b/harbour/doc/en/lang.txt @@ -17,418 +17,417 @@ * */ - -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_LANGERRMSG() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Language and Nation - * $ONELINER$ - * Description of an error code using current language - * $SYNTAX$ - * HB_LANGERRMSG( ) --> cErrorMessage - * $ARGUMENTS$ - * is one of the generic error codes (EG_...) defined - * in include/error.ch - * $RETURNS$ - * HB_LANGERRMSG() return the error message string represented by - * the code . - * $DESCRIPTION$ - * This function return the error message associated with an error - * code using the current language selected. - * $EXAMPLES$ - * #include "error.ch" - * REQUEST HB_LANG_ES - * PROCEDURE Main() - * // English: Argument error - * ? "English:", HB_LANGERRMSG( EG_ARG ) - * "ES" ) - * // Spanish: Error de argumento - * ? "Spanish:", HB_LANGERRMSG( EG_ARG ) - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $FILES$ - * Library are rtl, lang - * Header is error.ch - * $SEEALSO$ - * HB_LANGSELECT(),NATIONMSG() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_LANGERRMSG() + $CATEGORY$ + API + $SUBCATEGORY$ + Language and Nation + $ONELINER$ + Description of an error code using current language + $SYNTAX$ + HB_LANGERRMSG( ) --> cErrorMessage + $ARGUMENTS$ + is one of the generic error codes (EG_...) defined + in include/error.ch + $RETURNS$ + HB_LANGERRMSG() return the error message string represented by + the code . + $DESCRIPTION$ + This function return the error message associated with an error + code using the current language selected. + $EXAMPLES$ + #include "error.ch" + REQUEST HB_LANG_ES + PROCEDURE Main() + // English: Argument error + ? "English:", HB_LANGERRMSG( EG_ARG ) + "ES" ) + // Spanish: Error de argumento + ? "Spanish:", HB_LANGERRMSG( EG_ARG ) + RETURN + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + All + $FILES$ + Library are rtl, lang + Header is error.ch + $SEEALSO$ + HB_LANGSELECT(),NATIONMSG() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_LANGMESSAGE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Language and Nation - * $ONELINER$ - * Returns international strings messages and errors - * $SYNTAX$ - * HB_LANGMESSAGE( ) --> cMessage - * $ARGUMENTS$ - * is the message number to get. - * $RETURNS$ - * HB_LANGMESSAGE() return the text associated with the code . - * $DESCRIPTION$ - * HB_LANGMESSAGE() is similar to NATIONMSG() but give access to the - * whole list of language messages: Day and month names, generic error - * messages, internal errors, and others... - * - * Use the header file hblang.ch for a list of base values for . - * $EXAMPLES$ - * #include "hblang.ch" - * REQUEST HB_LANG_ES - * PROCEDURE Main() - * // English: Monday - * ? "English:", HB_LANGMESSAGE( HB_LANG_ITEM_BASE_DAY + 1 ) - * "ES" ) - * // Spanish: Lunes - * ? "Spanish:", HB_LANGMESSAGE( HB_LANG_ITEM_BASE_DAY + 1 ) - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $FILES$ - * Library are rtl, lang - * Header is hblang.ch - * $SEEALSO$ - * HB_LANGSELECT(),NATIONMSG(),REQUEST - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_LANGMESSAGE() + $CATEGORY$ + API + $SUBCATEGORY$ + Language and Nation + $ONELINER$ + Returns international strings messages and errors + $SYNTAX$ + HB_LANGMESSAGE( ) --> cMessage + $ARGUMENTS$ + is the message number to get. + $RETURNS$ + HB_LANGMESSAGE() return the text associated with the code . + $DESCRIPTION$ + HB_LANGMESSAGE() is similar to NATIONMSG() but give access to the + whole list of language messages: Day and month names, generic error + messages, internal errors, and others... + + Use the header file hblang.ch for a list of base values for . + $EXAMPLES$ + #include "hblang.ch" + REQUEST HB_LANG_ES + PROCEDURE Main() + // English: Monday + ? "English:", HB_LANGMESSAGE( HB_LANG_ITEM_BASE_DAY + 1 ) + "ES" ) + // Spanish: Lunes + ? "Spanish:", HB_LANGMESSAGE( HB_LANG_ITEM_BASE_DAY + 1 ) + RETURN + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + All + $FILES$ + Library are rtl, lang + Header is hblang.ch + $SEEALSO$ + HB_LANGSELECT(),NATIONMSG(),REQUEST + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_LANGNAME() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Language and Nation - * $ONELINER$ - * Return the name of the current language module in use - * $SYNTAX$ - * HB_LANGNAME() --> cLangName - * $ARGUMENTS$ - * None. - * $RETURNS$ - * Name of the current language in use - * $DESCRIPTION$ - * This function return the current name of the language module in use. - * $EXAMPLES$ - * REQUEST HB_LANG_PT - * REQUEST HB_LANG_RO - * REQUEST HB_LANG_ES - * PROCEDURE Main() - * hb_langSelect( "pt" ) // Default language is now Portuguese - * ? CDOW( Date() ) //Segunda-feira - * ? "Current language is ", hb_langName() // Portuguese - * ? "Old language id selected is ", hb_langSelect() // PT - * hb_langSelect( "ro" ) // Default language is now Romanian - * ? CMONTH( Date() ) // Mai - * ? "Old language id selected is ", hb_langSelect() // RO - * hb_langSelect( "es" ) // Default language is now Spanish - * ? "Current language is ",hb_langName() // Spanish - * ? CMONTH( Date() ) // Mayo - * ? CDOW( Date() ) // Lunes - * RETURN - * $TESTS$ - * See tests/langapi.prg, tests/langmsg.prg - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $FILES$ - * Library are rtl, lang - * $SEEALSO$ - * HB_LANGSELECT(),NATIONMSG() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_LANGNAME() + $CATEGORY$ + API + $SUBCATEGORY$ + Language and Nation + $ONELINER$ + Return the name of the current language module in use + $SYNTAX$ + HB_LANGNAME() --> cLangName + $ARGUMENTS$ + None. + $RETURNS$ + Name of the current language in use + $DESCRIPTION$ + This function return the current name of the language module in use. + $EXAMPLES$ + REQUEST HB_LANG_PT + REQUEST HB_LANG_RO + REQUEST HB_LANG_ES + PROCEDURE Main() + hb_langSelect( "pt" ) // Default language is now Portuguese + ? CDOW( Date() ) //Segunda-feira + ? "Current language is ", hb_langName() // Portuguese + ? "Old language id selected is ", hb_langSelect() // PT + hb_langSelect( "ro" ) // Default language is now Romanian + ? CMONTH( Date() ) // Mai + ? "Old language id selected is ", hb_langSelect() // RO + hb_langSelect( "es" ) // Default language is now Spanish + ? "Current language is ",hb_langName() // Spanish + ? CMONTH( Date() ) // Mayo + ? CDOW( Date() ) // Lunes + RETURN + $TESTS$ + See tests/langapi.prg, tests/langmsg.prg + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + All + $FILES$ + Library are rtl, lang + $SEEALSO$ + HB_LANGSELECT(),NATIONMSG() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_LANGSELECT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Language and Nation - * $ONELINER$ - * Select a specific nation message module - * $SYNTAX$ - * HB_LANGSELECT( [ ][, ] ) --> cOldLang - * $ARGUMENTS$ - * The optional ID of the country language module. - * Possible values for are below as defined in the - * Lang library, sorted by language. - * Optional codepage ID into which the language - * module strings are automatically converted by Harbour. - * - * - * Language - * - * Basque eu - * Belorussian be - * Bulgarian bg - * Catalan ca - * Chinese Simplified zh_sim - * Chinese Traditional zh_tra - * Croatian hr - * Czech cs - * Dutch nl - * Esperanto eo - * French fr - * Galician gl - * German de - * Greek el - * Hebrew he - * Hungarian hu - * Icelandic is - * Indonesian id - * Italian it - * Korean ko - * Lithuanian lt - * Polish pl - * Portuguese pt - * Romanian ro - * Russian ru - * Serbian (cyrillic) sr_cyr - * Serbian (latin) sr_lat - * Slovak sk - * Slovenian sl - * Spanish es - * Swedish sv - * Turkish tr - * Ukrainian uk - *
- * $RETURNS$ - * The old language indentifier - * $DESCRIPTION$ - * This function set a default language module for date/month names, - * internal warnigs, NatMsg messages and internal errors. When a - * Lang ID is selected all messages will be output with the current - * language selected until another one is selected or the program ends. - * The default language is English (cLang == "EN"). - * - * NOTE: You must REQUEST every language module you intend to use. - * For example: to use the Russian RU866 language you must add the - * following to your program: REQUEST HB_LANG_RU866 - * $EXAMPLES$ - * REQUEST HB_LANG_PT - * REQUEST HB_LANG_RO - * REQUEST HB_LANG_ES - * PROCEDURE Main() - * HB_LANGSELECT( "pt" ) // Default language is now Portuguese - * ? CDOW( Date() ) // Segunda-feira - * ? "Old language id selected is ", HB_LANGSELECT() // PT - * HB_LANGSELECT( "ro" ) // Default language is now Romanian - * ? CMONTH( Date() ) // Mai - * ? "Old language id selected is ", HB_LANGSELECT() // RO - * HB_LANGSELECT( "es" ) // Default language is now Spanish - * ? CMONTH( Date() ) // Mayo - * ? CDOW( Date() ) // Lunes - * RETURN - * $TESTS$ - * See tests/langapi.prg, tests/langmsg.prg - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $FILES$ - * Libraty are rtl, lang - * $SEEALSO$ - * HB_LANGNAME(),HB_CDPSELECT(),NATIONMSG(),REQUEST - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_LANGSELECT() + $CATEGORY$ + API + $SUBCATEGORY$ + Language and Nation + $ONELINER$ + Select a specific nation message module + $SYNTAX$ + HB_LANGSELECT( [ ][, ] ) --> cOldLang + $ARGUMENTS$ + The optional ID of the country language module. + Possible values for are below as defined in the + Lang library, sorted by language. + Optional codepage ID into which the language + module strings are automatically converted by Harbour. + + + Language + + Basque eu + Belorussian be + Bulgarian bg + Catalan ca + Chinese Simplified zh_sim + Chinese Traditional zh_tra + Croatian hr + Czech cs + Dutch nl + Esperanto eo + French fr + Galician gl + German de + Greek el + Hebrew he + Hungarian hu + Icelandic is + Indonesian id + Italian it + Korean ko + Lithuanian lt + Polish pl + Portuguese pt + Romanian ro + Russian ru + Serbian (cyrillic) sr_cyr + Serbian (latin) sr_lat + Slovak sk + Slovenian sl + Spanish es + Swedish sv + Turkish tr + Ukrainian uk +
+ $RETURNS$ + The old language indentifier + $DESCRIPTION$ + This function set a default language module for date/month names, + internal warnigs, NatMsg messages and internal errors. When a + Lang ID is selected all messages will be output with the current + language selected until another one is selected or the program ends. + The default language is English (cLang == "EN"). + + NOTE: You must REQUEST every language module you intend to use. + For example: to use the Russian RU866 language you must add the + following to your program: REQUEST HB_LANG_RU866 + $EXAMPLES$ + REQUEST HB_LANG_PT + REQUEST HB_LANG_RO + REQUEST HB_LANG_ES + PROCEDURE Main() + HB_LANGSELECT( "pt" ) // Default language is now Portuguese + ? CDOW( Date() ) // Segunda-feira + ? "Old language id selected is ", HB_LANGSELECT() // PT + HB_LANGSELECT( "ro" ) // Default language is now Romanian + ? CMONTH( Date() ) // Mai + ? "Old language id selected is ", HB_LANGSELECT() // RO + HB_LANGSELECT( "es" ) // Default language is now Spanish + ? CMONTH( Date() ) // Mayo + ? CDOW( Date() ) // Lunes + RETURN + $TESTS$ + See tests/langapi.prg, tests/langmsg.prg + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + All + $FILES$ + Libraty are rtl, lang + $SEEALSO$ + HB_LANGNAME(),HB_CDPSELECT(),NATIONMSG(),REQUEST + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_CDPSELECT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Language and Nation - * $ONELINER$ - * Select the active code page by language ID - * $SYNTAX$ - * HB_CDPSELECT( [] ) --> cOldLang - * $ARGUMENTS$ - * The optional ID of the country language module. - * Possible values for are below as defined in the - * Codepage library, sorted by language. - * - * - * Language Codepage - * - * Bulgarian 866 BG866 - * Bulgarian ISO-8859-5 BGISO - * Bulgarian MIK BGMIK - * Bulgarian Windows-1251 BGWIN - * Croatian 437 HR437 - * Croatian 852 HR852 - * Croatian Windows-1250 HR1250 - * Czech 852 CS852 - * Czech ISO-8859-2 CSISO - * Czech KAM CSKAM - * Czech Windoes-1250 CSWIN - * English 437 EN - * French 850 FR - * German 850 DE - * German ISO-8859-1 DEWIN - * Greek 737 EL - * Greek Windows-1253 ELWIN - * Hungarian (ntxhu852) 852 HU852 - * Hungarian (sixhu852) 852 HU852S - * Hungarian (ntxhu852) ISO-8859-2 HUISO - * Hungarian (sixhu852) ISO-8859-2 HUISOS - * Hungarian (ntxhu852) Windows-1250 HUWIN - * Hungarian (sixhu852) Windows-1250 HUWINS - * Italian 437 IT437 - * Italian 850 IT850 - * Italian ISO-8859-1b ITISB - * Italian ISO-8859-1 ITISO - * Lithuanian Windows-1257 LT - * Polish 852 PL852 - * Polish ISO-8859-2 PLISO - * Polish Mazowia PLMAZ - * Polish Windows-1250 PLWIN - * Portuguese 850 PT850 - * Portuguese ISO-8859-1 PTISO - * Russian 866 RU866 - * Russian KOI-8 RUKOI8 - * Russian Windows-1251 RU1251 - * Serbian Windows-1251 SRWIN - * Slovak 852 SK852 - * Slovak ISO-8859-2 SKISO - * Slovak Kamenicky SKKAM - * Slovak Windows-1250 SKWIN - * Slovenian 437 SL437 - * Slovenian 852 SL852 - * Slovenian ISO-8859-2 SLISO - * Slovenian Windows-1250 SLWIN - * Spanish 850 ES - * Spanish ISO-8859-1 ESWIN - * Spanish Modern ISO-8859-1 ESMWIN - * Swedish 850 SV850 - * Swedish (Clipper) 437 SVCLIP - * Swedish ISO-8859-1 SVWIN - * Turkish 857 TR857 - * Turkish Windows-1254 TRWIN - * Ukrainian 866 UA866 - * Ukrainian KOI-8U UAKOI8 - * Ukrainian Windows-1251 UA1251 - *
- * $RETURNS$ - * The old language indentifier - * $DESCRIPTION$ - * HB_CDPSELECT() set the active code page use by Harbour for - * sorting and comparing strings. The default code page use ASCII - * order (cLang == "EN"). - * - * NOTE: You must REQUEST every code page module you intend to use. - * For example: to use the Russian RU866 code page you must add the - * following to your program: REQUEST HB_CODEPAGE_RU866 - * $EXAMPLES$ - * REQUEST HB_CODEPAGE_HU852 - * PROCEDURE Main() - * LOCAL cTxt := Chr( 71 ) + " > " + Chr( 144 ) + " is" - * ? hb_cdpSelect() // EN - * ? cTxt, Chr( 71 ) > Chr( 144 ) // G > É is .F. - * ? hb_cdpSelect( "HU852" ) // EN - * ? cTxt, Chr( 71 ) > Chr( 144 ) // G > É is .T. - * ? hb_cdpSelect( "EN" ) // HU852 - * ? cTxt, Chr( 71 ) > Chr( 144 ) // G > É is .F. - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is a Harbour Extension. - * $PLATFORMS$ - * All - * $FILES$ - * Libraty are rtl, codepage - * $SEEALSO$ - * HB_LANGNAME(),HB_LANGSELECT(),HB_TRANSLATE(),NATIONMSG(),REQUEST - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_CDPSELECT() + $CATEGORY$ + API + $SUBCATEGORY$ + Language and Nation + $ONELINER$ + Select the active code page by language ID + $SYNTAX$ + HB_CDPSELECT( [] ) --> cOldLang + $ARGUMENTS$ + The optional ID of the country language module. + Possible values for are below as defined in the + Codepage library, sorted by language. + + + Language Codepage + + Bulgarian 866 BG866 + Bulgarian ISO-8859-5 BGISO + Bulgarian MIK BGMIK + Bulgarian Windows-1251 BGWIN + Croatian 437 HR437 + Croatian 852 HR852 + Croatian Windows-1250 HR1250 + Czech 852 CS852 + Czech ISO-8859-2 CSISO + Czech KAM CSKAM + Czech Windoes-1250 CSWIN + English 437 EN + French 850 FR + German 850 DE + German ISO-8859-1 DEWIN + Greek 737 EL + Greek Windows-1253 ELWIN + Hungarian (ntxhu852) 852 HU852 + Hungarian (sixhu852) 852 HU852S + Hungarian (ntxhu852) ISO-8859-2 HUISO + Hungarian (sixhu852) ISO-8859-2 HUISOS + Hungarian (ntxhu852) Windows-1250 HUWIN + Hungarian (sixhu852) Windows-1250 HUWINS + Italian 437 IT437 + Italian 850 IT850 + Italian ISO-8859-1b ITISB + Italian ISO-8859-1 ITISO + Lithuanian Windows-1257 LT + Polish 852 PL852 + Polish ISO-8859-2 PLISO + Polish Mazowia PLMAZ + Polish Windows-1250 PLWIN + Portuguese 850 PT850 + Portuguese ISO-8859-1 PTISO + Russian 866 RU866 + Russian KOI-8 RUKOI8 + Russian Windows-1251 RU1251 + Serbian Windows-1251 SRWIN + Slovak 852 SK852 + Slovak ISO-8859-2 SKISO + Slovak Kamenicky SKKAM + Slovak Windows-1250 SKWIN + Slovenian 437 SL437 + Slovenian 852 SL852 + Slovenian ISO-8859-2 SLISO + Slovenian Windows-1250 SLWIN + Spanish 850 ES + Spanish ISO-8859-1 ESWIN + Spanish Modern ISO-8859-1 ESMWIN + Swedish 850 SV850 + Swedish (Clipper) 437 SVCLIP + Swedish ISO-8859-1 SVWIN + Turkish 857 TR857 + Turkish Windows-1254 TRWIN + Ukrainian 866 UA866 + Ukrainian KOI-8U UAKOI8 + Ukrainian Windows-1251 UA1251 +
+ $RETURNS$ + The old language indentifier + $DESCRIPTION$ + HB_CDPSELECT() set the active code page use by Harbour for + sorting and comparing strings. The default code page use ASCII + order (cLang == "EN"). + + NOTE: You must REQUEST every code page module you intend to use. + For example: to use the Russian RU866 code page you must add the + following to your program: REQUEST HB_CODEPAGE_RU866 + $EXAMPLES$ + REQUEST HB_CODEPAGE_HU852 + PROCEDURE Main() + LOCAL cTxt := Chr( 71 ) + " > " + Chr( 144 ) + " is" + ? hb_cdpSelect() // EN + ? cTxt, Chr( 71 ) > Chr( 144 ) // G > É is .F. + ? hb_cdpSelect( "HU852" ) // EN + ? cTxt, Chr( 71 ) > Chr( 144 ) // G > É is .T. + ? hb_cdpSelect( "EN" ) // HU852 + ? cTxt, Chr( 71 ) > Chr( 144 ) // G > É is .F. + RETURN + $STATUS$ + R + $COMPLIANCE$ + This function is a Harbour Extension. + $PLATFORMS$ + All + $FILES$ + Libraty are rtl, codepage + $SEEALSO$ + HB_LANGNAME(),HB_LANGSELECT(),HB_TRANSLATE(),NATIONMSG(),REQUEST + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_TRANSLATE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Language and Nation - * $ONELINER$ - * Translate a string from one code page to the other - * $SYNTAX$ - * HB_TRANSLATE( , [], [] ) --> cDstText - * $ARGUMENTS$ - * Is the source string to translate. - * - * Is the optional character code page ID of the source - * string. If not specified, the default code page is used. - * - * Is the optional character code page ID of the destination - * string. If not specified, the default code page is used. - * $RETURNS$ - * HB_TRANSLATE() return destination string converted from the source - * string. - * $DESCRIPTION$ - * HB_TRANSLATE() try to convert a source string from one code page - * into the other. If a code page ID is not recognized, or not linked - * in, the default code page is used. HB_TRANSLATE() is used usually - * to convert between the Dos and the Windows code pages of the same - * language. - * - * NOTE: If the source code page and target code page does not have - * the same number of characters, a translation can not be done and - * the destination string is a copy of the source string. - * - * NOTE: You must REQUEST every code page module you intend to use. - * For example: to use the Russian RU866 code page you must add the - * following to your program: REQUEST HB_CODEPAGE_RU866 - * $EXAMPLES$ - * REQUEST HB_CODEPAGE_DE - * REQUEST HB_CODEPAGE_DEWIN - * PROCEDURE Main() - * LOCAL cTxt := "A" + Chr( 142 ) + "BC" - * ? "German CP-850 text:", cTxt - * ? "German Windows-1252 text:", hb_Translate( cTxt, "DE", "DEWIN" ) - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is a Harbour Extension. - * $PLATFORMS$ - * All - * $FILES$ - * Libraty are rtl, codepage - * $SEEALSO$ - * HB_LANGSELECT(),HB_CDPSELECT(),NATIONMSG(),REQUEST - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_TRANSLATE() + $CATEGORY$ + API + $SUBCATEGORY$ + Language and Nation + $ONELINER$ + Translate a string from one code page to the other + $SYNTAX$ + HB_TRANSLATE( , [], [] ) --> cDstText + $ARGUMENTS$ + Is the source string to translate. + + Is the optional character code page ID of the source + string. If not specified, the default code page is used. + + Is the optional character code page ID of the destination + string. If not specified, the default code page is used. + $RETURNS$ + HB_TRANSLATE() return destination string converted from the source + string. + $DESCRIPTION$ + HB_TRANSLATE() try to convert a source string from one code page + into the other. If a code page ID is not recognized, or not linked + in, the default code page is used. HB_TRANSLATE() is used usually + to convert between the Dos and the Windows code pages of the same + language. + + NOTE: If the source code page and target code page does not have + the same number of characters, a translation can not be done and + the destination string is a copy of the source string. + + NOTE: You must REQUEST every code page module you intend to use. + For example: to use the Russian RU866 code page you must add the + following to your program: REQUEST HB_CODEPAGE_RU866 + $EXAMPLES$ + REQUEST HB_CODEPAGE_DE + REQUEST HB_CODEPAGE_DEWIN + PROCEDURE Main() + LOCAL cTxt := "A" + Chr( 142 ) + "BC" + ? "German CP-850 text:", cTxt + ? "German Windows-1252 text:", hb_Translate( cTxt, "DE", "DEWIN" ) + RETURN + $STATUS$ + R + $COMPLIANCE$ + This function is a Harbour Extension. + $PLATFORMS$ + All + $FILES$ + Libraty are rtl, codepage + $SEEALSO$ + HB_LANGSELECT(),HB_CDPSELECT(),NATIONMSG(),REQUEST + $END$ */ diff --git a/harbour/doc/en/license.txt b/harbour/doc/en/license.txt index 38fcae5901..913d96a4e7 100644 --- a/harbour/doc/en/license.txt +++ b/harbour/doc/en/license.txt @@ -2,148 +2,147 @@ * $Id$ */ -/* $DOC$ - * $TEMPLATE$ - * Document - * $NAME$ - * Harbour License - * $CATEGORY$ - * Document - * $SUBCATEGORY$ - * License - * $ONELINER$ - * Harbour License - * $DESCRIPTION$ - * - * THE HARBOUR PROJECT COMPILER LICENSE - * ==================================== - * - * Note: This license applies to most of the files in the src/compiler - * directory. - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA (or visit - * their web site at http://www.gnu.org/). - * - * - * THE HARBOUR PROJECT LIBRARY LICENSE - * =================================== - * - * Note: This license applies to most of the files in the include directory, - * source directory, and subdirectories. - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2, or (at your option) - * any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this software; see the file COPYING. If not, write to - * the Free Software Foundation, Inc., 59 Temple Place, Suite 330, - * Boston, MA 02111-1307 USA (or visit the web site http://www.gnu.org/). - * - * As a special exception, the Harbour Project gives permission for - * additional uses of the text contained in its release of Harbour. - * - * The exception is that, if you link the Harbour libraries with other - * files to produce an executable, this does not by itself cause the - * resulting executable to be covered by the GNU General Public License. - * Your use of that executable is in no way restricted on account of - * linking the Harbour library code into it. - * - * This exception does not however invalidate any other reasons why - * the executable file might be covered by the GNU General Public License. - * - * This exception applies only to the code released by the Harbour - * Project under the name Harbour. If you copy code from other - * Harbour Project or Free Software Foundation releases into a copy of - * Harbour, as the General Public License permits, the exception does - * not apply to the code that you add in this way. To avoid misleading - * anyone as to the status of such modified files, you must delete - * this exception notice from them. - * - * If you write modifications of your own for Harbour, it is your choice - * whether to permit this exception to apply to your modifications. - * If you do not wish that, delete this exception notice. - * - * - * THE OLD HARBOUR PROJECT LIBRARY LICENSE - * ======================================= - * - * Note: This license only applies to the following files: - * 

- *      contrib\libmisc\dates2.c (Only the DateTime() function by Jon Berg)
- *      samples\pe\*
- *      source\rtl\philes.c
- *      source\rtl\binnum.c
- *      source\lang\msgsr852.c
- *      source\lang\msgpl852.c
- *      source\lang\msgpliso.c
- *      source\lang\msgplmaz.c
- *      source\lang\msgeu.c
- *      source\lang\msgcsiso.c
- *      source\lang\msgcswin.c
- *      source\lang\msgcskam.c
- *      source\lang\msgsriso.c
- *      source\lang\msgde.c
- *      source\lang\msghr852.c
- *      source\lang\msgcs852.c
- *      source\lang\msghriso.c
- *      source\lang\msgis850.c
- *
- * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version, with one exception: - * - * The exception is that if you link the Harbour Runtime Library (HRL) - * and/or the Harbour Virtual Machine (HVM) with other files to produce - * an executable, this does not by itself cause the resulting executable - * to be covered by the GNU General Public License. Your use of that - * executable is in no way restricted on account of linking the HRL - * and/or HVM code into it. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA (or visit - * their web site at http://www.gnu.org/). - * - * - * THE HARBOUR PROJECT CONTRIB LICENSE - * =================================== - * - * There is no one single license that applies to the Harbour Project - * contrib files. Some files use the Harbour Project Compiler license. - * Some files use the Harbour Project Library license. Some files use - * the old Harbour Project Library license (and in one case, just one - * function in a file that otherwise uses the Harbour Project Library - * license uses the old license - this is the DateTime() function in - * the file contrib\libmisc\dates2.c). Some files may even use other - * types of free software or open source software licenses. Some files - * have been donated to the public domain. If you use any of the contrib - * files, you need to investigate the license that applies to each file. - * - * $SEEALSO$ - * Overview - * $END$ +/* $DOC$ + $TEMPLATE$ + Document + $NAME$ + Harbour License + $CATEGORY$ + Document + $SUBCATEGORY$ + License + $ONELINER$ + Harbour License + $DESCRIPTION$ + THE HARBOUR PROJECT COMPILER LICENSE + ==================================== + + Note: This license applies to most of the files in the src/compiler + directory. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA (or visit + their web site at http://www.gnu.org/). + + + THE HARBOUR PROJECT LIBRARY LICENSE + =================================== + + Note: This license applies to most of the files in the include directory, + source directory, and subdirectories. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this software; see the file COPYING. If not, write to + the Free Software Foundation, Inc., 59 Temple Place, Suite 330, + Boston, MA 02111-1307 USA (or visit the web site http://www.gnu.org/). + + As a special exception, the Harbour Project gives permission for + additional uses of the text contained in its release of Harbour. + + The exception is that, if you link the Harbour libraries with other + files to produce an executable, this does not by itself cause the + resulting executable to be covered by the GNU General Public License. + Your use of that executable is in no way restricted on account of + linking the Harbour library code into it. + + This exception does not however invalidate any other reasons why + the executable file might be covered by the GNU General Public License. + + This exception applies only to the code released by the Harbour + Project under the name Harbour. If you copy code from other + Harbour Project or Free Software Foundation releases into a copy of + Harbour, as the General Public License permits, the exception does + not apply to the code that you add in this way. To avoid misleading + anyone as to the status of such modified files, you must delete + this exception notice from them. + + If you write modifications of your own for Harbour, it is your choice + whether to permit this exception to apply to your modifications. + If you do not wish that, delete this exception notice. + + + THE OLD HARBOUR PROJECT LIBRARY LICENSE + ======================================= + + Note: This license only applies to the following files: + 
+          contrib\libmisc\dates2.c (Only the DateTime() function by Jon Berg)
+          samples\pe\*
+          source\rtl\philes.c
+          source\rtl\binnum.c
+          source\lang\msgsr852.c
+          source\lang\msgpl852.c
+          source\lang\msgpliso.c
+          source\lang\msgplmaz.c
+          source\lang\msgeu.c
+          source\lang\msgcsiso.c
+          source\lang\msgcswin.c
+          source\lang\msgcskam.c
+          source\lang\msgsriso.c
+          source\lang\msgde.c
+          source\lang\msghr852.c
+          source\lang\msgcs852.c
+          source\lang\msghriso.c
+          source\lang\msgis850.c
+
+ This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version, with one exception: + + The exception is that if you link the Harbour Runtime Library (HRL) + and/or the Harbour Virtual Machine (HVM) with other files to produce + an executable, this does not by itself cause the resulting executable + to be covered by the GNU General Public License. Your use of that + executable is in no way restricted on account of linking the HRL + and/or HVM code into it. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA (or visit + their web site at http://www.gnu.org/). + + + THE HARBOUR PROJECT CONTRIB LICENSE + =================================== + + There is no one single license that applies to the Harbour Project + contrib files. Some files use the Harbour Project Compiler license. + Some files use the Harbour Project Library license. Some files use + the old Harbour Project Library license (and in one case, just one + function in a file that otherwise uses the Harbour Project Library + license uses the old license - this is the DateTime() function in + the file contrib\libmisc\dates2.c). Some files may even use other + types of free software or open source software licenses. Some files + have been donated to the public domain. If you use any of the contrib + files, you need to investigate the license that applies to each file. + + $SEEALSO$ + Overview + $END$ */ diff --git a/harbour/doc/en/macro.txt b/harbour/doc/en/macro.txt index 18f27cfda3..82965ac599 100644 --- a/harbour/doc/en/macro.txt +++ b/harbour/doc/en/macro.txt @@ -2,84 +2,84 @@ * $Id$ */ -/* $DOC$ - * $TEMPLATE$ - * Document - * $NAME$ - * Macro compiler - * $CATEGORY$ - * Document - * $SUBCATEGORY$ - * Compiler - * $ONELINER$ - * Macro compiler - * $DESCRIPTION$ - * Invoking the macro compiler: - * ============================== - * - * &variable - * or - * &( expression ) - * or - * &variable.text - * $END$ +/* $DOC$ + $TEMPLATE$ + Document + $NAME$ + Macro compiler + $CATEGORY$ + Document + $SUBCATEGORY$ + Compiler + $ONELINER$ + Macro compiler + $DESCRIPTION$ + Invoking the macro compiler: + ============================== + + &variable + or + &( expression ) + or + &variable.text + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_SETMACRO() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Macro - * $ONELINER$ - * Enable/disable the macro compiler runtime features. - * $SYNTAX$ - * HB_SETMACRO( , [] ) --> - * $ARGUMENTS$ - * One of the HB_SM_* constants defined in set.ch. - * - * .T. to enable or .F. to disable a feature - * $RETURNS$ - * HB_SETMACRO() return the old state of requested feature. - * $DESCRIPTION$ - * This function enables or disables some features of the macro - * compiler. The Harbour is extending the macro features compared - * to an original set available in CA-Cl*pper. Enabling/disabling - * some of them allows to keep strict CA-Cl*pper compatibility. - * - * Available features are: - * HB_SM_HARBOUR - enables harbour extensions: - * operators: ++, --, +=, -=, *=, /=, ^= - * objects: assigments to an instance variable - * - * HB_SM_XBASE - enables other Xbase++ dialects extensions: - * expanding of expresions lists - * - * HB_SM_SHORTCUTS - enables optimized evaluation of - * logical operators (.and., .or.) - * - * HB_SM_PREPROC - enables preprocessing of commands - * This is meaningfull if Harbour is compiled with - * HB_MACRO_STATEMENTS flag - * - * $EXAMPLES$ - * INIT PROCEDURE IWANTCLIPPER() - * HB_SETMACRO( HB_SM_HARBOUR, .F. ) - * HB_SETMACRO( HB_SM_XBASE, .F. ) - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $FILES$ - * Header file is set.ch - * Library is macro - * $SEEALSO$ - * Macro compiler - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_SETMACRO() + $CATEGORY$ + API + $SUBCATEGORY$ + Macro + $ONELINER$ + Enable/disable the macro compiler runtime features. + $SYNTAX$ + HB_SETMACRO( , [] ) --> + $ARGUMENTS$ + One of the HB_SM_* constants defined in set.ch. + + .T. to enable or .F. to disable a feature + $RETURNS$ + HB_SETMACRO() return the old state of requested feature. + $DESCRIPTION$ + This function enables or disables some features of the macro + compiler. The Harbour is extending the macro features compared + to an original set available in CA-Cl*pper. Enabling/disabling + some of them allows to keep strict CA-Cl*pper compatibility. + + Available features are: + HB_SM_HARBOUR - enables harbour extensions: + operators: ++, --, +=, -=, *=, /=, ^= + objects: assigments to an instance variable + + HB_SM_XBASE - enables other Xbase++ dialects extensions: + expanding of expresions lists + + HB_SM_SHORTCUTS - enables optimized evaluation of + logical operators (.and., .or.) + + HB_SM_PREPROC - enables preprocessing of commands + This is meaningfull if Harbour is compiled with + HB_MACRO_STATEMENTS flag + + $EXAMPLES$ + INIT PROCEDURE IWANTCLIPPER() + HB_SETMACRO( HB_SM_HARBOUR, .F. ) + HB_SETMACRO( HB_SM_XBASE, .F. ) + RETURN + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + All + $FILES$ + Header file is set.ch + Library is macro + $SEEALSO$ + Macro compiler + $END$ */ diff --git a/harbour/doc/en/math.txt b/harbour/doc/en/math.txt index dd007ff3e6..b767dc2159 100644 --- a/harbour/doc/en/math.txt +++ b/harbour/doc/en/math.txt @@ -18,726 +18,725 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ABS() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Math - * $ONELINER$ - * Return the absolute value of a number. - * $SYNTAX$ - * ABS() --> - * $ARGUMENTS$ - * Any number. - * $RETURNS$ - * The absolute numeric value. - * $DESCRIPTION$ - * This function yields the absolute value of the numeric value or - * expression . - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL nNumber := 50 - * LOCAL nNumber1 := 27 - * CLS - * - * ? nNumber - nNumber1 - * ? nNumber1 - nNumber - * ? ABS( nNumber - nNumber1 ) - * ? ABS( nNumber1 - nNumber ) - * ? ABS( -1 * 345 ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ABS() + $CATEGORY$ + API + $SUBCATEGORY$ + Math + $ONELINER$ + Return the absolute value of a number. + $SYNTAX$ + ABS() --> + $ARGUMENTS$ + Any number. + $RETURNS$ + The absolute numeric value. + $DESCRIPTION$ + This function yields the absolute value of the numeric value or + expression . + $EXAMPLES$ + PROCEDURE Main() + LOCAL nNumber := 50 + LOCAL nNumber1 := 27 + CLS + + ? nNumber - nNumber1 + ? nNumber1 - nNumber + ? ABS( nNumber - nNumber1 ) + ? ABS( nNumber1 - nNumber ) + ? ABS( -1 * 345 ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * EXP() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Math - * $ONELINER$ - * Calculates the value of e raised to the passed power. - * $SYNTAX$ - * EXP( ) --> - * $ARGUMENTS$ - * Any real number. - * $RETURNS$ - * The anti-logarithm of - * $DESCRIPTION$ - * This function returns the value of e raised to the power of - * . It is the inverse of LOG(). - * $EXAMPLES$ - * ? EXP(45) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * LOG() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + EXP() + $CATEGORY$ + API + $SUBCATEGORY$ + Math + $ONELINER$ + Calculates the value of e raised to the passed power. + $SYNTAX$ + EXP( ) --> + $ARGUMENTS$ + Any real number. + $RETURNS$ + The anti-logarithm of + $DESCRIPTION$ + This function returns the value of e raised to the power of + . It is the inverse of LOG(). + $EXAMPLES$ + ? EXP(45) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + LOG() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * INT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Math - * $ONELINER$ - * Return the integer port of a numeric value. - * $SYNTAX$ - * INT( ) --> - * $ARGUMENTS$ - * Any numeric value. - * $RETURNS$ - * The integer portion of the numeric value. - * $DESCRIPTION$ - * This function converts a numeric expression to an integer. All - * decimal digits are truncated. This function does not round a value - * upward or downward; it merely truncates a number at the decimal - * point. - * $EXAMPLES$ - * SET DECIMAL TO 5 - * ? INT( 632512.62541 ) - * ? INT( 845414111.91440 ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ROUND(),STRZERO() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + INT() + $CATEGORY$ + API + $SUBCATEGORY$ + Math + $ONELINER$ + Return the integer port of a numeric value. + $SYNTAX$ + INT( ) --> + $ARGUMENTS$ + Any numeric value. + $RETURNS$ + The integer portion of the numeric value. + $DESCRIPTION$ + This function converts a numeric expression to an integer. All + decimal digits are truncated. This function does not round a value + upward or downward; it merely truncates a number at the decimal + point. + $EXAMPLES$ + SET DECIMAL TO 5 + ? INT( 632512.62541 ) + ? INT( 845414111.91440 ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + ROUND(),STRZERO() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * LOG() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Math - * $ONELINER$ - * Returns the natural logarithm of a number. - * $SYNTAX$ - * LOG( ) --> - * $ARGUMENTS$ - * Any numeric expression. - * $RETURNS$ - * The natural logarithm of . - * $DESCRIPTION$ - * This function returns the natural logarithm of the number . - * If is 0 or less than 0, a numeric overflow occurs, - * which is depicted on the display device as a series of asterisks. - * This function is the inverse of EXP(). - * $EXAMPLES$ - * ? LOG( 632512 ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * EXP() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + LOG() + $CATEGORY$ + API + $SUBCATEGORY$ + Math + $ONELINER$ + Returns the natural logarithm of a number. + $SYNTAX$ + LOG( ) --> + $ARGUMENTS$ + Any numeric expression. + $RETURNS$ + The natural logarithm of . + $DESCRIPTION$ + This function returns the natural logarithm of the number . + If is 0 or less than 0, a numeric overflow occurs, + which is depicted on the display device as a series of asterisks. + This function is the inverse of EXP(). + $EXAMPLES$ + ? LOG( 632512 ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + EXP() + $END$ */ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + MAX() + $CATEGORY$ + API + $SUBCATEGORY$ + Math + $ONELINER$ + Returns the maximum of two numbers or dates. + $SYNTAX$ + MAX( , ) --> + $ARGUMENTS$ + Any date or numeric value. -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * MAX() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Math - * $ONELINER$ - * Returns the maximum of two numbers or dates. - * $SYNTAX$ - * MAX( , ) --> - * $ARGUMENTS$ - * Any date or numeric value. - * - * Any date or numeric value (same type as ). - * $RETURNS$ - * The larger numeric (or later date) value. - * $DESCRIPTION$ - * This function returns the larger of the two passed espressions. If - * and are numeric data types, the value returned by - * this function will be a numeric data type as well and will be the - * larger of the two numbers passed to it. If and - * are date data types, the return value will be a date data type as - * well. It will be the later of the two dates passed to it. - * $EXAMPLES$ - * ? MAX( 214514214, 6251242142 ) - * ? MAX( STOD( "20001111" ), STOD( "20140621" ) ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * Min() - * $END$ + Any date or numeric value (same type as ). + $RETURNS$ + The larger numeric (or later date) value. + $DESCRIPTION$ + This function returns the larger of the two passed espressions. If + and are numeric data types, the value returned by + this function will be a numeric data type as well and will be the + larger of the two numbers passed to it. If and + are date data types, the return value will be a date data type as + well. It will be the later of the two dates passed to it. + $EXAMPLES$ + ? MAX( 214514214, 6251242142 ) + ? MAX( STOD( "20001111" ), STOD( "20140621" ) ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + Min() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * MIN() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Math - * $ONELINER$ - * Determines the minumum of two numbers or dates. - * $SYNTAX$ - * MIN( , ) --> - * $ARGUMENTS$ - * Any date or numeric value. - * - * Any date or numeric value. - * $RETURNS$ - * The smaller numeric (or earlier date) value. - * $DESCRIPTION$ - * This function returns the smaller of the two passed espressions. - * and must be the same data type. If numeric, the - * smaller number is returned. If dates, the earlier date is returned. - * $EXAMPLES$ - * ? MIN( 214514214, 6251242142 ) - * ? MIN( STOD( "20001111" ), STOD( "20140621" ) ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * MAX() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + MIN() + $CATEGORY$ + API + $SUBCATEGORY$ + Math + $ONELINER$ + Determines the minumum of two numbers or dates. + $SYNTAX$ + MIN( , ) --> + $ARGUMENTS$ + Any date or numeric value. + + Any date or numeric value. + $RETURNS$ + The smaller numeric (or earlier date) value. + $DESCRIPTION$ + This function returns the smaller of the two passed espressions. + and must be the same data type. If numeric, the + smaller number is returned. If dates, the earlier date is returned. + $EXAMPLES$ + ? MIN( 214514214, 6251242142 ) + ? MIN( STOD( "20001111" ), STOD( "20140621" ) ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + MAX() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * MOD() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Math - * $ONELINER$ - * Return the modulus of two numbers. - * $SYNTAX$ - * MOD( , ) --> - * $ARGUMENTS$ - * Numerator in a divisional expression. - * - * Denominator in a divisional expression. - * $RETURNS$ - * The remainder after the division operation. - * $DESCRIPTION$ - * This functuion returns the remainder of one number divided by - * another. - * $EXAMPLES$ - * ? Mod( 12, 8.521 ) - * ? Mod( 12, 0 ) - * ? Mod( 62412.5142, 4522114.12014 ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * % - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + MOD() + $CATEGORY$ + API + $SUBCATEGORY$ + Math + $ONELINER$ + Return the modulus of two numbers. + $SYNTAX$ + MOD( , ) --> + $ARGUMENTS$ + Numerator in a divisional expression. + + Denominator in a divisional expression. + $RETURNS$ + The remainder after the division operation. + $DESCRIPTION$ + This functuion returns the remainder of one number divided by + another. + $EXAMPLES$ + ? Mod( 12, 8.521 ) + ? Mod( 12, 0 ) + ? Mod( 62412.5142, 4522114.12014 ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + % + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SQRT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Math - * $ONELINER$ - * Calculates the square root of a number. - * $SYNTAX$ - * SQRT( ) --> - * $ARGUMENTS$ - * Any numeric value. - * $RETURNS$ - * The square root of . - * $DESCRIPTION$ - * This function returns the square root of . The precision - * of this evaluation is based solely on the settings of the - * SET DECIMAL TO command. Any negative number passed as - * will always return a 0. - * $EXAMPLES$ - * SET DECIMAL TO 5 - * ? SQRT( 632512.62541 ) - * ? SQRT( 845414111.91440 ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ROUND() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SQRT() + $CATEGORY$ + API + $SUBCATEGORY$ + Math + $ONELINER$ + Calculates the square root of a number. + $SYNTAX$ + SQRT( ) --> + $ARGUMENTS$ + Any numeric value. + $RETURNS$ + The square root of . + $DESCRIPTION$ + This function returns the square root of . The precision + of this evaluation is based solely on the settings of the + SET DECIMAL TO command. Any negative number passed as + will always return a 0. + $EXAMPLES$ + SET DECIMAL TO 5 + ? SQRT( 632512.62541 ) + ? SQRT( 845414111.91440 ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + ROUND() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ROUND() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Math - * $ONELINER$ - * Rounds off a numeric expression. - * $SYNTAX$ - * ROUND( , ) --> - * $ARGUMENTS$ - * Any numeric value. - * - * The number of places to round to. - * $RETURNS$ - * The rounded number. - * $DESCRIPTION$ - * This function rounds off the value of to the number of - * decimal places specified by . If the value of is - * a negative number, the function will attempt to round in - * whole numbers. Numbers from 5 through 9 will be rounded up, all - * others will be rounded down. - * $EXAMPLES$ - * ? ROUND( 632512.62541, 5 ) - * ? ROUND( 845414111.91440, 3 ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * INT(),STR(),VAL(),SET FIXED - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ROUND() + $CATEGORY$ + API + $SUBCATEGORY$ + Math + $ONELINER$ + Rounds off a numeric expression. + $SYNTAX$ + ROUND( , ) --> + $ARGUMENTS$ + Any numeric value. + + The number of places to round to. + $RETURNS$ + The rounded number. + $DESCRIPTION$ + This function rounds off the value of to the number of + decimal places specified by . If the value of is + a negative number, the function will attempt to round in + whole numbers. Numbers from 5 through 9 will be rounded up, all + others will be rounded down. + $EXAMPLES$ + ? ROUND( 632512.62541, 5 ) + ? ROUND( 845414111.91440, 3 ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + INT(),STR(),VAL(),SET FIXED + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_mathGetLastError() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Math - * $ONELINER$ - * get the last math lib error - * $SYNTAX$ - * C Prototype - * - * #include "hbmath.h" - * hb_mathGetLastError( HB_MATH_EXCEPTION * phb_exc ) - * --> int iMathErrorType - * $ARGUMENTS$ - * phb_exc pointer to HB_MATH_EXCEPTION structure, if not NULL, - * the structure will be filled with information about the - * last math error: - * - * typedef struct _HB_MATH_EXCEPTION { - * int type; // Math error type, is one of the constants - * // HB_MATH_ERR_xxx defined in hbmath.ch - * char *funcname; // Pointer to name of the math C RTL routine - * // that caused the error. - * char *error; // Pointer to error description. - * double arg1; // First and - * double arg2; // Second double argument to the math routine. - * double retval; // Corrected return value for the math routine. - * int retvalwidth; // Width and - * int retvaldec; // Decimals of the corrected return value, - * // both default to -1 - * int handled; // 1, if the math error is already corrected, - * // 0 otherwise. - * } HB_MATH_EXCEPTION; - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbmath.h - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_mathGetLastError() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Math + $ONELINER$ + get the last math lib error + $SYNTAX$ + C Prototype + + #include "hbmath.h" + hb_mathGetLastError( HB_MATH_EXCEPTION * phb_exc ) + --> int iMathErrorType + $ARGUMENTS$ + phb_exc pointer to HB_MATH_EXCEPTION structure, if not NULL, + the structure will be filled with information about the + last math error: + + typedef struct _HB_MATH_EXCEPTION { + int type; // Math error type, is one of the constants + // HB_MATH_ERR_xxx defined in hbmath.ch + char *funcname; // Pointer to name of the math C RTL routine + // that caused the error. + char *error; // Pointer to error description. + double arg1; // First and + double arg2; // Second double argument to the math routine. + double retval; // Corrected return value for the math routine. + int retvalwidth; // Width and + int retvaldec; // Decimals of the corrected return value, + // both default to -1 + int handled; // 1, if the math error is already corrected, + // 0 otherwise. + } HB_MATH_EXCEPTION; + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbmath.h + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * hb_mathResetError() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Math - * $ONELINER$ - * Reset the internal math error information structure - * $SYNTAX$ - * C Prototype - * - * #include "hbmath.h" - * hb_mathResetError( void ) - * $ARGUMENTS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbmath.h - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + hb_mathResetError() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Math + $ONELINER$ + Reset the internal math error information structure + $SYNTAX$ + C Prototype + + #include "hbmath.h" + hb_mathResetError( void ) + $ARGUMENTS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbmath.h + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_mathIsMathErr() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Math - * $ONELINER$ - * Check if harbour math error handling is available - * $SYNTAX$ - * C Prototype - * - * #include "hbmath.h" - * hb_mathIsMathErr( void ) --> int iIsMathHandler - * $ARGUMENTS$ - * - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbmath.h - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_mathIsMathErr() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Math + $ONELINER$ + Check if harbour math error handling is available + $SYNTAX$ + C Prototype + + #include "hbmath.h" + hb_mathIsMathErr( void ) --> int iIsMathHandler + $ARGUMENTS$ + + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbmath.h + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_mathSetHandler() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Math - * $ONELINER$ - * set the harbour math handler - * $SYNTAX$ - * C Prototype - * - * #include "hbmath.h" - * hb_mathSetHandler( HB_MATH_HANDLERPROC handlerproc ) - * --> HB_MATH_HANDLERPROC previous_handerproc - * $ARGUMENTS$ - * handlerproc custom math handler - * typedef int (* HB_MATH_HANDLERPROC)(HB_MATH_EXCEPTION * err) - * $RETURNS$ - * previous_handlerproc previous math handler - * typedef int (* HB_MATH_HANDLERPROC)(HB_MATH_EXCEPTION * err) - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbmath.h - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_mathSetHandler() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Math + $ONELINER$ + set the harbour math handler + $SYNTAX$ + C Prototype + + #include "hbmath.h" + hb_mathSetHandler( HB_MATH_HANDLERPROC handlerproc ) + --> HB_MATH_HANDLERPROC previous_handerproc + $ARGUMENTS$ + handlerproc custom math handler + typedef int (* HB_MATH_HANDLERPROC)(HB_MATH_EXCEPTION * err) + $RETURNS$ + previous_handlerproc previous math handler + typedef int (* HB_MATH_HANDLERPROC)(HB_MATH_EXCEPTION * err) + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbmath.h + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_mathGetHandler() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Math - * $ONELINER$ - * get current Harbour math error handler - * $SYNTAX$ - * C Prototype - * - * #include "hbmath.h" - * hb_mathGetHandler( void ) --> HB_MATH_HANDLERPROC handlerproc - * $ARGUMENTS$ - * handlerproc custom math handler - * typedef int (* HB_MATH_HANDLERPROC)(HB_MATH_EXCEPTION * err) - * $RETURNS$ - * - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbmath.h - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_mathGetHandler() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Math + $ONELINER$ + get current Harbour math error handler + $SYNTAX$ + C Prototype + + #include "hbmath.h" + hb_mathGetHandler( void ) --> HB_MATH_HANDLERPROC handlerproc + $ARGUMENTS$ + handlerproc custom math handler + typedef int (* HB_MATH_HANDLERPROC)(HB_MATH_EXCEPTION * err) + $RETURNS$ + + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbmath.h + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_mathSetErrMode() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Math - * $ONELINER$ - * set math error handling mode - * $SYNTAX$ - * C Prototype - * - * #include "hbmath.h" - * hb_mathSetErrMode( int imode ) --> int ioldmode - * $ARGUMENTS$ - * imode math error handling mode, one of the following - * constants, defined in hbmath.ch: - * HB_MATH_ERRMODE_DEFAULT - * HB_MATH_ERRMODE_CDEFAULT - * HB_MATH_ERRMODE_USER - * HB_MATH_ERRMODE_USERDEFAULT - * HB_MATH_ERRMODE_USERCDEFAULT - * $RETURNS$ - * ioldmode old math error handling mode - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbmath.h - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_mathGetErrMode() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_mathSetErrMode() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Math + $ONELINER$ + set math error handling mode + $SYNTAX$ + C Prototype + + #include "hbmath.h" + hb_mathSetErrMode( int imode ) --> int ioldmode + $ARGUMENTS$ + imode math error handling mode, one of the following + constants, defined in hbmath.ch: + HB_MATH_ERRMODE_DEFAULT + HB_MATH_ERRMODE_CDEFAULT + HB_MATH_ERRMODE_USER + HB_MATH_ERRMODE_USERDEFAULT + HB_MATH_ERRMODE_USERCDEFAULT + $RETURNS$ + ioldmode old math error handling mode + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbmath.h + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + hb_mathGetErrMode() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_mathGetErrMode() - * $CATEGORY$ - * C level API - * $SUBCATEGORY$ - * Math - * $ONELINER$ - * get math error handling mode - * $SYNTAX$ - * C Prototype - * - * #include "hbmath.h" - * hb_mathGetErrMode( void ) --> imode - * $ARGUMENTS$ - * - * $RETURNS$ - * imode math error handling mode - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * NA - * $FILES$ - * Header file is hbmath.h - * Library is rtl - * $PLATFORMS$ - * All - * $SEEALSO$ - * hb_mathSetErrMode() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_mathGetErrMode() + $CATEGORY$ + C level API + $SUBCATEGORY$ + Math + $ONELINER$ + get math error handling mode + $SYNTAX$ + C Prototype + + #include "hbmath.h" + hb_mathGetErrMode( void ) --> imode + $ARGUMENTS$ + + $RETURNS$ + imode math error handling mode + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + NA + $FILES$ + Header file is hbmath.h + Library is rtl + $PLATFORMS$ + All + $SEEALSO$ + hb_mathSetErrMode() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_MATHERMODE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Math - * $ONELINER$ - * Set/Get math error handling mode - * $SYNTAX$ - * HB_MATHERMODE( [] ) --> - * $ARGUMENTS$ - * [] new math error handling mode, one of the following - * constants, defined in hbmath.ch: - * HB_MATH_ERRMODE_DEFAULT - * HB_MATH_ERRMODE_CDEFAULT - * HB_MATH_ERRMODE_USER - * HB_MATH_ERRMODE_USERDEFAULT - * HB_MATH_ERRMODE_USERCDEFAULT - * $RETURNS$ - * old math error handling mode - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $PLATFORMS$ - * All - * $FILES$ - * Header file is hbmath.ch - * Library is rtl - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_MATHERMODE() + $CATEGORY$ + API + $SUBCATEGORY$ + Math + $ONELINER$ + Set/Get math error handling mode + $SYNTAX$ + HB_MATHERMODE( [] ) --> + $ARGUMENTS$ + [] new math error handling mode, one of the following + constants, defined in hbmath.ch: + HB_MATH_ERRMODE_DEFAULT + HB_MATH_ERRMODE_CDEFAULT + HB_MATH_ERRMODE_USER + HB_MATH_ERRMODE_USERDEFAULT + HB_MATH_ERRMODE_USERCDEFAULT + $RETURNS$ + old math error handling mode + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $PLATFORMS$ + All + $FILES$ + Header file is hbmath.ch + Library is rtl + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_MATHERBLOCK() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Math - * $ONELINER$ - * Set/Get math error handling codeblock - * $SYNTAX$ - * HB_MATHERBLOCK( [] ) --> - * $ARGUMENTS$ - * - * $RETURNS$ - * is the current error handler codeblock - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_MATHERBLOCK() + $CATEGORY$ + API + $SUBCATEGORY$ + Math + $ONELINER$ + Set/Get math error handling codeblock + $SYNTAX$ + HB_MATHERBLOCK( [] ) --> + $ARGUMENTS$ + + $RETURNS$ + is the current error handler codeblock + $DESCRIPTION$ + + $EXAMPLES$ + + $STATUS$ + R + $COMPLIANCE$ + + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + + $END$ */ diff --git a/harbour/doc/en/memo.txt b/harbour/doc/en/memo.txt index f21a13a34d..88a12ba5c0 100644 --- a/harbour/doc/en/memo.txt +++ b/harbour/doc/en/memo.txt @@ -20,353 +20,353 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * MEMOTRAN() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Converts hard and soft carriage returns within strings. - * $SYNTAX$ - * MEMOTRAN( , , ) --> - * $ARGUMENTS$ - * is a string of chars to convert. - * - * is the character to replace hard returns with. If not - * specified defaults to semicolon. - * - * is the character to replace soft returns with. If not - * specified defaults to single space. - * $RETURNS$ - * Transformed string. - * $DESCRIPTION$ - * Returns a string/memo with carriage return chars converted to - * specified chars. - * $EXAMPLES$ - * ? MEMOTRAN( DATA->CNOTES ) - * $TESTS$ - * @ 1, 1 SAY MEMOTRAN( Data->CNOTES ) - * will display converted string starting on row two, column two of the - * current device. - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * HARDCR(),STRTRAN() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + MEMOTRAN() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Converts hard and soft carriage returns within strings. + $SYNTAX$ + MEMOTRAN( , , ) --> + $ARGUMENTS$ + is a string of chars to convert. + + is the character to replace hard returns with. If not + specified defaults to semicolon. + + is the character to replace soft returns with. If not + specified defaults to single space. + $RETURNS$ + Transformed string. + $DESCRIPTION$ + Returns a string/memo with carriage return chars converted to + specified chars. + $EXAMPLES$ + ? MEMOTRAN( DATA->CNOTES ) + $TESTS$ + @ 1, 1 SAY MEMOTRAN( Data->CNOTES ) + will display converted string starting on row two, column two of the + current device. + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + HARDCR(),STRTRAN() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HARDCR() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Replace all soft carriage returns with hard carriages returns. - * $SYNTAX$ - * HARDCR( ) --> - * $ARGUMENTS$ - * is a string of chars to convert. - * $RETURNS$ - * Transformed string. - * $DESCRIPTION$ - * Returns a string/memo with soft carriage return chars converted to - * hard carriage return chars. - * $EXAMPLES$ - * ? HARDCR( Data->CNOTES ) - * $TESTS$ - * @ 1, 1 SAY HARDCR( Data->CNOTES ) - * will display converted string starting on row two, column two of the - * current device. - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * MEMOTRAN(),STRTRAN() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HARDCR() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Replace all soft carriage returns with hard carriages returns. + $SYNTAX$ + HARDCR( ) --> + $ARGUMENTS$ + is a string of chars to convert. + $RETURNS$ + Transformed string. + $DESCRIPTION$ + Returns a string/memo with soft carriage return chars converted to + hard carriage return chars. + $EXAMPLES$ + ? HARDCR( Data->CNOTES ) + $TESTS$ + @ 1, 1 SAY HARDCR( Data->CNOTES ) + will display converted string starting on row two, column two of the + current device. + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + MEMOTRAN(),STRTRAN() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * MEMOREAD() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Return the text file's contents as a character string - * $SYNTAX$ - * MEMOREAD( ) --> cString - * $ARGUMENTS$ - * is the filename to read from disk. - * It must include the file extension. If file to be read - * lives in another directory, you must include the path. - * $RETURNS$ - * Returns the contents of a text file as a character string. - * - * If cannot be found or read MEMOREAD returns an empty - * string (""). - * $DESCRIPTION$ - * MEMOREAD() is a function that reads the content of a text file (till - * now) from disk (floppy, HD, CD-ROM, etc.) into a memory string. - * In that way you can manipulate as any character string or assigned - * to a memo field to be saved in a database. - * - * MEMOREAD() function is used together with MEMOEDIT() and MEMOWRIT() - * to get from disk text from several sources that would be edited, - * searched, replaced, displayed, etc. - * - * It is used to import data from other sources to our database. - * - * Note: - * MEMOREAD() does not use the settings SET DEFAULT or SET PATH to - * search for . - * It searches for in the current directory. - * - * Over a network, MEMOREAD() attempts to open in read-only - * mode and shared. If the file is used in mode exclusive by another - * process, the function will returns a null string (""). - * $EXAMPLES$ - * * This example uses MEMOREAD() to assign the contents of a text - * * file to a character variable for later search - * - * cFile := "account.prg" - * cString := MEMOREAD( cFile ) - * cCopyright := "Melina" - * - * IF At( "Melina", cString ) == 0 // check for copyright - * MEMOWRIT( cFile, cCopyright + cString ) // if not, add it! - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All(64K) - * $FILES$ - * Library is rtl - * $SEEALSO$ - * MEMOEDIT(),MEMOWRIT(),REPLACE,HB_MEMOREAD() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + MEMOREAD() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Return the text file's contents as a character string + $SYNTAX$ + MEMOREAD( ) --> cString + $ARGUMENTS$ + is the filename to read from disk. + It must include the file extension. If file to be read + lives in another directory, you must include the path. + $RETURNS$ + Returns the contents of a text file as a character string. + + If cannot be found or read MEMOREAD returns an empty + string (""). + $DESCRIPTION$ + MEMOREAD() is a function that reads the content of a text file (till + now) from disk (floppy, HD, CD-ROM, etc.) into a memory string. + In that way you can manipulate as any character string or assigned + to a memo field to be saved in a database. + + MEMOREAD() function is used together with MEMOEDIT() and MEMOWRIT() + to get from disk text from several sources that would be edited, + searched, replaced, displayed, etc. + + It is used to import data from other sources to our database. + + Note: + MEMOREAD() does not use the settings SET DEFAULT or SET PATH to + search for . + It searches for in the current directory. + + Over a network, MEMOREAD() attempts to open in read-only + mode and shared. If the file is used in mode exclusive by another + process, the function will returns a null string (""). + $EXAMPLES$ + * This example uses MEMOREAD() to assign the contents of a text + * file to a character variable for later search + + cFile := "account.prg" + cString := MEMOREAD( cFile ) + cCopyright := "Melina" + + IF At( "Melina", cString ) == 0 // check for copyright + MEMOWRIT( cFile, cCopyright + cString ) // if not, add it! + ENDIF + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All(64K) + $FILES$ + Library is rtl + $SEEALSO$ + MEMOEDIT(),MEMOWRIT(),REPLACE,HB_MEMOREAD() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_MEMOREAD() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Return the text file's contents as a character string - * $SYNTAX$ - * HB_MEMOREAD( ) --> cString - * $ARGUMENTS$ - * is the filename to read from disk. - * It must include the file extension. If file to be read - * lives in another directory, you must include the path. - * $RETURNS$ - * Returns the contents of a text file as a character string. - * - * If cannot be found or read HB_MEMOREAD returns an empty - * string (""). - * $DESCRIPTION$ - * HB_MEMOREAD() is a function that reads the content of a text file - * (till now) from disk (floppy, HD, CD-ROM, etc.) into a memory string. - * In that way you can manipulate as any character string or assigned - * to a memo field to be saved in a database. - * - * HB_MEMOREAD() function is used together with MEMOEDIT() and HB_MEMOWRIT() - * to get from disk text from several sources that would be edited, - * searched, replaced, displayed, etc. - * - * It is used to import data from other sources to our database. - * - * Note: - * HB_MEMOREAD() does not use the settings SET DEFAULT or SET PATH to - * search for . - * It searches for in the current directory. - * - * Over a network, HB_MEMOREAD() attempts to open in read-only - * mode and shared. If the file is used in mode exclusive by another - * process, the function will returns a null string (""). - * - * HB_MEMOREAD() vs MEMOREAD(): - * HB_MEMOREAD() is identical to MEMOREAD() except it won't truncate the - * last byte (on non-UNIX compatible systems) if it's a EOF char. - * $EXAMPLES$ - * * This example uses HB_MEMOREAD() to assign the contents of a text - * * file to a character variable for later search - * - * cFile := "account.prg" - * cString := HB_MEMOREAD( cFile ) - * cCopyright := "Melina" - * - * IF At( "Melina", cString ) == 0 // check for copyright - * HB_MEMOWRIT( cFile, cCopyright + cString ) // if not, add it! - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All(64K) - * $FILES$ - * Library is rtl - * $SEEALSO$ - * MEMOEDIT(),HB_MEMOWRIT(),REPLACE,MEMOREAD() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_MEMOREAD() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Return the text file's contents as a character string + $SYNTAX$ + HB_MEMOREAD( ) --> cString + $ARGUMENTS$ + is the filename to read from disk. + It must include the file extension. If file to be read + lives in another directory, you must include the path. + $RETURNS$ + Returns the contents of a text file as a character string. + + If cannot be found or read HB_MEMOREAD returns an empty + string (""). + $DESCRIPTION$ + HB_MEMOREAD() is a function that reads the content of a text file + (till now) from disk (floppy, HD, CD-ROM, etc.) into a memory string. + In that way you can manipulate as any character string or assigned + to a memo field to be saved in a database. + + HB_MEMOREAD() function is used together with MEMOEDIT() and HB_MEMOWRIT() + to get from disk text from several sources that would be edited, + searched, replaced, displayed, etc. + + It is used to import data from other sources to our database. + + Note: + HB_MEMOREAD() does not use the settings SET DEFAULT or SET PATH to + search for . + It searches for in the current directory. + + Over a network, HB_MEMOREAD() attempts to open in read-only + mode and shared. If the file is used in mode exclusive by another + process, the function will returns a null string (""). + + HB_MEMOREAD() vs MEMOREAD(): + HB_MEMOREAD() is identical to MEMOREAD() except it won't truncate the + last byte (on non-UNIX compatible systems) if it's a EOF char. + $EXAMPLES$ + * This example uses HB_MEMOREAD() to assign the contents of a text + * file to a character variable for later search + + cFile := "account.prg" + cString := HB_MEMOREAD( cFile ) + cCopyright := "Melina" + + IF At( "Melina", cString ) == 0 // check for copyright + HB_MEMOWRIT( cFile, cCopyright + cString ) // if not, add it! + ENDIF + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All(64K) + $FILES$ + Library is rtl + $SEEALSO$ + MEMOEDIT(),HB_MEMOWRIT(),REPLACE,MEMOREAD() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * MEMOWRIT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Write a memo field or character string to a text file on disk - * $SYNTAX$ - * MEMOWRIT( , ) --> lSuccess - * $ARGUMENTS$ - * is the filename to read from disk. - * It must include the file extension. If file to be read - * lives in another directory, you must include the path. - * - * Is the memo field or character string, to be write to - * . - * $RETURNS$ - * Function returns true (.T.) if the writing operation was successful; - * otherwise, it returns false (.F.). - * $DESCRIPTION$ - * This a function that writes a memo field or character string to a - * text file on disk (floppy, HD, CD-ROM, etc.) - * If you not specified a path, MEMOWRIT() writes to the - * current directory. If exists, it is overwritten. - * - * There is a third parameter (optional), , (not found in - * CA-Cl*pper) which let to programmer change the default behavior of - * - always - to write the EOF character, CHR(26) as in CA-Cl*pper. - * - * MEMOWRIT() function is used together with MEMOREAD() and MEMOEDIT() - * to save to disk text from several sources that was edited, searched, - * replaced, displayed, etc. - * - * Note that MEMOWRIT() do not use the directory settings SET DEFAULT. - * $EXAMPLES$ - * * This example uses MEMOWRIT() to write the contents of a character - * variable to a text file. - * - * cFile := "account.prg" - * cString := MEMOREAD( cFile ) - * - * IF At( "Melina", cString ) == 0 // check for copyright - * MEMOWRIT( cFile, cCopyright + cString ) // if not, add it! - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * MEMOEDIT(),MEMOREAD(),HB_MEMOWRIT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + MEMOWRIT() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Write a memo field or character string to a text file on disk + $SYNTAX$ + MEMOWRIT( , ) --> lSuccess + $ARGUMENTS$ + is the filename to read from disk. + It must include the file extension. If file to be read + lives in another directory, you must include the path. + + Is the memo field or character string, to be write to + . + $RETURNS$ + Function returns true (.T.) if the writing operation was successful; + otherwise, it returns false (.F.). + $DESCRIPTION$ + This a function that writes a memo field or character string to a + text file on disk (floppy, HD, CD-ROM, etc.) + If you not specified a path, MEMOWRIT() writes to the + current directory. If exists, it is overwritten. + + There is a third parameter (optional), , (not found in + CA-Cl*pper) which let to programmer change the default behavior of + - always - to write the EOF character, CHR(26) as in CA-Cl*pper. + + MEMOWRIT() function is used together with MEMOREAD() and MEMOEDIT() + to save to disk text from several sources that was edited, searched, + replaced, displayed, etc. + + Note that MEMOWRIT() do not use the directory settings SET DEFAULT. + $EXAMPLES$ + * This example uses MEMOWRIT() to write the contents of a character + variable to a text file. + + cFile := "account.prg" + cString := MEMOREAD( cFile ) + + IF At( "Melina", cString ) == 0 // check for copyright + MEMOWRIT( cFile, cCopyright + cString ) // if not, add it! + ENDIF + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + MEMOEDIT(),MEMOREAD(),HB_MEMOWRIT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_MEMOWRIT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Write a memo field or character string to a text file on disk - * $SYNTAX$ - * HB_MEMOWRIT( , , [] ) --> lSuccess - * $ARGUMENTS$ - * is the filename to read from disk. - * It must include the file extension. If file to be read - * lives in another directory, you must include the path. - * - * Is the memo field or character string, to be write to - * . - * - * Is a logic variable that settle if the "end of file" - * character - CHR( 26 ) - is written to disk. - * This parameter is optional. By default is true (.T.) - * $RETURNS$ - * Function returns true (.T.) if the writing operation was successful; - * otherwise, it returns false (.F.). - * $DESCRIPTION$ - * This a function that writes a memo field or character string to a - * text file on disk (floppy, HD, CD-ROM, etc.) - * If you not specified a path, HB_MEMOWRIT() writes to the - * current directory. If exists, it is overwritten. - * - * There is a third parameter (optional), , (not found in - * CA-Cl*pper) which let to programmer change the default behavior of - * - always - to write the EOF character, CHR( 26 ) as in CA-Cl*pper. - * - * If there is no third parameter, nothing change, EOF is written as - * in CA-Cl*pper, the same occurs when is set to .T. - * But, if is set to .F., EOF char is Not written to the - * end of the file. - * - * HB_MEMOWRIT() function is used together with HB_MEMOREAD() and - * MEMOEDIT() to save to disk text from several sources that was edited, - * searched, replaced, displayed, etc. - * - * Note that HB_MEMOWRIT() do not use the directory settings SET DEFAULT. - * - * HB_MEMOWRIT() vs MEMOWRIT(): - * HB_MEMOWRIT() never writes the obsolete EOF char at the end of the file. - * $EXAMPLES$ - * * This example uses HB_MEMOWRIT() to write the contents of a character - * * variable to a text file. - * - * cFile := "account.prg" - * cString := HB_MEMOREAD( cFile ) - * cCopyright := "Melina" - * - * IF At( "Melina", cString ) == 0 // check for copyright - * HB_MEMOWRIT( cFile, cCopyright + cString ) // if not, add it! - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * MEMOEDIT(),MEMOREAD(),HB_MEMOWRIT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_MEMOWRIT() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Write a memo field or character string to a text file on disk + $SYNTAX$ + HB_MEMOWRIT( , , [] ) --> lSuccess + $ARGUMENTS$ + is the filename to read from disk. + It must include the file extension. If file to be read + lives in another directory, you must include the path. + + Is the memo field or character string, to be write to + . + + Is a logic variable that settle if the "end of file" + character - CHR( 26 ) - is written to disk. + This parameter is optional. By default is true (.T.) + $RETURNS$ + Function returns true (.T.) if the writing operation was successful; + otherwise, it returns false (.F.). + $DESCRIPTION$ + This a function that writes a memo field or character string to a + text file on disk (floppy, HD, CD-ROM, etc.) + If you not specified a path, HB_MEMOWRIT() writes to the + current directory. If exists, it is overwritten. + + There is a third parameter (optional), , (not found in + CA-Cl*pper) which let to programmer change the default behavior of + - always - to write the EOF character, CHR( 26 ) as in CA-Cl*pper. + + If there is no third parameter, nothing change, EOF is written as + in CA-Cl*pper, the same occurs when is set to .T. + But, if is set to .F., EOF char is Not written to the + end of the file. + + HB_MEMOWRIT() function is used together with HB_MEMOREAD() and + MEMOEDIT() to save to disk text from several sources that was edited, + searched, replaced, displayed, etc. + + Note that HB_MEMOWRIT() do not use the directory settings SET DEFAULT. + + HB_MEMOWRIT() vs MEMOWRIT(): + HB_MEMOWRIT() never writes the obsolete EOF char at the end of the file. + $EXAMPLES$ + * This example uses HB_MEMOWRIT() to write the contents of a character + * variable to a text file. + + cFile := "account.prg" + cString := HB_MEMOREAD( cFile ) + cCopyright := "Melina" + + IF At( "Melina", cString ) == 0 // check for copyright + HB_MEMOWRIT( cFile, cCopyright + cString ) // if not, add it! + ENDIF + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + MEMOEDIT(),MEMOREAD(),HB_MEMOWRIT() + $END$ */ diff --git a/harbour/doc/en/memvar2.txt b/harbour/doc/en/memvar2.txt index dc90418ceb..3febd2b8a4 100644 --- a/harbour/doc/en/memvar2.txt +++ b/harbour/doc/en/memvar2.txt @@ -2,175 +2,174 @@ * $Id$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * FIELD - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * Declares a list of database field names. - * $SYNTAX$ - * FIELD [, [in ] - * $ARGUMENTS$ - * A valid field name - * - * Additional field name - * - * An valid alias name - * $DESCRIPTION$ - * This command declares the names of fields (and and - * following) with an optional alias identifier as for each. - * This command allow Harbour to resolve any reference to a field - * specified in the field list by viewing it as a field when it is not - * referenced by an alias. If a field is not listed in this list and it - * is not explicity tagged with an alias indentifier, it may be viewed - * as a memory variable, which may cause run-time errors. This command - * has no effect on memory variables or on field reference buried within - * a macro expression. - * $EXAMPLES$ - * PROCEDURE Main() - * FIELD Id - * FIELD Name - * USE tests NEW - * Name := "Sales" - * Id := 5 - * USE - * RETURN - * $TESTS$ - * See tests/testwarn.prg - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * None. - * $SEEALSO$ - * MEMVAR,PRIVATE,PUBLIC,STATIC - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + FIELD + $CATEGORY$ + Command + $SUBCATEGORY$ + RDD + $ONELINER$ + Declares a list of database field names. + $SYNTAX$ + FIELD [, [in ] + $ARGUMENTS$ + A valid field name + + Additional field name + + An valid alias name + $DESCRIPTION$ + This command declares the names of fields (and and + following) with an optional alias identifier as for each. + This command allow Harbour to resolve any reference to a field + specified in the field list by viewing it as a field when it is not + referenced by an alias. If a field is not listed in this list and it + is not explicity tagged with an alias indentifier, it may be viewed + as a memory variable, which may cause run-time errors. This command + has no effect on memory variables or on field reference buried within + a macro expression. + $EXAMPLES$ + PROCEDURE Main() + FIELD Id + FIELD Name + USE tests NEW + Name := "Sales" + Id := 5 + USE + RETURN + $TESTS$ + See tests/testwarn.prg + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + None. + $SEEALSO$ + MEMVAR,PRIVATE,PUBLIC,STATIC + $END$ */ - -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * LOCAL - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Variable management - * $ONELINER$ - * Initializes a local memory variable or array - * $SYNTAX$ - * LOCAL [:= ] - * $ARGUMENTS$ - * Name of a memory variable or array. - * - * Value to be assinged to a variable or array - * $DESCRIPTION$ - * This command created a LOCAL memory variable or array. The name - * of either is specified in . If more then one variable is being - * initialized with the LOCAL command,separate each entry with a comma. - * If a variable or an array is to be assingned a start-up value,that - * expression may be specified in and folling. Is Strong type - * compile mode is used, the Compiler will check if the value recived - * matchs the type specified in . - * - * LOCAL varibles are symbols generated at run time and are resolved - * at compile time. The visibility and life span of a LOCAL variable or - * array is limited to the function or procedure in which it is defined. - * - * No macro expansions are allowed in the LOCAL declaration statement. - * - * No Harbour command other then FUNCTION, PROCEDURE, PUBLIC, PRIVATE, - * PARAMETERS, MEMVAR, STATIC and FIELD, may precede the LOCAL command. - * - * LOCAL array reference may not be initialized (i.e., assigned values) - * on the same command line as the LOCAL command statement. This can be - * done later in the program. - * - * LOCAL variables and arrays are not affected by the RELEASE command. - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL n, lVar - * - * n := iif( lVar, "A", 3 ) - * n := 2 - * n := "a" - * n := seconds() + 2 - * n := int( seconds() + 2 ) - * RETURN - * $TESTS$ - * See tests/testwarn.prg for more examples - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * None - * $SEEALSO$ - * FIELD,PRIVATE,PUBLIC,STATIC,MEMVAR - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + LOCAL + $CATEGORY$ + Command + $SUBCATEGORY$ + Variable management + $ONELINER$ + Initializes a local memory variable or array + $SYNTAX$ + LOCAL [:= ] + $ARGUMENTS$ + Name of a memory variable or array. + + Value to be assinged to a variable or array + $DESCRIPTION$ + This command created a LOCAL memory variable or array. The name + of either is specified in . If more then one variable is being + initialized with the LOCAL command,separate each entry with a comma. + If a variable or an array is to be assingned a start-up value,that + expression may be specified in and folling. Is Strong type + compile mode is used, the Compiler will check if the value recived + matchs the type specified in . + + LOCAL varibles are symbols generated at run time and are resolved + at compile time. The visibility and life span of a LOCAL variable or + array is limited to the function or procedure in which it is defined. + + No macro expansions are allowed in the LOCAL declaration statement. + + No Harbour command other then FUNCTION, PROCEDURE, PUBLIC, PRIVATE, + PARAMETERS, MEMVAR, STATIC and FIELD, may precede the LOCAL command. + + LOCAL array reference may not be initialized (i.e., assigned values) + on the same command line as the LOCAL command statement. This can be + done later in the program. + + LOCAL variables and arrays are not affected by the RELEASE command. + $EXAMPLES$ + PROCEDURE Main() + LOCAL n, lVar + + n := iif( lVar, "A", 3 ) + n := 2 + n := "a" + n := seconds() + 2 + n := int( seconds() + 2 ) + RETURN + $TESTS$ + See tests/testwarn.prg for more examples + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + None + $SEEALSO$ + FIELD,PRIVATE,PUBLIC,STATIC,MEMVAR + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * MEMVAR - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Variable management - * $ONELINER$ - * Declares private and public variables and arrays. - * $SYNTAX$ - * MEMVAR - * $ARGUMENTS$ - * Memory variable Name - * $DESCRIPTION$ - * This command tells the compiler to resolve any reference to a memory - * variable designated within this list s if it possessed an explicit - * memory variable alias with either the M-> or MEMVAR-> prefix.Only - * those memory variables that do not contain any such explicit are - * affected by this command. Those memory variabls within macro - * expansions are not affected by this command. - * - * The MEMVAR declaration must apear before any executable commands;it - * is similat to the LOCAL,STATIC,FIELD,PARAMETERS,FUNCTION, and - * PROCEDURE commands statements. - * $EXAMPLES$ - * MEMVAR y AS NUMERIC - * PROCEDURE Main() - * LOCAL n, lVar - * - * n := iif( lVar, "A", 3 ) - * n := 2 - * n := "a" - * n := seconds() + 2 - * n := int( seconds() + 2 ) - * y := n - * ? y - * RETURN - * $TESTS$ - * See tests/testwarn.prg for more examples - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * None. - * $SEEALSO$ - * LOCAL,STATIC,FIELD,PRIVATE,PUBLIC - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + MEMVAR + $CATEGORY$ + Command + $SUBCATEGORY$ + Variable management + $ONELINER$ + Declares private and public variables and arrays. + $SYNTAX$ + MEMVAR + $ARGUMENTS$ + Memory variable Name + $DESCRIPTION$ + This command tells the compiler to resolve any reference to a memory + variable designated within this list s if it possessed an explicit + memory variable alias with either the M-> or MEMVAR-> prefix.Only + those memory variables that do not contain any such explicit are + affected by this command. Those memory variabls within macro + expansions are not affected by this command. + + The MEMVAR declaration must apear before any executable commands;it + is similat to the LOCAL,STATIC,FIELD,PARAMETERS,FUNCTION, and + PROCEDURE commands statements. + $EXAMPLES$ + MEMVAR y AS NUMERIC + PROCEDURE Main() + LOCAL n, lVar + + n := iif( lVar, "A", 3 ) + n := 2 + n := "a" + n := seconds() + 2 + n := int( seconds() + 2 ) + y := n + ? y + RETURN + $TESTS$ + See tests/testwarn.prg for more examples + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + None. + $SEEALSO$ + LOCAL,STATIC,FIELD,PRIVATE,PUBLIC + $END$ */ diff --git a/harbour/doc/en/menu.txt b/harbour/doc/en/menu.txt index 66d8612fc6..3ab1e1c8d0 100644 --- a/harbour/doc/en/menu.txt +++ b/harbour/doc/en/menu.txt @@ -13,387 +13,387 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ACHOICE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Allows selection of an element from an array - * $SYNTAX$ - * ACHOICE(, , , , , [ | ], [ | ], [], []) --> nPosition - * $ARGUMENTS$ - * - topmost row used to display array (default 0) - * - * - leftmost row used to display array (default 0) - * - * - bottommost row used to display array (default MaxRow()) - * - * - rightmost row used to display array (default MaxCol()) - * - * - the character array of items from which to select - * - * - an array of items, either logical or character, - * which is used to determine if a particular item - * may be selected. If the type of a given item is - * character, it is macro evaluated, and the result - * is expected to be a logical. A value of .T. means - * that the item may be selected, .F. that it may not. - * (See next argument: lSelectableItems) - * - * - a logical value which is used to apply to all - * items in acMenuItems. If .T., all items may be - * selected; if .F., none may be selected. - * (See previous argument: alSelectableItems) - * Default .T. - * - * - the name of a function to be called which may - * affect special processing of keystrokes. It is - * specified without parentheses or parameters. - * When it is called, it will be supplied with the - * parameters: nMode, nCurElement, and nRowPos. - * Default NIL. - * - * - a codeblock to be called which may - * affect special processing of keystrokes. It - * should be specified in the form - * {| nMode, nCurElemenet, nRowPos | ; - * MyFunc( nMode, nCurElemenet, nRowPos ) }. - * Default NIL. - * - * - the number of the element to be highlighted as - * the current item when the array is initially - * displayed. 1 origin. Default 1. - * - * - the number of the window row on which the initial - * item is to be displayed. 0 origin. Default 0. - * $RETURNS$ - * - the number of the item to be selected, or 0 if the - * selection was aborted. - * $DESCRIPTION$ - * Allows selection of an element from an array. - * Please see standard CA-Cl*pper documentation for ACHOICE for - * additional detail. - * $EXAMPLES$ - * aItems := { "One", "Two", "Three" } - * nChoice := AChoice( 10, 10, 20, 20, aItems ) - * IF nChoice == 0 - * ? "You did not choose an item" - * ELSE - * ? "You chose element " + hb_ntos( nChoice ) - * ?? " which has a value of " + aItems[ nChoice ] - * ENDIF - * $FILES$ - * Library is rtl - * $COMPLIANCE$ - * C - * $SEEALSO$ - * MENU TO - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ACHOICE() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Allows selection of an element from an array + $SYNTAX$ + ACHOICE(, , , , , [ | ], [ | ], [], []) --> nPosition + $ARGUMENTS$ + - topmost row used to display array (default 0) + + - leftmost row used to display array (default 0) + + - bottommost row used to display array (default MaxRow()) + + - rightmost row used to display array (default MaxCol()) + + - the character array of items from which to select + + - an array of items, either logical or character, + which is used to determine if a particular item + may be selected. If the type of a given item is + character, it is macro evaluated, and the result + is expected to be a logical. A value of .T. means + that the item may be selected, .F. that it may not. + (See next argument: lSelectableItems) + + - a logical value which is used to apply to all + items in acMenuItems. If .T., all items may be + selected; if .F., none may be selected. + (See previous argument: alSelectableItems) + Default .T. + + - the name of a function to be called which may + affect special processing of keystrokes. It is + specified without parentheses or parameters. + When it is called, it will be supplied with the + parameters: nMode, nCurElement, and nRowPos. + Default NIL. + + - a codeblock to be called which may + affect special processing of keystrokes. It + should be specified in the form + {| nMode, nCurElemenet, nRowPos | ; + MyFunc( nMode, nCurElemenet, nRowPos ) }. + Default NIL. + + - the number of the element to be highlighted as + the current item when the array is initially + displayed. 1 origin. Default 1. + + - the number of the window row on which the initial + item is to be displayed. 0 origin. Default 0. + $RETURNS$ + - the number of the item to be selected, or 0 if the + selection was aborted. + $DESCRIPTION$ + Allows selection of an element from an array. + Please see standard CA-Cl*pper documentation for ACHOICE for + additional detail. + $EXAMPLES$ + aItems := { "One", "Two", "Three" } + nChoice := AChoice( 10, 10, 20, 20, aItems ) + IF nChoice == 0 + ? "You did not choose an item" + ELSE + ? "You chose element " + hb_ntos( nChoice ) + ?? " which has a value of " + aItems[ nChoice ] + ENDIF + $FILES$ + Library is rtl + $COMPLIANCE$ + C + $SEEALSO$ + MENU TO + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __AtPrompt() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Display a menu item on screen and define a message - * $SYNTAX$ - * __AtPrompt( , , , [] ) --> .F. - * $ARGUMENTS$ - * is the row number to display the menu . Value could - * range from zero to MaxRow(). - * - * is the column number to display the menu . Value - * could range from zero to MaxCol(). - * - * is the menu item character string to display. - * - * define a message to display each time this menu item is - * highlighted. could be a character string or code block that - * is evaluated to a character string. If is not specified or - * of the wrong type, an empty string ("") would be used. - * $RETURNS$ - * __AtPrompt() always return .F. - * $DESCRIPTION$ - * With __AtPrompt() you define and display a menu item, each call to - * __AtPrompt() add another item to the menu, to start the menu itself - * you should call the __MenuTo() function (MENU TO command). You can - * define any row and column combination and they will be displayed at - * the order of definition. After each call to __AtPrompt(), the cursor - * is placed one column to the right of the last text displayed, and - * ROW() and COL() are updated. - * - * @...PROMPT command is preprocessed into __AtPrompt() function during - * compile time. - * $EXAMPLES$ - * // display a two line menu with status line at the bottom - * // let the user select favorite day - * SET MESSAGE TO 24 CENTER - * @ 10, 2 PROMPT "Sunday" MESSAGE "This is the 1st item" - * @ 11, 2 PROMPT "Monday" MESSAGE "Now we're on the 2nd item" - * MENU TO nChoice - * DO CASE - * CASE nChoice == 0 // user press Esc key - * QUIT - * CASE nChoice == 1 // user select 1st menu item - * ? "Guess you don't like Mondays" - * CASE nChoice == 2 // user select 2nd menu item - * ? "Just another day for some" - * ENDCASE - * $STATUS$ - * R - * $COMPLIANCE$ - * C(menu) - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ACHOICE(),MENU TO,SET MESSAGE,SET INTENSITY,SET WRAP,__MENUTO() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __AtPrompt() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Display a menu item on screen and define a message + $SYNTAX$ + __AtPrompt( , , , [] ) --> .F. + $ARGUMENTS$ + is the row number to display the menu . Value could + range from zero to MaxRow(). + + is the column number to display the menu . Value + could range from zero to MaxCol(). + + is the menu item character string to display. + + define a message to display each time this menu item is + highlighted. could be a character string or code block that + is evaluated to a character string. If is not specified or + of the wrong type, an empty string ("") would be used. + $RETURNS$ + __AtPrompt() always return .F. + $DESCRIPTION$ + With __AtPrompt() you define and display a menu item, each call to + __AtPrompt() add another item to the menu, to start the menu itself + you should call the __MenuTo() function (MENU TO command). You can + define any row and column combination and they will be displayed at + the order of definition. After each call to __AtPrompt(), the cursor + is placed one column to the right of the last text displayed, and + ROW() and COL() are updated. + + @...PROMPT command is preprocessed into __AtPrompt() function during + compile time. + $EXAMPLES$ + // display a two line menu with status line at the bottom + // let the user select favorite day + SET MESSAGE TO 24 CENTER + @ 10, 2 PROMPT "Sunday" MESSAGE "This is the 1st item" + @ 11, 2 PROMPT "Monday" MESSAGE "Now we're on the 2nd item" + MENU TO nChoice + DO CASE + CASE nChoice == 0 // user press Esc key + QUIT + CASE nChoice == 1 // user select 1st menu item + ? "Guess you don't like Mondays" + CASE nChoice == 2 // user select 2nd menu item + ? "Just another day for some" + ENDCASE + $STATUS$ + R + $COMPLIANCE$ + C(menu) + $FILES$ + Library is rtl + $SEEALSO$ + ACHOICE(),MENU TO,SET MESSAGE,SET INTENSITY,SET WRAP,__MENUTO() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * @...PROMPT - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Display a menu item on screen and define a message - * $SYNTAX$ - * @ , PROMPT [MESSAGE ] - * $ARGUMENTS$ - * is the row number to display the menu . Value could - * range from zero to MaxRow(). - * - * is the column number to display the menu . Value - * could range from zero to MaxCol(). - * - * is the menu item character string to display. - * - * define a message to display each time this menu item is - * highlighted. could be a character string or code block that - * is evaluated to a character string. If is not specified or - * of the wrong type, an empty string ("") would be used. - * $DESCRIPTION$ - * With @...Prompt you define and display a menu item, each call to - * @...Prompt add another item to the menu, to start the menu itself - * you should call the __MenuTo() function (MENU TO command). You can - * define any row and column combination and they will be displayed at - * the order of definition. After each call to @...Prompt, the cursor - * is placed one column to the right of the last text displayed, and - * ROW() and COL() are updated. - * - * @...PROMPT command is preprocessed into __AtPrompt() function during - * compile time. - * $EXAMPLES$ - * // display a two line menu with status line at the bottom - * // let the user select favorite day - * SET MESSAGE TO 24 CENTER - * @ 10, 2 PROMPT "Sunday" MESSAGE "This is the 1st item" - * @ 11, 2 PROMPT "Monday" MESSAGE "Now we're on the 2nd item" - * MENU TO nChoice - * DO CASE - * CASE nChoice == 0 // user press Esc key - * QUIT - * CASE nChoice == 1 // user select 1st menu item - * ? "Guess you don't like Mondays" - * CASE nChoice == 2 // user select 2nd menu item - * ? "Just another day for some" - * ENDCASE - * $STATUS$ - * R - * $COMPLIANCE$ - * C(menu) - * $SEEALSO$ - * ACHOICE(),MENU TO,SET MESSAGE,SET INTENSITY,SET WRAP,__MENUTO() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + @...PROMPT + $CATEGORY$ + Command + $SUBCATEGORY$ + User interface + $ONELINER$ + Display a menu item on screen and define a message + $SYNTAX$ + @ , PROMPT [MESSAGE ] + $ARGUMENTS$ + is the row number to display the menu . Value could + range from zero to MaxRow(). + + is the column number to display the menu . Value + could range from zero to MaxCol(). + + is the menu item character string to display. + + define a message to display each time this menu item is + highlighted. could be a character string or code block that + is evaluated to a character string. If is not specified or + of the wrong type, an empty string ("") would be used. + $DESCRIPTION$ + With @...Prompt you define and display a menu item, each call to + @...Prompt add another item to the menu, to start the menu itself + you should call the __MenuTo() function (MENU TO command). You can + define any row and column combination and they will be displayed at + the order of definition. After each call to @...Prompt, the cursor + is placed one column to the right of the last text displayed, and + ROW() and COL() are updated. + + @...PROMPT command is preprocessed into __AtPrompt() function during + compile time. + $EXAMPLES$ + // display a two line menu with status line at the bottom + // let the user select favorite day + SET MESSAGE TO 24 CENTER + @ 10, 2 PROMPT "Sunday" MESSAGE "This is the 1st item" + @ 11, 2 PROMPT "Monday" MESSAGE "Now we're on the 2nd item" + MENU TO nChoice + DO CASE + CASE nChoice == 0 // user press Esc key + QUIT + CASE nChoice == 1 // user select 1st menu item + ? "Guess you don't like Mondays" + CASE nChoice == 2 // user select 2nd menu item + ? "Just another day for some" + ENDCASE + $STATUS$ + R + $COMPLIANCE$ + C(menu) + $SEEALSO$ + ACHOICE(),MENU TO,SET MESSAGE,SET INTENSITY,SET WRAP,__MENUTO() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __MenuTo() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Invoked a menu defined by set of @...PROMPT - * $SYNTAX$ - * __MenuTo( , ) --> nChoice - * $ARGUMENTS$ - * is a set/get code block for variable named . - * - * is a character string that contain the name of the - * variable to hold the menu choices, if this variable does not exist - * a PRIVATE variable with the name would be created to - * hold the result. - * $RETURNS$ - * __MenuTo() return the number of select menu item, or 0 if there was - * no item to select from or if the user pressed the Esc key. - * $DESCRIPTION$ - * __MenuTo() invoked the menu define by previous __AtPrompt() call - * and display a highlight bar that the user can move to select an - * option from the menu. If does not exist or not visible, - * a PRIVATE variable named is created and hold the current - * menu selection. If there is a variable named , its value - * is used to select the first highlighted item. - * - * Menu prompts and messages are displayed in current Standard color, - * highlighted bar is displayed using current Enhanced color. - * - * Pressing the arrow keys move the highlighted bar. When a menu item - * is highlighted the message associated with it is displayed on the - * line specified with SET MESSAGE. If SET WRAP is ON and the user - * press UP arrow while on the first selection the last menu item is - * highlighted, if the user press Down arrow while on the last item, - * the first item is highlighted. - * - * Following are active keys that handled by __MenuTo(): - * - * - * - * key Meaning - * - * Up Move to previous item - * Down Move to next item - * Left Move to previous item - * Right Move to next item - * Home Move to the first item - * End Move to the last item - * Page-Up Select menu item, return position - * Page-Down Select menu item, return position - * Enter Select menu item, return position - * Esc Abort selection, return 0 - * First letter Select next menu with the same first letter, - * | return this item position. - *
- * upon exit the cursor is placed at MaxRow()-1, 0 - * __MenuTo() can be nested without loosing the previous prompts. - * - * MENU TO command is preprocessed into __MenuTo() function during - * compile time. - * $EXAMPLES$ - * // display menu item on each screen corner and let user select one - * CLS - * SET MESSAGE TO MaxRow() / 2 CENTER - * SET WRAP ON - * @ 0 , 0 PROMPT "1. Upper left" MESSAGE " One " - * @ 0 , MaxCol()-16 PROMPT "2. Upper right" MESSAGE " Two " - * @ MaxRow() - 1, MaxCol()-16 PROMPT "3. Bottom right" MESSAGE "Three" - * @ MaxRow() - 1, 0 PROMPT "4. Bottom left" MESSAGE "Four " - * MENU TO nChoice - * SetPos( MaxRow() / 2, MaxCol() / 2 - 10 ) - * IF nChoice == 0 - * ?? "Esc was pressed" - * ELSE - * ?? "Selected option is", nChoice - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * @...PROMPT,ACHOICE(),SET MESSAGE,SET INTENSITY,SET WRAP,__ATPROMPT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __MenuTo() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Invoked a menu defined by set of @...PROMPT + $SYNTAX$ + __MenuTo( , ) --> nChoice + $ARGUMENTS$ + is a set/get code block for variable named . + + is a character string that contain the name of the + variable to hold the menu choices, if this variable does not exist + a PRIVATE variable with the name would be created to + hold the result. + $RETURNS$ + __MenuTo() return the number of select menu item, or 0 if there was + no item to select from or if the user pressed the Esc key. + $DESCRIPTION$ + __MenuTo() invoked the menu define by previous __AtPrompt() call + and display a highlight bar that the user can move to select an + option from the menu. If does not exist or not visible, + a PRIVATE variable named is created and hold the current + menu selection. If there is a variable named , its value + is used to select the first highlighted item. + + Menu prompts and messages are displayed in current Standard color, + highlighted bar is displayed using current Enhanced color. + + Pressing the arrow keys move the highlighted bar. When a menu item + is highlighted the message associated with it is displayed on the + line specified with SET MESSAGE. If SET WRAP is ON and the user + press UP arrow while on the first selection the last menu item is + highlighted, if the user press Down arrow while on the last item, + the first item is highlighted. + + Following are active keys that handled by __MenuTo(): + + + + key Meaning + + Up Move to previous item + Down Move to next item + Left Move to previous item + Right Move to next item + Home Move to the first item + End Move to the last item + Page-Up Select menu item, return position + Page-Down Select menu item, return position + Enter Select menu item, return position + Esc Abort selection, return 0 + First letter Select next menu with the same first letter, + | return this item position. +
+ upon exit the cursor is placed at MaxRow()-1, 0 + __MenuTo() can be nested without loosing the previous prompts. + + MENU TO command is preprocessed into __MenuTo() function during + compile time. + $EXAMPLES$ + // display menu item on each screen corner and let user select one + CLS + SET MESSAGE TO MaxRow() / 2 CENTER + SET WRAP ON + @ 0 , 0 PROMPT "1. Upper left" MESSAGE " One " + @ 0 , MaxCol()-16 PROMPT "2. Upper right" MESSAGE " Two " + @ MaxRow() - 1, MaxCol()-16 PROMPT "3. Bottom right" MESSAGE "Three" + @ MaxRow() - 1, 0 PROMPT "4. Bottom left" MESSAGE "Four " + MENU TO nChoice + SetPos( MaxRow() / 2, MaxCol() / 2 - 10 ) + IF nChoice == 0 + ?? "Esc was pressed" + ELSE + ?? "Selected option is", nChoice + ENDIF + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + @...PROMPT,ACHOICE(),SET MESSAGE,SET INTENSITY,SET WRAP,__ATPROMPT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * MENU TO - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Invoked a menu defined by set of @...PROMPT - * $SYNTAX$ - * MENU TO - * $ARGUMENTS$ - * is a character string that contain the name of the - * variable to hold the menu choices, if this variable does not exist - * a PRIVATE variable with the name would be created to - * hold the result. - * $DESCRIPTION$ - * Menu To() invoked the menu define by previous __AtPrompt() call - * and display a highlight bar that the user can move to select an - * option from the menu. If does not exist or not visible, - * a PRIVATE variable named is created and hold the current - * menu selection. If there is a variable named , its value - * is used to select the first highlighted item. - * - * Menu prompts and messages are displayed in current Standard color, - * highlighted bar is displayed using current Enhanced color. - * - * Pressing the arrow keys move the highlighted bar. When a menu item - * is highlighted the message associated with it is displayed on the - * line specified with SET MESSAGE. If SET WRAP is ON and the user - * press UP arrow while on the first selection the last menu item is - * highlighted, if the user press Down arrow while on the last item, - * the first item is highlighted. - * - * Following are active keys that handled by Menu To: - * - * - * key Meaning - * - * Up - Move to previous item - * Down - Move to next item - * Left - Move to previous item - * Right - Move to next item - * Home - Move to the first item - * End - Move to the last item - * Page-Up - Select menu item, return position - * Page-Down - Select menu item, return position - * Enter - Select menu item, return position - * Esc - Abort selection, return 0 - * First letter - Select next menu with the same first letter, - * | return this item position. - *
- * upon exit the cursor is placed at MaxRow()-1, 0 - * Menu To can be nested without loosing the previous prompts. - * - * MENU TO command is preprocessed into __MenuTo() function during - * compile time. - * $EXAMPLES$ - * // display menu item on each screen corner and let user select one - * CLS - * SET MESSAGE TO MaxRow() / 2 CENTER - * SET WRAP ON - * @ 0 , 0 PROMPT "1. Upper left" MESSAGE " One " - * @ 0 , MaxCol() - 16 PROMPT "2. Upper right" MESSAGE " Two " - * @ MaxRow() - 1, MaxCol() - 16 PROMPT "3. Bottom right" MESSAGE "Three" - * @ MaxRow() - 1, 0 PROMPT "4. Bottom left" MESSAGE "Four " - * MENU TO nChoice - * SetPos( MaxRow() / 2, MaxCol() / 2 - 10 ) - * IF nChoice == 0 - * ?? "Esc was pressed" - * ELSE - * ?? "Selected option is", nChoice - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * @...PROMPT,ACHOICE(),SET MESSAGE,SET INTENSITY,SET WRAP,__ATPROMPT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + MENU TO + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Invoked a menu defined by set of @...PROMPT + $SYNTAX$ + MENU TO + $ARGUMENTS$ + is a character string that contain the name of the + variable to hold the menu choices, if this variable does not exist + a PRIVATE variable with the name would be created to + hold the result. + $DESCRIPTION$ + Menu To() invoked the menu define by previous __AtPrompt() call + and display a highlight bar that the user can move to select an + option from the menu. If does not exist or not visible, + a PRIVATE variable named is created and hold the current + menu selection. If there is a variable named , its value + is used to select the first highlighted item. + + Menu prompts and messages are displayed in current Standard color, + highlighted bar is displayed using current Enhanced color. + + Pressing the arrow keys move the highlighted bar. When a menu item + is highlighted the message associated with it is displayed on the + line specified with SET MESSAGE. If SET WRAP is ON and the user + press UP arrow while on the first selection the last menu item is + highlighted, if the user press Down arrow while on the last item, + the first item is highlighted. + + Following are active keys that handled by Menu To: + + + key Meaning + + Up - Move to previous item + Down - Move to next item + Left - Move to previous item + Right - Move to next item + Home - Move to the first item + End - Move to the last item + Page-Up - Select menu item, return position + Page-Down - Select menu item, return position + Enter - Select menu item, return position + Esc - Abort selection, return 0 + First letter - Select next menu with the same first letter, + | return this item position. +
+ upon exit the cursor is placed at MaxRow()-1, 0 + Menu To can be nested without loosing the previous prompts. + + MENU TO command is preprocessed into __MenuTo() function during + compile time. + $EXAMPLES$ + // display menu item on each screen corner and let user select one + CLS + SET MESSAGE TO MaxRow() / 2 CENTER + SET WRAP ON + @ 0 , 0 PROMPT "1. Upper left" MESSAGE " One " + @ 0 , MaxCol() - 16 PROMPT "2. Upper right" MESSAGE " Two " + @ MaxRow() - 1, MaxCol() - 16 PROMPT "3. Bottom right" MESSAGE "Three" + @ MaxRow() - 1, 0 PROMPT "4. Bottom left" MESSAGE "Four " + MENU TO nChoice + SetPos( MaxRow() / 2, MaxCol() / 2 - 10 ) + IF nChoice == 0 + ?? "Esc was pressed" + ELSE + ?? "Selected option is", nChoice + ENDIF + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + @...PROMPT,ACHOICE(),SET MESSAGE,SET INTENSITY,SET WRAP,__ATPROMPT() + $END$ */ diff --git a/harbour/doc/en/misc.txt b/harbour/doc/en/misc.txt index b4ab98c2a5..1fafd4115a 100644 --- a/harbour/doc/en/misc.txt +++ b/harbour/doc/en/misc.txt @@ -13,346 +13,346 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * OS() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Return the current operating system. - * $SYNTAX$ - * OS() --> - * $RETURNS$ - * The current operating system. - * $DESCRIPTION$ - * This function will return the current operating system. - * $EXAMPLES$ - * ? OS() - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + OS() + $CATEGORY$ + API + $SUBCATEGORY$ + Environment + $ONELINER$ + Return the current operating system. + $SYNTAX$ + OS() --> + $RETURNS$ + The current operating system. + $DESCRIPTION$ + This function will return the current operating system. + $EXAMPLES$ + ? OS() + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * VERSION() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Returns the HARBOUR Version or the Harbour/Compiler Version. - * $SYNTAX$ - * VERSION() --> - * $ARGUMENTS$ - * None - * $RETURNS$ - * String containing the Harbour Version - * $DESCRIPTION$ - * This function returns the current Harbour Version. - * $EXAMPLES$ - * ? VERSION() // "Harbour Terminal: Standard stream console" - * $TESTS$ - * - * $STATUS$ - * S - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * OS() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + VERSION() + $CATEGORY$ + API + $SUBCATEGORY$ + Environment + $ONELINER$ + Returns the HARBOUR Version or the Harbour/Compiler Version. + $SYNTAX$ + VERSION() --> + $ARGUMENTS$ + None + $RETURNS$ + String containing the Harbour Version + $DESCRIPTION$ + This function returns the current Harbour Version. + $EXAMPLES$ + ? VERSION() // "Harbour Terminal: Standard stream console" + $TESTS$ + + $STATUS$ + S + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + OS() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * GETENV() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Obtains a system environmental setting. - * $SYNTAX$ - * GETENV( ) --> - * $ARGUMENTS$ - * Enviromental variable to obtain. - * $RETURNS$ - * Value of the Environment Variable. - * $DESCRIPTION$ - * This function yields a string that is the value of the - * environment variable , which is stored at the - * system level. - * - * If no environment variable - * is found, an empty string is returned. - * $EXAMPLES$ - * ? GETENV( "PATH" ) - * ? GETENV( "CONFIG" ) - * ? GETENV( "HARBOURCMD", "-n -l -es2" ) - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * GETE - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + GETENV() + $CATEGORY$ + API + $SUBCATEGORY$ + Environment + $ONELINER$ + Obtains a system environmental setting. + $SYNTAX$ + GETENV( ) --> + $ARGUMENTS$ + Enviromental variable to obtain. + $RETURNS$ + Value of the Environment Variable. + $DESCRIPTION$ + This function yields a string that is the value of the + environment variable , which is stored at the + system level. + + If no environment variable + is found, an empty string is returned. + $EXAMPLES$ + ? GETENV( "PATH" ) + ? GETENV( "CONFIG" ) + ? GETENV( "HARBOURCMD", "-n -l -es2" ) + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + GETE + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * GETE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Obtains a system environmental setting. - * $SYNTAX$ - * GETE( ) --> - * $ARGUMENTS$ - * Enviromental variable to obtain. - * $RETURNS$ - * Value of the Environment Variable. - * $DESCRIPTION$ - * This function yields a string that is the value of the - * environment variable , which is stored at the - * system level. - * - * If no environment variable - * is found, an empty string is returned. - * $EXAMPLES$ - * ? GETE( "PATH" ) - * ? GETE( "CONFIG" ) - * ? GETE( "HARBOURCMD", "-n -l -es2" ) - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * This is CA-Cl*pper compliant. - * - * The parameter is a Harbour extension. - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * GETENV - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + GETE() + $CATEGORY$ + API + $SUBCATEGORY$ + Environment + $ONELINER$ + Obtains a system environmental setting. + $SYNTAX$ + GETE( ) --> + $ARGUMENTS$ + Enviromental variable to obtain. + $RETURNS$ + Value of the Environment Variable. + $DESCRIPTION$ + This function yields a string that is the value of the + environment variable , which is stored at the + system level. + + If no environment variable + is found, an empty string is returned. + $EXAMPLES$ + ? GETE( "PATH" ) + ? GETE( "CONFIG" ) + ? GETE( "HARBOURCMD", "-n -l -es2" ) + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + This is CA-Cl*pper compliant. + + The parameter is a Harbour extension. + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + GETENV + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_GETENV() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Obtains a system environmental setting. - * $SYNTAX$ - * HB_GETENV(, [], [] ) --> - * $ARGUMENTS$ - * Enviromental variable to obtain. - * - * Optional value to return if is not found. - * - * optional logical parameter specifing whether to - * apply automatic codepage conversion (to the codepage - * specified by Set( _SET_OSCODEPAGE ) on the obtained value. - * The default is .T. Note that if the default value is passed and the environment - * value is not found, this codepage conversion is not performed against - * the returned default value - * $RETURNS$ - * Value of the environment variable or or an empty string. - * $DESCRIPTION$ - * This function yields a string that is the value of the - * environment variable , which is stored at the - * system level. - * - * If no environment variable - * can be found, the value of the function will be - * if it is passed, else an empty string. - * $EXAMPLES$ - * ? HB_GETENV( "PATH" ) - * ? HB_GETENV( "CONFIG" ) - * ? HB_GETENV( "HARBOURCMD", "-n -l -es2" ) - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * GETENV, GETE - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_GETENV() + $CATEGORY$ + API + $SUBCATEGORY$ + Environment + $ONELINER$ + Obtains a system environmental setting. + $SYNTAX$ + HB_GETENV(, [], [] ) --> + $ARGUMENTS$ + Enviromental variable to obtain. + + Optional value to return if is not found. + + optional logical parameter specifing whether to + apply automatic codepage conversion (to the codepage + specified by Set( _SET_OSCODEPAGE ) on the obtained value. + The default is .T. Note that if the default value is passed and the environment + value is not found, this codepage conversion is not performed against + the returned default value + $RETURNS$ + Value of the environment variable or or an empty string. + $DESCRIPTION$ + This function yields a string that is the value of the + environment variable , which is stored at the + system level. + + If no environment variable + can be found, the value of the function will be + if it is passed, else an empty string. + $EXAMPLES$ + ? HB_GETENV( "PATH" ) + ? HB_GETENV( "CONFIG" ) + ? HB_GETENV( "HARBOURCMD", "-n -l -es2" ) + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + GETENV, GETE + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * __RUN() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Run an external program. - * $SYNTAX$ - * __RUN( ) - * $ARGUMENTS$ - * Command to execute. - * $DESCRIPTION$ - * This command runs an external program. Ensure that - * you have enough free memory to be able to run the external - * program. Do not use it to run 'Terminate and Stay Resident' programs - * (in case of MS-DOS) since that causes several problems. - * - * Note: This function is what the RUN command preprocesses into. - * It is considered bad form to use this function directly. - * Use the RUN command instead. - * $EXAMPLES$ - * __run( "edit " + cMyTextFile ) // Runs an external editor - * __run( "command" ) // Gives a OS shell - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * RUN - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + __RUN() + $CATEGORY$ + API + $SUBCATEGORY$ + Environment + $ONELINER$ + Run an external program. + $SYNTAX$ + __RUN( ) + $ARGUMENTS$ + Command to execute. + $DESCRIPTION$ + This command runs an external program. Ensure that + you have enough free memory to be able to run the external + program. Do not use it to run 'Terminate and Stay Resident' programs + (in case of MS-DOS) since that causes several problems. + + Note: This function is what the RUN command preprocesses into. + It is considered bad form to use this function directly. + Use the RUN command instead. + $EXAMPLES$ + __run( "edit " + cMyTextFile ) // Runs an external editor + __run( "command" ) // Gives a OS shell + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + RUN + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * TONE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Sound a tone with a specified frequency and duration. - * $SYNTAX$ - * TONE( , ) --> NIL - * $ARGUMENTS$ - * A non-negative numeric value that specifies the - * frequency of the tone in hertz. - * - * A positive numeric value which specifies the duration - * of the tone in 1/18 of a second units. - * $RETURNS$ - * TONE() always returns NIL. - * $DESCRIPTION$ - * TONE() is a sound function that could be used to irritate the end - * user, his or her dog, and the surrounding neighborhood. The frequency - * is limited to the range 0 to 32767 Hz. - * $EXAMPLES$ - * IF lOk // Good Sound - * TONE( 500, 1 ) - * TONE( 4000, 1 ) - * TONE( 2500, 1 ) - * ELSE // Bad Sound - * TONE( 300, 1 ) - * TONE( 499, 5 ) - * TONE( 700, 5 ) - * ENDIF - * $TESTS$ - * TONE( 800, 1 ) // same as ? CHR( 7 ) - * TONE( 32000, 200 ) // any dogs around yet? - * TONE( 130.80, 1 ) // musical note - C - * TONE( 400, 0 ) // short beep - * TONE( 700 ) // short beep - * TONE( 10, 18.2 ) // 1 second delay - * TONE( -1 ) // 1/18.2 second delay - * TONE( ) // 1/18.2 second delay - * $STATUS$ - * S - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * CHR(),SET BELL - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + TONE() + $CATEGORY$ + API + $SUBCATEGORY$ + Environment + $ONELINER$ + Sound a tone with a specified frequency and duration. + $SYNTAX$ + TONE( , ) --> NIL + $ARGUMENTS$ + A non-negative numeric value that specifies the + frequency of the tone in hertz. + + A positive numeric value which specifies the duration + of the tone in 1/18 of a second units. + $RETURNS$ + TONE() always returns NIL. + $DESCRIPTION$ + TONE() is a sound function that could be used to irritate the end + user, his or her dog, and the surrounding neighborhood. The frequency + is limited to the range 0 to 32767 Hz. + $EXAMPLES$ + IF lOk // Good Sound + TONE( 500, 1 ) + TONE( 4000, 1 ) + TONE( 2500, 1 ) + ELSE // Bad Sound + TONE( 300, 1 ) + TONE( 499, 5 ) + TONE( 700, 5 ) + ENDIF + $TESTS$ + TONE( 800, 1 ) // same as ? CHR( 7 ) + TONE( 32000, 200 ) // any dogs around yet? + TONE( 130.80, 1 ) // musical note - C + TONE( 400, 0 ) // short beep + TONE( 700 ) // short beep + TONE( 10, 18.2 ) // 1 second delay + TONE( -1 ) // 1/18.2 second delay + TONE( ) // 1/18.2 second delay + $STATUS$ + S + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + CHR(),SET BELL + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * RUN - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Run an external program. - * $SYNTAX$ - * RUN - * $ARGUMENTS$ - * Command to execute. - * $DESCRIPTION$ - * This command runs an external program. Please make sure that you have - * enough free memory to be able to run the external program. - * Do not use it to run Terminate and Stay Resident programs - * (in case of DOS) since that causes several problems. - * $EXAMPLES$ - * RUN ( "edit " + cMyTextFile ) // Runs an external editor - * RUN command // Gives a OS shell - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * RUN - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + RUN + $CATEGORY$ + API + $SUBCATEGORY$ + Environment + $ONELINER$ + Run an external program. + $SYNTAX$ + RUN + $ARGUMENTS$ + Command to execute. + $DESCRIPTION$ + This command runs an external program. Please make sure that you have + enough free memory to be able to run the external program. + Do not use it to run Terminate and Stay Resident programs + (in case of DOS) since that causes several problems. + $EXAMPLES$ + RUN ( "edit " + cMyTextFile ) // Runs an external editor + RUN command // Gives a OS shell + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + RUN + $END$ */ diff --git a/harbour/doc/en/nation.txt b/harbour/doc/en/nation.txt index bacc550558..aebe0cf237 100644 --- a/harbour/doc/en/nation.txt +++ b/harbour/doc/en/nation.txt @@ -15,114 +15,114 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ISAFFIRM() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Language and Nation - * $ONELINER$ - * Checks if passed char is an affirmation char - * $SYNTAX$ - * ISAFFIRM( ) --> - * $ARGUMENTS$ - * is a char or string of chars - * $RETURNS$ - * True if passed char is an affirmation char, otherwise - * false - * $DESCRIPTION$ - * This function is used to check if a user's input is true or not - * according to the msgxxx module used. - * $EXAMPLES$ - * // Wait until user enters Y - * DO WHILE ! ISAFFIRM( cYesNo ) - * ACCEPT "Sure: " TO cYesNo - * ENDDO - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ISNEGATIVE(),NATIONMSG() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ISAFFIRM() + $CATEGORY$ + API + $SUBCATEGORY$ + Language and Nation + $ONELINER$ + Checks if passed char is an affirmation char + $SYNTAX$ + ISAFFIRM( ) --> + $ARGUMENTS$ + is a char or string of chars + $RETURNS$ + True if passed char is an affirmation char, otherwise + false + $DESCRIPTION$ + This function is used to check if a user's input is true or not + according to the msgxxx module used. + $EXAMPLES$ + // Wait until user enters Y + DO WHILE ! ISAFFIRM( cYesNo ) + ACCEPT "Sure: " TO cYesNo + ENDDO + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + ISNEGATIVE(),NATIONMSG() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ISNEGATIVE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Language and Nation - * $ONELINER$ - * Checks if passed char is a negation char. - * $SYNTAX$ - * ISNEGATIVE( ) --> - * $ARGUMENTS$ - * is a char or string of chars - * $RETURNS$ - * True if passed char is a negation char, otherwise - * false. - * $DESCRIPTION$ - * This function is used to check if a user's input is true or not - * according to the msgxxx module used. - * $EXAMPLES$ - * // Wait until user enters N - * DO WHILE ! ISNEGATIVE( cYesNo ) - * ACCEPT "Sure: " TO cYesNo - * ENDDO - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ISAFFIRM(),NATIONMSG() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ISNEGATIVE() + $CATEGORY$ + API + $SUBCATEGORY$ + Language and Nation + $ONELINER$ + Checks if passed char is a negation char. + $SYNTAX$ + ISNEGATIVE( ) --> + $ARGUMENTS$ + is a char or string of chars + $RETURNS$ + True if passed char is a negation char, otherwise + false. + $DESCRIPTION$ + This function is used to check if a user's input is true or not + according to the msgxxx module used. + $EXAMPLES$ + // Wait until user enters N + DO WHILE ! ISNEGATIVE( cYesNo ) + ACCEPT "Sure: " TO cYesNo + ENDDO + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + ISAFFIRM(),NATIONMSG() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * Language and Nation MSG() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Language and Nation - * $ONELINER$ - * Returns international strings messages. - * $SYNTAX$ - * Language and Nation MSG( ) --> - * $ARGUMENTS$ - * is the message number you want to get. - * $RETURNS$ - * If is a valid message selector, returns the message. - * If is nil returns "Invalid Argument", and if is any - * other type it returns an empty string. - * $DESCRIPTION$ - * Language and Nation MSG() returns international message descriptions. - * $EXAMPLES$ - * // Displays "Sure Y/N: " and waits until user enters Y - * // Y/N is the string for NATIONMSG( 12 ) with default natmsg module. - * DO WHILE ! ISAFFIRM( cYesNo ) - * ACCEPT "Sure " + NATIONMSG( 12 ) + ": " TO cYesNo - * ENDDO - * $STATUS$ - * C - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ISAFFIRM(),ISNEGATIVE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + Language and Nation MSG() + $CATEGORY$ + API + $SUBCATEGORY$ + Language and Nation + $ONELINER$ + Returns international strings messages. + $SYNTAX$ + Language and Nation MSG( ) --> + $ARGUMENTS$ + is the message number you want to get. + $RETURNS$ + If is a valid message selector, returns the message. + If is nil returns "Invalid Argument", and if is any + other type it returns an empty string. + $DESCRIPTION$ + Language and Nation MSG() returns international message descriptions. + $EXAMPLES$ + // Displays "Sure Y/N: " and waits until user enters Y + // Y/N is the string for NATIONMSG( 12 ) with default natmsg module. + DO WHILE ! ISAFFIRM( cYesNo ) + ACCEPT "Sure " + NATIONMSG( 12 ) + ": " TO cYesNo + ENDDO + $STATUS$ + C + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + ISAFFIRM(),ISNEGATIVE() + $END$ */ diff --git a/harbour/doc/en/objfunc.txt b/harbour/doc/en/objfunc.txt index 139014f660..8631c7d97c 100644 --- a/harbour/doc/en/objfunc.txt +++ b/harbour/doc/en/objfunc.txt @@ -18,784 +18,784 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __objHasData() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Objects - * $ONELINER$ - * Determine whether a symbol exist in object as VAR - * $SYNTAX$ - * __objHasData( , ) --> lExist - * $ARGUMENTS$ - * is an object to scan. - * - * is the name of the symbol to look for. - * $RETURNS$ - * __objHasData() return .T. if the given exist as VAR - * (instance variable) in object , ) --> lExist + $ARGUMENTS$ + is an object to scan. + + is the name of the symbol to look for. + $RETURNS$ + __objHasData() return .T. if the given exist as VAR + (instance variable) in object , ) --> lExist - * $ARGUMENTS$ - * is an object to scan. - * - * is the name of the symbol to look for. - * $RETURNS$ - * __objHasMethod() return .T. if the given exist as METHOD - * (class function) in object , ) --> lExist + $ARGUMENTS$ + is an object to scan. + + is the name of the symbol to look for. + $RETURNS$ + __objHasMethod() return .T. if the given exist as METHOD + (class function) in object , [], [nClassType] ) --> aNames - * $ARGUMENTS$ - * is an object to scan. - * - * is an optional logical value that specifies the information - * to return. A value of .T. instruct the function to return list of - * all VAR names, .F. return list of all METHOD names. Default value - * is .T. - * - * is on optional numeric code for selecting which class - * type to return. Default value is HB_MSGLISTALL, returning the whole - * list. - * $RETURNS$ - * __objGetMsgList() return an array of character stings with all VAR - * names or all METHOD names for a given object. __objGetMsgList() - * would return an empty array {} if the given object does not contain - * the requested information. - * $DESCRIPTION$ - * __objGetMsgList() is a low level class support function that let you - * find all instance variable or method names for a given object. - * - * If specified, the following table shows the values for - * that allow you to distinguish between VAR and CLASS VAR: - * - * - * hboo.ch Value Meaning - * - * HB_MSGLISTALL 0 All types - * HB_MSGLISTCLASS 1 CLASS VAR only - * HB_MSGLISTPURE 2 VAR only - *
- * - * VAR are instance variable usable within each object from a class, - * where each object has its own VARs. - * - * CLASS VAR are shared by all objects from a Class, so the changed - * value within Object1 will be reflected when accessing the CLASS VAR - * from Object2. - * $EXAMPLES$ - * // show information about TBrowse class - * oB := TBrowseNew( 0, 0, 24, 79 ) - * aData := __objGetMsgList( oB, .T. ) - * aClassData := __objGetMsgList( oB, .T., HB_MSGLISTCLASS ) - * aMethod := __objGetMsgList( oB, .F. ) - * FOR i := 1 TO Len( aData ) - * ? "VAR name:", aData[ i ] - * NEXT - * FOR i := 1 TO Len( aClassData ) - * ? "CLASS VAR name:", aClassData[ i ] - * NEXT - * FOR i := 1 TO Len( aMethod ) - * ? "METHOD name:", aMethod[ i ] - * NEXT - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Header file is hboo.ch - * Library is rtl - * $SEEALSO$ - * __ObjGetMethodList(),__ObjGetValueList(),__objHasData(),__objHasMethod() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __objGetMsgList() + $CATEGORY$ + API + $SUBCATEGORY$ + Objects + $ONELINER$ + Return names of all VAR or METHOD for a given object + $SYNTAX$ + __objGetMsgList( , [], [nClassType] ) --> aNames + $ARGUMENTS$ + is an object to scan. + + is an optional logical value that specifies the information + to return. A value of .T. instruct the function to return list of + all VAR names, .F. return list of all METHOD names. Default value + is .T. + + is on optional numeric code for selecting which class + type to return. Default value is HB_MSGLISTALL, returning the whole + list. + $RETURNS$ + __objGetMsgList() return an array of character stings with all VAR + names or all METHOD names for a given object. __objGetMsgList() + would return an empty array {} if the given object does not contain + the requested information. + $DESCRIPTION$ + __objGetMsgList() is a low level class support function that let you + find all instance variable or method names for a given object. + + If specified, the following table shows the values for + that allow you to distinguish between VAR and CLASS VAR: + + table> + hboo.ch Value Meaning + + HB_MSGLISTALL 0 All types + HB_MSGLISTCLASS 1 CLASS VAR only + HB_MSGLISTPURE 2 VAR only + /table> + + VAR are instance variable usable within each object from a class, + where each object has its own VARs. + + CLASS VAR are shared by all objects from a Class, so the changed + value within Object1 will be reflected when accessing the CLASS VAR + from Object2. + $EXAMPLES$ + // show information about TBrowse class + oB := TBrowseNew( 0, 0, 24, 79 ) + aData := __objGetMsgList( oB, .T. ) + aClassData := __objGetMsgList( oB, .T., HB_MSGLISTCLASS ) + aMethod := __objGetMsgList( oB, .F. ) + FOR i := 1 TO Len( aData ) + ? "VAR name:", aData[ i ] + NEXT + FOR i := 1 TO Len( aClassData ) + ? "CLASS VAR name:", aClassData[ i ] + NEXT + FOR i := 1 TO Len( aMethod ) + ? "METHOD name:", aMethod[ i ] + NEXT + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Header file is hboo.ch + Library is rtl + $SEEALSO$ + __ObjGetMethodList(),__ObjGetValueList(),__objHasData(),__objHasMethod() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __objGetMethodList() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Objects - * $ONELINER$ - * Return names of all METHOD for a given object - * $SYNTAX$ - * __objGetMethodList( ) --> aMethodNames - * $ARGUMENTS$ - * is an object to scan. - * $RETURNS$ - * __objGetMethodList() return an array of character stings with all - * METHOD names for a given object. __objGetMethodList() would return - * an empty array {} if the given object does not contain any METHOD. - * $DESCRIPTION$ - * __objGetMethodList() is a low level class support function that let - * you find all class functions names for a given object. - * It is equivalent to __objGetMsgList( oObject, .F. ). - * $EXAMPLES$ - * // show information about TBrowse class - * oB := TBrowseNew( 0, 0, 24, 79 ) - * aMethod := __objGetMethodList( oB ) - * FOR i := 1 TO Len( aMethod ) - * ? "METHOD name:", aMethod[ i ] - * NEXT - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is rtl - * $SEEALSO$ - * __objGetMsgList(),__ObjGetValueList(),__objHasData(),__objHasMethod() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __objGetMethodList() + $CATEGORY$ + API + $SUBCATEGORY$ + Objects + $ONELINER$ + Return names of all METHOD for a given object + $SYNTAX$ + __objGetMethodList( ) --> aMethodNames + $ARGUMENTS$ + is an object to scan. + $RETURNS$ + __objGetMethodList() return an array of character stings with all + METHOD names for a given object. __objGetMethodList() would return + an empty array {} if the given object does not contain any METHOD. + $DESCRIPTION$ + __objGetMethodList() is a low level class support function that let + you find all class functions names for a given object. + It is equivalent to __objGetMsgList( oObject, .F. ). + $EXAMPLES$ + // show information about TBrowse class + oB := TBrowseNew( 0, 0, 24, 79 ) + aMethod := __objGetMethodList( oB ) + FOR i := 1 TO Len( aMethod ) + ? "METHOD name:", aMethod[ i ] + NEXT + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is rtl + $SEEALSO$ + __objGetMsgList(),__ObjGetValueList(),__objHasData(),__objHasMethod() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __objGetValueList() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Objects - * $ONELINER$ - * Return an array of VAR names and values for a given object - * $SYNTAX$ - * __objGetValueList( , [] ) --> aData - * $ARGUMENTS$ - * is an object to scan. - * - * is an optional array with VAR names you want to exclude - * from the scan. - * $RETURNS$ - * __objGetValueList() return a 2D array that contain pairs of a VAR - * symbol name and the value of VAR. __objGetValueList() would return - * an empty array {} if the given object does not contain the requested - * information. - * $DESCRIPTION$ - * __objGetValueList() is a low level class support function that - * return an array with VAR names and value, each array element is a - * pair of: aData[ i, HB_OO_DATA_SYMBOL ] contain the symbol name - * aData[ i, HB_OO_DATA_VALUE ] contain the value of DATA - * $EXAMPLES$ - * // show information about TBrowse class - * oB := TBrowseNew( 0, 0, 24, 79 ) - * aData := __objGetValueList( oB ) - * FOR i := 1 TO len( aData ) - * ? "VAR name:", aData[ i, HB_OO_DATA_SYMBOL ], ; - * " value=", aData[ i, HB_OO_DATA_VALUE ] - * NEXT - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Header file is hboo.ch - * Library is rtl - * $SEEALSO$ - * __objGetMethodList(),__objGetMsgList(),__objHasData(),__objHasMethod(),__ObjSetValueList() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __objGetValueList() + $CATEGORY$ + API + $SUBCATEGORY$ + Objects + $ONELINER$ + Return an array of VAR names and values for a given object + $SYNTAX$ + __objGetValueList( , [] ) --> aData + $ARGUMENTS$ + is an object to scan. + + is an optional array with VAR names you want to exclude + from the scan. + $RETURNS$ + __objGetValueList() return a 2D array that contain pairs of a VAR + symbol name and the value of VAR. __objGetValueList() would return + an empty array {} if the given object does not contain the requested + information. + $DESCRIPTION$ + __objGetValueList() is a low level class support function that + return an array with VAR names and value, each array element is a + pair of: aData[ i, HB_OO_DATA_SYMBOL ] contain the symbol name + aData[ i, HB_OO_DATA_VALUE ] contain the value of DATA + $EXAMPLES$ + // show information about TBrowse class + oB := TBrowseNew( 0, 0, 24, 79 ) + aData := __objGetValueList( oB ) + FOR i := 1 TO len( aData ) + ? "VAR name:", aData[ i, HB_OO_DATA_SYMBOL ], ; + " value=", aData[ i, HB_OO_DATA_VALUE ] + NEXT + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Header file is hboo.ch + Library is rtl + $SEEALSO$ + __objGetMethodList(),__objGetMsgList(),__objHasData(),__objHasMethod(),__ObjSetValueList() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __ObjSetValueList() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Objects - * $ONELINER$ - * Set object with an array of VAR names and values - * $SYNTAX$ - * __ObjSetValueList( , ) --> oObject - * $ARGUMENTS$ - * is an object to set. - * - * is a 2D array with a pair of instance variables and values - * for setting those variable. - * $RETURNS$ - * __ObjSetValueList() return a reference to . - * $DESCRIPTION$ - * __ObjSetValueList() is a low level class support function that let - * you set a group of instance variables with values. each array - * element in is a pair of: - * aData[ i, HB_OO_DATA_SYMBOL ] which contain the variable name to set - * aData[ i, HB_OO_DATA_VALUE ] contain the new variable value. - * $EXAMPLES$ - * // set some TBrowse instance variable - * oB := TBrowse():New() - * aData := Array( 4, 2 ) - * aData[ 1, HB_OO_DATA_SYMBOL ] = "nTop" - * aData[ 1, HB_OO_DATA_VALUE ] = 1 - * aData[ 2, HB_OO_DATA_SYMBOL ] = "nLeft" - * aData[ 2, HB_OO_DATA_VALUE ] = 10 - * aData[ 3, HB_OO_DATA_SYMBOL ] = "nBottom" - * aData[ 3, HB_OO_DATA_VALUE ] = 20 - * aData[ 4, HB_OO_DATA_SYMBOL ] = "nRight" - * aData[ 4, HB_OO_DATA_VALUE ] = 70 - * __ObjSetValueList( oB, aData ) - * ? oB:nTop // 1 - * ? oB:nLeft // 10 - * ? oB:nBottom // 20 - * ? oB:nRight // 70 - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Header file is hboo.ch - * Library is rtl - * $SEEALSO$ - * __ObjGetValueList() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __ObjSetValueList() + $CATEGORY$ + API + $SUBCATEGORY$ + Objects + $ONELINER$ + Set object with an array of VAR names and values + $SYNTAX$ + __ObjSetValueList( , ) --> oObject + $ARGUMENTS$ + is an object to set. + + is a 2D array with a pair of instance variables and values + for setting those variable. + $RETURNS$ + __ObjSetValueList() return a reference to . + $DESCRIPTION$ + __ObjSetValueList() is a low level class support function that let + you set a group of instance variables with values. each array + element in is a pair of: + aData[ i, HB_OO_DATA_SYMBOL ] which contain the variable name to set + aData[ i, HB_OO_DATA_VALUE ] contain the new variable value. + $EXAMPLES$ + // set some TBrowse instance variable + oB := TBrowse():New() + aData := Array( 4, 2 ) + aData[ 1, HB_OO_DATA_SYMBOL ] = "nTop" + aData[ 1, HB_OO_DATA_VALUE ] = 1 + aData[ 2, HB_OO_DATA_SYMBOL ] = "nLeft" + aData[ 2, HB_OO_DATA_VALUE ] = 10 + aData[ 3, HB_OO_DATA_SYMBOL ] = "nBottom" + aData[ 3, HB_OO_DATA_VALUE ] = 20 + aData[ 4, HB_OO_DATA_SYMBOL ] = "nRight" + aData[ 4, HB_OO_DATA_VALUE ] = 70 + __ObjSetValueList( oB, aData ) + ? oB:nTop // 1 + ? oB:nLeft // 10 + ? oB:nBottom // 20 + ? oB:nRight // 70 + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Header file is hboo.ch + Library is rtl + $SEEALSO$ + __ObjGetValueList() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __objAddMethod() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Objects - * $ONELINER$ - * Add a METHOD to an already existing class - * $SYNTAX$ - * __objAddMethod( , , ) --> oObject - * $ARGUMENTS$ - * is the object to work on. - * - * is the symbol name of the new METHOD to add. - * - * is a pointer to a function to associate with the method. - * $RETURNS$ - * __objAddMethod() return a reference to . - * $DESCRIPTION$ - * __objAddMethod() is a low level class support function that add a - * new METHOD to an object. is unchanged if a symbol with the - * name already exist in . - * - * Note that is a special pointer to a function that was - * created using the @ operator, see example below. - * $EXAMPLES$ - * // create a new THappy class and add a Smile method - * oHappy := HBClass():New( "THappy" ) - * __objAddMethod( oHappy, "Smile", @MySmile() ) - * ? oHappy:Smile( 1 ) // :) - * ? oHappy:Smile( 2 ) // ;) - * ? oHappy:Smile( 3 ) // *SMILE* - * - * STATIC FUNCTION MySmile( nType ) - * LOCAL cSmile - * DO CASE - * CASE nType == 1 - * cSmile := ":)" - * CASE nType == 2 - * cSmile := ";)" - * CASE nType == 3 - * cSmile := "*SMILE*" - * ENDCASE - * RETURN cSmile - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is rtl - * $SEEALSO$ - * __objAddInline(),__objAddData(),__objDelMethod(),__ObjGetMethodList(),__objGetMsgList(),__objHasMethod(),__objModMethod() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __objAddMethod() + $CATEGORY$ + API + $SUBCATEGORY$ + Objects + $ONELINER$ + Add a METHOD to an already existing class + $SYNTAX$ + __objAddMethod( , , ) --> oObject + $ARGUMENTS$ + is the object to work on. + + is the symbol name of the new METHOD to add. + + is a pointer to a function to associate with the method. + $RETURNS$ + __objAddMethod() return a reference to . + $DESCRIPTION$ + __objAddMethod() is a low level class support function that add a + new METHOD to an object. is unchanged if a symbol with the + name already exist in . + + Note that is a special pointer to a function that was + created using the @ operator, see example below. + $EXAMPLES$ + // create a new THappy class and add a Smile method + oHappy := HBClass():New( "THappy" ) + __objAddMethod( oHappy, "Smile", @MySmile() ) + ? oHappy:Smile( 1 ) // :) + ? oHappy:Smile( 2 ) // ;) + ? oHappy:Smile( 3 ) // *SMILE* + + STATIC FUNCTION MySmile( nType ) + LOCAL cSmile + DO CASE + CASE nType == 1 + cSmile := ":)" + CASE nType == 2 + cSmile := ";)" + CASE nType == 3 + cSmile := "*SMILE*" + ENDCASE + RETURN cSmile + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is rtl + $SEEALSO$ + __objAddInline(),__objAddData(),__objDelMethod(),__ObjGetMethodList(),__objGetMsgList(),__objHasMethod(),__objModMethod() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __objAddInline() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Objects - * $ONELINER$ - * Add an INLINE to an already existing class - * $SYNTAX$ - * __objAddInline( , , ) --> oObject - * $ARGUMENTS$ - * is the object to work on. - * - * is the symbol name of the new INLINE to add. - * - * is a code block to associate with the INLINE method. - * $RETURNS$ - * __objAddInline() return a reference to . - * $DESCRIPTION$ - * __objAddInline() is a low level class support function that add a - * new INLINE method to an object. is unchanged if a symbol - * with the name already exist in . - * $EXAMPLES$ - * // create a new THappy class and add a Smile INLINE method - * oHappy := HBClass():New( "THappy" ) - * bInline := {| nType | { ":)", ";)", "*SMILE*" }[ nType ] } - * __objAddInline( oHappy, "Smile", bInline ) - * ? oHappy:Smile( 1 ) // :) - * ? oHappy:Smile( 2 ) // ;) - * ? oHappy:Smile( 3 ) // *SMILE* - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is rtl - * $SEEALSO$ - * __objAddData(),__objAddMethod(),__objDelInline(),__ObjGetMethodList(),__objGetMsgList(),__objHasMethod() ,__objModInline() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __objAddInline() + $CATEGORY$ + API + $SUBCATEGORY$ + Objects + $ONELINER$ + Add an INLINE to an already existing class + $SYNTAX$ + __objAddInline( , , ) --> oObject + $ARGUMENTS$ + is the object to work on. + + is the symbol name of the new INLINE to add. + + is a code block to associate with the INLINE method. + $RETURNS$ + __objAddInline() return a reference to . + $DESCRIPTION$ + __objAddInline() is a low level class support function that add a + new INLINE method to an object. is unchanged if a symbol + with the name already exist in . + $EXAMPLES$ + // create a new THappy class and add a Smile INLINE method + oHappy := HBClass():New( "THappy" ) + bInline := {| nType | { ":)", ";)", "*SMILE*" }[ nType ] } + __objAddInline( oHappy, "Smile", bInline ) + ? oHappy:Smile( 1 ) // :) + ? oHappy:Smile( 2 ) // ;) + ? oHappy:Smile( 3 ) // *SMILE* + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is rtl + $SEEALSO$ + __objAddData(),__objAddMethod(),__objDelInline(),__ObjGetMethodList(),__objGetMsgList(),__objHasMethod() ,__objModInline() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __objAddData() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Objects - * $ONELINER$ - * Add a VAR to an already existing class - * $SYNTAX$ - * __objAddData( , ) --> oObject - * $ARGUMENTS$ - * is the object to work on. - * - * is the symbol name of the new VAR to add. - * $RETURNS$ - * __objAddData() return a reference to . - * $DESCRIPTION$ - * __objAddData() is a low level class support function that add a new - * VAR to an object. is unchanged if a symbol with the name - * already exist in . - * $EXAMPLES$ - * // create a new THappy class and add a lHappy VAR - * oHappy := HBClass():New( "THappy" ) - * __objAddData( oHappy, "lHappy" ) - * oHappy:lHappy := .T. - * IF oHappy:lHappy - * ? "Happy, Happy, Joy, Joy !!!" - * ELSE - * ? ":(..." - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is rtl - * $SEEALSO$ - * __objAddInline(),__objAddMethod(),__objDelData(),__objGetMsgList(),__ObjGetValueList(),__objHasData(),__ObjSetValueList() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __objAddData() + $CATEGORY$ + API + $SUBCATEGORY$ + Objects + $ONELINER$ + Add a VAR to an already existing class + $SYNTAX$ + __objAddData( , ) --> oObject + $ARGUMENTS$ + is the object to work on. + + is the symbol name of the new VAR to add. + $RETURNS$ + __objAddData() return a reference to . + $DESCRIPTION$ + __objAddData() is a low level class support function that add a new + VAR to an object. is unchanged if a symbol with the name + already exist in . + $EXAMPLES$ + // create a new THappy class and add a lHappy VAR + oHappy := HBClass():New( "THappy" ) + __objAddData( oHappy, "lHappy" ) + oHappy:lHappy := .T. + IF oHappy:lHappy + ? "Happy, Happy, Joy, Joy !!!" + ELSE + ? ":(..." + ENDIF + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is rtl + $SEEALSO$ + __objAddInline(),__objAddMethod(),__objDelData(),__objGetMsgList(),__ObjGetValueList(),__objHasData(),__ObjSetValueList() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __objModMethod() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Objects - * $ONELINER$ - * Modify (replace) a METHOD in an already existing class - * $SYNTAX$ - * __objModMethod( , , ) --> oObject - * $ARGUMENTS$ - * is the object to work on. - * - * is the symbol name of the METHOD to modify. - * - * is a pointer to a new function to associate with the - * method. - * $RETURNS$ - * __objModMethod() return a reference to . - * $DESCRIPTION$ - * __objModMethod() is a low level class support function that modify - * a METHOD in an object and replace it with a new function. - * is unchanged if a symbol with the name does not exist - * in . __objModMethod() is used in inheritance mechanism. - * - * Note that is a special pointer to a function that was - * created using the @ operator, see example below. - * $EXAMPLES$ - * // create a new THappy class and add a Smile method - * oHappy := HBClass():New( "THappy" ) - * __objAddMethod( oHappy, "Smile", @MySmile() ) - * ? oHappy:Smile( 1 ) // :) - * ? oHappy:Smile( 2 ) // ;) - * // replace Smile method with a new function - * __objAddMethod( oHappy, "Smile", @YourSmile() ) - * ? oHappy:Smile( 1 ) // *SMILE* - * ? oHappy:Smile( 2 ) // *WINK* - * - * STATIC FUNCTION MySmile( nType ) - * LOCAL cSmile - * DO CASE - * CASE nType == 1 - * cSmile := ":)" - * CASE nType == 2 - * cSmile := ";)" - * ENDCASE - * RETURN cSmile - * - * STATIC FUNCTION YourSmile( nType ) - * LOCAL cSmile - * DO CASE - * CASE nType == 1 - * cSmile := "*SMILE*" - * CASE nType == 2 - * cSmile := "*WINK*" - * ENDCASE - * RETURN cSmile - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is rtl - * $SEEALSO$ - * __objAddMethod(),__objDelMethod(),__ObjGetMethodList(),__objGetMsgList(),__objHasMethod() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __objModMethod() + $CATEGORY$ + API + $SUBCATEGORY$ + Objects + $ONELINER$ + Modify (replace) a METHOD in an already existing class + $SYNTAX$ + __objModMethod( , , ) --> oObject + $ARGUMENTS$ + is the object to work on. + + is the symbol name of the METHOD to modify. + + is a pointer to a new function to associate with the + method. + $RETURNS$ + __objModMethod() return a reference to . + $DESCRIPTION$ + __objModMethod() is a low level class support function that modify + a METHOD in an object and replace it with a new function. + is unchanged if a symbol with the name does not exist + in . __objModMethod() is used in inheritance mechanism. + + Note that is a special pointer to a function that was + created using the @ operator, see example below. + $EXAMPLES$ + // create a new THappy class and add a Smile method + oHappy := HBClass():New( "THappy" ) + __objAddMethod( oHappy, "Smile", @MySmile() ) + ? oHappy:Smile( 1 ) // :) + ? oHappy:Smile( 2 ) // ;) + // replace Smile method with a new function + __objAddMethod( oHappy, "Smile", @YourSmile() ) + ? oHappy:Smile( 1 ) // *SMILE* + ? oHappy:Smile( 2 ) // *WINK* + + STATIC FUNCTION MySmile( nType ) + LOCAL cSmile + DO CASE + CASE nType == 1 + cSmile := ":)" + CASE nType == 2 + cSmile := ";)" + ENDCASE + RETURN cSmile + + STATIC FUNCTION YourSmile( nType ) + LOCAL cSmile + DO CASE + CASE nType == 1 + cSmile := "*SMILE*" + CASE nType == 2 + cSmile := "*WINK*" + ENDCASE + RETURN cSmile + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is rtl + $SEEALSO$ + __objAddMethod(),__objDelMethod(),__ObjGetMethodList(),__objGetMsgList(),__objHasMethod() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __objModInline() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Objects - * $ONELINER$ - * Modify (replace) an INLINE method in an already existing class - * $SYNTAX$ - * __objModInline( , , ) --> oObject - * $ARGUMENTS$ - * is the object to work on. - * - * is the symbol name of the INLINE method to modify. - * - * is a new code block to associate with the INLINE method. - * $RETURNS$ - * __objModInline() return a reference to . - * $DESCRIPTION$ - * __objModInline() is a low level class support function that modify - * an INLINE method in an object and replace it with a new code block. - * is unchanged if a symbol with the name does - * not exist in . __objModInline() is used in inheritance - * mechanism. - * $EXAMPLES$ - * // create a new THappy class and add a Smile INLINE method - * oHappy := HBClass():New( "THappy" ) - * bMyInline := {| nType | { ":)", ";)" }[ nType ] } - * bYourInline := {| nType | { "*SMILE*", "*WINK*" }[ nType ] } - * __objAddInline( oHappy, "Smile", bMyInline ) - * ? oHappy:Smile( 1 ) // :) - * ? oHappy:Smile( 2 ) // ;) - * // replace Smile inline method with a new code block - * __objModInline( oHappy, "Smile", bYourInline ) - * ? oHappy:Smile( 1 ) // *SMILE* - * ? oHappy:Smile( 2 ) // *WINK* - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is rtl - * $SEEALSO$ - * __objAddInline(),__objDelInline(),__ObjGetMethodList(),__objGetMsgList(),__objHasMethod() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __objModInline() + $CATEGORY$ + API + $SUBCATEGORY$ + Objects + $ONELINER$ + Modify (replace) an INLINE method in an already existing class + $SYNTAX$ + __objModInline( , , ) --> oObject + $ARGUMENTS$ + is the object to work on. + + is the symbol name of the INLINE method to modify. + + is a new code block to associate with the INLINE method. + $RETURNS$ + __objModInline() return a reference to . + $DESCRIPTION$ + __objModInline() is a low level class support function that modify + an INLINE method in an object and replace it with a new code block. + is unchanged if a symbol with the name does + not exist in . __objModInline() is used in inheritance + mechanism. + $EXAMPLES$ + // create a new THappy class and add a Smile INLINE method + oHappy := HBClass():New( "THappy" ) + bMyInline := {| nType | { ":)", ";)" }[ nType ] } + bYourInline := {| nType | { "*SMILE*", "*WINK*" }[ nType ] } + __objAddInline( oHappy, "Smile", bMyInline ) + ? oHappy:Smile( 1 ) // :) + ? oHappy:Smile( 2 ) // ;) + // replace Smile inline method with a new code block + __objModInline( oHappy, "Smile", bYourInline ) + ? oHappy:Smile( 1 ) // *SMILE* + ? oHappy:Smile( 2 ) // *WINK* + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is rtl + $SEEALSO$ + __objAddInline(),__objDelInline(),__ObjGetMethodList(),__objGetMsgList(),__objHasMethod() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __objDelMethod() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Objects - * $ONELINER$ - * Delete a METHOD from class - * $SYNTAX$ - * __objDelMethod( , ) --> oObject - * $ARGUMENTS$ - * is the object to work on. - * - * is the symbol name of METHOD or INLINE method to be - * deleted (removed) from the object. - * $RETURNS$ - * __objDelMethod() return a reference to . - * $DESCRIPTION$ - * __objDelMethod() is a low level class support function that deletes - * (removes) a METHOD or an INLINE method from an object. is - * unchanged if a symbol with the name does not exist in - * . - * - * __objDelInline() is exactly the same as __objDelMethod(). - * $EXAMPLES$ - * // create a new THappy class and add a Smile method - * oHappy := HBClass():New( "THappy" ) - * __objAddMethod( oHappy, "Smile", @MySmile() ) - * ? __objHasMethod( oHappy, "Smile" ) // .T. - * // remove Smile method - * __objDelMethod( oHappy, "Smile" ) - * ? __objHasMethod( oHappy, "Smile" ) // .F. - * - * STATIC FUNCTION MySmile( nType ) - * LOCAL cSmile - * DO CASE - * CASE nType == 1 - * cSmile := ":)" - * CASE nType == 2 - * cSmile := ";)" - * ENDCASE - * RETURN cSmile - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is rtl - * $SEEALSO$ - * __objAddInline(),__objAddMethod(),__ObjGetMethodList(),__objGetMsgList(),__objHasMethod(),__objModInline(),__objModMethod() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __objDelMethod() + $CATEGORY$ + API + $SUBCATEGORY$ + Objects + $ONELINER$ + Delete a METHOD from class + $SYNTAX$ + __objDelMethod( , ) --> oObject + $ARGUMENTS$ + is the object to work on. + + is the symbol name of METHOD or INLINE method to be + deleted (removed) from the object. + $RETURNS$ + __objDelMethod() return a reference to . + $DESCRIPTION$ + __objDelMethod() is a low level class support function that deletes + (removes) a METHOD or an INLINE method from an object. is + unchanged if a symbol with the name does not exist in + . + + __objDelInline() is exactly the same as __objDelMethod(). + $EXAMPLES$ + // create a new THappy class and add a Smile method + oHappy := HBClass():New( "THappy" ) + __objAddMethod( oHappy, "Smile", @MySmile() ) + ? __objHasMethod( oHappy, "Smile" ) // .T. + // remove Smile method + __objDelMethod( oHappy, "Smile" ) + ? __objHasMethod( oHappy, "Smile" ) // .F. + + STATIC FUNCTION MySmile( nType ) + LOCAL cSmile + DO CASE + CASE nType == 1 + cSmile := ":)" + CASE nType == 2 + cSmile := ";)" + ENDCASE + RETURN cSmile + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is rtl + $SEEALSO$ + __objAddInline(),__objAddMethod(),__ObjGetMethodList(),__objGetMsgList(),__objHasMethod(),__objModInline(),__objModMethod() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __objDelInline() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Objects - * $ONELINER$ - * Delete a METHOD INLINE from class - * $SYNTAX$ - * __objDelInline( , ) --> oObject - * $ARGUMENTS$ - * is the object to work on. - * - * is the symbol name of METHOD or INLINE method to be - * deleted (removed) from the object. - * $RETURNS$ - * __objDelInMethod() return a reference to . - * $DESCRIPTION$ - * __objDelInMethod() is a low level class support function that delete - * (remove) a METHOD or an INLINE method from an object. is - * unchanged if a symbol with the name does not exist in - * . - * $EXAMPLES$ - * // create a new THappy class and add a Smile method - * oHappy := HBClass():New( "THappy" ) - * __objAddMethod( oHappy, "Smile", @MySmile() ) - * ? __objHasMethod( oHappy, "Smile" ) // .T. - * // remove Smile method - * __objDelInMethod( oHappy, "Smile" ) - * ? __objHasMethod( oHappy, "Smile" ) // .F. - * - * STATIC FUNCTION MySmile( nType ) - * LOCAL cSmile - * DO CASE - * CASE nType == 1 - * cSmile := ":)" - * CASE nType == 2 - * cSmile := ";)" - * ENDCASE - * RETURN cSmile - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is rtl - * $SEEALSO$ - * __objAddInline(),__objAddMethod(),__ObjGetMethodList(),__objGetMsgList(),__objHasMethod(),__objModInline(),__objModMethod() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __objDelInline() + $CATEGORY$ + API + $SUBCATEGORY$ + Objects + $ONELINER$ + Delete a METHOD INLINE from class + $SYNTAX$ + __objDelInline( , ) --> oObject + $ARGUMENTS$ + is the object to work on. + + is the symbol name of METHOD or INLINE method to be + deleted (removed) from the object. + $RETURNS$ + __objDelInMethod() return a reference to . + $DESCRIPTION$ + __objDelInMethod() is a low level class support function that delete + (remove) a METHOD or an INLINE method from an object. is + unchanged if a symbol with the name does not exist in + . + $EXAMPLES$ + // create a new THappy class and add a Smile method + oHappy := HBClass():New( "THappy" ) + __objAddMethod( oHappy, "Smile", @MySmile() ) + ? __objHasMethod( oHappy, "Smile" ) // .T. + // remove Smile method + __objDelInMethod( oHappy, "Smile" ) + ? __objHasMethod( oHappy, "Smile" ) // .F. + + STATIC FUNCTION MySmile( nType ) + LOCAL cSmile + DO CASE + CASE nType == 1 + cSmile := ":)" + CASE nType == 2 + cSmile := ";)" + ENDCASE + RETURN cSmile + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is rtl + $SEEALSO$ + __objAddInline(),__objAddMethod(),__ObjGetMethodList(),__objGetMsgList(),__objHasMethod(),__objModInline(),__objModMethod() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __objDelData() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Objects - * $ONELINER$ - * Delete a VAR (instance variable) from class - * $SYNTAX$ - * __objDelMethod( , ) --> oObject - * $ARGUMENTS$ - * is the object to work on. - * - * is the symbol name of VAR to be deleted (removed) from - * the object. - * $RETURNS$ - * __objDelData() return a reference to . - * $DESCRIPTION$ - * __objDelData() is a low level class support function that delete - * (remove) a VAR from an object. is unchanged if a symbol - * with the name does not exist in . - * $EXAMPLES$ - * // create a new THappy class and add a lHappy VAR - * oHappy := HBClass():New( "THappy" ) - * __objAddData( oHappy, "lHappy" ) - * ? __objHasData( oHappy, "lHappy" ) // .T. - * // remove lHappy VAR - * __objDelData( oHappy, "lHappy" ) - * ? __objHasData( oHappy, "lHappy" ) // .F. - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is rtl - * $SEEALSO$ - * __objAddData(),__objGetMsgList(),__ObjGetValueList(),__objHasData(),__ObjSetValueList() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __objDelData() + $CATEGORY$ + API + $SUBCATEGORY$ + Objects + $ONELINER$ + Delete a VAR (instance variable) from class + $SYNTAX$ + __objDelMethod( , ) --> oObject + $ARGUMENTS$ + is the object to work on. + + is the symbol name of VAR to be deleted (removed) from + the object. + $RETURNS$ + __objDelData() return a reference to . + $DESCRIPTION$ + __objDelData() is a low level class support function that delete + (remove) a VAR from an object. is unchanged if a symbol + with the name does not exist in . + $EXAMPLES$ + // create a new THappy class and add a lHappy VAR + oHappy := HBClass():New( "THappy" ) + __objAddData( oHappy, "lHappy" ) + ? __objHasData( oHappy, "lHappy" ) // .T. + // remove lHappy VAR + __objDelData( oHappy, "lHappy" ) + ? __objHasData( oHappy, "lHappy" ) // .F. + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is rtl + $SEEALSO$ + __objAddData(),__objGetMsgList(),__ObjGetValueList(),__objHasData(),__ObjSetValueList() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __objDerivedFrom() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Objects - * $ONELINER$ - * Determine whether a class is derived from another class - * $SYNTAX$ - * __objDerivedFrom( , ) --> lIsParent - * $ARGUMENTS$ - * is the object to check. - * - * is the object that may be a parent. can be either - * an Object or a Character string with the class name. - * $RETURNS$ - * __objDerivedFrom() return a logical TRUE (.T.) if is - * derived from . - * $DESCRIPTION$ - * __objDerivedFrom() is a low level class support function that check - * is one class is a super class of the other, or in other words, does - * class a child or descendant of . - * $EXAMPLES$ - * // Create three classes and check their relations - * - * #include "hbclass.ch" - * PROCEDURE Main() - * LOCAL oSuper, oObject, oDress - * oSuper := TMood():New() - * oObject := THappy():New() - * oDress := TShirt():New() - * ? __objDerivedFrom( oObject, oSuper ) // .T. - * ? __objDerivedFrom( oSuper, oObject ) // .F. - * ? __objDerivedFrom( oObject, oDress ) // .F. - * RETURN - * - * CREATE CLASS TMood - * METHOD New() INLINE Self - * ENDCLASS - * - * CREATE CLASS THappy FROM TMood - * METHOD Smile() INLINE QOut( "*smile*" ) - * ENDCLASS - * - * CREATE CLASS TShirt - * VAR Color - * VAR Size - * METHOD New() INLINE Self - * ENDCLASS - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is rtl - * $SEEALSO$ - * __objHasData(),__ObjHasMethod() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __objDerivedFrom() + $CATEGORY$ + API + $SUBCATEGORY$ + Objects + $ONELINER$ + Determine whether a class is derived from another class + $SYNTAX$ + __objDerivedFrom( , ) --> lIsParent + $ARGUMENTS$ + is the object to check. + + is the object that may be a parent. can be either + an Object or a Character string with the class name. + $RETURNS$ + __objDerivedFrom() return a logical TRUE (.T.) if is + derived from . + $DESCRIPTION$ + __objDerivedFrom() is a low level class support function that check + is one class is a super class of the other, or in other words, does + class a child or descendant of . + $EXAMPLES$ + // Create three classes and check their relations + + #include "hbclass.ch" + PROCEDURE Main() + LOCAL oSuper, oObject, oDress + oSuper := TMood():New() + oObject := THappy():New() + oDress := TShirt():New() + ? __objDerivedFrom( oObject, oSuper ) // .T. + ? __objDerivedFrom( oSuper, oObject ) // .F. + ? __objDerivedFrom( oObject, oDress ) // .F. + RETURN + + CREATE CLASS TMood + METHOD New() INLINE Self + ENDCLASS + + CREATE CLASS THappy FROM TMood + METHOD Smile() INLINE QOut( "*smile*" ) + ENDCLASS + + CREATE CLASS TShirt + VAR Color + VAR Size + METHOD New() INLINE Self + ENDCLASS + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is rtl + $SEEALSO$ + __objHasData(),__ObjHasMethod() + $END$ */ diff --git a/harbour/doc/en/rdddb.txt b/harbour/doc/en/rdddb.txt index 6ee303e084..245efa2c54 100644 --- a/harbour/doc/en/rdddb.txt +++ b/harbour/doc/en/rdddb.txt @@ -2,7 +2,6 @@ * $Id$ */ - /* * The following parts are Copyright of the individual authors. * www - http://harbour-project.org @@ -16,1258 +15,1258 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DBEVAL() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Execute and Execution - * $ONELINER$ - * Performs a code block operation on the current Database - * $SYNTAX$ - * DBEVAL( , - * [], [], - * [], [], - * [] ) --> NIL - * $ARGUMENTS$ - * Operation that is to be performed - * - * Code block for the For condition - * - * Code block for the WHILE condition - * - * Number of NEXT records to process - * - * Record number to work on exactly - * - * Toggle to rewind record pointer - * $RETURNS$ - * DBEVAL() always returns NIL - * $DESCRIPTION$ - * Performs a code block operation on the current Database - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL nCount - * - * USE test - * - * dbGoto( 4 ) - * ? RecNo() - * COUNT TO nCount - * ? RecNo(), nCount - * COUNT TO nCount NEXT 10 - * ? RecNo(), nCount - * - * RETURN - * $STATUS$ - * S - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * EVAL() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DBEVAL() + $CATEGORY$ + API + $SUBCATEGORY$ + Execute and Execution + $ONELINER$ + Performs a code block operation on the current Database + $SYNTAX$ + DBEVAL( , + [], [], + [], [], + [] ) --> NIL + $ARGUMENTS$ + Operation that is to be performed + + Code block for the For condition + + Code block for the WHILE condition + + Number of NEXT records to process + + Record number to work on exactly + + Toggle to rewind record pointer + $RETURNS$ + DBEVAL() always returns NIL + $DESCRIPTION$ + Performs a code block operation on the current Database + $EXAMPLES$ + PROCEDURE Main() + LOCAL nCount + + USE test + + dbGoto( 4 ) + ? RecNo() + COUNT TO nCount + ? RecNo(), nCount + COUNT TO nCount NEXT 10 + ? RecNo(), nCount + + RETURN + $STATUS$ + S + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + EVAL() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DBF() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Alias name of a work area - * $SYNTAX$ - * Dbf() --> - * $RETURNS$ - * Name of alias - * $DESCRIPTION$ - * This function returns the same alias name ofthe currently selected - * work area. - * $EXAMPLES$ - * PROCEDURE Main() - * - * USE test - * SELECT 0 - * ? iif( DBF() == "", "No Name", DBF() ) - * ? test->( DBF() ) - * ? Alias( 1 ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * ALIAS() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DBF() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Alias name of a work area + $SYNTAX$ + Dbf() --> + $RETURNS$ + Name of alias + $DESCRIPTION$ + This function returns the same alias name ofthe currently selected + work area. + $EXAMPLES$ + PROCEDURE Main() + + USE test + SELECT 0 + ? iif( DBF() == "", "No Name", DBF() ) + ? test->( DBF() ) + ? Alias( 1 ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + ALIAS() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DBAPPEND() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Appends a new record to a database file. - * $SYNTAX$ - * DbAppend( [] ) --> NIL - * $ARGUMENTS$ - * Toggle to release record locks - * $RETURNS$ - * DbAppend() always returns NIL - * $DESCRIPTION$ - * This function add a new record to the end of the database - * in the selected or aliased work area. All fields in that - * database will be given empty data values - character fields - * will be filled with blank spaces,date fields with CTOD('//'), - * numeric fields with 0, logical fields with .F., and memo fields - * with NULL bytes. The header of the database is not updated until - * the record is flushed from the buffer and the contents are - * written to the disk. - * - * Under a networking enviroment, DBAPPEND() performs an additional - * operation: It attrmps to lock the newly added record. If - * the database file is currently locked or if a locking assignment - * if made to LASTREC()+1, NETERR() will return a logical true (.T.) - * immediately after the DBAPPEND() function. This function does - * not unlock the locked records. - * - * If is passed a logical true (.T.) value, it will - * release the record locks, which allows the application to main- - * tain multiple record locks during an appending operation. The - * default for this parameter is a logical false (.F.). - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL cName := "HARBOUR", nId := 10 - * USE test - * test->( dbAppend() ) - * REPLACE test->Name WITH cName, test->Id WITH nId - * USE - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBUNLOCK(),DBUNLOCKALL() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DBAPPEND() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Appends a new record to a database file. + $SYNTAX$ + DbAppend( [] ) --> NIL + $ARGUMENTS$ + Toggle to release record locks + $RETURNS$ + DbAppend() always returns NIL + $DESCRIPTION$ + This function add a new record to the end of the database + in the selected or aliased work area. All fields in that + database will be given empty data values - character fields + will be filled with blank spaces,date fields with CTOD('//'), + numeric fields with 0, logical fields with .F., and memo fields + with NULL bytes. The header of the database is not updated until + the record is flushed from the buffer and the contents are + written to the disk. + + Under a networking enviroment, DBAPPEND() performs an additional + operation: It attrmps to lock the newly added record. If + the database file is currently locked or if a locking assignment + if made to LASTREC()+1, NETERR() will return a logical true (.T.) + immediately after the DBAPPEND() function. This function does + not unlock the locked records. + + If is passed a logical true (.T.) value, it will + release the record locks, which allows the application to main- + tain multiple record locks during an appending operation. The + default for this parameter is a logical false (.F.). + $EXAMPLES$ + PROCEDURE Main() + LOCAL cName := "HARBOUR", nId := 10 + USE test + test->( dbAppend() ) + REPLACE test->Name WITH cName, test->Id WITH nId + USE + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBUNLOCK(),DBUNLOCKALL() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DBCLEARFILTER() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Clears the current filter condiction in a work area - * $SYNTAX$ - * DbClearFilTer() --> NIL - * $RETURNS$ - * DbClearFilTer() always returns NIL - * $DESCRIPTION$ - * This function clears any active filter condiction - * for the current or selected work area. - * $EXAMPLES$ - * PROCEDURE Main() - * USE test - * SET FILTER TO Left( test->Name, 2 ) == "An" - * dbEdit() - * Test->( dbClearFilter() ) - * USE - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBSETFILTER(),DBFILTER() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DBCLEARFILTER() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Clears the current filter condiction in a work area + $SYNTAX$ + DbClearFilTer() --> NIL + $RETURNS$ + DbClearFilTer() always returns NIL + $DESCRIPTION$ + This function clears any active filter condiction + for the current or selected work area. + $EXAMPLES$ + PROCEDURE Main() + USE test + SET FILTER TO Left( test->Name, 2 ) == "An" + dbEdit() + Test->( dbClearFilter() ) + USE + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBSETFILTER(),DBFILTER() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DBCLOSEALL() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Close all open files in all work areas. - * $SYNTAX$ - * DbCloseAll() --> NIL - * $RETURNS$ - * DBCLOSEALL() always return NIL - * $DESCRIPTION$ - * This function close all open databases and all associated - * indexes. In addition, it closes all format files and moves - * the work area pointer to the first position - * $EXAMPLES$ - * PROCEDURE Main() - * USE test NEW - * dbEdit() - * USE test1 NEW - * dbEdit() - * dbCloseAll() - * USE - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBUSEAREA(),DBCLOSEAREA() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DBCLOSEALL() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Close all open files in all work areas. + $SYNTAX$ + DbCloseAll() --> NIL + $RETURNS$ + DBCLOSEALL() always return NIL + $DESCRIPTION$ + This function close all open databases and all associated + indexes. In addition, it closes all format files and moves + the work area pointer to the first position + $EXAMPLES$ + PROCEDURE Main() + USE test NEW + dbEdit() + USE test1 NEW + dbEdit() + dbCloseAll() + USE + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBUSEAREA(),DBCLOSEAREA() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * DBCLOSEAREA() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Close a database file in a work area. - * $SYNTAX$ - * DbCloseArea() - * $DESCRIPTION$ - * This function will close any database open in the selected - * or aliased work area. - * $EXAMPLES$ - * PROCEDURE Main() - * USE test - * dbEdit() - * Test->( dbCloseArea() ) - * USE - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBUSEAREA(),DBCLOSEALL() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + DBCLOSEAREA() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Close a database file in a work area. + $SYNTAX$ + DbCloseArea() + $DESCRIPTION$ + This function will close any database open in the selected + or aliased work area. + $EXAMPLES$ + PROCEDURE Main() + USE test + dbEdit() + Test->( dbCloseArea() ) + USE + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBUSEAREA(),DBCLOSEALL() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * DBCOMMIT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Updates all index and database buffers for a given workarea - * $SYNTAX$ - * DBCOMMIT() - * $DESCRIPTION$ - * This function updates all of the information for a give,selected, - * or active workarea. This operation includes all database and index - * buffers for that work area only. This function does not update all - * open work areas. - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL cName := SPACE( 40 ) - * LOCAL nId := 0 - * USE test EXCLUSIVE NEW - * // - * @ 10, 10 GET cName - * @ 11, 10 GET nId - * READ - * // - * IF UPDATED() - * APPEND BLANK - * REPLACE tests->Name WITH cName - * REPLACE tests->Id WITH nId - * tests->( DBCOMMIT() ) - * ENDIF - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBCLOSEALL(),DBCOMMITALL(),DBUNLOCK() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + DBCOMMIT() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Updates all index and database buffers for a given workarea + $SYNTAX$ + DBCOMMIT() + $DESCRIPTION$ + This function updates all of the information for a give,selected, + or active workarea. This operation includes all database and index + buffers for that work area only. This function does not update all + open work areas. + $EXAMPLES$ + PROCEDURE Main() + LOCAL cName := SPACE( 40 ) + LOCAL nId := 0 + USE test EXCLUSIVE NEW + // + @ 10, 10 GET cName + @ 11, 10 GET nId + READ + // + IF UPDATED() + APPEND BLANK + REPLACE tests->Name WITH cName + REPLACE tests->Id WITH nId + tests->( DBCOMMIT() ) + ENDIF + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBCLOSEALL(),DBCOMMITALL(),DBUNLOCK() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * DBCOMMITALL() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Flushes the memory buffer and performs a hard-disk write - * $SYNTAX$ - * DBCOMMIT() - * $DESCRIPTION$ - * This function performs a hard-disk write for all work areas. - * Before the disk write is performed,all buffers are flushed. - * open work areas. - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL cName := SPACE( 40 ) - * LOCAL nId := 0 - * USE test EXCLUSIVE NEW - * USE testid NEW INDEX testid - * // - * @ 10, 10 GET cName - * @ 11, 10 GET nId - * READ - * // - * IF UPDATED() - * APPEND BLANK - * REPLACE tests->Name WITH cName - * REPLACE tests->Id WITH nId - * IF ! testid->( DBSEEK( nId ) ) - * APPEND BLANK - * REPLACE tests->Id WITH nId - * ENDIF - * ENDIF - * DBCOMMITALL() - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBCLOSEALL(),DBCOMMIT(),DBUNLOCK() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + DBCOMMITALL() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Flushes the memory buffer and performs a hard-disk write + $SYNTAX$ + DBCOMMIT() + $DESCRIPTION$ + This function performs a hard-disk write for all work areas. + Before the disk write is performed,all buffers are flushed. + open work areas. + $EXAMPLES$ + PROCEDURE Main() + LOCAL cName := SPACE( 40 ) + LOCAL nId := 0 + USE test EXCLUSIVE NEW + USE testid NEW INDEX testid + // + @ 10, 10 GET cName + @ 11, 10 GET nId + READ + // + IF UPDATED() + APPEND BLANK + REPLACE tests->Name WITH cName + REPLACE tests->Id WITH nId + IF ! testid->( DBSEEK( nId ) ) + APPEND BLANK + REPLACE tests->Id WITH nId + ENDIF + ENDIF + DBCOMMITALL() + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBCLOSEALL(),DBCOMMIT(),DBUNLOCK() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * DBCREATE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Creates an empty database from a array. - * $SYNTAX$ - * DBCREATE( , , [], [], - * [] ) - * $ARGUMENTS$ - * Name of database to be create - * - * Name of a multidimensional array that contains the - * database structure - * - * Name of the RDD - * - * 3-way toggle to Open the file in New or Current workarea: - * - * - * NIL The file is not opened. - * True It is opened in a New area. - * False It is opened in the current area. - *
- * - * Name of database Alias - * $DESCRIPTION$ - * This function creates the database file specified as from the - * multidimensional array . If no file extension is use with - * the .dbf extension is assumed. - * The array specified in must follow a few guidelines when being - * built prior to a call to DBCREATE(): - * - * - All subscripts values in the second dimension must be set to proper values - * - * - The fourth subscript value in the second dimension - which contains - * the decimal value-must he specified. even 1kw nonnumeric fields. - * - * - The second subscript value in the second dimension-which contains - * the field data type-must contain a proper value: C, D, L, M or N - * It is possible to use additional letters (or clarity (e.g., 'Numeric' - * for 'N'): however, the first letter of this array element must - * be a proper value. - * - * The DBCREATE( ) function does not use the decimal field to - * calculate the length of a character held longer than 256. Values - * up to the maximum length of a character field (which is 65,519 bytes) - * are stored directly in the database in the length attribute if that - * database was created via this function. However, a file containing - * fields longer than 256 bytes is not compatible with any interpreter. - * - * The parameter specifies the name of the Replaceable - * Database Driver to use to create the database. If it is not - * specified, then the Replaceable Database Driver in the current work - * area is used. - * - * The parameter specifies if the already created database is - * to be opened, and where. If NIL, the file is not opened. If True, - * it is opened in a New area, and if False it is opened in the current - * area (closing any file already occupying that area). - * The parameter specifies the alias name for the new opened - * database. - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL nI, aStruct := { { "CHARACTER", "C", 25, 0 }, ; - * { "NUMERIC", "N", 8, 0 }, ; - * { "DOUBLE", "N", 8, 2 }, ; - * { "DATE", "D", 8, 0 }, ; - * { "LOGICAL", "L", 1, 0 }, ; - * { "MEMO1", "M", 10, 0 }, ; - * { "MEMO2", "M", 10, 0 } } - * - * REQUEST DBFCDX - * - * dbCreate( "testdbf", aStruct, "DBFCDX", .T., "MYALIAS" ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is not CA-Cl*pper compliant - * $FILES$ - * Library is rdd - * Header is dbstruct.ch - * $SEEALSO$ - * AFIELDS()*,DBSTRUCT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + DBCREATE() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Creates an empty database from a array. + $SYNTAX$ + DBCREATE( , , [], [], + [] ) + $ARGUMENTS$ + Name of database to be create + + Name of a multidimensional array that contains the + database structure + + Name of the RDD + + 3-way toggle to Open the file in New or Current workarea: + + + NIL The file is not opened. + True It is opened in a New area. + False It is opened in the current area. +
+ + Name of database Alias + $DESCRIPTION$ + This function creates the database file specified as from the + multidimensional array . If no file extension is use with + the .dbf extension is assumed. + The array specified in must follow a few guidelines when being + built prior to a call to DBCREATE(): + + - All subscripts values in the second dimension must be set to proper values + + - The fourth subscript value in the second dimension - which contains + the decimal value-must he specified. even 1kw nonnumeric fields. + + - The second subscript value in the second dimension-which contains + the field data type-must contain a proper value: C, D, L, M or N + It is possible to use additional letters (or clarity (e.g., 'Numeric' + for 'N'): however, the first letter of this array element must + be a proper value. + + The DBCREATE( ) function does not use the decimal field to + calculate the length of a character held longer than 256. Values + up to the maximum length of a character field (which is 65,519 bytes) + are stored directly in the database in the length attribute if that + database was created via this function. However, a file containing + fields longer than 256 bytes is not compatible with any interpreter. + + The parameter specifies the name of the Replaceable + Database Driver to use to create the database. If it is not + specified, then the Replaceable Database Driver in the current work + area is used. + + The parameter specifies if the already created database is + to be opened, and where. If NIL, the file is not opened. If True, + it is opened in a New area, and if False it is opened in the current + area (closing any file already occupying that area). + The parameter specifies the alias name for the new opened + database. + $EXAMPLES$ + PROCEDURE Main() + LOCAL nI, aStruct := { { "CHARACTER", "C", 25, 0 }, ; + { "NUMERIC", "N", 8, 0 }, ; + { "DOUBLE", "N", 8, 2 }, ; + { "DATE", "D", 8, 0 }, ; + { "LOGICAL", "L", 1, 0 }, ; + { "MEMO1", "M", 10, 0 }, ; + { "MEMO2", "M", 10, 0 } } + + REQUEST DBFCDX + + dbCreate( "testdbf", aStruct, "DBFCDX", .T., "MYALIAS" ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + This function is not CA-Cl*pper compliant + $FILES$ + Library is rdd + Header is dbstruct.ch + $SEEALSO$ + AFIELDS()*,DBSTRUCT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * DBDELETE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Mark a record for deletion in a database. - * $SYNTAX$ - * DBDELETE() - * $DESCRIPTION$ - * This function marks a record for deletion in the selected - * or aliased work area. If the DELETED setting is on, the record - * will still be visible until the record pointer in that work area - * is moved to another record. - * - * In a networking situation, this function requires that the record - * be locked prior to issuing the DBDELETE() function. - * $EXAMPLES$ - * nId := 10 - * USE testid INDEX testid NEW - * IF testid->( DBSEEK( nId ) ) - * IF testid->( RLOCK() ) - * DBDELETE() - * ENDIF - * ENDIF - * USE - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBRECALL() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + DBDELETE() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Mark a record for deletion in a database. + $SYNTAX$ + DBDELETE() + $DESCRIPTION$ + This function marks a record for deletion in the selected + or aliased work area. If the DELETED setting is on, the record + will still be visible until the record pointer in that work area + is moved to another record. + + In a networking situation, this function requires that the record + be locked prior to issuing the DBDELETE() function. + $EXAMPLES$ + nId := 10 + USE testid INDEX testid NEW + IF testid->( DBSEEK( nId ) ) + IF testid->( RLOCK() ) + DBDELETE() + ENDIF + ENDIF + USE + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBRECALL() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DBFILTER() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Return the filter expression in a work area - * $SYNTAX$ - * DBFILTER() --> cFilter - * $RETURNS$ - * DBFILTER() returns the filter expression. - * $DESCRIPTION$ - * This function return the expression of the SET FILTER TO command - * for the current or designated work area. If no filter condition - * is present, a NULL string will be returned. - * $EXAMPLES$ - * USE test INDEX test NEW - * SET FILTER TO Name == "Harbour" - * USE testid INDEX testid NEW - * SET FILTER TO Id == 1 - * SELECT Test - * // - * ? DBFILTER() - * ? testid->( DBFILTER() ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBRELATION(),DBRSELECT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DBFILTER() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Return the filter expression in a work area + $SYNTAX$ + DBFILTER() --> cFilter + $RETURNS$ + DBFILTER() returns the filter expression. + $DESCRIPTION$ + This function return the expression of the SET FILTER TO command + for the current or designated work area. If no filter condition + is present, a NULL string will be returned. + $EXAMPLES$ + USE test INDEX test NEW + SET FILTER TO Name == "Harbour" + USE testid INDEX testid NEW + SET FILTER TO Id == 1 + SELECT Test + // + ? DBFILTER() + ? testid->( DBFILTER() ) + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBRELATION(),DBRSELECT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * DBGOBOTTOM() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Moves the record pointer to the bottom of the database. - * $SYNTAX$ - * DBGOBOTTOM() - * $DESCRIPTION$ - * This function moves the record pointer in the selected or aliased - * work area to the end of the file. The position of the record pointer - * is affected by the values in the index key or by an active FILTER - * condition. Otherwise, if no index is active or if no filter condition - * is present, the value of the record pointer will be LASTREC(). - * $EXAMPLES$ - * USE tests - * DBGOTOP() - * ? RECNO() - * DBGOBOTTOM() - * ? RECNO() - * USE - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * BOF(),EOF(),DBSKIP(),DBSEEK(),DBGOTOP() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + DBGOBOTTOM() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Moves the record pointer to the bottom of the database. + $SYNTAX$ + DBGOBOTTOM() + $DESCRIPTION$ + This function moves the record pointer in the selected or aliased + work area to the end of the file. The position of the record pointer + is affected by the values in the index key or by an active FILTER + condition. Otherwise, if no index is active or if no filter condition + is present, the value of the record pointer will be LASTREC(). + $EXAMPLES$ + USE tests + DBGOTOP() + ? RECNO() + DBGOBOTTOM() + ? RECNO() + USE + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + BOF(),EOF(),DBSKIP(),DBSEEK(),DBGOTOP() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * DBGOTO() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Position the record pointer to a specific location. - * $SYNTAX$ - * DBGOTO() - * $ARGUMENTS$ - * Record number or unique identity - * $DESCRIPTION$ - * This function places the record pointer, if working with a .dbf file, - * in selected or aliased work area at the record number specified by - * . The position is not affected by an active index or - * by any enviromental SET condiction. - * - * The parameter may be something other than a record - * number. In some data formats, for example, the value of - * is a unique primary key while in other formats, could - * be an array offset if the data set was an array. - * - * Issuing a DBGOTO(RECNO()) call in a network enviroment will refresh - * the database and index buffers. This is the same as a DBSKIP(0) call. - * $EXAMPLES$ - * The following example uses DBGOTO() to iteratively process - * every fourth record: - * - * DBUSEAREA( .T., "DBFNTX", "sales", "sales", .T. ) - * // - * // toggle every fourth record - * DO WHILE ! EOF() - * DBGOTO( RECNO() + 4 ) - * sales->Group := "Bear" - * ENDDO - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * BOF(),EOF(),DBGOTOP(),DBGOBOTTOM(),DBSEEK(),DBSKIP() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + DBGOTO() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Position the record pointer to a specific location. + $SYNTAX$ + DBGOTO() + $ARGUMENTS$ + Record number or unique identity + $DESCRIPTION$ + This function places the record pointer, if working with a .dbf file, + in selected or aliased work area at the record number specified by + . The position is not affected by an active index or + by any enviromental SET condiction. + + The parameter may be something other than a record + number. In some data formats, for example, the value of + is a unique primary key while in other formats, could + be an array offset if the data set was an array. + + Issuing a DBGOTO(RECNO()) call in a network enviroment will refresh + the database and index buffers. This is the same as a DBSKIP(0) call. + $EXAMPLES$ + The following example uses DBGOTO() to iteratively process + every fourth record: + + DBUSEAREA( .T., "DBFNTX", "sales", "sales", .T. ) + // + // toggle every fourth record + DO WHILE ! EOF() + DBGOTO( RECNO() + 4 ) + sales->Group := "Bear" + ENDDO + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + BOF(),EOF(),DBGOTOP(),DBGOBOTTOM(),DBSEEK(),DBSKIP() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * DBGOTOP() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Moves the record pointer to the top of the database. - * $SYNTAX$ - * DBGOTOP() - * $DESCRIPTION$ - * This function moves the record pointer in the selected or aliased - * work area to the top of the file. The position of the record pointer - * is affected by the values in the index key or by an active FILTER - * condition. Otherwise, if no index is active or if no filter condition - * is present, the value of RECNO() will be 1. - * $EXAMPLES$ - * USE tests - * DBGOTOP() - * ? RECNO() - * DBGOBOTTOM() - * ? RECNO() - * USE - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * BOF(),EOF(),DBSKIP(),DBSEEK(),DBGOBOTTOM() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + DBGOTOP() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Moves the record pointer to the top of the database. + $SYNTAX$ + DBGOTOP() + $DESCRIPTION$ + This function moves the record pointer in the selected or aliased + work area to the top of the file. The position of the record pointer + is affected by the values in the index key or by an active FILTER + condition. Otherwise, if no index is active or if no filter condition + is present, the value of RECNO() will be 1. + $EXAMPLES$ + USE tests + DBGOTOP() + ? RECNO() + DBGOBOTTOM() + ? RECNO() + USE + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + BOF(),EOF(),DBSKIP(),DBSEEK(),DBGOBOTTOM() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * DBRECALL() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Recalls a record previousy marked for deletion. - * $SYNTAX$ - * DBRECALL() - * $DESCRIPTION$ - * This function unmarks those records marked for deletion and - * reactivates them in the aliased or selected work area. If a record - * is DELETED and the DELETED setting is on, the record will still be - * visible for a DBRECALL() provided that the database record pointer - * has not been skipped. Once a record marked for deletion with the - * DELETE setting ON has been skipped, it no longer can be brought back - * with DBRECALL(). - * $EXAMPLES$ - * USE test NEW - * DBGOTO( 10 ) - * DBDELETE() - * ? DELETED() - * DBRECALL() - * ? DELETED() - * USE - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBDELETE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + DBRECALL() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Recalls a record previousy marked for deletion. + $SYNTAX$ + DBRECALL() + $DESCRIPTION$ + This function unmarks those records marked for deletion and + reactivates them in the aliased or selected work area. If a record + is DELETED and the DELETED setting is on, the record will still be + visible for a DBRECALL() provided that the database record pointer + has not been skipped. Once a record marked for deletion with the + DELETE setting ON has been skipped, it no longer can be brought back + with DBRECALL(). + $EXAMPLES$ + USE test NEW + DBGOTO( 10 ) + DBDELETE() + ? DELETED() + DBRECALL() + ? DELETED() + USE + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBDELETE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DBRLOCK() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * This function locks the record based on identity - * $SYNTAX$ - * DBRLOCK([]) --> lSuccess - * $ARGUMENTS$ - * Record identifier - * $RETURNS$ - * DBRLOCK() returns a logical true (.T.) if lock was successful - * $DESCRIPTION$ - * This function attempts to lock a record which is identified - * by in the active data set. If the lock is successful - * the function will return a logical true (.T.) value; otherwise - * a logical false (.F.) will be returned. If is not - * passed it will be assumed to lock the current active record/data - * item. - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL x := 0 - * USE tests NEW - * FOR x := 1 TO reccount() - * IF ! DBRLOCK() - * DBUNLOCK() - * ENDIF - * NEXT - * USE - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBUNLOCK(),DBUNLOCKALL(),FLOCK(),RLOCK() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DBRLOCK() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + This function locks the record based on identity + $SYNTAX$ + DBRLOCK([]) --> lSuccess + $ARGUMENTS$ + Record identifier + $RETURNS$ + DBRLOCK() returns a logical true (.T.) if lock was successful + $DESCRIPTION$ + This function attempts to lock a record which is identified + by in the active data set. If the lock is successful + the function will return a logical true (.T.) value; otherwise + a logical false (.F.) will be returned. If is not + passed it will be assumed to lock the current active record/data + item. + $EXAMPLES$ + PROCEDURE Main() + LOCAL x := 0 + USE tests NEW + FOR x := 1 TO reccount() + IF ! DBRLOCK() + DBUNLOCK() + ENDIF + NEXT + USE + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBUNLOCK(),DBUNLOCKALL(),FLOCK(),RLOCK() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DBRLOCKLIST() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * This function return a list of locked records in the database work area - * $SYNTAX$ - * DBRLOCKLIST() --> aRecordLocks - * $RETURNS$ - * is an array of lock records - * $DESCRIPTION$ - * This function will return an array of locked records in a given - * and active work area. If the return array is an empty array - * (meaning no elements in it), then there are no locked records in that - * work area. - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL aList := {} - * LOCAL x := 0 - * USE tests NEW - * DBGOTO( 10 ) - * RLOCK() - * DBGOTO( 100 ) - * RLOCK() - * aList := DBRLOCKLIST() - * FOR x := 1 TO Len( aList ) - * ? aList[ x ] - * NEXT - * USE - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * RLOCK(),DBRLOCK(),DBRUNLOCK() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DBRLOCKLIST() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + This function return a list of locked records in the database work area + $SYNTAX$ + DBRLOCKLIST() --> aRecordLocks + $RETURNS$ + is an array of lock records + $DESCRIPTION$ + This function will return an array of locked records in a given + and active work area. If the return array is an empty array + (meaning no elements in it), then there are no locked records in that + work area. + $EXAMPLES$ + PROCEDURE Main() + LOCAL aList := {} + LOCAL x := 0 + USE tests NEW + DBGOTO( 10 ) + RLOCK() + DBGOTO( 100 ) + RLOCK() + aList := DBRLOCKLIST() + FOR x := 1 TO Len( aList ) + ? aList[ x ] + NEXT + USE + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + RLOCK(),DBRLOCK(),DBRUNLOCK() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * DBRUNLOCK() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Unlocks a record based on its identifier - * $SYNTAX$ - * DBRUNLOCK([]) - * $ARGUMENTS$ - * Record identifier, typically a record number - * $DESCRIPTION$ - * This function will attempt to unlock the record specified as - * , which in a .dbf format is the record number. If not - * specified, them the current active record/data item will be - * unlocked - * $EXAMPLES$ - * PROCEDURE Main() - * USE tests NEW - * DBGOTO( 10 ) - * IF RLOCK() - * ? tests->ID - * DBRUNLOCK() - * ENDIF - * USE - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * RLOCK(),DBRLOCK(),DBRLOCKLIST() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + DBRUNLOCK() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Unlocks a record based on its identifier + $SYNTAX$ + DBRUNLOCK([]) + $ARGUMENTS$ + Record identifier, typically a record number + $DESCRIPTION$ + This function will attempt to unlock the record specified as + , which in a .dbf format is the record number. If not + specified, them the current active record/data item will be + unlocked + $EXAMPLES$ + PROCEDURE Main() + USE tests NEW + DBGOTO( 10 ) + IF RLOCK() + ? tests->ID + DBRUNLOCK() + ENDIF + USE + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + RLOCK(),DBRLOCK(),DBRLOCKLIST() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DBSEEK() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Searches for a value based on an active index. - * $SYNTAX$ - * DBSEEK(, [],[]) --> lFound - * $ARGUMENTS$ - * Any expression - * - * Toggle SOFTSEEK condition - * - * is an optional logical value that set the current - * record position to the last record if successful - * $RETURNS$ - * DBSEEK() returns logical true (.T.) if found, otherwise false - * $DESCRIPTION$ - * This function searches for the first record in a database file whose - * index key matches . If the item is found, the function will - * return a logical true (.T.), the value of FOUND() wilI be a logical - * true (.T.), and the value of EOF() wilI be a logical false (.F.). If - * no item is found. then the function will return a logical false, the - * value of FOUND( ) will be a logical false (.F.), and the value of - * EOF( ) will be a logical true (.T.). - * - * This function always "rewinds" the database pointer and starts the - * search from the top of the file. - * - * If the SOFTSEEK flag is on or if is set to a logical true - * (.T.) the value of FOUND() will be a logical false and EOF() will be - * false if there is an item in the index key with a greater value than - * the key expression ; at this point the record pointer will - * position itself on that record. However, if there is no greater key - * in the index,EOF() will return a logical true (.T.) value. If - * is not passed, the function will look to the internal - * status of SOFTSEEK before performing the operation. The default of - * is a logical false (.F.) - * $EXAMPLES$ - * PROCEDURE Main() - * USE tests NEW INDEX tests - * DBGOTO( 10 ) - * nId := tests->nId - * IF tests->( DBSEEK( nId ) ) - * IF RLOCK() - * ? tests->Name - * DBRUNLOCK() - * ENDIF - * ENDIF - * USE - * RETURN - * - * ACCEPT "Employee name: " TO cName - * IF Employee->( DBSEEK( cName ) ) - * Employee->( ViewRecord() ) - * ELSE - * ? "Not found" - * ENDIF - * $STATUS$ - * S - * $COMPLIANCE$ - * DBSEEK() is Compatible with CA-Cl*pper 5.3 - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBGOBOTTOM(),DBGOTOP(),DBSKIP(),EOF(),BOF(),FOUND() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DBSEEK() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Searches for a value based on an active index. + $SYNTAX$ + DBSEEK(, [],[]) --> lFound + $ARGUMENTS$ + Any expression + + Toggle SOFTSEEK condition + + is an optional logical value that set the current + record position to the last record if successful + $RETURNS$ + DBSEEK() returns logical true (.T.) if found, otherwise false + $DESCRIPTION$ + This function searches for the first record in a database file whose + index key matches . If the item is found, the function will + return a logical true (.T.), the value of FOUND() wilI be a logical + true (.T.), and the value of EOF() wilI be a logical false (.F.). If + no item is found. then the function will return a logical false, the + value of FOUND( ) will be a logical false (.F.), and the value of + EOF( ) will be a logical true (.T.). + + This function always "rewinds" the database pointer and starts the + search from the top of the file. + + If the SOFTSEEK flag is on or if is set to a logical true + (.T.) the value of FOUND() will be a logical false and EOF() will be + false if there is an item in the index key with a greater value than + the key expression ; at this point the record pointer will + position itself on that record. However, if there is no greater key + in the index,EOF() will return a logical true (.T.) value. If + is not passed, the function will look to the internal + status of SOFTSEEK before performing the operation. The default of + is a logical false (.F.) + $EXAMPLES$ + PROCEDURE Main() + USE tests NEW INDEX tests + DBGOTO( 10 ) + nId := tests->nId + IF tests->( DBSEEK( nId ) ) + IF RLOCK() + ? tests->Name + DBRUNLOCK() + ENDIF + ENDIF + USE + RETURN + + ACCEPT "Employee name: " TO cName + IF Employee->( DBSEEK( cName ) ) + Employee->( ViewRecord() ) + ELSE + ? "Not found" + ENDIF + $STATUS$ + S + $COMPLIANCE$ + DBSEEK() is Compatible with CA-Cl*pper 5.3 + $FILES$ + Library is rdd + $SEEALSO$ + DBGOBOTTOM(),DBGOTOP(),DBSKIP(),EOF(),BOF(),FOUND() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * DBSELECTAREA() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Change to another work area - * $SYNTAX$ - * DBSELECTAREA() - - * $ARGUMENTS$ - * Alias or work area - * $DESCRIPTION$ - * This function moves the Harbour internal primary focus to the work - * area designated by . If is numeric, then it will - * select the numeric work area; if is character,then it will - * select the work area with the alias name. - * - * DBSELECTAREA(0) will select the next avaliable and unused work area. - * Up to 255 work areas are supported. Each work area has its own alias - * and record pointer, as well as its own FOUND(), DBFILTER(), - * DBRSELECT() and DBRELATION() function values. - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL nId - * USE tests NEW INDEX tests - * USE tests1 NEW INDEX tests1 - * DBSELECTAREA( 1 ) - * nId := tests->Id - * DBSELECTAREA( 2 ) - * IF DBSEEK( nId ) - * ? tests1->cName - * ENDIF - * DBCLOSEALL() - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBUSEAREA(),SELECT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + DBSELECTAREA() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Change to another work area + $SYNTAX$ + DBSELECTAREA() - + $ARGUMENTS$ + Alias or work area + $DESCRIPTION$ + This function moves the Harbour internal primary focus to the work + area designated by . If is numeric, then it will + select the numeric work area; if is character,then it will + select the work area with the alias name. + + DBSELECTAREA(0) will select the next avaliable and unused work area. + Up to 255 work areas are supported. Each work area has its own alias + and record pointer, as well as its own FOUND(), DBFILTER(), + DBRSELECT() and DBRELATION() function values. + $EXAMPLES$ + PROCEDURE Main() + LOCAL nId + USE tests NEW INDEX tests + USE tests1 NEW INDEX tests1 + DBSELECTAREA( 1 ) + nId := tests->Id + DBSELECTAREA( 2 ) + IF DBSEEK( nId ) + ? tests1->cName + ENDIF + DBCLOSEALL() + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBUSEAREA(),SELECT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DBSETDRIVER() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Establishes the RDD name for the selected work area - * $SYNTAX$ - * DBSETDRIVER( [] ) --> cCurrentDriver - * $ARGUMENTS$ - * Optional database driver name - * $RETURNS$ - * DBSETDRIVER() returns the name of active driver - * $DESCRIPTION$ - * This function returns the name of the current database driver for the - * selected work area. The default will be "DBFNTX". If specified, - * contains the name of the database driver that should be - * used to activate and manage the work area. If the specified driver is - * not avaliable,this function will have no effect. - * $EXAMPLES$ - * DBSETDRIVER("ADS") - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBUSEAREA() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DBSETDRIVER() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Establishes the RDD name for the selected work area + $SYNTAX$ + DBSETDRIVER( [] ) --> cCurrentDriver + $ARGUMENTS$ + Optional database driver name + $RETURNS$ + DBSETDRIVER() returns the name of active driver + $DESCRIPTION$ + This function returns the name of the current database driver for the + selected work area. The default will be "DBFNTX". If specified, + contains the name of the database driver that should be + used to activate and manage the work area. If the specified driver is + not avaliable,this function will have no effect. + $EXAMPLES$ + DBSETDRIVER("ADS") + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBUSEAREA() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * DBSKIP() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Moves the record pointer in the selected work area. - * $SYNTAX$ - * DBSKIP([]) - * $ARGUMENTS$ - * Numbers of records to move record pointer. - * $DESCRIPTION$ - * This function moves the record pointer in the selected or - * aliased work area. The default value for will be 1. - * A DBSKIP(0) will flush and refresh the internal database bufer and - * make any changes made to the record visible without moving the record - * pointer in either direction. - * $EXAMPLES$ - * PROCEDURE Main() - * USE tests NEW - * DBGOTOP() - * DO WHILE ! EOF() - * ? tests->Id, tests->Name - * DBSKIP() - * ENDDO - * USE - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * BOF(),DBGOBOTTOM(),DBGOTOP(),DBSEEK(),EOF() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + DBSKIP() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Moves the record pointer in the selected work area. + $SYNTAX$ + DBSKIP([]) + $ARGUMENTS$ + Numbers of records to move record pointer. + $DESCRIPTION$ + This function moves the record pointer in the selected or + aliased work area. The default value for will be 1. + A DBSKIP(0) will flush and refresh the internal database bufer and + make any changes made to the record visible without moving the record + pointer in either direction. + $EXAMPLES$ + PROCEDURE Main() + USE tests NEW + DBGOTOP() + DO WHILE ! EOF() + ? tests->Id, tests->Name + DBSKIP() + ENDDO + USE + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + BOF(),DBGOBOTTOM(),DBGOTOP(),DBSEEK(),EOF() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * DBSETFILTER() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Establishes a filter condition for a work area. - * $SYNTAX$ - * DBSETFILTER(, []) - * $ARGUMENTS$ - * Code block expression for filtered evaluation. - * - * Optional character expression of code block. - * $DESCRIPTION$ - * This function masks a database so that only those records that meet - * the condition prescribed by the expression in the code block - * and literally expressed as are visible. - * If is not passed to this function,then the DBFILTER() - * function will return an empty string showing no filter in that work - * area which in fact,would be not correct. - * $EXAMPLES$ - * PROCEDURE Main() - * USE tests NEW - * DBSETFILTER( {|| tests->Id <100 }, "tests->Id <100" ) - * DBGOTOP() - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBFILTER(),DBCLEARFILTER() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + DBSETFILTER() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Establishes a filter condition for a work area. + $SYNTAX$ + DBSETFILTER(, []) + $ARGUMENTS$ + Code block expression for filtered evaluation. + + Optional character expression of code block. + $DESCRIPTION$ + This function masks a database so that only those records that meet + the condition prescribed by the expression in the code block + and literally expressed as are visible. + If is not passed to this function,then the DBFILTER() + function will return an empty string showing no filter in that work + area which in fact,would be not correct. + $EXAMPLES$ + PROCEDURE Main() + USE tests NEW + DBSETFILTER( {|| tests->Id <100 }, "tests->Id <100" ) + DBGOTOP() + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBFILTER(),DBCLEARFILTER() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DBSTRUCT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Creates a multidimensional array of a database structure. - * $SYNTAX$ - * DBSTRUCT() --> aStruct - * $RETURNS$ - * DBSTRUCT() returns an array pointer to database structure - * $DESCRIPTION$ - * This function returns a multidimensional array. This array has array - * pointers to other arrays,each of which contains the characteristic - * of a field in the active work area. The lenght of this array is based - * in the number of fields in that particular work area. In other words, - * LEN(DBSTRUCT()) is equal to the value obtained from FCOUNT(). - * Each subscript position - * $EXAMPLES$ - * #include "dbstruct.ch" - * PROCEDURE Main() - * LOCAL aStru, x - * USE tests NEW - * aStru := dbStruct() - * FOR x := 1 TO LEN( aStru ) - * ? aStru[ x ][ DBS_NAME ] - * NEXT - * USE - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * Header is dbstruct.ch - * $SEEALSO$ - * AFIELDS()* - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DBSTRUCT() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Creates a multidimensional array of a database structure. + $SYNTAX$ + DBSTRUCT() --> aStruct + $RETURNS$ + DBSTRUCT() returns an array pointer to database structure + $DESCRIPTION$ + This function returns a multidimensional array. This array has array + pointers to other arrays,each of which contains the characteristic + of a field in the active work area. The lenght of this array is based + in the number of fields in that particular work area. In other words, + LEN(DBSTRUCT()) is equal to the value obtained from FCOUNT(). + Each subscript position + $EXAMPLES$ + #include "dbstruct.ch" + PROCEDURE Main() + LOCAL aStru, x + USE tests NEW + aStru := dbStruct() + FOR x := 1 TO LEN( aStru ) + ? aStru[ x ][ DBS_NAME ] + NEXT + USE + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + Header is dbstruct.ch + $SEEALSO$ + AFIELDS()* + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * DBUNLOCK() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Unlock a record or release a file lock - * $SYNTAX$ - * DBUNLOCK() - * $DESCRIPTION$ - * This function releases the file or record lock in the currently - * selected or aliased work area. It will not unlock an associated lock - * in a related databases. - * $EXAMPLES$ - * nId := 10 - * USE testid INDEX testid NEW - * IF testid->( DBSEEK( nId ) ) - * IF testid->( RLOCK() ) - * DBDELETE() - * ELSE - * DBUNLOCK() - * ENDIF - * ENDIF - * USE - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBUNLOCKALL(),FLOCK(),RLOCK() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + DBUNLOCK() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Unlock a record or release a file lock + $SYNTAX$ + DBUNLOCK() + $DESCRIPTION$ + This function releases the file or record lock in the currently + selected or aliased work area. It will not unlock an associated lock + in a related databases. + $EXAMPLES$ + nId := 10 + USE testid INDEX testid NEW + IF testid->( DBSEEK( nId ) ) + IF testid->( RLOCK() ) + DBDELETE() + ELSE + DBUNLOCK() + ENDIF + ENDIF + USE + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBUNLOCKALL(),FLOCK(),RLOCK() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * DBUNLOCKALL() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Unlocks all records and releases all file locks in all work areas. - * $SYNTAX$ - * DBUNLOCKALL() - * $DESCRIPTION$ - * This function will remove all file and record locks in all work area. - * $EXAMPLES$ - * nId := 10 - * USE tests INDEX testid NEW - * USE tests1 INDEX tests NEW - * IF testid->( DBSEEK( nId ) ) - * IF testid->( RLOCK() ) - * DBDELETE() - * ELSE - * DBUNLOCK() - * ENDIF - * ELSE - * DBUNLOCKALL() - * ENDIF - * USE - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBUNLOCK(),FLOCK(),RLOCK() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + DBUNLOCKALL() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Unlocks all records and releases all file locks in all work areas. + $SYNTAX$ + DBUNLOCKALL() + $DESCRIPTION$ + This function will remove all file and record locks in all work area. + $EXAMPLES$ + nId := 10 + USE tests INDEX testid NEW + USE tests1 INDEX tests NEW + IF testid->( DBSEEK( nId ) ) + IF testid->( RLOCK() ) + DBDELETE() + ELSE + DBUNLOCK() + ENDIF + ELSE + DBUNLOCKALL() + ENDIF + USE + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBUNLOCK(),FLOCK(),RLOCK() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * DBUSEAREA() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Opens a work area and uses a database file. - * $SYNTAX$ - * DBUSEAREA( [], [], , [], - * [], []) - * $ARGUMENTS$ - * A optional logical expression for the new work area - * - * Database driver name - * - * File Name - * - * Alias name - * - * Shared/exclusive status flag - * - * Read-write status flag. - * $DESCRIPTION$ - * This function opens an existing database named in the current - * work area. If is set to a logical true (.T.) value, then - * the database will be opened in the next available and unused - * work area. The default value of is a logical false (.F.). - * If used, is the name of the database driver associated with - * the file that is opened. The default for this will be the - * value of DBSETDRlVER(). - * - * IF used, contains the alias name for that work area, If not - * specified, the root name of the database specified in will be - * used. - * - * If is set to a logical true (.T.) value, the database that - * is specified in will be opened by the user EXCLUSIVELY. Thus - * locking it from all other nodes or users on the network. If - * is set to a logical false (.F.) value, then the database will be in - * SHARED mode. If is not passed, then the function will turn - * to the internal setting of SET EXCLUSIVE to determine a setting. - * - * If is specified, the file will be set to READ ONLY mode. - * If it is not specified, the file will he opened in normal read-write - * mode. - * $EXAMPLES$ - * DBUSEAREA( .T.,, "tests" ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBCLOSEAREA(),DBSETDRIVER(),SELECT(),SET() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + DBUSEAREA() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Opens a work area and uses a database file. + $SYNTAX$ + DBUSEAREA( [], [], , [], + [], []) + $ARGUMENTS$ + A optional logical expression for the new work area + + Database driver name + + File Name + + Alias name + + Shared/exclusive status flag + + Read-write status flag. + $DESCRIPTION$ + This function opens an existing database named in the current + work area. If is set to a logical true (.T.) value, then + the database will be opened in the next available and unused + work area. The default value of is a logical false (.F.). + If used, is the name of the database driver associated with + the file that is opened. The default for this will be the + value of DBSETDRlVER(). + + IF used, contains the alias name for that work area, If not + specified, the root name of the database specified in will be + used. + + If is set to a logical true (.T.) value, the database that + is specified in will be opened by the user EXCLUSIVELY. Thus + locking it from all other nodes or users on the network. If + is set to a logical false (.F.) value, then the database will be in + SHARED mode. If is not passed, then the function will turn + to the internal setting of SET EXCLUSIVE to determine a setting. + + If is specified, the file will be set to READ ONLY mode. + If it is not specified, the file will he opened in normal read-write + mode. + $EXAMPLES$ + DBUSEAREA( .T.,, "tests" ) + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBCLOSEAREA(),DBSETDRIVER(),SELECT(),SET() + $END$ */ diff --git a/harbour/doc/en/rddmisc.txt b/harbour/doc/en/rddmisc.txt index c93b682a9c..365e2533cb 100644 --- a/harbour/doc/en/rddmisc.txt +++ b/harbour/doc/en/rddmisc.txt @@ -15,1028 +15,1028 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * AFIELDS()* - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Fills referenced arrays with database field information - * $SYNTAX$ - * AFields([,][,][,]) --> - * $ARGUMENTS$ - * Array of field names - * - * Array of field names - * - * Array of field names - * - * Array of field names - * $RETURNS$ - * Number od fields in a database or work area - * $DESCRIPTION$ - * This function will fill a series of arrays with field - * names, field types, field lenghts, and number of field - * decimal positions for the currently selected or designed - * database. Each array parallels the different descriptors - * of a file's structure. The first array will consist of the - * names of the fields in the current work area. All other arrays - * are optional and will be filled with the corrensponding data. - * This function will return zero if no parameters are specified - * or if no database is avaliable in the current work area. Otherwise, - * the number of fields or the lenght of the shortest array argument, - * witchever is smaller, will be returned. - * - * AFIELDS() is a compatibility function, it is superseded by - * DBSTRUCT() which returns one multidimensional array. - * - * NOTE: The destination arrays must be initialized to a given size, - * usually FCOUNT(), before calling this function. - * - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL aNames, aTypes, aLens, aDecs, nCount, nFields, i - * USE Test - * - * nCount := FCount() - * ? "Number of fields:", nCount - * PrintFields( nCount ) // Information for all fields - * PrintFields( 4 ) // Information for first 4 fields - * RETURN - * - * PROCEDURE PrintFields( nCount ) - * LOCAL aNames, aTypes, aLens, aDecs, nFields, i - * - * aNames := Array( nCount ) - * aTypes := Array( nCount ) - * aLens := Array( nCount ) - * aDecs := Array( nCount ) - * nFields := aFields( aNames, aTypes, aLens, aDecs ) - * - * ? "Number of items :", nFields - * FOR i := 1 TO nFields - * ? i, PadR( aNames[ i ], 12 ), aTypes[ i ] - * ?? aLens[ i ], aDecs[ i ] - * NEXT - * ? - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBSTRUCT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + AFIELDS()* + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Fills referenced arrays with database field information + $SYNTAX$ + AFields([,][,][,]) --> + $ARGUMENTS$ + Array of field names + + Array of field names + + Array of field names + + Array of field names + $RETURNS$ + Number od fields in a database or work area + $DESCRIPTION$ + This function will fill a series of arrays with field + names, field types, field lenghts, and number of field + decimal positions for the currently selected or designed + database. Each array parallels the different descriptors + of a file's structure. The first array will consist of the + names of the fields in the current work area. All other arrays + are optional and will be filled with the corrensponding data. + This function will return zero if no parameters are specified + or if no database is avaliable in the current work area. Otherwise, + the number of fields or the lenght of the shortest array argument, + witchever is smaller, will be returned. + + AFIELDS() is a compatibility function, it is superseded by + DBSTRUCT() which returns one multidimensional array. + + NOTE: The destination arrays must be initialized to a given size, + usually FCOUNT(), before calling this function. + + $EXAMPLES$ + PROCEDURE Main() + LOCAL aNames, aTypes, aLens, aDecs, nCount, nFields, i + USE Test + + nCount := FCount() + ? "Number of fields:", nCount + PrintFields( nCount ) // Information for all fields + PrintFields( 4 ) // Information for first 4 fields + RETURN + + PROCEDURE PrintFields( nCount ) + LOCAL aNames, aTypes, aLens, aDecs, nFields, i + + aNames := Array( nCount ) + aTypes := Array( nCount ) + aLens := Array( nCount ) + aDecs := Array( nCount ) + nFields := aFields( aNames, aTypes, aLens, aDecs ) + + ? "Number of items :", nFields + FOR i := 1 TO nFields + ? i, PadR( aNames[ i ], 12 ), aTypes[ i ] + ?? aLens[ i ], aDecs[ i ] + NEXT + ? + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBSTRUCT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ALIAS() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Returns the alias name of a work area - * $SYNTAX$ - * Alias([]) --> - * $ARGUMENTS$ - * Number of a work area - * $RETURNS$ - * Name of alias - * $DESCRIPTION$ - * This function returns the alias of the work area indicated by - * If is not provided, the alias of the current work area is - * returned. - * $EXAMPLES$ - * PROCEDURE Main() - * - * USE test - * SELECT 0 - * ? iif( Alias() == "", "No Name", Alias() ) - * ? test->( Alias() ) - * ? Alias( 1 ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBF() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ALIAS() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Returns the alias name of a work area + $SYNTAX$ + Alias([]) --> + $ARGUMENTS$ + Number of a work area + $RETURNS$ + Name of alias + $DESCRIPTION$ + This function returns the alias of the work area indicated by + If is not provided, the alias of the current work area is + returned. + $EXAMPLES$ + PROCEDURE Main() + + USE test + SELECT 0 + ? iif( Alias() == "", "No Name", Alias() ) + ? test->( Alias() ) + ? Alias( 1 ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBF() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * BOF() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Test for the beggining-of-file condition - * $SYNTAX$ - * BOF() --> - * $RETURNS$ - * BOF() Logical true (.T.) or false (.F.) - * $DESCRIPTION$ - * This function determines if the beggining of the file marker has been - * reached. If so, the function will return a logical true (.T.); otherwise, - * a logical false (.F.) will be returned. - * By default, BOF() will apply to the currently selected database unless - * the function is preceded by an alias - * $EXAMPLES$ - * PROCEDURE Main() - * USE tests NEW - * DBGOTOP() - * ? "Is Eof()", EOF() - * DBGOBOTTOM() - * ? "Is Eof()", EOF() - * USE - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * EOF(),FOUND(),LASTREC() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + BOF() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Test for the beggining-of-file condition + $SYNTAX$ + BOF() --> + $RETURNS$ + BOF() Logical true (.T.) or false (.F.) + $DESCRIPTION$ + This function determines if the beggining of the file marker has been + reached. If so, the function will return a logical true (.T.); otherwise, + a logical false (.F.) will be returned. + By default, BOF() will apply to the currently selected database unless + the function is preceded by an alias + $EXAMPLES$ + PROCEDURE Main() + USE tests NEW + DBGOTOP() + ? "Is Eof()", EOF() + DBGOBOTTOM() + ? "Is Eof()", EOF() + USE + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + EOF(),FOUND(),LASTREC() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * ZAP - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Remove all records from the current database file - * $SYNTAX$ - * ZAP - * $ARGUMENTS$ - * (This command has no arguments) - * $DESCRIPTION$ - * This command removes all of the records from the database in the - * current work area. This operation also updates any index file in - * use at the time of this operation. In addition, this command removes - * all items within an associated memo file. - * In a network enviroment, any file that is about to be ZAPped must - * be used exclusively. - * $EXAMPLES$ - * USE tests NEW INDEX tests - * ZAP - * USE - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * DELETE,PACK,USE - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + ZAP + $CATEGORY$ + Command + $SUBCATEGORY$ + Database + $ONELINER$ + Remove all records from the current database file + $SYNTAX$ + ZAP + $ARGUMENTS$ + (This command has no arguments) + $DESCRIPTION$ + This command removes all of the records from the database in the + current work area. This operation also updates any index file in + use at the time of this operation. In addition, this command removes + all items within an associated memo file. + In a network enviroment, any file that is about to be ZAPped must + be used exclusively. + $EXAMPLES$ + USE tests NEW INDEX tests + ZAP + USE + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + DELETE,PACK,USE + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DELETED() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Tests the record's deletion flag. - * $SYNTAX$ - * DELETED() --> lDeleted - * $ARGUMENTS$ - * (This command has no arguments) - * $RETURNS$ - * DELETED() return a logical true (.T.) or false (.F.). - * $DESCRIPTION$ - * This function returns a logical true (.T.) is the current record in the - * selected or designated work area ha ben marked for deletion. If not, the - * function will return a logical false (.F.). - * $EXAMPLES$ - * PROCEDURE Main() - * USE test NEW - * DBGOTO() - * DBDELETE() - * ? "Is Record Deleted", Test->( DELETED() ) - * DBRECALL() - * USE - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBDELETE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DELETED() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Tests the record's deletion flag. + $SYNTAX$ + DELETED() --> lDeleted + $ARGUMENTS$ + (This command has no arguments) + $RETURNS$ + DELETED() return a logical true (.T.) or false (.F.). + $DESCRIPTION$ + This function returns a logical true (.T.) is the current record in the + selected or designated work area ha ben marked for deletion. If not, the + function will return a logical false (.F.). + $EXAMPLES$ + PROCEDURE Main() + USE test NEW + DBGOTO() + DBDELETE() + ? "Is Record Deleted", Test->( DELETED() ) + DBRECALL() + USE + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBDELETE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * EOF() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Test for end-of-file condition. - * $SYNTAX$ - * EOF() --> - * $ARGUMENTS$ - * (This command has no arguments) - * $RETURNS$ - * A logical true (.T.) or false (.F.) - * $DESCRIPTION$ - * This function determines if the end-of-file marker has been reached. - * If it has, the function will return a logical true (.T.); otherwise - * a logical false (.F.) will be returnd - * $EXAMPLES$ - * PROCEDURE Main() - * USE tests NEW - * DBGOTOP() - * ? "Is Eof()", EOF() - * DBGOBOTTOM() - * ? "Is Eof()", EOF() - * USE - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * BOF(),FOUND(),LASTREC() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + EOF() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Test for end-of-file condition. + $SYNTAX$ + EOF() --> + $ARGUMENTS$ + (This command has no arguments) + $RETURNS$ + A logical true (.T.) or false (.F.) + $DESCRIPTION$ + This function determines if the end-of-file marker has been reached. + If it has, the function will return a logical true (.T.); otherwise + a logical false (.F.) will be returnd + $EXAMPLES$ + PROCEDURE Main() + USE tests NEW + DBGOTOP() + ? "Is Eof()", EOF() + DBGOBOTTOM() + ? "Is Eof()", EOF() + USE + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + BOF(),FOUND(),LASTREC() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * FCOUNT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Counts the number of fields in an active database. - * $SYNTAX$ - * FCOUNT() --> nFields - * $RETURNS$ - * Return the number of fields - * $DESCRIPTION$ - * This function returns the number of fields in the current or designated - * work area. If no database is open in this work area, the function will - * return 0. - * $EXAMPLES$ - * PROCEDURE Main() - * USE tests NEW - * ? "This database have", tests->( FCOUNT() ), "Fields" - * USE - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * FIELDNAME(),TYPE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + FCOUNT() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Counts the number of fields in an active database. + $SYNTAX$ + FCOUNT() --> nFields + $RETURNS$ + Return the number of fields + $DESCRIPTION$ + This function returns the number of fields in the current or designated + work area. If no database is open in this work area, the function will + return 0. + $EXAMPLES$ + PROCEDURE Main() + USE tests NEW + ? "This database have", tests->( FCOUNT() ), "Fields" + USE + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + FIELDNAME(),TYPE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * FIELDGET() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Obtains the value of a specified field - * $SYNTAX$ - * FIELDGET() --> ValueField - * $ARGUMENTS$ - * Is the numeric field position - * $RETURNS$ - * Any expression - * $DESCRIPTION$ - * This function returns the value of the field at the th location - * in the selected or designed work area. If the value in does not - * correspond to n avaliable field position in this work area, the function - * will return a NIL data type. - * $EXAMPLES$ - * PROCEDURE Main() - * USE test NEW - * ? test->( FieldGet( 1 ) ) - * USE - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * FIELDPUT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + FIELDGET() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Obtains the value of a specified field + $SYNTAX$ + FIELDGET() --> ValueField + $ARGUMENTS$ + Is the numeric field position + $RETURNS$ + Any expression + $DESCRIPTION$ + This function returns the value of the field at the th location + in the selected or designed work area. If the value in does not + correspond to n avaliable field position in this work area, the function + will return a NIL data type. + $EXAMPLES$ + PROCEDURE Main() + USE test NEW + ? test->( FieldGet( 1 ) ) + USE + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + FIELDPUT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * FIELDNAME() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Return the name of a field at a numeric field location. - * $SYNTAX$ - * FIELDNAME/FIELD() --> cFieldName - * $ARGUMENTS$ - * Field order in the database. - * $RETURNS$ - * returns the field name. - * $DESCRIPTION$ - * This function return the name of the field at the th position. - * If the numeric value passed to this function does not correspond to an - * existing field in the designated or selected work area, this function - * will return a NULL byte. - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL x - * USE tests NEW - * FOR x := 1 TO tests->( FCOUNT() ) - * ? "Field Name", FieldName( x ) - * NEXT - * USE - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBSTRUCT(),FCOUNT(),LEN(),VALTYPE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + FIELDNAME() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Return the name of a field at a numeric field location. + $SYNTAX$ + FIELDNAME/FIELD() --> cFieldName + $ARGUMENTS$ + Field order in the database. + $RETURNS$ + returns the field name. + $DESCRIPTION$ + This function return the name of the field at the th position. + If the numeric value passed to this function does not correspond to an + existing field in the designated or selected work area, this function + will return a NULL byte. + $EXAMPLES$ + PROCEDURE Main() + LOCAL x + USE tests NEW + FOR x := 1 TO tests->( FCOUNT() ) + ? "Field Name", FieldName( x ) + NEXT + USE + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBSTRUCT(),FCOUNT(),LEN(),VALTYPE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * FIELDPOS() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Return the ordinal position of a field. - * $SYNTAX$ - * FIELDPOS() --> nFieldPos - * $ARGUMENTS$ - * Name of a field. - * $RETURNS$ - * is ordinal position of the field. - * $DESCRIPTION$ - * This function return the ordinal position of the specified field - * in the current or aliased work areaIf there isn't field under the name - * of or of no database is open in the selected work area, the func- - * tion will return a 0. - * $EXAMPLES$ - * PROCEDURE Main() - * USE test NEW - * ? test->( FIELDPOS( "ID" ) ) - * USE - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * FIELDGET(),FIELDPUT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + FIELDPOS() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Return the ordinal position of a field. + $SYNTAX$ + FIELDPOS() --> nFieldPos + $ARGUMENTS$ + Name of a field. + $RETURNS$ + is ordinal position of the field. + $DESCRIPTION$ + This function return the ordinal position of the specified field + in the current or aliased work areaIf there isn't field under the name + of or of no database is open in the selected work area, the func- + tion will return a 0. + $EXAMPLES$ + PROCEDURE Main() + USE test NEW + ? test->( FIELDPOS( "ID" ) ) + USE + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + FIELDGET(),FIELDPUT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * FIELDPUT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Set the value of a field variable - * $SYNTAX$ - * FIELDPUT(, ) --> ValueAssigned - * $ARGUMENTS$ - * The field numeric position - * - * Expression to be assigned to the specified field - * $RETURNS$ - * Any expression - * $DESCRIPTION$ - * This function assings the value in to the th - * field in the current or designated work area. If the operation is - * successful, the return value of the function will be the same value - * assigned to the specified field. If the operation is not successful, - * the function will return a NIL data type - * $EXAMPLES$ - * USE tests NEW - * FIELDPUT( 1, "Mr. Jones" ) - * USE - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * FIELDGET() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + FIELDPUT() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Set the value of a field variable + $SYNTAX$ + FIELDPUT(, ) --> ValueAssigned + $ARGUMENTS$ + The field numeric position + + Expression to be assigned to the specified field + $RETURNS$ + Any expression + $DESCRIPTION$ + This function assings the value in to the th + field in the current or designated work area. If the operation is + successful, the return value of the function will be the same value + assigned to the specified field. If the operation is not successful, + the function will return a NIL data type + $EXAMPLES$ + USE tests NEW + FIELDPUT( 1, "Mr. Jones" ) + USE + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + FIELDGET() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * FLOCK() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Locks a file - * $SYNTAX$ - * FLOCK() --> lSuccess - * $RETURNS$ - * A true (.T.) value, if the lock was successful;otherwise - * false (.F.) - * $DESCRIPTION$ - * This function returns a logical true (.T.) if a file lock is - * attempted and is successfully placed on the current or designated - * database. This function will also unlock all records locks placed - * by the same network station. - * $EXAMPLES$ - * USE tests New - * IF FLOCK() - * SUM tests->Ammount - * ENDIF - * USE - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * RLOCK() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + FLOCK() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Locks a file + $SYNTAX$ + FLOCK() --> lSuccess + $RETURNS$ + A true (.T.) value, if the lock was successful;otherwise + false (.F.) + $DESCRIPTION$ + This function returns a logical true (.T.) if a file lock is + attempted and is successfully placed on the current or designated + database. This function will also unlock all records locks placed + by the same network station. + $EXAMPLES$ + USE tests New + IF FLOCK() + SUM tests->Ammount + ENDIF + USE + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + RLOCK() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * FOUND() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Determine the success of a previous search operation. - * $SYNTAX$ - * FOUND() --> lSuccess - * $ARGUMENTS$ - * (This function has no arguments) - * $RETURNS$ - * A logical true (.T.) is successful; otherwise, false (.F.) - * $DESCRIPTION$ - * This function is used to test if the previous SEEK, LOCATE, CONTINUE, - * or FIND operation was successful. Each wrk area has its own FOUND() - * flag, so that a FOUND() condition may be tested in unselected work - * areas by using an alias. - * $EXAMPLES$ - * nId := 100 - * USE tests NEW INDEX tests - * SEEK nId - * IF FOUND() - * ? tests->Name - * ENDIF - * USE - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * EOF() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + FOUND() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Determine the success of a previous search operation. + $SYNTAX$ + FOUND() --> lSuccess + $ARGUMENTS$ + (This function has no arguments) + $RETURNS$ + A logical true (.T.) is successful; otherwise, false (.F.) + $DESCRIPTION$ + This function is used to test if the previous SEEK, LOCATE, CONTINUE, + or FIND operation was successful. Each wrk area has its own FOUND() + flag, so that a FOUND() condition may be tested in unselected work + areas by using an alias. + $EXAMPLES$ + nId := 100 + USE tests NEW INDEX tests + SEEK nId + IF FOUND() + ? tests->Name + ENDIF + USE + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + EOF() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HEADER() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Return the length of a database file header - * $SYNTAX$ - * HEADER() --> nBytes - * $RETURNS$ - * The numeric size of a database file header in bytes - * $DESCRIPTION$ - * This function returns the number of bytes in the header of the - * selected database ot the database in the designated work area. - * - * If used in conjunction with the LASTREC(), RECSIZE() and DISKSPACE() - * functions, this functions is capable of implementing a backup and - * restore routine. - * $EXAMPLES$ - * USE tests NEW - * ? Header() - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DISKSPACE(),LASTREC(),RECSIZE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HEADER() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Return the length of a database file header + $SYNTAX$ + HEADER() --> nBytes + $RETURNS$ + The numeric size of a database file header in bytes + $DESCRIPTION$ + This function returns the number of bytes in the header of the + selected database ot the database in the designated work area. + + If used in conjunction with the LASTREC(), RECSIZE() and DISKSPACE() + functions, this functions is capable of implementing a backup and + restore routine. + $EXAMPLES$ + USE tests NEW + ? Header() + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DISKSPACE(),LASTREC(),RECSIZE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * LASTREC() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Returns the number of records in an active work area or database. - * $SYNTAX$ - * LASTREC() | RECCOUNT()* --> nRecords - * $RETURNS$ - * The number of records - * $DESCRIPTION$ - * This function returns the number of records present in the database - * in the selected or designated work area. If no records are present - * the value of this function will be 0. Additionaly, if no database is - * in use in the selected or designated work area, this function will - * return a 0 value as well. - * $EXAMPLES$ - * USE tests NEW - * ? LASTREC(), RECCOUNT() - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rdd - * $SEEALSO$ - * EOF() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + LASTREC() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Returns the number of records in an active work area or database. + $SYNTAX$ + LASTREC() | RECCOUNT()* --> nRecords + $RETURNS$ + The number of records + $DESCRIPTION$ + This function returns the number of records present in the database + in the selected or designated work area. If no records are present + the value of this function will be 0. Additionaly, if no database is + in use in the selected or designated work area, this function will + return a 0 value as well. + $EXAMPLES$ + USE tests NEW + ? LASTREC(), RECCOUNT() + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rdd + $SEEALSO$ + EOF() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * LUPDATE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Yields the date the database was last updated. - * $SYNTAX$ - * LUPDATE() --> dModification - * $ARGUMENTS$ - * (This function has no arguments) - * $RETURNS$ - * The date of the last modification. - * $DESCRIPTION$ - * This function returns the date recorded by the OS when the selected - * or designated database was last written to disk. This function will - * only work for those database files in USE. - * $EXAMPLES$ - * PROCEDURE Main() - * USE tests NEW - * ? LUpdate() - * USE - * RETURN - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rdd - * $SEEALSO$ - * FIELDNAME(),LASTREC(),RECSIZE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + LUPDATE() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Yields the date the database was last updated. + $SYNTAX$ + LUPDATE() --> dModification + $ARGUMENTS$ + (This function has no arguments) + $RETURNS$ + The date of the last modification. + $DESCRIPTION$ + This function returns the date recorded by the OS when the selected + or designated database was last written to disk. This function will + only work for those database files in USE. + $EXAMPLES$ + PROCEDURE Main() + USE tests NEW + ? LUpdate() + USE + RETURN + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rdd + $SEEALSO$ + FIELDNAME(),LASTREC(),RECSIZE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * NETERR() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Tests the success of a network function - * $SYNTAX$ - * NETERR([]) --> lError - * $ARGUMENTS$ - * Is a logical Expression. - * $RETURNS$ - * A value based on the success of a network operation or - * function. - * $DESCRIPTION$ - * This function return a logical true (.T.) is a USE, APPEND BLANK, or - * a USE...EXCLUSIVE command is issue and fails in a network enviroment. - * In the case of USE and USE...EXCLUSIVE commands, a NETERR() value - * of .T. would be returned if another node of the network has the - * exclusive use of a file. And the case of the APPEND BLANK command, - * NETERR() will return a logical true (.T.) if the file or record - * is locked by another node or the value of LASTREC() has been advanced - * The value of NETERR() may be changed via the value of . - * This allow the run-time error-handling system to control the way - * certains errors are handled. - * $EXAMPLES$ - * USE test NEW INDEX test - * IF ! NetErr() - * SEEK test->Name := "HARBOUR" - * IF Found() - * ? test->Name - * ENDIF - * ENDIF - * USE - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * FLOCK(),RLOCK() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + NETERR() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Tests the success of a network function + $SYNTAX$ + NETERR([]) --> lError + $ARGUMENTS$ + Is a logical Expression. + $RETURNS$ + A value based on the success of a network operation or + function. + $DESCRIPTION$ + This function return a logical true (.T.) is a USE, APPEND BLANK, or + a USE...EXCLUSIVE command is issue and fails in a network enviroment. + In the case of USE and USE...EXCLUSIVE commands, a NETERR() value + of .T. would be returned if another node of the network has the + exclusive use of a file. And the case of the APPEND BLANK command, + NETERR() will return a logical true (.T.) if the file or record + is locked by another node or the value of LASTREC() has been advanced + The value of NETERR() may be changed via the value of . + This allow the run-time error-handling system to control the way + certains errors are handled. + $EXAMPLES$ + USE test NEW INDEX test + IF ! NetErr() + SEEK test->Name := "HARBOUR" + IF Found() + ? test->Name + ENDIF + ENDIF + USE + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + FLOCK(),RLOCK() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * RECCOUNT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Counts the number of records in a database. - * $SYNTAX$ - * RECCOUNT()* | LASTREC() --> nRecords - * $ARGUMENTS$ - * (This function has no arguments) - * $RETURNS$ - * The number of records - * $DESCRIPTION$* - * This function returns the number of records present in the database - * in the selected or designated work area. If no records are present - * the value of this function will be 0. Additionaly, if no database is - * in use in the selected or designated work area, this function will - * return a 0 value as well. - * $EXAMPLES$ - * USE test NEW - * USE harbour NEW - * ? RecCount() - * ? Test->( RecCount() ) - * CLOSE ALL - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * EOF(),LASTREC(),RECNO(),DBGOBOTTOM() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + RECCOUNT() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Counts the number of records in a database. + $SYNTAX$ + RECCOUNT()* | LASTREC() --> nRecords + $ARGUMENTS$ + (This function has no arguments) + $RETURNS$ + The number of records + CRIPTION$* + This function returns the number of records present in the database + in the selected or designated work area. If no records are present + the value of this function will be 0. Additionaly, if no database is + in use in the selected or designated work area, this function will + return a 0 value as well. + $EXAMPLES$ + USE test NEW + USE harbour NEW + ? RecCount() + ? Test->( RecCount() ) + CLOSE ALL + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + EOF(),LASTREC(),RECNO(),DBGOBOTTOM() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * RECNO() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Returns the current record number or identity. - * $SYNTAX$ - * RECNO() --> Identity - * $ARGUMENTS$ - * (This function has no arguments) - * $RETURNS$ - * RECNO() The record number or identity - * $DESCRIPTION$ - * This function returns the position of the record pointer in the - * currently selected ot designated work area. - * - * If the database file is empty and if the RDD is the traditional .dbf - * file, the value of this function will be 1. - * $EXAMPLES$ - * USE tests NEW - * DBGOTOP() - * RECNO() // Returns 1 - * DBGOTO( 50 ) - * RECNO() // Returns 50 - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBGOTO(),DBGOTOP(),DBGOBOTTOM(),LASTREC(),EOF(),BOF() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + RECNO() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Returns the current record number or identity. + $SYNTAX$ + RECNO() --> Identity + $ARGUMENTS$ + (This function has no arguments) + $RETURNS$ + RECNO() The record number or identity + $DESCRIPTION$ + This function returns the position of the record pointer in the + currently selected ot designated work area. + + If the database file is empty and if the RDD is the traditional .dbf + file, the value of this function will be 1. + $EXAMPLES$ + USE tests NEW + DBGOTOP() + RECNO() // Returns 1 + DBGOTO( 50 ) + RECNO() // Returns 50 + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DBGOTO(),DBGOTOP(),DBGOBOTTOM(),LASTREC(),EOF(),BOF() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * RECSIZE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Returns the size of a single record in an active database. - * $SYNTAX$ - * RECSIZE() --> nBytes - * $ARGUMENTS$ - * (This function has no arguments) - * $RETURNS$ - * The record size. - * $DESCRIPTION$ - * This function returns the number os bytes used by a single record - * in the currently selected or designated database file. If no database - * is in use in this work area, the return value from this function - * will be 0. - * $EXAMPLES$ - * USE tests NEW - * DBGOTOP() - * RECSIZE() // Returns 1 - * DBGOTO( 50 ) - * RECSIZE() - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DISKSPACE(),FIELDNAME(),HEADER(),LASTREC() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + RECSIZE() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Returns the size of a single record in an active database. + $SYNTAX$ + RECSIZE() --> nBytes + $ARGUMENTS$ + (This function has no arguments) + $RETURNS$ + The record size. + $DESCRIPTION$ + This function returns the number os bytes used by a single record + in the currently selected or designated database file. If no database + is in use in this work area, the return value from this function + will be 0. + $EXAMPLES$ + USE tests NEW + DBGOTOP() + RECSIZE() // Returns 1 + DBGOTO( 50 ) + RECSIZE() + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + DISKSPACE(),FIELDNAME(),HEADER(),LASTREC() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * RLOCK() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Lock a record in a work area - * $SYNTAX$ - * RLOCK() --> lSuccess - * $ARGUMENTS$ - * (This function has no arguments) - * $RETURNS$ - * RLOCK() True (.T.) if record lock is successful; otherwise, it - * returns false (.F.). - * $DESCRIPTION$ - * This function returns a logical true (.T.) if an attempt to lock a - * specific record in a selected or designated work area is successful. - * It will yield a false (.F.) if either the file or the desired record - * is currently locked. - * A record that is locked remains locked until another RLOCK() is issued - * or until an UNLOCK command is executed. - * On a Network enviroment the follow command need that the record is - * locked: - * - * @...GET - * - * DELETE (single record) - * - * RECALL (single record) - * - * REPLACE (single record) - * $EXAMPLES$ - * nId := 10 - * USE testid INDEX testid NEW - * IF testid->( DBSEEK( nId ) ) - * IF testid->( RLOCK() ) - * DBDELETE() - * ENDIF - * ENDIF - * USE - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * FLOCK() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + RLOCK() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Lock a record in a work area + $SYNTAX$ + RLOCK() --> lSuccess + $ARGUMENTS$ + (This function has no arguments) + $RETURNS$ + RLOCK() True (.T.) if record lock is successful; otherwise, it + returns false (.F.). + $DESCRIPTION$ + This function returns a logical true (.T.) if an attempt to lock a + specific record in a selected or designated work area is successful. + It will yield a false (.F.) if either the file or the desired record + is currently locked. + A record that is locked remains locked until another RLOCK() is issued + or until an UNLOCK command is executed. + On a Network enviroment the follow command need that the record is + locked: + + @...GET + + DELETE (single record) + + RECALL (single record) + + REPLACE (single record) + $EXAMPLES$ + nId := 10 + USE testid INDEX testid NEW + IF testid->( DBSEEK( nId ) ) + IF testid->( RLOCK() ) + DBDELETE() + ENDIF + ENDIF + USE + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + FLOCK() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SELECT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Returns the work area number for a specified alias. - * $SYNTAX$ - * SELECT([]) --> nWorkArea - * $ARGUMENTS$ - * is the target work area alias name. - * $RETURNS$ - * SELECT() returns the work area number. - * $DESCRIPTION$ - * This function returns the work area number for the specified alias - * name . If no parameter is specified, the current work area will - * be the return value of the function. - * $EXAMPLES$ - * USE tests NEW - * USE names NEW - * cOldArea := Select( "names" ) - * SELECT test - * LIST - * SELECT cOldArea - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * ALIAS(), USED() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SELECT() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Returns the work area number for a specified alias. + $SYNTAX$ + SELECT([]) --> nWorkArea + $ARGUMENTS$ + is the target work area alias name. + $RETURNS$ + SELECT() returns the work area number. + $DESCRIPTION$ + This function returns the work area number for the specified alias + name . If no parameter is specified, the current work area will + be the return value of the function. + $EXAMPLES$ + USE tests NEW + USE names NEW + cOldArea := Select( "names" ) + SELECT test + LIST + SELECT cOldArea + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + ALIAS(), USED() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * USED() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Checks whether a database is in use in a work area - * $SYNTAX$ - * USED() --> lDbfOpen - * $ARGUMENTS$ - * (This function has no arguments) - * $RETURNS$ - * True is a database is Used;otherwise False - * $DESCRIPTION$ - * This function returns a logical true (.T.) if a database file is in - * USE in the current or designated work area. If no alias is specified - * along with this function , it will default to the currently selected - * work area. - * $EXAMPLES$ - * USE tests NEW - * USE names NEW - * ? USED() // .T. - * ? TESTS->( USED() ) //.T. - * CLOSE - * ? USED() // .F. - * SELECT tests - * ? USED() //.T. - * $TESTS$ - * - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * ALIAS(), SELECT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + USED() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Checks whether a database is in use in a work area + $SYNTAX$ + USED() --> lDbfOpen + $ARGUMENTS$ + (This function has no arguments) + $RETURNS$ + True is a database is Used;otherwise False + $DESCRIPTION$ + This function returns a logical true (.T.) if a database file is in + USE in the current or designated work area. If no alias is specified + along with this function , it will default to the currently selected + work area. + $EXAMPLES$ + USE tests NEW + USE names NEW + ? USED() // .T. + ? TESTS->( USED() ) //.T. + CLOSE + ? USED() // .F. + SELECT tests + ? USED() //.T. + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + ALIAS(), SELECT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * PACK - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Remove records marked for deletion from a database - * $SYNTAX$ - * PACK - * $ARGUMENTS$ - * (This command has no arguments) - * $DESCRIPTION$ - * This command removes records that were marked for deletion from the - * currently selected database. This command does not pack the contents - * of a memo field; those files must be packed via low-level fuctions. - * - * All open index files will be automatically reindexed once PACK command - * has completed its operation. On completion, the record pointer is placed - * on the first record in the database. - * $EXAMPLES$ - * USE tests NEW INDEX tests - * DBGOTO( 10 ) - * DELETE NEXT 10 - * PACK - * USE - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * DBEVAL(), DELETE, DELETED(), ZAP, RECALL - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + PACK + $CATEGORY$ + Command + $SUBCATEGORY$ + Database + $ONELINER$ + Remove records marked for deletion from a database + $SYNTAX$ + PACK + $ARGUMENTS$ + (This command has no arguments) + $DESCRIPTION$ + This command removes records that were marked for deletion from the + currently selected database. This command does not pack the contents + of a memo field; those files must be packed via low-level fuctions. + + All open index files will be automatically reindexed once PACK command + has completed its operation. On completion, the record pointer is placed + on the first record in the database. + $EXAMPLES$ + USE tests NEW INDEX tests + DBGOTO( 10 ) + DELETE NEXT 10 + PACK + USE + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + DBEVAL(), DELETE, DELETED(), ZAP, RECALL + $END$ */ diff --git a/harbour/doc/en/rddord.txt b/harbour/doc/en/rddord.txt index 0b999a8308..ba9087c41f 100644 --- a/harbour/doc/en/rddord.txt +++ b/harbour/doc/en/rddord.txt @@ -15,490 +15,490 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ORDBAGEXT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Returns the Order Bag extension - * $SYNTAX$ - * ORDBAGEXT() --> cBagExt - * $ARGUMENTS$ - * None - * $RETURNS$ - * The RDD extension name. - * $DESCRIPTION$ - * This function return th character name of the RDD extension for - * the order bag. This is determined by the active RDD for the selected - * work area. - * - * This function replaces the Indexord() function. - * $EXAMPLES$ - * USE tests NEW VIA "DBFNTX" - * ? ORDBAGEXT() // Returns .ntx - * DBCLOSEAREA() - * USE tests NEW VIA "DBFCDX" - * ? ORDBAGEXT() // Returns .cdx - * DBCLOSEAREA() - * $STATUS$ - * S - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rdd - * $SEEALSO$ - * INDEXEXT(),ORDBAGNAME() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ORDBAGEXT() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Returns the Order Bag extension + $SYNTAX$ + ORDBAGEXT() --> cBagExt + $ARGUMENTS$ + None + $RETURNS$ + The RDD extension name. + $DESCRIPTION$ + This function return th character name of the RDD extension for + the order bag. This is determined by the active RDD for the selected + work area. + + This function replaces the Indexord() function. + $EXAMPLES$ + USE tests NEW VIA "DBFNTX" + ? ORDBAGEXT() // Returns .ntx + DBCLOSEAREA() + USE tests NEW VIA "DBFCDX" + ? ORDBAGEXT() // Returns .cdx + DBCLOSEAREA() + $STATUS$ + S + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rdd + $SEEALSO$ + INDEXEXT(),ORDBAGNAME() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ORDBAGNAME() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Returns the Order Bag Name. - * $SYNTAX$ - * ORDBAGNAME( | ) --> cOrderBagName - * $ARGUMENTS$ - * A numeric value representing the Order bag number. - * - * The character name of the Order Bag. - * $RETURNS$ - * ORDBAGNAME() returns the Order bag name - * $DESCRIPTION$ - * This function returns the name of the order bag for the specified - * work area. If is specidied, it will represent the position - * in the order list of the target order. If is specified, - * it will represent the name of the target order. In essence, it will - * tell the name of the database (if That Rdd is in use) for a given - * index name or index order number. If is not specified - * or is 0, the Current active order will be used. - * $EXAMPLES$ - * USE tests VIA "DBFCDX" NEW - * SET INDEX TO tests - * ORDBAGNAME( "TeName" ) // Returns: Customer - * ORDBAGNAME( "TeLast" ) // Returns: Customer - * ORDBAGNAME( "teZip" ) // Returns: Customer - * SET ORDER TO TAG TeName - * ? OrderBagName() // Returns: Custumer - * $TESTS$ - * See Examples - * $STATUS$ - * S - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rdd - * $SEEALSO$ - * INDEXORD(),ORDBAGEXT(),ALIAS() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ORDBAGNAME() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Returns the Order Bag Name. + $SYNTAX$ + ORDBAGNAME( | ) --> cOrderBagName + $ARGUMENTS$ + A numeric value representing the Order bag number. + + The character name of the Order Bag. + $RETURNS$ + ORDBAGNAME() returns the Order bag name + $DESCRIPTION$ + This function returns the name of the order bag for the specified + work area. If is specidied, it will represent the position + in the order list of the target order. If is specified, + it will represent the name of the target order. In essence, it will + tell the name of the database (if That Rdd is in use) for a given + index name or index order number. If is not specified + or is 0, the Current active order will be used. + $EXAMPLES$ + USE tests VIA "DBFCDX" NEW + SET INDEX TO tests + ORDBAGNAME( "TeName" ) // Returns: Customer + ORDBAGNAME( "TeLast" ) // Returns: Customer + ORDBAGNAME( "teZip" ) // Returns: Customer + SET ORDER TO TAG TeName + ? OrderBagName() // Returns: Custumer + $TESTS$ + See Examples + $STATUS$ + S + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rdd + $SEEALSO$ + INDEXORD(),ORDBAGEXT(),ALIAS() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * ORDCONDSET() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Set the Condition and scope for an order - * $SYNTAX$ - * ORDCONSET([], - * [], - * [], - * [], - * [], - * [], - * [], - * [], - * [], - * [], - * [], - * [], - * [], - * [], - * []) - * $ARGUMENTS$ - * is a string that specifies the FOR condition for the - * order. - * - * is a code block that defines a FOR condition that - * each record within the scope must meet in order to be processed. If - * a record does not meet the specified condition, it is ignored and the - * next record is processed.Duplicate keys values are not added to the - * index file when a FOR condition is Used. - * $DESCRIPTION$ - * - * $EXAMPLES$ - * - * $TESTS$ - * - * $STATUS$ - * S - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rdd - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + ORDCONDSET() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Set the Condition and scope for an order + $SYNTAX$ + ORDCONSET([], + [], + [], + [], + [], + [], + [], + [], + [], + [], + [], + [], + [], + [], + []) + $ARGUMENTS$ + is a string that specifies the FOR condition for the + order. + + is a code block that defines a FOR condition that + each record within the scope must meet in order to be processed. If + a record does not meet the specified condition, it is ignored and the + next record is processed.Duplicate keys values are not added to the + index file when a FOR condition is Used. + $DESCRIPTION$ + + $EXAMPLES$ + + $TESTS$ + + $STATUS$ + S + $COMPLIANCE$ + C + $FILES$ + Library is rdd + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * ORDCREATE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Create an Order in an Order Bag - * $SYNTAX$ - * ORDCREATE(,[], , - * [], []) - * $ARGUMENTS$ - * Name of the file that contains one or more Orders. - * - * Name of the order to be created. - * - * Key value for order for each record in the current work area - * - * Code block that evaluates to a key for the order for each - * record in the work area. - * - * Toggle the unique status of the index. - * $DESCRIPTION$ - * This function creates an order for the current work area. It is - * similar to the DBCREATEINDEX() except that this function allows - * different orders based on the RDD in effect. The name of the file - * or the name of the order are technically - * both considered to be "optional" except that at least one of two - * must exist in order to create the order. - * - * The parameter is the index key expression; typically in - * a .dbf driver, the maximum length of the key is 255 characters. - * - * If is not specified, then the code block is create by - * macro expanding the value of . - * - * If is not specified, then the current internal setting of - * SET UNIQUE ON or OFF will be observed. - * - * The active RDD driver determines the capacity in the order for a - * specific order bag. - * - * If the name is found in the order bag can contain - * a single order, the the name is erased and a new - * order is added to the order list in the current or specified work - * area.On the other hand, if it can contain multiples tags and if - * does not already exist in the order list, then it is - * added. It is does exist, then the replaces the former - * name in the order list in the current or specified work area. - * $EXAMPLES$ - * USE tests VIA "DBFNDX" NEW - * ORDCREATE( "FNAME",, "Tests->fName" ) - * - * USE tests VIA "DBFCDX" NEW - * ORDCREATE( , "lName", "tests->lName" ) - * $TESTS$ - * See examples - * $STATUS$ - * S - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rdd - * $SEEALSO$ - * DBCREATEINDEX(),ORDNAME(),ORDSETFOCUS() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + ORDCREATE() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Create an Order in an Order Bag + $SYNTAX$ + ORDCREATE(,[], , + [], []) + $ARGUMENTS$ + Name of the file that contains one or more Orders. + + Name of the order to be created. + + Key value for order for each record in the current work area + + Code block that evaluates to a key for the order for each + record in the work area. + + Toggle the unique status of the index. + $DESCRIPTION$ + This function creates an order for the current work area. It is + similar to the DBCREATEINDEX() except that this function allows + different orders based on the RDD in effect. The name of the file + or the name of the order are technically + both considered to be "optional" except that at least one of two + must exist in order to create the order. + + The parameter is the index key expression; typically in + a .dbf driver, the maximum length of the key is 255 characters. + + If is not specified, then the code block is create by + macro expanding the value of . + + If is not specified, then the current internal setting of + SET UNIQUE ON or OFF will be observed. + + The active RDD driver determines the capacity in the order for a + specific order bag. + + If the name is found in the order bag can contain + a single order, the the name is erased and a new + order is added to the order list in the current or specified work + area.On the other hand, if it can contain multiples tags and if + does not already exist in the order list, then it is + added. It is does exist, then the replaces the former + name in the order list in the current or specified work area. + $EXAMPLES$ + USE tests VIA "DBFNDX" NEW + ORDCREATE( "FNAME",, "Tests->fName" ) + + USE tests VIA "DBFCDX" NEW + ORDCREATE( , "lName", "tests->lName" ) + $TESTS$ + See examples + $STATUS$ + S + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rdd + $SEEALSO$ + DBCREATEINDEX(),ORDNAME(),ORDSETFOCUS() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * ORDDESTROY() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Remove an Order from an Order Bag - * $SYNTAX$ - * ORDDESTROY( [, ]) - * $ARGUMENTS$ - * Name of the order to remove - * - * Name of the order bag from which order id to be - * removed - * $DESCRIPTION$ - * This function attempts to remove the order named from the - * file containing the order bag name . If - * is not specified, then the name of the file will be based on the value - * of the ORDNAME() function. If the extension is not included with the - * name of the order file, then the extension will be obtained from the - * default extension of the current and active RDD. - * - * The DBFNTX driver do not support multiple order bags; therefore, there - * cannot be an order to "destroy" from a bag. This function only works - * for those drivers with support multiple orders bags (e.q. DBFCDX - * and RDDADS drivers). - * $EXAMPLES$ - * USE tests VIA "DBFCDX" NEW - * OrdDestroy( "lName", "tests" ) - * $TESTS$ - * See examples - * $STATUS$ - * S - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rdd - * $SEEALSO$ - * ORDCREATE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + ORDDESTROY() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Remove an Order from an Order Bag + $SYNTAX$ + ORDDESTROY( [, ]) + $ARGUMENTS$ + Name of the order to remove + + Name of the order bag from which order id to be + removed + $DESCRIPTION$ + This function attempts to remove the order named from the + file containing the order bag name . If + is not specified, then the name of the file will be based on the value + of the ORDNAME() function. If the extension is not included with the + name of the order file, then the extension will be obtained from the + default extension of the current and active RDD. + + The DBFNTX driver do not support multiple order bags; therefore, there + cannot be an order to "destroy" from a bag. This function only works + for those drivers with support multiple orders bags (e.q. DBFCDX + and RDDADS drivers). + $EXAMPLES$ + USE tests VIA "DBFCDX" NEW + OrdDestroy( "lName", "tests" ) + $TESTS$ + See examples + $STATUS$ + S + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rdd + $SEEALSO$ + ORDCREATE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ORDFOR() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Return the FOR expression of an Order - * $SYNTAX$ - * ORDFOR([, ]) --> cForExp - * - * $ARGUMENTS$ - * It the name of the target order,or the numeric position - * of the order. - * - * Name of the order bag. - * $RETURNS$ - * ORDFOR() returns a expression containing the FOR condition for - * an order. - * $DESCRIPTION$ - * This function returns a character string that is the expression for - * the FOR condition for the specified order. The order may be specified - * if is the name of the order.However, may be an - * numeric which represent the position in the order list of the desired - * Order. - * $EXAMPLES$ - * USE tests NEW VIA "DBFCDX" - * INDEX ON tests->ID ; - * TO tests ; - * FOR tests->ID > 100 - * - * ORDFOR( "tests" ) // Returns: tests->ID > 100 - * $TESTS$ - * See examples - * $STATUS$ - * S - * $COMPLIANCE$ - * This function is CA-Cl*pper compliant with one exception: - * If the paramter is not specified or is 0, the current - * active order is used. - * $PLATFORMS$ - * All - * $FILES$ - * Library is rdd - * $SEEALSO$ - * ORDKEY(),ORDCREATE(),ORDNAME(),ORDNUMBER() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ORDFOR() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Return the FOR expression of an Order + $SYNTAX$ + ORDFOR([, ]) --> cForExp + + $ARGUMENTS$ + It the name of the target order,or the numeric position + of the order. + + Name of the order bag. + $RETURNS$ + ORDFOR() returns a expression containing the FOR condition for + an order. + $DESCRIPTION$ + This function returns a character string that is the expression for + the FOR condition for the specified order. The order may be specified + if is the name of the order.However, may be an + numeric which represent the position in the order list of the desired + Order. + $EXAMPLES$ + USE tests NEW VIA "DBFCDX" + INDEX ON tests->ID ; + TO tests ; + FOR tests->ID > 100 + + ORDFOR( "tests" ) // Returns: tests->ID > 100 + $TESTS$ + See examples + $STATUS$ + S + $COMPLIANCE$ + This function is CA-Cl*pper compliant with one exception: + If the paramter is not specified or is 0, the current + active order is used. + $PLATFORMS$ + All + $FILES$ + Library is rdd + $SEEALSO$ + ORDKEY(),ORDCREATE(),ORDNAME(),ORDNUMBER() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ORDKEY() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Return the key expression of an Order - * $SYNTAX$ - * ORDKEY( | [, ]) --> cExpKey - * $ARGUMENTS$ - * It the name of the target order,or the numeric position - * of the order. - * - * Name of the order bag. - * $RETURNS$ - * Returns a character string, cExpKey. - * $DESCRIPTION$ - * - * $EXAMPLES$ - * USE tests NEW VIA "DBFCDX" - * INDEX ON tests->fName ; - * TO tests ; - * FOR tests->fName > "CK" - * INDEX ON tests->Id TO TestId - * - * ORDKEY( "tests" ) // Returns: tests->fName - * SET ORDER TO 2 - * ORDKEY() // Returns: tests->Id - * - * $STATUS$ - * S - * $COMPLIANCE$ - * This function is CA-Cl*pper compliant with one exception: - * If the paramter is not specified or is 0, the current - * active order is used. - * $PLATFORMS$ - * All - * $FILES$ - * Library is rdd - * $SEEALSO$ - * ORDFOR(),ORDNAME(),ORDNUMBER(),ORDKEY() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ORDKEY() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Return the key expression of an Order + $SYNTAX$ + ORDKEY( | [, ]) --> cExpKey + $ARGUMENTS$ + It the name of the target order,or the numeric position + of the order. + + Name of the order bag. + $RETURNS$ + Returns a character string, cExpKey. + $DESCRIPTION$ + + $EXAMPLES$ + USE tests NEW VIA "DBFCDX" + INDEX ON tests->fName ; + TO tests ; + FOR tests->fName > "CK" + INDEX ON tests->Id TO TestId + + ORDKEY( "tests" ) // Returns: tests->fName + SET ORDER TO 2 + ORDKEY() // Returns: tests->Id + + $STATUS$ + S + $COMPLIANCE$ + This function is CA-Cl*pper compliant with one exception: + If the paramter is not specified or is 0, the current + active order is used. + $PLATFORMS$ + All + $FILES$ + Library is rdd + $SEEALSO$ + ORDFOR(),ORDNAME(),ORDNUMBER(),ORDKEY() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * INDEXEXT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Returns the file extension of the index module used in an application - * $SYNTAX$ - * INDEXEXT() --> - * $ARGUMENTS$ - * None. - * $RETURNS$ - * Current driver file extension - * $DESCRIPTION$ - * This function returns a string that tells what indexes are to be used - * or will be created in the compiled application. The default value is - * ".ntx". This is controled by the particular database driver that is - * linked with the application. - * $EXAMPLES$ - * IF INDEXEXT() == ".ntx" - * ? "Current driver being used is DBFNTX" - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rdd - * $SEEALSO$ - * INDEXKEY(),INDEXORD() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + INDEXEXT() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Returns the file extension of the index module used in an application + $SYNTAX$ + INDEXEXT() --> + $ARGUMENTS$ + None. + $RETURNS$ + Current driver file extension + $DESCRIPTION$ + This function returns a string that tells what indexes are to be used + or will be created in the compiled application. The default value is + ".ntx". This is controled by the particular database driver that is + linked with the application. + $EXAMPLES$ + IF INDEXEXT() == ".ntx" + ? "Current driver being used is DBFNTX" + ENDIF + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rdd + $SEEALSO$ + INDEXKEY(),INDEXORD() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * INDEXKEY() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Yields the key expression of a specified index file. - * $SYNTAX$ - * INDEXKEY() --> - * $ARGUMENTS$ - * Index order number - * $RETURNS$ - * The index key - * $DESCRIPTION$ - * This function returns a character string stored in the header of the - * index file - * - * The index key is displayed for an index file that is designated by - * , its position in the USE...INDEX or SET INDEX TO command in - * the currently selected or designated work area. If there is no - * corresnponding index key at the specified order position, a NULL - * byte will be returned. - * $EXAMPLES$ - * USE tests NEW INDEX test1 - * ? INDEXKEY( 1 ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rdd - * $SEEALSO$ - * INDEXORD() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + INDEXKEY() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Yields the key expression of a specified index file. + $SYNTAX$ + INDEXKEY() --> + $ARGUMENTS$ + Index order number + $RETURNS$ + The index key + $DESCRIPTION$ + This function returns a character string stored in the header of the + index file + + The index key is displayed for an index file that is designated by + , its position in the USE...INDEX or SET INDEX TO command in + the currently selected or designated work area. If there is no + corresnponding index key at the specified order position, a NULL + byte will be returned. + $EXAMPLES$ + USE tests NEW INDEX test1 + ? INDEXKEY( 1 ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rdd + $SEEALSO$ + INDEXORD() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * INDEXORD() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Database - * $ONELINER$ - * Returns the numeric position of the controlling index. - * $SYNTAX$ - * INDEXORD() --> - * $ARGUMENTS$ - * None. - * $RETURNS$ - * Ordinal position of a controling index - * $DESCRIPTION$ - * The INDEXORD() function returns the numeric position of the current - * controlling index in the selected or designated work area. - * A returned value of 0 indicated that no active index is controlling - * the database,which therefore is in the natural order. - * $EXAMPLES$ - * USE tests NEW INDEX test1 - * IF INDEXORD() > 0 - * ? "Current order is", INDEXORD() - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rdd - * $SEEALSO$ - * INDEXKEY() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + INDEXORD() + $CATEGORY$ + API + $SUBCATEGORY$ + Database + $ONELINER$ + Returns the numeric position of the controlling index. + $SYNTAX$ + INDEXORD() --> + $ARGUMENTS$ + None. + $RETURNS$ + Ordinal position of a controling index + $DESCRIPTION$ + The INDEXORD() function returns the numeric position of the current + controlling index in the selected or designated work area. + A returned value of 0 indicated that no active index is controlling + the database,which therefore is in the natural order. + $EXAMPLES$ + USE tests NEW INDEX test1 + IF INDEXORD() > 0 + ? "Current order is", INDEXORD() + ENDIF + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rdd + $SEEALSO$ + INDEXKEY() + $END$ */ diff --git a/harbour/doc/en/readme.txt b/harbour/doc/en/readme.txt index 2ca9b04d1b..696834f639 100644 --- a/harbour/doc/en/readme.txt +++ b/harbour/doc/en/readme.txt @@ -2,104 +2,103 @@ * $Id$ */ -/* $DOC$ - * $TEMPLATE$ - * Document - * $NAME$ - * OVERVIEW - * $CATEGORY$ - * Document - * $ONELINER$ - * HARBOUR Read me - * $DESCRIPTION$ - * - * The Harbour project - * - * ************************************************************************ - * * This file contains information on obtaining, installing, and using * - * * Harbour. Please read it *completely* before asking for help. * - * ************************************************************************ - - * Harbour is a free implementation of an xBase language compiler. It is - * designed to be source code compatible with the CA-Cl*pper(r) compiler. - * That means that if you've got some code that would compile using - * CA-Cl*pper(r) then it should compile under Harbour. The Harbour-Project - * web page is: - * - * http://harbour-project.org/ - * - * Status and other information is always available from the web site. - * There is a Harbour mailing list. Harbour is still at a very early - * stage of development, so the mailing list is very much a Developers - * only list, although every body is welcome to join in the discussions. - * - * We would like you to join the Harbour development team. If you are - * interested you may suscribe to our mailing list and start contributing - * to this free public project. - * - * Please feel free to report all questions, ideas, suggestions, fixes, - * code, etc. you may need and want. With the help of all of you, the Harbour - * compiler and runtime libraries will become a reality very soon. - * - * What this distribution contains - * =============================== - * - * This distribution is a Source code only distribution. It does not contain - * any executable files. Executable versions of Harbour are available from - * the web site. Executable versions of Harbour DO NOT create runable - * programs. Harbour at the moment produces C output code, which must be - * compiled with the Harbour Virtual Machine and the support libraries - * in order to create a functioning program. - * Please test running Harbour against your CA-Cl*pper source code and report - * any problems that might occur. - * - * Very important: The preprocessor functionality is now working. - * - * Installation - * ------------ - * - * 1. Unzip with Harbour zip file using pkunzip or equivalent. - * - * E.G. pkunzip -d build72.zip - * - * This will create Harbour/ directory and all the relevant sub - * directories. - * - * 2. Compile Harbour using your C compiler. Make files for different - * platforms are included in the directory. - * - * --- COPYRIGHT --- - * - * What copyright information do we have - * - * --- LICENCE --- - * - * Information about the License for usage of Harbour is available in the - * file licence.txt (when we have a license) - * - * --- DISCLAIMER --- - * - * Participants of The Harbour Project assume no responsibility for errors or - * omissions in these materials. - * - * THESE MATERIALS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. - * - * Participants of The Harbour Project further do not warrant the accuracy or - * completeness of the code, information, text, output or any other items - * contained within these materials. Participants of The Harbour Project - * shall not be liable for any special, direct, indirect, incidental, or - * consequential damages, including without limitation, lost revenues or - * lost profits, which may result from the use or mis-use of these materials. - * - * The information in The Harbour Project is subject to change without notice - * and does not represent any future commitment by the participants of The - * Harbour Project. - * - * The Harbour Project - * - * $SEEALSO$ - * License - * $END$ +/* $DOC$ + $TEMPLATE$ + Document + $NAME$ + OVERVIEW + $CATEGORY$ + Document + $ONELINER$ + HARBOUR Read me + $DESCRIPTION$ + The Harbour project + + ************************************************************************ + * This file contains information on obtaining, installing, and using * + * Harbour. Please read it *completely* before asking for help. * + ************************************************************************ + + Harbour is a free implementation of an xBase language compiler. It is + designed to be source code compatible with the CA-Cl*pper(r) compiler. + That means that if you've got some code that would compile using + CA-Cl*pper(r) then it should compile under Harbour. The Harbour-Project + web page is: + + http://harbour-project.org/ + + Status and other information is always available from the web site. + There is a Harbour mailing list. Harbour is still at a very early + stage of development, so the mailing list is very much a Developers + only list, although every body is welcome to join in the discussions. + + We would like you to join the Harbour development team. If you are + interested you may suscribe to our mailing list and start contributing + to this free public project. + + Please feel free to report all questions, ideas, suggestions, fixes, + code, etc. you may need and want. With the help of all of you, the Harbour + compiler and runtime libraries will become a reality very soon. + + What this distribution contains + =============================== + + This distribution is a Source code only distribution. It does not contain + any executable files. Executable versions of Harbour are available from + the web site. Executable versions of Harbour DO NOT create runable + programs. Harbour at the moment produces C output code, which must be + compiled with the Harbour Virtual Machine and the support libraries + in order to create a functioning program. + Please test running Harbour against your CA-Cl*pper source code and report + any problems that might occur. + + Very important: The preprocessor functionality is now working. + + Installation + ------------ + + 1. Unzip with Harbour zip file using pkunzip or equivalent. + + E.G. pkunzip -d build72.zip + + This will create Harbour/ directory and all the relevant sub + directories. + + 2. Compile Harbour using your C compiler. Make files for different + platforms are included in the directory. + + --- COPYRIGHT --- + + What copyright information do we have + + --- LICENCE --- + + Information about the License for usage of Harbour is available in the + file licence.txt (when we have a license) + + --- DISCLAIMER --- + + Participants of The Harbour Project assume no responsibility for errors or + omissions in these materials. + + THESE MATERIALS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. + + Participants of The Harbour Project further do not warrant the accuracy or + completeness of the code, information, text, output or any other items + contained within these materials. Participants of The Harbour Project + shall not be liable for any special, direct, indirect, incidental, or + consequential damages, including without limitation, lost revenues or + lost profits, which may result from the use or mis-use of these materials. + + The information in The Harbour Project is subject to change without notice + and does not represent any future commitment by the participants of The + Harbour Project. + + The Harbour Project + + $SEEALSO$ + License + $END$ */ diff --git a/harbour/doc/en/sayget.txt b/harbour/doc/en/sayget.txt index 075c805aae..256a642fdf 100644 --- a/harbour/doc/en/sayget.txt +++ b/harbour/doc/en/sayget.txt @@ -2,206 +2,206 @@ * $Id$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * @...GET - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Creates a GET object and displays it to the screen - * $SYNTAX$ - * @ , [SAY [PICTURE ] COLOR ] - * GET [PICTURE ] [WHEN ] [COLOR ] - * [VALID / RANGE ,] - * $ARGUMENTS$ - * The row coordinate. - * - * The column coordinate. - * - * Message to display. - * - * Character expression of PICTURE displayed. - * - * Color to be Used for the SAY expression. - * - * An variable/field name. - * - * Character expression of PICTURE to get. - * - * Logical expression to allow GET. - * - * Logical expression to validate GET input. - * - * Lower RANGE value. - * - * Upper RANGE value. - * - * Color string to be used for the GET expression. - * $DESCRIPTION$ - * This command adds a GET object to the reserved array variable - * named GETLIST[] and displays it to the screen. The field or variable - * to be added to the GET object is specified in and is displayed - * at row, column coordinate , . - * - * If the SAY clause is used will be displayed starting at - * ,, with the field variable displayed at ROW(), - * COL()+ 1. If , the picture template for the SAY expression - * , is used, all formatting rules contained will apply See the - * TRANSFORM I function for further information. - * - * If is specified, the PICTURE clause of will be - * used for the GET object and all formatting rules will apply. See - * the table below for GET formatting rules. - * - * If the WHEN clause is specified,when evaluates to a logical - * true (.T.) condition, the GET object will he activated otherwise the - * GET object will be skipped and no information will be obtained via - * the screen. The name of a user-defined function returning a logical - * true (.T.) or false ( F.) or a code block may be ,specified in - * This clause not activated until a READ command or READMODAL() - * function call is issued. - * - * If the VALID clause is specified and evaluates to it logical - * true (.T.) condition the current GET will be considered valid and - * the get operation will continue onto the next active GET object. If - * not, the cursor will remain on this GET object until aborted or - * until the condition in evaluates to true (.T.). The name - * of a user-defined function returning a logical true (.T.) or false - * (.F.) or it code block may be specified in . This clause is - * not activated until a READ command or READMODAL( ) function call is - * issued. - * - * If the RANGE clause is specified instead of the VALID clause, the - * two inclusive range values for must be specified in - * and . Id is a date data type, and must - * also be date data types; if is a numeric data type - * and must also be numeric data types. If a value fails the - * RANGE test ,a message of OUT OF RANGE will appear in the SCOREBOARD - * area (row = 0, col = 60). The RANGE message may be turned off it the - * SET SCOREBOARD command or SET() function appropriately toggled. - * - * NOTE GET functions/formatting rules: - - * - * @A Allows only alphabetic characters. - * @B Numbers will be left justified - * @C All positive numbers will be followed by CR. - * @D All dates will be in the SET DATE format. - * @E Dates will be in British formal: numbers in European format. - * @K Allows a suggested value to be seen within the GET - * area but clears It if any non cursor key is pressed when - * the cursor is in the first Position in the GET area. - * @R Non template characters will be inserted. - * @S Allows horizontal scrolling of a field or variable that - * is characters wide. - * @X All negative numbers will be followed by DB - * @Z Displays zero values as blanks. - * @! Forces uppercase lettering - * @( Displays negative numbers in parentheses with leading spaces. - * @) Displays negative numbers in parentheses without leading spaces. - *
- - * GET templates/formatting rules: - - * - * A Only alphabetic characters allowed. - * N Only alphabetic and numeric characters allowed - * X Any character allowed. - * L Only T or F allowed For logical data. - * Y Only Y or N allowed for logical data. - * 9 Only digits, including signs, will be allowed. - * # Only digits, signs. and spaces will he allowed. - * ! Alphabetic characters are converted to Uppercase. - * $ Dollar will be displayed in place of leading - * spaces for numeric data types. - * * Asterisk,, will Be displayed in place of leading spaces - * for numeric data types. - * . Position of decimal point. - * , Position of comma. - *
- * - * Format PICTURE functions may he grouped together as well as used - * in Conjunction with a PICTURE templates;however, a blank space must - * be included in the PICTURE string if there are both functions and - * templates. - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL cVar := Space( 50 ) - * LOCAL nId := 0 - * CLS - * @ 3,1 SAY "Name" GET cVar PICTURE "@!S 30" - * @ 4,1 SAY "Id" GET nId PICTURE "999.999" - * READ - * ? "The name you entered is",cVar - * ? "The id you entered is",nId - * RETURN - * $TESTS$ - * See Examples - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $SEEALSO$ - * @...SAY,READ,TRANSFORM() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + @...GET + $CATEGORY$ + Command + $SUBCATEGORY$ + User interface + $ONELINER$ + Creates a GET object and displays it to the screen + $SYNTAX$ + @ , [SAY [PICTURE ] COLOR ] + GET [PICTURE ] [WHEN ] [COLOR ] + [VALID / RANGE ,] + $ARGUMENTS$ + The row coordinate. + + The column coordinate. + + Message to display. + + Character expression of PICTURE displayed. + + Color to be Used for the SAY expression. + + An variable/field name. + + Character expression of PICTURE to get. + + Logical expression to allow GET. + + Logical expression to validate GET input. + + Lower RANGE value. + + Upper RANGE value. + + Color string to be used for the GET expression. + $DESCRIPTION$ + This command adds a GET object to the reserved array variable + named GETLIST[] and displays it to the screen. The field or variable + to be added to the GET object is specified in and is displayed + at row, column coordinate , . + + If the SAY clause is used will be displayed starting at + ,, with the field variable displayed at ROW(), + COL()+ 1. If , the picture template for the SAY expression + , is used, all formatting rules contained will apply See the + TRANSFORM I function for further information. + + If is specified, the PICTURE clause of will be + used for the GET object and all formatting rules will apply. See + the table below for GET formatting rules. + + If the WHEN clause is specified,when evaluates to a logical + true (.T.) condition, the GET object will he activated otherwise the + GET object will be skipped and no information will be obtained via + the screen. The name of a user-defined function returning a logical + true (.T.) or false ( F.) or a code block may be ,specified in + This clause not activated until a READ command or READMODAL() + function call is issued. + + If the VALID clause is specified and evaluates to it logical + true (.T.) condition the current GET will be considered valid and + the get operation will continue onto the next active GET object. If + not, the cursor will remain on this GET object until aborted or + until the condition in evaluates to true (.T.). The name + of a user-defined function returning a logical true (.T.) or false + (.F.) or it code block may be specified in . This clause is + not activated until a READ command or READMODAL( ) function call is + issued. + + If the RANGE clause is specified instead of the VALID clause, the + two inclusive range values for must be specified in + and . Id is a date data type, and must + also be date data types; if is a numeric data type + and must also be numeric data types. If a value fails the + RANGE test ,a message of OUT OF RANGE will appear in the SCOREBOARD + area (row = 0, col = 60). The RANGE message may be turned off it the + SET SCOREBOARD command or SET() function appropriately toggled. + + NOTE GET functions/formatting rules: + + + @A Allows only alphabetic characters. + @B Numbers will be left justified + @C All positive numbers will be followed by CR. + @D All dates will be in the SET DATE format. + @E Dates will be in British formal: numbers in European format. + @K Allows a suggested value to be seen within the GET + area but clears It if any non cursor key is pressed when + the cursor is in the first Position in the GET area. + @R Non template characters will be inserted. + @S Allows horizontal scrolling of a field or variable that + is characters wide. + @X All negative numbers will be followed by DB + @Z Displays zero values as blanks. + @! Forces uppercase lettering + @( Displays negative numbers in parentheses with leading spaces. + @) Displays negative numbers in parentheses without leading spaces. +
+ + GET templates/formatting rules: + + + A Only alphabetic characters allowed. + N Only alphabetic and numeric characters allowed + X Any character allowed. + L Only T or F allowed For logical data. + Y Only Y or N allowed for logical data. + 9 Only digits, including signs, will be allowed. + # Only digits, signs. and spaces will he allowed. + ! Alphabetic characters are converted to Uppercase. + $ Dollar will be displayed in place of leading + spaces for numeric data types. + * Asterisk,, will Be displayed in place of leading spaces + for numeric data types. + . Position of decimal point. + , Position of comma. +
+ + Format PICTURE functions may he grouped together as well as used + in Conjunction with a PICTURE templates;however, a blank space must + be included in the PICTURE string if there are both functions and + templates. + $EXAMPLES$ + PROCEDURE Main() + LOCAL cVar := Space( 50 ) + LOCAL nId := 0 + CLS + @ 3,1 SAY "Name" GET cVar PICTURE "@!S 30" + @ 4,1 SAY "Id" GET nId PICTURE "999.999" + READ + ? "The name you entered is",cVar + ? "The id you entered is",nId + RETURN + $TESTS$ + See Examples + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $SEEALSO$ + @...SAY,READ,TRANSFORM() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * @...SAY - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Displays data at specified coordinates of the current device. - * $SYNTAX$ - * @ , SAY [ PICTURE ] [COLOR ] - * $ARGUMENTS$ - * Row coordinate - * - * Column coordinate - * - * Value to display - * - * PICTURE format - * - * Color string - * $DESCRIPTION$ - * This command displays the contents of at row column - * coordinates , . A PICTURE clause may be specified - * in . If the current device is set to the printer, the output - * will go to the printer; the default is for all output to go to - * the screen. - * - * For a complete list of PICTURES templates and functions, see the - * @...GET command. - * $EXAMPLES$ - * PROCEDURE Main() - * CLS - * @ 2, 1 SAY "Harbour" - * @ 3, 1 SAY "is" COLOR "b/r+" - * @ 4, 1 SAY "Power" PICTURE "@!" - * RETURN - * $TESTS$ - * See Examples - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * - * $SEEALSO$ - * @...GET,SET DEVICE,TRANSFORM() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + @...SAY + $CATEGORY$ + Command + $SUBCATEGORY$ + User interface + $ONELINER$ + Displays data at specified coordinates of the current device. + $SYNTAX$ + @ , SAY [ PICTURE ] [COLOR ] + $ARGUMENTS$ + Row coordinate + + Column coordinate + + Value to display + + PICTURE format + + Color string + $DESCRIPTION$ + This command displays the contents of at row column + coordinates , . A PICTURE clause may be specified + in . If the current device is set to the printer, the output + will go to the printer; the default is for all output to go to + the screen. + + For a complete list of PICTURES templates and functions, see the + @...GET command. + $EXAMPLES$ + PROCEDURE Main() + CLS + @ 2, 1 SAY "Harbour" + @ 3, 1 SAY "is" COLOR "b/r+" + @ 4, 1 SAY "Power" PICTURE "@!" + RETURN + $TESTS$ + See Examples + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + + $SEEALSO$ + @...GET,SET DEVICE,TRANSFORM() + $END$ */ diff --git a/harbour/doc/en/set.txt b/harbour/doc/en/set.txt index 2949a3c8a9..664a4b39d6 100644 --- a/harbour/doc/en/set.txt +++ b/harbour/doc/en/set.txt @@ -1,5 +1,5 @@ /* - * $Id$ + * $Id$ */ /* @@ -30,1426 +30,1426 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __SETCENTURY() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Set the Current Century - * $SYNTAX$ - * __SETCENTURY([ | ] ) --> lPreviousValue - * $ARGUMENTS$ - * optional or (not case sensitive) - * .T. or "ON" to enable the century setting (4-digit years) - * .F. or "OFF" to disable the century setting (2-digit years) - * $RETURNS$ - * Either the current or previous century setting as a logical value - * $FILES$ - * Library is rtl - * $COMPLIANCE$ - * C - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __SETCENTURY() + $CATEGORY$ + API + $SUBCATEGORY$ + Environment + $ONELINER$ + Set the Current Century + $SYNTAX$ + __SETCENTURY([ | ] ) --> lPreviousValue + $ARGUMENTS$ + optional or (not case sensitive) + .T. or "ON" to enable the century setting (4-digit years) + .F. or "OFF" to disable the century setting (2-digit years) + $RETURNS$ + Either the current or previous century setting as a logical value + $FILES$ + Library is rtl + $COMPLIANCE$ + C + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SET() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Changes or evaluated environmental settings - * $SYNTAX$ - * Set( [, [, ] ] ) --> xPreviousSetting - * $ARGUMENTS$ - * Set Number - * - * Any expression to assign a value to the setting - * - * Logical expression - * - * - * - * _SET_ALTERNATE | - * - * If enabled, QOUT() and QQOUT() write to the screen and to - * a file, provided that a file has been opened or created - * with _SET_ALTFILE. If disabled, which is the default, - * QOUT() and QQOUT() only write to the screen (and/or to - * the PRINTFILE). Defaults to disabled. - * - * _SET_ALTFILE - * - * When set, creates or opens file to write QOUT() and - * QQOUT() output to. If is TRUE and the file - * already exists, the file is opened and positioned at end - * of file. Otherwise, the file is created. If a file is - * already opened, it is closed before the new file is - * opened or created (even if it is the same file). The - * default file extension is ".txt". There is no default - * file name. Call with an empty string to close the file. - * - * _SET_AUTOPEN | - * - * TODO: Document - * - * _SET_AUTORDER | - * - * TODO: Document - * - * _SET_AUTOSHARE | - * - * TODO: Document - * - * _SET_BELL | - * - * When enabled, the bell sounds when the last position of - * a GET is reached and/or when a GET validation fails. - * Disabled by default. - * - * _SET_CANCEL | - * - * When enabled, which is the default, pressing Alt+C or - * Ctrl+Break terminates the program. When disabled, both - * keystrokes can be read by INKEY(). Note: SET KEY has - * precedence over SET CANCEL. - * - * _SET_COLOR - * - * Sets the current color scheme, using color pairs in the - * sequence ",,,, - * ". Each color pair uses the format - * "/". The color codes are space - * or "N" for black, "B" for blue, "G" for green, "BG" for - * Cyan, "R" for red, "RB" for magenta, "GR" for brown, "W" - * for white, "N+" for gray, "B+" for bright blue, "G+" for - * bright green, "BG+" for bright cyan, "R+" for bright red, - * "RB+" for bright magenta, "GR+" for yellow, and "W+" for - * bright white. Special codes are "I" for inverse video, - * "U" for underline on a monochrome monitor (blue on a - * color monitor), and "X" for blank. The default color is - * "W/N,N/W,N,N,N/W". - * - * _SET_CONFIRM | - * - * If enabled, an exit key must be pressed to leave a GET. - * If disabled, which is the default, typing past the end - * will leave a GET. - * - * _SET_CONSOLE | - * - * If enabled, which is the default, all screen output goes - * to the screen. When disabled, screen output is suppressed - * (Note: This setting does not affect OUTSTD() or OUTERR()). - * - * _SET_CURSOR - * - * If enabled, which is the default, the cursor is displayed - * on screen. If disabled, the screen cursor is hidden. - * - * _SET_DATEFORMAT - * - * Sets the default date format for display, date input, and - * date conversion. Defaults to American ("mm/dd/yy"). Other - * formats include ANSI ("yy.mm.dd"), British ("dd/mm/yy"), - * French ("dd/mm/yy"), German ("dd.mm.yy"), Italian - * ("dd-mm-yy"), Japan ("yy/mm/dd"), and USA ("mm-dd-yy"). - * SET CENTURY modifies the date format. SET CENTURY ON - * replaces the "y"s with "YYYY". SET CENTURY OFF replaces - * the "y"s with "YY". - * - * _SET_DEBUG - * - * When set to .T., pressing Alt+D activates the debugger. - * When set to .F., which is the default, Alt+D can be read - * by INKEY(). (Also affected by AltD(1) and AltD(0)) - * - * _SET_DECIMALS - * - * Sets the number of decimal digits to use when displaying - * printing numeric values when SET FIXED is ON. Defaults to - * 2. If SET FIXED is OFF, then SET DECIMALS is only used to - * determine the number of decimal digits to use after using - * EXP(), LOG(), SQRT(), or division. Other math operations - * may adjust the number of decimal digits that the result - * will display. Note: This never affects the precision of - * a number. Only the display format is affected. - * - * _SET_DEFAULT - * - * Sets the default directory in which to open, create and - * check for files. Defaults to current directory (blank). - * - * _SET_DELETED | - * - * If enabled, deleted records will be processed. If - * disabled, which is the default, deleted records will - * be ignored. - * - * _SET_DELIMCHARS - * - * Sets the GET delimiter characters. Defaults to "::". - * - * _SET_DELIMITERS | - * - * If enabled, GETs are delimited on screen. If disabled, - * which is the default, no GET delimiters are used. - * - * _SET_DEVICE - * - * Selects the output device for DEVOUT(). When set to - * "PRINTER", all output is sent to the printer device or - * file set by _SET_PRINTFILE. When set to anything else, - * all output is sent to the screen. Defaults to "SCREEN". - * - * _SET_EOF | - * - * Defaults to FALSE on UN*X, but defaults to TRUE on - * everything else. If set to FALSE, then CHR( 26 ) does not - * get written when using COPY TO DELIMITED, COPY TO SDF, - * or when closing any of the various text files that are - * created using various SET values. - * [This is a Harbour extension] - * - * _SET_EPOCH - * - * Determines how to handle the conversion of 2-digit years - * to 4 digit years. When a 2-digit year is greater than or - * equal to the year part of the epoch, the century part of - * the epoch is added to the year. When a 2-digit year is - * less than the year part of the epoch, the century part - * of the epoch is incremented and added to the year. The - * default epoch is 1900, which converts all 2-digit years - * to 19xx. Example: If the epoch is set to 1950, 2-digit - * years in the range from 50 to 99 get converted to 19xx - * and 2-digit years in the range 00 to 49 get converted - * to 20xx. - * - * _SET_ESCAPE | - * - * When enabled, which is the default, pressing Esc will - * exit a READ. When disabled, pressing Esc during a READ - * is ignored, unless the Esc key has been assigned to a - * function using SET KEY. - * - * _SET_EVENTMASK - * - * Determines which events INKEY() will respond to. - * INKEY_MOVE allows mouse movement events. INKEY_LDOWN - * allows the left mouse button down click. INKEY_LUP - * allows the left mouse button up click. INKEY_RDOWN - * allows the right mouse button down click. INKEY_RUP - * allows the right mouse button up clock. INKEY_KEYBOARD - * allows keyboard keystrokes. INKEY_ALL allows all of the - * preceding events. Events may be combined (e.g., using - * INKEY_LDOWN + INKEY_RUP will allow left mouse button - * down clicks and right mouse button up clicks). The - * default is INKEY_KEYBOARD. - * - * _SET_EXACT | - * - * When enabled, all string comparisons other than "==" - * exclude trailing spaces when checking for equality. - * When disabled, which is the default, all string - * comparisons other than "==" treat two strings as - * equal if the right hand string is "" or if the right - * hand string is shorter than or the same length as the - * left hand string and all of the characters in the right - * hand string match the corresponding characters in the - * left hand string. - * - * _SET_EXCLUSIVE | - * - * When enabled, which is the default, all database files - * are opened in exclusive mode. When disabled, all - * database files are opened in shared mode. Note: The - * EXCLUSIVE and SHARED clauses of the USE command can be - * used to override this setting. - * - * _SET_EXIT | - * - * Toggles the use of Uparrow and Dnarrow as READ exit keys. - * Specifying true (.T.) enables them as exit keys, and - * false (.F.) disables them. Used internally by the - * ReadExit() function. - * - * _SET_EXTRA | - * - * QUESTION: What is this for? - * It does not affect _SET_EXTRAFILE in CA-Cl*pper! - * - * _SET_EXTRAFILE - * - * When set, creates or opens file to write QOUT() and - * QQOUT() output to. If is TRUE and the file - * already exists, the file is opened and positioned at end - * of file. Otherwise, the file is created. If a file is - * already opened, it is closed before the new file is - * opened or created (even if it is the same file). The - * default file extension is ".prn". There is no default - * file name. Call with an empty string to close the file. - * - * _SET_FIXED | - * - * When enabled, all numeric values will be displayed - * and printed with the number of decimal digits set - * by SET DECIMALS, unless a PICTURE clause is used. - * When disabled, which is the default, the number - * of decimal digits that are displayed depends upon - * a variety of factors. See _SET_DECIMALS for more. - * - * _SET_INSERT | - * - * When enabled, characters typed in a GET or MEMOEDIT - * are inserted. When disabled, which is the default, - * characters typed in a GET or MEMOEDIT overwrite. - * Note: This setting can also be toggled between on and - * off by pressing the Insert key during a GET or MEMOEDIT. - * - * _SET_INTENSITY | - * - * When enabled, which is the default, GETs and PROMPTs - * are displayed using the enhanced color setting. When - * disabled, GETs and PROMPTs are displayed using the - * standard color setting. - * - * _SET_LANGUAGE - * - * Specifies the language to be used for Harbour messages. - * [This is a Harbour extension] - * - * _SET_MARGIN - * - * Sets the left margin for all printed output. The default - * value is 0. Note: PCOL() reflects the printer's column - * position including the margin (e.g., SET MARGIN TO 5 - * followed by DEVPOS(5, 10) makes PCOL() return 15). - * - * _SET_MBLOCKSIZE - * - * TODO: Document - * - * _SET_MCENTER | - * - * If enabled, display PROMPTs centered on the MESSAGE row. - * If disabled, which is the default, display PROMPTS at - * column position 0 on the MESSAGE row. - * - * _SET_MESSAGE - * - * If set to 0, which is the default, PROMPTs are always - * suppressed. Otherwise, PROMPTs are displayed on the - * set row. Note: It is not possible to display prompts - * on the top-most screen row, because row 0 is reserved - * for the SCOREBOARD, if enabled. - * - * _SET_MFILEEXT - * - * TODO: Document - * - * _SET_OPTIMIZE | - * - * TODO: Document - * - * _SET_PATH - * - * Specifies a path of directories to search through to - * locate a file that can't be located in the DEFAULT - * directory. Defaults to no path (""). Directories must - * be separated by a semicolon (e.g., "C:\data;C:\more"). - * - * _SET_PRINTER | - * - * If enabled, QOUT() and QQOUT() write to the screen and to - * a file, provided that a file has been opened or created - * with _SET_ALTFILE. If disabled, which is the default, - * QOUT() and QQOUT() only write to the screen (and/or to - * the ALTFILE). - * - * _SET_PRINTFILE - * - * When set, creates or opens file to write QOUT(), QQOUT() - * and DEVOUT() output to. If is TRUE and the - * file already exists, the file is opened and positioned - * at end of file. Otherwise, the file is created. If a - * file is already opened, it is closed before the new file - * is opened or created (even if it is the same file). The - * default file extension is ".prn". The default file name - * is "PRN", which maps to the default printer device. Call - * with an empty string to close the file. - * - * _SET_SCOREBOARD | - * - * When enabled, which is the default, READ and MEMOEDIT - * display status messages on screen row 0. When disabled, - * READ and MEMOEDIT status messages are suppressed. - * - * _SET_SCROLLBREAK | - * - * QUESTION: What is this flag for? - * - * _SET_SOFTSEEK | - * - * When enabled, a SEEK that fails will position the record - * pointer to the first key that is higher than the sought - * after key or to LASTREC() + 1 if there is no higher key. - * When disabled, which is the default, a SEEK that fails - * will position the record pointer to LASTREC()+1. - * - * _SET_STRICTREAD | - * - * TODO: Document - * - * _SET_TYPEAHEAD - * - * Sets the size of the keyboard typeahead buffer. Defaults - * to 50. The minimum is 16 and the maximum is 4096. - * - * _SET_UNIQUE | - * - * When enabled, indexes are not allowed to have duplicate - * keys. When disabled, indexes are allowed duplicate keys. - * - * _SET_VIDEOMODE - * - * TODO: Document - * - * _SET_WRAP | - * - * When enabled, lightbar menus can be navigated from the - * last position to the first and from the first position - * to the last. When disabled, which is the default, there - * is a hard stop at the first and last positions. - * $RETURNS$ - * SET() The current or previous setting - * $FILES$ - * Library is rtl - * $COMPLIANCE$ - * C - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SET() + $CATEGORY$ + API + $SUBCATEGORY$ + Environment + $ONELINER$ + Changes or evaluated environmental settings + $SYNTAX$ + Set( [, [, ] ] ) --> xPreviousSetting + $ARGUMENTS$ + Set Number + + Any expression to assign a value to the setting + + Logical expression + + + + _SET_ALTERNATE | + + If enabled, QOUT() and QQOUT() write to the screen and to + a file, provided that a file has been opened or created + with _SET_ALTFILE. If disabled, which is the default, + QOUT() and QQOUT() only write to the screen (and/or to + the PRINTFILE). Defaults to disabled. + + _SET_ALTFILE + + When set, creates or opens file to write QOUT() and + QQOUT() output to. If is TRUE and the file + already exists, the file is opened and positioned at end + of file. Otherwise, the file is created. If a file is + already opened, it is closed before the new file is + opened or created (even if it is the same file). The + default file extension is ".txt". There is no default + file name. Call with an empty string to close the file. + + _SET_AUTOPEN | + + TODO: Document + + _SET_AUTORDER | + + TODO: Document + + _SET_AUTOSHARE | + + TODO: Document + + _SET_BELL | + + When enabled, the bell sounds when the last position of + a GET is reached and/or when a GET validation fails. + Disabled by default. + + _SET_CANCEL | + + When enabled, which is the default, pressing Alt+C or + Ctrl+Break terminates the program. When disabled, both + keystrokes can be read by INKEY(). Note: SET KEY has + precedence over SET CANCEL. + + _SET_COLOR + + Sets the current color scheme, using color pairs in the + sequence ",,,, + ". Each color pair uses the format + "/". The color codes are space + or "N" for black, "B" for blue, "G" for green, "BG" for + Cyan, "R" for red, "RB" for magenta, "GR" for brown, "W" + for white, "N+" for gray, "B+" for bright blue, "G+" for + bright green, "BG+" for bright cyan, "R+" for bright red, + "RB+" for bright magenta, "GR+" for yellow, and "W+" for + bright white. Special codes are "I" for inverse video, + "U" for underline on a monochrome monitor (blue on a + color monitor), and "X" for blank. The default color is + "W/N,N/W,N,N,N/W". + + _SET_CONFIRM | + + If enabled, an exit key must be pressed to leave a GET. + If disabled, which is the default, typing past the end + will leave a GET. + + _SET_CONSOLE | + + If enabled, which is the default, all screen output goes + to the screen. When disabled, screen output is suppressed + (Note: This setting does not affect OUTSTD() or OUTERR()). + + _SET_CURSOR + + If enabled, which is the default, the cursor is displayed + on screen. If disabled, the screen cursor is hidden. + + _SET_DATEFORMAT + + Sets the default date format for display, date input, and + date conversion. Defaults to American ("mm/dd/yy"). Other + formats include ANSI ("yy.mm.dd"), British ("dd/mm/yy"), + French ("dd/mm/yy"), German ("dd.mm.yy"), Italian + ("dd-mm-yy"), Japan ("yy/mm/dd"), and USA ("mm-dd-yy"). + SET CENTURY modifies the date format. SET CENTURY ON + replaces the "y"s with "YYYY". SET CENTURY OFF replaces + the "y"s with "YY". + + _SET_DEBUG + + When set to .T., pressing Alt+D activates the debugger. + When set to .F., which is the default, Alt+D can be read + by INKEY(). (Also affected by AltD(1) and AltD(0)) + + _SET_DECIMALS + + Sets the number of decimal digits to use when displaying + printing numeric values when SET FIXED is ON. Defaults to + 2. If SET FIXED is OFF, then SET DECIMALS is only used to + determine the number of decimal digits to use after using + EXP(), LOG(), SQRT(), or division. Other math operations + may adjust the number of decimal digits that the result + will display. Note: This never affects the precision of + a number. Only the display format is affected. + + _SET_DEFAULT + + Sets the default directory in which to open, create and + check for files. Defaults to current directory (blank). + + _SET_DELETED | + + If enabled, deleted records will be processed. If + disabled, which is the default, deleted records will + be ignored. + + _SET_DELIMCHARS + + Sets the GET delimiter characters. Defaults to "::". + + _SET_DELIMITERS | + + If enabled, GETs are delimited on screen. If disabled, + which is the default, no GET delimiters are used. + + _SET_DEVICE + + Selects the output device for DEVOUT(). When set to + "PRINTER", all output is sent to the printer device or + file set by _SET_PRINTFILE. When set to anything else, + all output is sent to the screen. Defaults to "SCREEN". + + _SET_EOF | + + Defaults to FALSE on UN*X, but defaults to TRUE on + everything else. If set to FALSE, then CHR( 26 ) does not + get written when using COPY TO DELIMITED, COPY TO SDF, + or when closing any of the various text files that are + created using various SET values. + [This is a Harbour extension] + + _SET_EPOCH + + Determines how to handle the conversion of 2-digit years + to 4 digit years. When a 2-digit year is greater than or + equal to the year part of the epoch, the century part of + the epoch is added to the year. When a 2-digit year is + less than the year part of the epoch, the century part + of the epoch is incremented and added to the year. The + default epoch is 1900, which converts all 2-digit years + to 19xx. Example: If the epoch is set to 1950, 2-digit + years in the range from 50 to 99 get converted to 19xx + and 2-digit years in the range 00 to 49 get converted + to 20xx. + + _SET_ESCAPE | + + When enabled, which is the default, pressing Esc will + exit a READ. When disabled, pressing Esc during a READ + is ignored, unless the Esc key has been assigned to a + function using SET KEY. + + _SET_EVENTMASK + + Determines which events INKEY() will respond to. + INKEY_MOVE allows mouse movement events. INKEY_LDOWN + allows the left mouse button down click. INKEY_LUP + allows the left mouse button up click. INKEY_RDOWN + allows the right mouse button down click. INKEY_RUP + allows the right mouse button up clock. INKEY_KEYBOARD + allows keyboard keystrokes. INKEY_ALL allows all of the + preceding events. Events may be combined (e.g., using + INKEY_LDOWN + INKEY_RUP will allow left mouse button + down clicks and right mouse button up clicks). The + default is INKEY_KEYBOARD. + + _SET_EXACT | + + When enabled, all string comparisons other than "==" + exclude trailing spaces when checking for equality. + When disabled, which is the default, all string + comparisons other than "==" treat two strings as + equal if the right hand string is "" or if the right + hand string is shorter than or the same length as the + left hand string and all of the characters in the right + hand string match the corresponding characters in the + left hand string. + + _SET_EXCLUSIVE | + + When enabled, which is the default, all database files + are opened in exclusive mode. When disabled, all + database files are opened in shared mode. Note: The + EXCLUSIVE and SHARED clauses of the USE command can be + used to override this setting. + + _SET_EXIT | + + Toggles the use of Uparrow and Dnarrow as READ exit keys. + Specifying true (.T.) enables them as exit keys, and + false (.F.) disables them. Used internally by the + ReadExit() function. + + _SET_EXTRA | + + QUESTION: What is this for? + It does not affect _SET_EXTRAFILE in CA-Cl*pper! + + _SET_EXTRAFILE + + When set, creates or opens file to write QOUT() and + QQOUT() output to. If is TRUE and the file + already exists, the file is opened and positioned at end + of file. Otherwise, the file is created. If a file is + already opened, it is closed before the new file is + opened or created (even if it is the same file). The + default file extension is ".prn". There is no default + file name. Call with an empty string to close the file. + + _SET_FIXED | + + When enabled, all numeric values will be displayed + and printed with the number of decimal digits set + by SET DECIMALS, unless a PICTURE clause is used. + When disabled, which is the default, the number + of decimal digits that are displayed depends upon + a variety of factors. See _SET_DECIMALS for more. + + _SET_INSERT | + + When enabled, characters typed in a GET or MEMOEDIT + are inserted. When disabled, which is the default, + characters typed in a GET or MEMOEDIT overwrite. + Note: This setting can also be toggled between on and + off by pressing the Insert key during a GET or MEMOEDIT. + + _SET_INTENSITY | + + When enabled, which is the default, GETs and PROMPTs + are displayed using the enhanced color setting. When + disabled, GETs and PROMPTs are displayed using the + standard color setting. + + _SET_LANGUAGE + + Specifies the language to be used for Harbour messages. + [This is a Harbour extension] + + _SET_MARGIN + + Sets the left margin for all printed output. The default + value is 0. Note: PCOL() reflects the printer's column + position including the margin (e.g., SET MARGIN TO 5 + followed by DEVPOS(5, 10) makes PCOL() return 15). + + _SET_MBLOCKSIZE + + TODO: Document + + _SET_MCENTER | + + If enabled, display PROMPTs centered on the MESSAGE row. + If disabled, which is the default, display PROMPTS at + column position 0 on the MESSAGE row. + + _SET_MESSAGE + + If set to 0, which is the default, PROMPTs are always + suppressed. Otherwise, PROMPTs are displayed on the + set row. Note: It is not possible to display prompts + on the top-most screen row, because row 0 is reserved + for the SCOREBOARD, if enabled. + + _SET_MFILEEXT + + TODO: Document + + _SET_OPTIMIZE | + + TODO: Document + + _SET_PATH + + Specifies a path of directories to search through to + locate a file that can't be located in the DEFAULT + directory. Defaults to no path (""). Directories must + be separated by a semicolon (e.g., "C:\data;C:\more"). + + _SET_PRINTER | + + If enabled, QOUT() and QQOUT() write to the screen and to + a file, provided that a file has been opened or created + with _SET_ALTFILE. If disabled, which is the default, + QOUT() and QQOUT() only write to the screen (and/or to + the ALTFILE). + + _SET_PRINTFILE + + When set, creates or opens file to write QOUT(), QQOUT() + and DEVOUT() output to. If is TRUE and the + file already exists, the file is opened and positioned + at end of file. Otherwise, the file is created. If a + file is already opened, it is closed before the new file + is opened or created (even if it is the same file). The + default file extension is ".prn". The default file name + is "PRN", which maps to the default printer device. Call + with an empty string to close the file. + + _SET_SCOREBOARD | + + When enabled, which is the default, READ and MEMOEDIT + display status messages on screen row 0. When disabled, + READ and MEMOEDIT status messages are suppressed. + + _SET_SCROLLBREAK | + + QUESTION: What is this flag for? + + _SET_SOFTSEEK | + + When enabled, a SEEK that fails will position the record + pointer to the first key that is higher than the sought + after key or to LASTREC() + 1 if there is no higher key. + When disabled, which is the default, a SEEK that fails + will position the record pointer to LASTREC()+1. + + _SET_STRICTREAD | + + TODO: Document + + _SET_TYPEAHEAD + + Sets the size of the keyboard typeahead buffer. Defaults + to 50. The minimum is 16 and the maximum is 4096. + + _SET_UNIQUE | + + When enabled, indexes are not allowed to have duplicate + keys. When disabled, indexes are allowed duplicate keys. + + _SET_VIDEOMODE + + TODO: Document + + _SET_WRAP | + + When enabled, lightbar menus can be navigated from the + last position to the first and from the first position + to the last. When disabled, which is the default, there + is a hard stop at the first and last positions. + $RETURNS$ + SET() The current or previous setting + $FILES$ + Library is rtl + $COMPLIANCE$ + C + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __SetFunction() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Events - * $ONELINER$ - * Assign a character string to a function key - * $SYNTAX$ - * __SetFunction( , [] ) --> NIL - * $ARGUMENTS$ - * is a number in the range 1..40 that represent the - * function key to be assigned. - * - * is a character string to set. If is not - * specified, the function key is going to be set to NIL releasing by - * that any previous __SetFunction() or SETKEY() for that function. - * $RETURNS$ - * __SetFunction() always return NIL. - * $DESCRIPTION$ - * __SetFunction() assign a character string with a function key, when - * this function key is pressed, the keyboard is stuffed with this - * character string. __SetFunction() has the effect of clearing any - * SETKEY() previously set to the same function number and vice versa. - * - * - * nFunctionKey Key to be set - * - * 1 .. 12 F1 .. F12 - * 13 .. 20 Shift-F3 .. Shift-F10 - * 21 .. 30 Ctrl-F1 .. Ctrl-F10 - * 31 .. 40 Alt-F1 .. Alt-F10 - *
- * - * SET FUNCTION command is preprocessed into __SetFunction() function - * during compile time. - * $EXAMPLES$ - * // Set F1 with a string - * CLS - * __SetFunction( 1, "I Am Lazy" + Chr( 13 ) ) - * cTest := Space( 20 ) - * @ 10, 0 SAY "type something or F1 for lazy mode " GET cTest - * READ - * ? cTest - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour use 11 and 12 to represent F11 and F12, while CA-Cl*pper use - * 11 and 12 to represent Shift-F1 and Shift-F2. - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * INKEY(),SETKEY(),__Keyboard(),SET KEY - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __SetFunction() + $CATEGORY$ + API + $SUBCATEGORY$ + Events + $ONELINER$ + Assign a character string to a function key + $SYNTAX$ + __SetFunction( , [] ) --> NIL + $ARGUMENTS$ + is a number in the range 1..40 that represent the + function key to be assigned. + + is a character string to set. If is not + specified, the function key is going to be set to NIL releasing by + that any previous __SetFunction() or SETKEY() for that function. + $RETURNS$ + __SetFunction() always return NIL. + $DESCRIPTION$ + __SetFunction() assign a character string with a function key, when + this function key is pressed, the keyboard is stuffed with this + character string. __SetFunction() has the effect of clearing any + SETKEY() previously set to the same function number and vice versa. + + + nFunctionKey Key to be set + + 1 .. 12 F1 .. F12 + 13 .. 20 Shift-F3 .. Shift-F10 + 21 .. 30 Ctrl-F1 .. Ctrl-F10 + 31 .. 40 Alt-F1 .. Alt-F10 +
+ + SET FUNCTION command is preprocessed into __SetFunction() function + during compile time. + $EXAMPLES$ + // Set F1 with a string + CLS + __SetFunction( 1, "I Am Lazy" + Chr( 13 ) ) + cTest := Space( 20 ) + @ 10, 0 SAY "type something or F1 for lazy mode " GET cTest + READ + ? cTest + $STATUS$ + R + $COMPLIANCE$ + Harbour use 11 and 12 to represent F11 and F12, while CA-Cl*pper use + 11 and 12 to represent Shift-F1 and Shift-F2. + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + INKEY(),SETKEY(),__Keyboard(),SET KEY + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * SET FUNCTION - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Assign a character string to a function key - * $SYNTAX$ - * SET FUNCTION TO [] - * $ARGUMENTS$ - * is a number in the range 1..40 that represent the - * function key to be assigned. - * - * is a character string to set. If is not - * specified, the function key is going to be set to NIL releasing by - * that any previous Set Function or SETKEY() for that function. - * $DESCRIPTION$ - * Set Function assign a character string with a function key, when - * this function key is pressed, the keyboard is stuffed with this - * character string. Set Function has the effect of clearing any - * SETKEY() previously set to the same function number and vice versa. - * - * - * nFunctionKey Key to be set - * - * 1 .. 12 F1 .. F12 - * 13 .. 20 Shift-F3 .. Shift-F10 - * 21 .. 30 Ctrl-F1 .. Ctrl-F10 - * 31 .. 40 Alt-F1 .. Alt-F10 - *
- * - * SET FUNCTION command is preprocessed into __SetFunction() function - * during compile time. - * $EXAMPLES$ - * // Set F1 with a string - * CLS - * SET FUNCTION 1 TO "I Am Lazy" + Chr( 13 ) - * cTest := Space( 20 ) - * @ 10, 0 SAY "type something or F1 for lazy mode " GET cTest - * READ - * ? cTest - * $STATUS$ - * R - * $COMPLIANCE$ - * Harbour use 11 and 12 to represent F11 and F12, while CA-Cl*pper use - * 11 and 12 to represent Shift-F1 and Shift-F2. - * $PLATFORMS$ - * All - * $SEEALSO$ - * INKEY(),SETKEY(),__Keyboard() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + SET FUNCTION + $CATEGORY$ + Command + $SUBCATEGORY$ + Environment + $ONELINER$ + Assign a character string to a function key + $SYNTAX$ + SET FUNCTION TO [] + $ARGUMENTS$ + is a number in the range 1..40 that represent the + function key to be assigned. + + is a character string to set. If is not + specified, the function key is going to be set to NIL releasing by + that any previous Set Function or SETKEY() for that function. + $DESCRIPTION$ + Set Function assign a character string with a function key, when + this function key is pressed, the keyboard is stuffed with this + character string. Set Function has the effect of clearing any + SETKEY() previously set to the same function number and vice versa. + + + nFunctionKey Key to be set + + 1 .. 12 F1 .. F12 + 13 .. 20 Shift-F3 .. Shift-F10 + 21 .. 30 Ctrl-F1 .. Ctrl-F10 + 31 .. 40 Alt-F1 .. Alt-F10 +
+ + SET FUNCTION command is preprocessed into __SetFunction() function + during compile time. + $EXAMPLES$ + // Set F1 with a string + CLS + SET FUNCTION 1 TO "I Am Lazy" + Chr( 13 ) + cTest := Space( 20 ) + @ 10, 0 SAY "type something or F1 for lazy mode " GET cTest + READ + ? cTest + $STATUS$ + R + $COMPLIANCE$ + Harbour use 11 and 12 to represent F11 and F12, while CA-Cl*pper use + 11 and 12 to represent Shift-F1 and Shift-F2. + $PLATFORMS$ + All + $SEEALSO$ + INKEY(),SETKEY(),__Keyboard() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SETKEY() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Events - * $ONELINER$ - * Assign an action block to a key - * $SYNTAX$ - * SETKEY( [, [, ] ] ) - * $ARGUMENTS$ - * is either a numeric key value, or an array of such values - * - * is an optional code-block to be assigned - * - * is an optional condition code-block - * $RETURNS$ - * Current assigned action-block - * $DESCRIPTION$ - * The SetKey() function returns the current code-block assigned to a - * key when called with only the key value. If the action block (and - * optionally the condition block) are passed, the current block is - * returned, and the new code block and condition block are stored. - * A group of keys may be assigned the same code block/condition block - * by using an array of key values in place on the first parameter. - * $EXAMPLES$ - * LOCAL bOldF10 := SetKey( K_F10, {|| Yahoo() } ) - * ... // some other processing - * SetKey( K_F10, bOldF10 ) - * ... // some other processing - * bBlock := SetKey( K_SPACE ) - * IF bBlock != NIL ... - * - * // make F10 exit current get, but only if in a get - ignores other - * // wait-states such as menus, achoices, etc... - * SetKey( K_F10, {|| GetActive():State := GE_WRITE },; - * {|| GetActive() != NIL } ) - * $TESTS$ - * None definable - * $STATUS$ - * R - * $COMPLIANCE$ - * SETKEY() is mostly CA-Cl*pper compliant. The only difference is the - * addition of the condition code-block parameter, allowing set-keys to - * be conditionally turned off or on. This condition-block cannot be - * returned once set - see SetKeyGet() - * $FILES$ - * Library is rtl - * $SEEALSO$ - * HB_SETKEYSAVE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SETKEY() + $CATEGORY$ + API + $SUBCATEGORY$ + Events + $ONELINER$ + Assign an action block to a key + $SYNTAX$ + SETKEY( [, [, ] ] ) + $ARGUMENTS$ + is either a numeric key value, or an array of such values + + is an optional code-block to be assigned + + is an optional condition code-block + $RETURNS$ + Current assigned action-block + $DESCRIPTION$ + The SetKey() function returns the current code-block assigned to a + key when called with only the key value. If the action block (and + optionally the condition block) are passed, the current block is + returned, and the new code block and condition block are stored. + A group of keys may be assigned the same code block/condition block + by using an array of key values in place on the first parameter. + $EXAMPLES$ + LOCAL bOldF10 := SetKey( K_F10, {|| Yahoo() } ) + ... // some other processing + SetKey( K_F10, bOldF10 ) + ... // some other processing + bBlock := SetKey( K_SPACE ) + IF bBlock != NIL ... + + // make F10 exit current get, but only if in a get - ignores other + // wait-states such as menus, achoices, etc... + SetKey( K_F10, {|| GetActive():State := GE_WRITE },; + {|| GetActive() != NIL } ) + $TESTS$ + None definable + $STATUS$ + R + $COMPLIANCE$ + SETKEY() is mostly CA-Cl*pper compliant. The only difference is the + addition of the condition code-block parameter, allowing set-keys to + be conditionally turned off or on. This condition-block cannot be + returned once set - see SetKeyGet() + $FILES$ + Library is rtl + $SEEALSO$ + HB_SETKEYSAVE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_SetKeyGet() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Events - * $ONELINER$ - * Determine a set-key code block and condition-block - * $SYNTAX$ - * HB_SETKEYGET( [, ] ) - * $ARGUMENTS$ - * is an numeric key value +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_SetKeyGet() + $CATEGORY$ + API + $SUBCATEGORY$ + Events + $ONELINER$ + Determine a set-key code block and condition-block + $SYNTAX$ + HB_SETKEYGET( [, ] ) + $ARGUMENTS$ + is an numeric key value - * is an optional return-parameter - * $RETURNS$ - * Current assigned action-block - * $DESCRIPTION$ - * The HB_SetKeyGet() function returns the current code-block assigned to - * a key, and optionally assigns the condition-block to the - * return-parameter - * $EXAMPLES$ - * LOCAL bOldF10, bOldF10Cond - * bOldF10 := HB_SetKeyGet( K_F10, @bOldF10Cond ) - * ... // some other processing - * SetKey( K_F10, bOldF10, bOldF10Cond ) - * $TESTS$ - * See test code above - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is rtl - * $SEEALSO$ - * SETKEY(),HB_SETKEYSAVE(),HB_SETKEYCHECK() - * $END$ + is an optional return-parameter + $RETURNS$ + Current assigned action-block + $DESCRIPTION$ + The HB_SetKeyGet() function returns the current code-block assigned to + a key, and optionally assigns the condition-block to the + return-parameter + $EXAMPLES$ + LOCAL bOldF10, bOldF10Cond + bOldF10 := HB_SetKeyGet( K_F10, @bOldF10Cond ) + ... // some other processing + SetKey( K_F10, bOldF10, bOldF10Cond ) + $TESTS$ + See test code above + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is rtl + $SEEALSO$ + SETKEY(),HB_SETKEYSAVE(),HB_SETKEYCHECK() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_SETKEYSAVE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Events - * $ONELINER$ - * Returns a copy of internal set-key list, optionally overwriting - * $SYNTAX$ - * HB_SETKEYSAVE( [ ] ) - * $ARGUMENTS$ - * is an optional set-key list from a previous call to - * HB_SetKeySave(), or NIL to clear current set-key list - * $RETURNS$ - * Current set-key list - * $DESCRIPTION$ - * HB_SetKeySave() is designed to act like the set() function which - * returns the current state of an environment setting, and optionally - * assigning a new value. In this case, the "environment setting" is the - * internal set-key list, and the optional new value is either a value - * returned from a previous call to SetKeySave() - to restore that list, - * or the value of NIL to clear the current list. - * $EXAMPLES$ - * LOCAL aKeys := HB_SetKeySave( NIL ) // removes all current set=keys - * ... // some other processing - * HB_SetKeySave( aKeys ) - * $TESTS$ - * None definable - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is rtl - * $SEEALSO$ - * SETKEY() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_SETKEYSAVE() + $CATEGORY$ + API + $SUBCATEGORY$ + Events + $ONELINER$ + Returns a copy of internal set-key list, optionally overwriting + $SYNTAX$ + HB_SETKEYSAVE( [ ] ) + $ARGUMENTS$ + is an optional set-key list from a previous call to + HB_SetKeySave(), or NIL to clear current set-key list + $RETURNS$ + Current set-key list + $DESCRIPTION$ + HB_SetKeySave() is designed to act like the set() function which + returns the current state of an environment setting, and optionally + assigning a new value. In this case, the "environment setting" is the + internal set-key list, and the optional new value is either a value + returned from a previous call to SetKeySave() - to restore that list, + or the value of NIL to clear the current list. + $EXAMPLES$ + LOCAL aKeys := HB_SetKeySave( NIL ) // removes all current set=keys + ... // some other processing + HB_SetKeySave( aKeys ) + $TESTS$ + None definable + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is rtl + $SEEALSO$ + SETKEY() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_SetKeyCheck() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Events - * $ONELINER$ - * Implements common hot-key activation code - * $SYNTAX$ - * HB_SetKeyCheck( [, ][, ][, ] ) - * $ARGUMENTS$ - * is a numeric key value to be tested code-block, if executed - * - * .. are optional parameters that will be passed to the code-block - * $RETURNS$ - * True if there is a hot-key associated with and it was executed; - * otherwise False - * If there is a hot-key association (before checking any condition): - * - if there is a condition-block, it is passed one parameter - - * - when the hot-key code-block is called, it is passed 1 to 4 parameters, - * depending on the parameters passed to HB_SetKeyCheck(). Any - * parameters so passed are directly passed to the code-block, with an - * additional parameter being - * $DESCRIPTION$ - * HB_SetKeyCheck() is intended as a common interface to the SetKey() - * functionality for such functions as ACHOICE(), DBEDIT(), MEMOEDIT(), - * ACCEPT, INPUT, READ, and WAIT - * $EXAMPLES$ - * // within ReadModal() - * IF HB_SetKeyCheck( K_ALT_X, GetActive() ) - * ... // some other processing - * ENDIF - * // within TBrowse handler - * CASE HB_SetKeyCheck( nInkey, oTBrowse ) - * RETURN - * CASE nInKey == K_ESC - * ... // some other processing - * $TESTS$ - * None definable - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is rtl - * $SEEALSO$ - * SETKEY(),HB_SETKEYSAVE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_SetKeyCheck() + $CATEGORY$ + API + $SUBCATEGORY$ + Events + $ONELINER$ + Implements common hot-key activation code + $SYNTAX$ + HB_SetKeyCheck( [, ][, ][, ] ) + $ARGUMENTS$ + is a numeric key value to be tested code-block, if executed + + .. are optional parameters that will be passed to the code-block + $RETURNS$ + True if there is a hot-key associated with and it was executed; + otherwise False + If there is a hot-key association (before checking any condition): + - if there is a condition-block, it is passed one parameter - + - when the hot-key code-block is called, it is passed 1 to 4 parameters, + depending on the parameters passed to HB_SetKeyCheck(). Any + parameters so passed are directly passed to the code-block, with an + additional parameter being + $DESCRIPTION$ + HB_SetKeyCheck() is intended as a common interface to the SetKey() + functionality for such functions as ACHOICE(), DBEDIT(), MEMOEDIT(), + ACCEPT, INPUT, READ, and WAIT + $EXAMPLES$ + // within ReadModal() + IF HB_SetKeyCheck( K_ALT_X, GetActive() ) + ... // some other processing + ENDIF + // within TBrowse handler + CASE HB_SetKeyCheck( nInkey, oTBrowse ) + RETURN + CASE nInKey == K_ESC + ... // some other processing + $TESTS$ + None definable + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is rtl + $SEEALSO$ + SETKEY(),HB_SETKEYSAVE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * SET KEY - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Assign an action block to a key - * $SYNTAX$ - * SET KEY to p] [when ] ) - * $ARGUMENTS$ - * is either a numeric key value, or an array of such values - * - * is an optional code-block to be assigned - * - * is an optional condition code-block - * $DESCRIPTION$ - * The Set Key Command function is translated to the SetKey() function - * witch returns the current code-block assigned to a - * key when called with only the key value. If the action block (and - * optionally the condition block) are passed, the current block is - * returned, and the new code block and condition block are stored. - * A group of keys may be assigned the same code block/condition block - * by using an array of key values in place on the first parameter. - * $EXAMPLES$ - * LOCAL bOldF10 := setKey( K_F10, {|| Yahoo() } ) - * ... // some other processing - * SET KEY K_F10 TO bOldF10 - * ... // some other processing - * bBlock := SetKey( K_SPACE ) - * IF bBlock != NIL ... - * - * // make F10 exit current get, but only if in a get - ignores other - * // wait-states such as menus, achoices, etc... - * SetKey( K_F10, {|| GetActive():State := GE_WRITE },; - * {|| GetActive() != NIL } ) - * $TESTS$ - * None definable - * $STATUS$ - * R - * $COMPLIANCE$ - * SET KEY is mostly CA-Cl*pper compliant. The only difference is the - * addition of the condition code-block parameter, allowing set-keys to - * be conditionally turned off or on. This condition-block cannot be - * returned once set - see SetKeyGet() - * $SEEALSO$ - * HB_SETKEYSAVE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + SET KEY + $CATEGORY$ + Command + $SUBCATEGORY$ + Environment + $ONELINER$ + Assign an action block to a key + $SYNTAX$ + SET KEY to p] [when ] ) + $ARGUMENTS$ + is either a numeric key value, or an array of such values + + is an optional code-block to be assigned + + is an optional condition code-block + $DESCRIPTION$ + The Set Key Command function is translated to the SetKey() function + witch returns the current code-block assigned to a + key when called with only the key value. If the action block (and + optionally the condition block) are passed, the current block is + returned, and the new code block and condition block are stored. + A group of keys may be assigned the same code block/condition block + by using an array of key values in place on the first parameter. + $EXAMPLES$ + LOCAL bOldF10 := setKey( K_F10, {|| Yahoo() } ) + ... // some other processing + SET KEY K_F10 TO bOldF10 + ... // some other processing + bBlock := SetKey( K_SPACE ) + IF bBlock != NIL ... + + // make F10 exit current get, but only if in a get - ignores other + // wait-states such as menus, achoices, etc... + SetKey( K_F10, {|| GetActive():State := GE_WRITE },; + {|| GetActive() != NIL } ) + $TESTS$ + None definable + $STATUS$ + R + $COMPLIANCE$ + SET KEY is mostly CA-Cl*pper compliant. The only difference is the + addition of the condition code-block parameter, allowing set-keys to + be conditionally turned off or on. This condition-block cannot be + returned once set - see SetKeyGet() + $SEEALSO$ + HB_SETKEYSAVE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SETTYPEAHEAD() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Sets the typeahead buffer to given size. - * $SYNTAX$ - * SETTYPEAHEAD( ) --> - * $ARGUMENTS$ - * is a valid typeahead size. - * $RETURNS$ - * The previous state of _SET_TYPEAHEAD - * $DESCRIPTION$ - * This function sets the typeahead buffer to a valid given size as is - * Set( _SET_TYPEAHEAD ) where used. - * $EXAMPLES$ - * // Sets typeahead to 12 - * SetTypeahead( 12 ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * __ACCEPT(),__INPUT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SETTYPEAHEAD() + $CATEGORY$ + API + $SUBCATEGORY$ + Environment + $ONELINER$ + Sets the typeahead buffer to given size. + $SYNTAX$ + SETTYPEAHEAD( ) --> + $ARGUMENTS$ + is a valid typeahead size. + $RETURNS$ + The previous state of _SET_TYPEAHEAD + $DESCRIPTION$ + This function sets the typeahead buffer to a valid given size as is + Set( _SET_TYPEAHEAD ) where used. + $EXAMPLES$ + // Sets typeahead to 12 + SetTypeahead( 12 ) + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + __ACCEPT(),__INPUT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __XHELP() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Internal - * $ONELINER$ - * Determines whether a Help() user defined function exists. - * $SYNTAX$ - * __XHELP() --> - * $ARGUMENTS$ - * None - * $RETURNS$ - * This function returns aleatory values. - * $DESCRIPTION$ - * This is an internal undocumented CA-Cl*pper function, which will - * try to call the user defined function HELP() if it is defined - * in the current application. This is the default SetKey() handler - * for the F1 key. - * $STATUS$ - * R - * $COMPLIANCE$ - * C52U - * $FILES$ - * Library is rtl - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __XHELP() + $CATEGORY$ + API + $SUBCATEGORY$ + Internal + $ONELINER$ + Determines whether a Help() user defined function exists. + $SYNTAX$ + __XHELP() --> + $ARGUMENTS$ + None + $RETURNS$ + This function returns aleatory values. + $DESCRIPTION$ + This is an internal undocumented CA-Cl*pper function, which will + try to call the user defined function HELP() if it is defined + in the current application. This is the default SetKey() handler + for the F1 key. + $STATUS$ + R + $COMPLIANCE$ + C52U + $FILES$ + Library is rtl + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * SET DEFAULT - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Establishes the Harbour search drive and directory. - * $SYNTAX$ - * SET DEFAULT TO [] - * $ARGUMENTS$ - * Drive and/or path. - * $DESCRIPTION$ - * This command changes the drive and directory used for reading and - * writing database,index,memory, and alternate files. Specifying no - * parameters with this command will default the operation to the - * current logged drive and directory. - * $EXAMPLES$ - * SET DEFAULT TO C:\temp - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * SET PATH,CURDIR(),SET() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + SET DEFAULT + $CATEGORY$ + Command + $SUBCATEGORY$ + Environment + $ONELINER$ + Establishes the Harbour search drive and directory. + $SYNTAX$ + SET DEFAULT TO [] + $ARGUMENTS$ + Drive and/or path. + $DESCRIPTION$ + This command changes the drive and directory used for reading and + writing database,index,memory, and alternate files. Specifying no + parameters with this command will default the operation to the + current logged drive and directory. + $EXAMPLES$ + SET DEFAULT TO C:\temp + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + SET PATH,CURDIR(),SET() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * SET WRAP - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Toggle wrapping the PROMPTs in a menu. - * $SYNTAX$ - * SET WRAP on | OFF | ( - * $ARGUMENTS$ - * Logical expression for toggle - * $DESCRIPTION$ - * This command toggles the highlighted bars in a @...PROMPT command - * to wrap around in a bottom-to-top and top-to-bottom manner. If the - * value of the logical expression is a logical false (.F.), - * the wrapping mode is set OFF; otherwise,it is set ON. - * $EXAMPLES$ - * See tests/menutest.prg - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * @...PROMPT,MENU TO - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + SET WRAP + $CATEGORY$ + Command + $SUBCATEGORY$ + Environment + $ONELINER$ + Toggle wrapping the PROMPTs in a menu. + $SYNTAX$ + SET WRAP on | OFF | ( + $ARGUMENTS$ + Logical expression for toggle + $DESCRIPTION$ + This command toggles the highlighted bars in a @...PROMPT command + to wrap around in a bottom-to-top and top-to-bottom manner. If the + value of the logical expression is a logical false (.F.), + the wrapping mode is set OFF; otherwise,it is set ON. + $EXAMPLES$ + See tests/menutest.prg + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + @...PROMPT,MENU TO + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * SET MESSAGE - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Establishes a message row for @...PROMPT command - * $SYNTAX$ - * SET MESSAGE TO [ [CENTER]] - * $ARGUMENTS$ - * Row number to display the message - * $DESCRIPTION$ - * This command is designed to work in conjunction with the MENU TO and - * @...PROMPT commands. With this command, a row number between 0 and - * MAXROW() may be specified in . This establishes the row on - * witch any message associated with an @...PROMPT command will appear. - * - * If the value of is 0, all messages will be suppressed. - * All messaged will be left-justifies unless the CENTER clause is - * used. In this case, the individual messages in each @...PROMPT command - * will be centered at the designated row (unless is 0). All - * messages are independent; therefore, the screen area is cleared out - * by the centered message will vary based on the length of each - * individual message. - * - * Specifying no parameters with this command set the row value to 0, - * witch suppresses all messages output. - * The British spelling of CENTRE is also supported. - * $EXAMPLES$ - * See tests/menutest.prg - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * SET(),SET WRAP,@...PROMPT,MENU TO - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + SET MESSAGE + $CATEGORY$ + Command + $SUBCATEGORY$ + Environment + $ONELINER$ + Establishes a message row for @...PROMPT command + $SYNTAX$ + SET MESSAGE TO [ [CENTER]] + $ARGUMENTS$ + Row number to display the message + $DESCRIPTION$ + This command is designed to work in conjunction with the MENU TO and + @...PROMPT commands. With this command, a row number between 0 and + MAXROW() may be specified in . This establishes the row on + witch any message associated with an @...PROMPT command will appear. + + If the value of is 0, all messages will be suppressed. + All messaged will be left-justifies unless the CENTER clause is + used. In this case, the individual messages in each @...PROMPT command + will be centered at the designated row (unless is 0). All + messages are independent; therefore, the screen area is cleared out + by the centered message will vary based on the length of each + individual message. + + Specifying no parameters with this command set the row value to 0, + witch suppresses all messages output. + The British spelling of CENTRE is also supported. + $EXAMPLES$ + See tests/menutest.prg + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + SET(),SET WRAP,@...PROMPT,MENU TO + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * SET PATH - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Specifies a search path for opening files - * $SYNTAX$ - * SET PATH TO [] - * $ARGUMENTS$ - * Search path for files - * $DESCRIPTION$ - * This command specifies the search path for files required by most - * commands and functions not found in the current drive and directory. - * This pertains primarily, but not exclusively, to databases, indexes, - * and memo files, as well as to memory, labels and reports files. The - * search hierarchy is: 1 Current drive and directory, 2 The SET DEFAULT - * path; 3 The SET PATH path. - * $EXAMPLES$ - * SET PATH TO C:\harbour\test - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * SET DEFAULT,CURDIR(),SET() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + SET PATH + $CATEGORY$ + Command + $SUBCATEGORY$ + Environment + $ONELINER$ + Specifies a search path for opening files + $SYNTAX$ + SET PATH TO [] + $ARGUMENTS$ + Search path for files + $DESCRIPTION$ + This command specifies the search path for files required by most + commands and functions not found in the current drive and directory. + This pertains primarily, but not exclusively, to databases, indexes, + and memo files, as well as to memory, labels and reports files. The + search hierarchy is: 1 Current drive and directory, 2 The SET DEFAULT + path; 3 The SET PATH path. + $EXAMPLES$ + SET PATH TO C:\harbour\test + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + SET DEFAULT,CURDIR(),SET() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * SET INTENSITY - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Toggles the enhanced display of PROMPT's and GETs. - * $SYNTAX$ - * SET INTENSITY ON | off | () - * $ARGUMENTS$ - * Logical expression for toggle command - * $DESCRIPTION$ - * This command set the field input color and @...PROMPT menu color - * to either highlighted (inverse video) or normal color. The default - * condition is ON (highlighted). - * $EXAMPLES$ - * SET INTENSITY ON - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * @...GET,@...PROMPT,@...SAY,SET() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + SET INTENSITY + $CATEGORY$ + Command + $SUBCATEGORY$ + Environment + $ONELINER$ + Toggles the enhanced display of PROMPT's and GETs. + $SYNTAX$ + SET INTENSITY ON | off | () + $ARGUMENTS$ + Logical expression for toggle command + $DESCRIPTION$ + This command set the field input color and @...PROMPT menu color + to either highlighted (inverse video) or normal color. The default + condition is ON (highlighted). + $EXAMPLES$ + SET INTENSITY ON + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + @...GET,@...PROMPT,@...SAY,SET() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * SET ALTERNATE - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Toggle and echos output to an alternate file - * $SYNTAX$ - * SET ALTERNATE to [ADDITIVE] - * SET ALTERNATE on | OFF | () - * $ARGUMENTS$ - * Name of alternate file. - * - * Logical expression for toggle - * $DESCRIPTION$ - * This command toggles and output console information to the alternate - * file , provided that the command is toggled on or the condition - * is set to a logical true (.T.). If does not has a - * file extension, .txt will be assumed. The file name may optionally - * have a drive letter and/or directory path. If none is specified, the - * current drive and directory will be used. - * If the ALTERNATE file is created but no ALTERNATE ON command is - * issued, nothing will be echoed to the file. - * If ADDITIVE clause is used, then the information will be appended - * to the existing alternate file. Otherwise, a new file will be created - * with the specified name (or an existing one will be overwritten) and - * the information will be appended to the file. The default is to create - * a new file. - * A SET ALTERNATE TO command will close the alternate file - * $EXAMPLES$ - * SET ALTERNATE TO test.txt - * SET ALTERNATE ON - * ? 'Harbour' - * ? "is" - * ? "Power" - * SET ALTERNATE TO - * SET ALTERNATE OFF - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * CLOSE,SET PRINTER,SET CONSOLE,SET() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + SET ALTERNATE + $CATEGORY$ + Command + $SUBCATEGORY$ + Environment + $ONELINER$ + Toggle and echos output to an alternate file + $SYNTAX$ + SET ALTERNATE to [ADDITIVE] + SET ALTERNATE on | OFF | () + $ARGUMENTS$ + Name of alternate file. + + Logical expression for toggle + $DESCRIPTION$ + This command toggles and output console information to the alternate + file , provided that the command is toggled on or the condition + is set to a logical true (.T.). If does not has a + file extension, .txt will be assumed. The file name may optionally + have a drive letter and/or directory path. If none is specified, the + current drive and directory will be used. + If the ALTERNATE file is created but no ALTERNATE ON command is + issued, nothing will be echoed to the file. + If ADDITIVE clause is used, then the information will be appended + to the existing alternate file. Otherwise, a new file will be created + with the specified name (or an existing one will be overwritten) and + the information will be appended to the file. The default is to create + a new file. + A SET ALTERNATE TO command will close the alternate file + $EXAMPLES$ + SET ALTERNATE TO test.txt + SET ALTERNATE ON + ? 'Harbour' + ? "is" + ? "Power" + SET ALTERNATE TO + SET ALTERNATE OFF + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + CLOSE,SET PRINTER,SET CONSOLE,SET() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * SET CENTURY - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Toggle the century digits in all dates display - * $SYNTAX$ - * SET CENTURY on | OFF | () - * $ARGUMENTS$ - * Logical expression for toggle - * $DESCRIPTION$ - * This command allows the input and display of dates with the century - * prefix. It will be in the standart MM/DD/YYYY format unless specified - * by the SET DATE command or SET() function. If is a logical - * true (.T.), the command will be set on; otherwise, the command will - * be set off - * $EXAMPLES$ - * SET CENTURY ON - * ? Date() - * SET CENTURY OFF - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * SET DATE,SET EPOCH,CTOD(),DATE(),DTOC(),SET() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + SET CENTURY + $CATEGORY$ + Command + $SUBCATEGORY$ + Environment + $ONELINER$ + Toggle the century digits in all dates display + $SYNTAX$ + SET CENTURY on | OFF | () + $ARGUMENTS$ + Logical expression for toggle + $DESCRIPTION$ + This command allows the input and display of dates with the century + prefix. It will be in the standart MM/DD/YYYY format unless specified + by the SET DATE command or SET() function. If is a logical + true (.T.), the command will be set on; otherwise, the command will + be set off + $EXAMPLES$ + SET CENTURY ON + ? Date() + SET CENTURY OFF + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + SET DATE,SET EPOCH,CTOD(),DATE(),DTOC(),SET() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * SET DATE - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Assigns a date format or chooses a predefined date data set. - * $SYNTAX$ - * SET DATE FORMAT [TO] - * - * SET DATE [TO] [ANSI / BRITISH / FRENCH / GERMAN / ITALIAN / JAPAN / USA / AMERICAN] - * $ARGUMENTS$ - * Keyword for date format - * $DESCRIPTION$ - * This command sets the date format for function display purposes. - * If specified, may be a customized date format in which the - * letters d, m and y may be used to design a date format. The default - * is an AMERICAN date format; specifying no parameters will set the - * date format to AMERICAN. Below is a table of the various predefined - * dates formats. - * - * - * Syntax Date Format - * ANSI yy.mm.dd - * BRITISH dd/mm/yy - * FRENCH dd/mm/yy - * GERMAN dd.mm.yy - * ITALIAN dd-mm-yy - * JAPAN yy.mm.dd - * USA mm-dd-yy - * AMERICAN mm/dd/yy - *
- * $EXAMPLES$ - * SET DATE JAPAN - * ? Date() - * SET DATE GERMAN - * ? Date() - * $TESTS$ - * See tests/dates.prg - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * SET DATE,SET EPOCH,CTOD(),DATE(),DTOC(),SET() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + SET DATE + $CATEGORY$ + Command + $SUBCATEGORY$ + Environment + $ONELINER$ + Assigns a date format or chooses a predefined date data set. + $SYNTAX$ + SET DATE FORMAT [TO] + + SET DATE [TO] [ANSI / BRITISH / FRENCH / GERMAN / ITALIAN / JAPAN / USA / AMERICAN] + $ARGUMENTS$ + Keyword for date format + $DESCRIPTION$ + This command sets the date format for function display purposes. + If specified, may be a customized date format in which the + letters d, m and y may be used to design a date format. The default + is an AMERICAN date format; specifying no parameters will set the + date format to AMERICAN. Below is a table of the various predefined + dates formats. + + + Syntax Date Format + ANSI yy.mm.dd + BRITISH dd/mm/yy + FRENCH dd/mm/yy + GERMAN dd.mm.yy + ITALIAN dd-mm-yy + JAPAN yy.mm.dd + USA mm-dd-yy + AMERICAN mm/dd/yy +
+ $EXAMPLES$ + SET DATE JAPAN + ? Date() + SET DATE GERMAN + ? Date() + $TESTS$ + See tests/dates.prg + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + SET DATE,SET EPOCH,CTOD(),DATE(),DTOC(),SET() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * SET EPOCH - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Specify a base year for interpreting dates - * $SYNTAX$ - * SET EPOCH TO - * $ARGUMENTS$ - * Base Century. - * $DESCRIPTION$ - * This command sets the base year value for dates that have only two - * digits. The default setting is 1900. Dates between 01/01/0100 and - * 12/31/2999 are fully supported. - * $EXAMPLES$ - * SET EPOCH TO 2000 - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * SET DATE,SET CENTURY,CTOD(),DATE(),DTOC(),SET() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + SET EPOCH + $CATEGORY$ + Command + $SUBCATEGORY$ + Environment + $ONELINER$ + Specify a base year for interpreting dates + $SYNTAX$ + SET EPOCH TO + $ARGUMENTS$ + Base Century. + $DESCRIPTION$ + This command sets the base year value for dates that have only two + digits. The default setting is 1900. Dates between 01/01/0100 and + 12/31/2999 are fully supported. + $EXAMPLES$ + SET EPOCH TO 2000 + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + SET DATE,SET CENTURY,CTOD(),DATE(),DTOC(),SET() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * SET FIXED - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Set the number of decimal position to be displayed - * $SYNTAX$ - * SET FIXED on | OFF | () - * $ARGUMENTS$ - * Logical expression for toggle - * $DESCRIPTION$ - * This command activates a system wide fixed placement of decimals - * places shown for all numeric outputs. If the value of is - * a logical true (.T.), FIXED will be turned ON; otherwise it will be - * turned OFF. - * - * When SET DECIMALS OFF is used, the following rules apply to the number - * of decimal placed displayed. - * - * - * Addition Same as operand with the greatest number of decimal digits - * Subtraction Same as operand with the greatest number of decimal digits - * Multiplication Sum of operand decimal digits - * Division Determined by SET DECIMAL TO - * Exponential Determined by SET DECIMAL TO - * LOG() Determined by SET DECIMAL TO - * EXP() Determined by SET DECIMAL TO - * SQRT() Determined by SET DECIMAL TO - * VAL() Determined by SET DECIMAL TO - *
- * $EXAMPLES$ - * SET FIXED ON - * ? 25141251 / 362 - * SET FIXED OFF - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * SET DECIMALS,EXP(),LOG(),SQRT(),VAL(),SET() - * $END$ -*/ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + SET FIXED + $CATEGORY$ + Command + $SUBCATEGORY$ + Environment + $ONELINER$ + Set the number of decimal position to be displayed + $SYNTAX$ + SET FIXED on | OFF | () + $ARGUMENTS$ + Logical expression for toggle + $DESCRIPTION$ + This command activates a system wide fixed placement of decimals + places shown for all numeric outputs. If the value of is + a logical true (.T.), FIXED will be turned ON; otherwise it will be + turned OFF. -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * SET PRINTER - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Toggles the printer and controls the printer device - * $SYNTAX$ - * SET PRINTER on | OFF - * SET PRINTER () - * SET PRINTER TO [] [ADDITIVE] - * $ARGUMENTS$ - * Logical condition by which to toggle the printer - * - * A device name or an alternate name - * $DESCRIPTION$ - * This command can direct all output that is not controlled by the - * @...SAY command and the DEVPOS() and DEVOUT() functions to the - * printer. If specified,the condition toggles the printer - * ON if a logical true (.T.) and OFF if a logical false (.F.). If no - * argument is specified in the command, the alternate file (if one - * is open) is closed, or the device is reselected and the PRINTER - * option is turned OFF. - * - * If a device is specified in , the output will be directed - * to that device instead of to the PRINTER. A specified device may be - * a literal string or a variable, as long as the variable is enclosed - * in parentheses. For a network, do not use a trailing colon when - * redirecting to a device. - * - * If an alternate file is specified, becomes the name of a - * file that will contain the output. If no file extension is specified - * an extension of .prn will be defaulted to. - * - * If the ADDITIVE clause is specified, the information will be appended - * to the end of the specified output file. Otherwise, a new file will - * be created with the specified name (or an existing file will first - * be cleared) and the information will then be appended to the file. - * The default is to create a new file. - * $EXAMPLES$ - * SET PRINTER ON - * SET PRINTER TO LPT1 - * ? 25141251 / 362 - * SET PRINTER .F. - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * SET DEVICE, SET CONSOLE, DEVOUT(), SET() - * $END$ -*/ + When SET DECIMALS OFF is used, the following rules apply to the number + of decimal placed displayed. -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * SET CONSOLE - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Toggle the console display - * $SYNTAX$ - * SET CONSOLE ON | off | () - * $ARGUMENTS$ - * Logical expression for toggle command - * $DESCRIPTION$ - * This command turns the screen display either off or on for all - * screens display other then direct output via the @...SAY commands - * or the <-> DEVOUT() function. - * - * If is a logical true (.T.),the console will be turned - * ON; otherwise, the console will be turned off. - * $EXAMPLES$ - * SET CONSOLE ON - * ? Date() - * SET CONSOLE OFF - * ? Date() - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * SET DEVICE,SET() - * $END$ + + Addition Same as operand with the greatest number of decimal digits + Subtraction Same as operand with the greatest number of decimal digits + Multiplication Sum of operand decimal digits + Division Determined by SET DECIMAL TO + Exponential Determined by SET DECIMAL TO + LOG() Determined by SET DECIMAL TO + EXP() Determined by SET DECIMAL TO + SQRT() Determined by SET DECIMAL TO + VAL() Determined by SET DECIMAL TO +
+ $EXAMPLES$ + SET FIXED ON + ? 25141251 / 362 + SET FIXED OFF + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + SET DECIMALS,EXP(),LOG(),SQRT(),VAL(),SET() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * SET DECIMALS - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Toggle the console display - * $SYNTAX$ - * SET DECIMALS TO [] - * $ARGUMENTS$ - * Number of decimals places - * $DESCRIPTION$ - * This command establishes the number of decimal places that Harbour - * will display in mathematical calculations, functions, memory variables, - * and fields. Issuing no parameter with this command will the default - * number of decimals to 0. For decimals to be seen, the SET FIXED ON - * command must be activated. - * $EXAMPLES$ - * SET FIXED ON - * ? 25141251 / 362 - * SET DECIMALS TO 10 - * ? 214514.214 / 6325 - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * SET FIXED,SET() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + SET PRINTER + $CATEGORY$ + Command + $SUBCATEGORY$ + Environment + $ONELINER$ + Toggles the printer and controls the printer device + $SYNTAX$ + SET PRINTER on | OFF + SET PRINTER () + SET PRINTER TO [] [ADDITIVE] + $ARGUMENTS$ + Logical condition by which to toggle the printer + + A device name or an alternate name + $DESCRIPTION$ + This command can direct all output that is not controlled by the + @...SAY command and the DEVPOS() and DEVOUT() functions to the + printer. If specified,the condition toggles the printer + ON if a logical true (.T.) and OFF if a logical false (.F.). If no + argument is specified in the command, the alternate file (if one + is open) is closed, or the device is reselected and the PRINTER + option is turned OFF. + + If a device is specified in , the output will be directed + to that device instead of to the PRINTER. A specified device may be + a literal string or a variable, as long as the variable is enclosed + in parentheses. For a network, do not use a trailing colon when + redirecting to a device. + + If an alternate file is specified, becomes the name of a + file that will contain the output. If no file extension is specified + an extension of .prn will be defaulted to. + + If the ADDITIVE clause is specified, the information will be appended + to the end of the specified output file. Otherwise, a new file will + be created with the specified name (or an existing file will first + be cleared) and the information will then be appended to the file. + The default is to create a new file. + $EXAMPLES$ + SET PRINTER ON + SET PRINTER TO LPT1 + ? 25141251 / 362 + SET PRINTER .F. + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + SET DEVICE, SET CONSOLE, DEVOUT(), SET() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * SET DEVICE - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Directs all @...SAY output to a device. - * $SYNTAX$ - * SET DEVICE TO [printer | SCREEN ] - * $ARGUMENTS$ - * None. - * $DESCRIPTION$ - * This command determines whether the output from the @...SAY command - * and the DEVPOS() and DEVOUT() function will be displayed on the - * printer. - * - * When the device is set to the PRINTER,the SET MARGIN value adjusts - * the position of the column values accordingly. Also, an automatic - * page eject will be issued when the current printhead position is - * less than the last printed row. Finally, if used in conjunction with - * the @...GET commands, the values for the GETs will all be ignored. - * $EXAMPLES$ - * SET DEVICE TO SCREEN - * ? 25141251 / 362 - * SET DEVICE TO PRINTER - * SET PRINTER TO LPT1 - * ? 214514.214 / 6325 - * SET PRINTER OFF - * SET DEVICE TO SCREEN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * @...SAY,SET PRINTER,SETPRC(),SET() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + SET CONSOLE + $CATEGORY$ + Command + $SUBCATEGORY$ + Environment + $ONELINER$ + Toggle the console display + $SYNTAX$ + SET CONSOLE ON | off | () + $ARGUMENTS$ + Logical expression for toggle command + $DESCRIPTION$ + This command turns the screen display either off or on for all + screens display other then direct output via the @...SAY commands + or the <-> DEVOUT() function. + + If is a logical true (.T.),the console will be turned + ON; otherwise, the console will be turned off. + $EXAMPLES$ + SET CONSOLE ON + ? Date() + SET CONSOLE OFF + ? Date() + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + SET DEVICE,SET() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * SET BELL - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Toggle the bell to sound once a GET has been completed. - * $SYNTAX$ - * SET BELL on | OFF | () - * $ARGUMENTS$ - * Logical expression for toggle command - * $DESCRIPTION$ - * This command toggles the bell to sound whenever a character is - * entered into the last character position of a GET, or if an invalid - * data type is entered into a GET. - * - * If is a logical true (.T.), the bell will be turned - * ON; otherwise, the bell will be turned off. - * $EXAMPLES$ - * SET BELL ON - * cDummy := Space( 20 ) - * @ 3,2 GET cDummy - * READ - * SET BELL OFF - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * SET() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + SET DECIMALS + $CATEGORY$ + Command + $SUBCATEGORY$ + Environment + $ONELINER$ + Toggle the console display + $SYNTAX$ + SET DECIMALS TO [] + $ARGUMENTS$ + Number of decimals places + $DESCRIPTION$ + This command establishes the number of decimal places that Harbour + will display in mathematical calculations, functions, memory variables, + and fields. Issuing no parameter with this command will the default + number of decimals to 0. For decimals to be seen, the SET FIXED ON + command must be activated. + $EXAMPLES$ + SET FIXED ON + ? 25141251 / 362 + SET DECIMALS TO 10 + ? 214514.214 / 6325 + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + SET FIXED,SET() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + SET DEVICE + $CATEGORY$ + Command + $SUBCATEGORY$ + Environment + $ONELINER$ + Directs all @...SAY output to a device. + $SYNTAX$ + SET DEVICE TO [printer | SCREEN ] + $ARGUMENTS$ + None. + $DESCRIPTION$ + This command determines whether the output from the @...SAY command + and the DEVPOS() and DEVOUT() function will be displayed on the + printer. + + When the device is set to the PRINTER,the SET MARGIN value adjusts + the position of the column values accordingly. Also, an automatic + page eject will be issued when the current printhead position is + less than the last printed row. Finally, if used in conjunction with + the @...GET commands, the values for the GETs will all be ignored. + $EXAMPLES$ + SET DEVICE TO SCREEN + ? 25141251 / 362 + SET DEVICE TO PRINTER + SET PRINTER TO LPT1 + ? 214514.214 / 6325 + SET PRINTER OFF + SET DEVICE TO SCREEN + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + @...SAY,SET PRINTER,SETPRC(),SET() + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + SET BELL + $CATEGORY$ + Command + $SUBCATEGORY$ + Environment + $ONELINER$ + Toggle the bell to sound once a GET has been completed. + $SYNTAX$ + SET BELL on | OFF | () + $ARGUMENTS$ + Logical expression for toggle command + $DESCRIPTION$ + This command toggles the bell to sound whenever a character is + entered into the last character position of a GET, or if an invalid + data type is entered into a GET. + + If is a logical true (.T.), the bell will be turned + ON; otherwise, the bell will be turned off. + $EXAMPLES$ + SET BELL ON + cDummy := Space( 20 ) + @ 3,2 GET cDummy + READ + SET BELL OFF + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + SET() + $END$ */ diff --git a/harbour/doc/en/setmode.txt b/harbour/doc/en/setmode.txt index b6f54a66f7..020088d5f2 100644 --- a/harbour/doc/en/setmode.txt +++ b/harbour/doc/en/setmode.txt @@ -9,74 +9,74 @@ * See COPYING for licensing terms. */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SETMODE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Change the video mode to a specified number of rows and columns - * $SYNTAX$ - * SETMODE( , ) --> lSuccess - * $ARGUMENTS$ - * is the number of rows for the video mode to set. - * - * is the number of columns for the video mode to set. - * $RETURNS$ - * SETMODE() returns true if the video mode change was successful; - * otherwise, it returns false. - * $DESCRIPTION$ - * SETMODE() is a function that change the video mode depend on the - * video card and monitor combination, to match the number of rows and - * columns specified. - * Note that there are only a real few combination or rows/cols pairs - * that produce the video mode change. - * The followings are availables for GTDOS: - * - * - * 12 rows x 40 columns 12 rows x 80 columns - * 25 rows x 40 columns 25 rows x 80 columns - * 28 rows x 40 columns 28 rows x 80 columns - * 50 rows x 40 columns 43 rows x 80 columns - * 50 rows x 80 columns - *
- * - * The follow modes are available to Windows - * - * - * 25 rows x 40 columns 25 rows x 80 columns - * 50 rows x 40 columns 43 rows x 80 columns - * 50 rows x 80 columns - *
- * - * Some modes only are availables for color and/or VGA monitors. - * Any change produced on the screen size is updated in the values - * returned by MAXROW() and MAXCOL(). - * $EXAMPLES$ - * // The first example change to a 12 lines of display mode: - * IF SetMode( 12, 40) - * ? "Hey man are you blind ?" - * ELSE - * ? "Mom bring me my glasses!" - * ENDIF - * - * // Next example change to a 50 lines mode: - * IF SETMODE( 50, 80) - * ? "This wonderful mode was successfully set" - * ELSE - * ? "Wait. this monitor are not made in rubber !" - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * Some of these modes are not availables in CA-Cl*pper - * $PLATFORMS$ - * DOS,Win - * $SEEALSO$ - * MAXCOL(),MAXROW() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SETMODE() + $CATEGORY$ + API + $SUBCATEGORY$ + Environment + $ONELINER$ + Change the video mode to a specified number of rows and columns + $SYNTAX$ + SETMODE( , ) --> lSuccess + $ARGUMENTS$ + is the number of rows for the video mode to set. + + is the number of columns for the video mode to set. + $RETURNS$ + SETMODE() returns true if the video mode change was successful; + otherwise, it returns false. + $DESCRIPTION$ + SETMODE() is a function that change the video mode depend on the + video card and monitor combination, to match the number of rows and + columns specified. + Note that there are only a real few combination or rows/cols pairs + that produce the video mode change. + The followings are availables for GTDOS: + + + 12 rows x 40 columns 12 rows x 80 columns + 25 rows x 40 columns 25 rows x 80 columns + 28 rows x 40 columns 28 rows x 80 columns + 50 rows x 40 columns 43 rows x 80 columns + 50 rows x 80 columns +
+ + The follow modes are available to Windows + + + 25 rows x 40 columns 25 rows x 80 columns + 50 rows x 40 columns 43 rows x 80 columns + 50 rows x 80 columns +
+ + Some modes only are availables for color and/or VGA monitors. + Any change produced on the screen size is updated in the values + returned by MAXROW() and MAXCOL(). + $EXAMPLES$ + // The first example change to a 12 lines of display mode: + IF SetMode( 12, 40) + ? "Hey man are you blind ?" + ELSE + ? "Mom bring me my glasses!" + ENDIF + + // Next example change to a 50 lines mode: + IF SETMODE( 50, 80) + ? "This wonderful mode was successfully set" + ELSE + ? "Wait. this monitor are not made in rubber !" + ENDIF + $STATUS$ + R + $COMPLIANCE$ + Some of these modes are not availables in CA-Cl*pper + $PLATFORMS$ + DOS,Win + $SEEALSO$ + MAXCOL(),MAXROW() + $END$ */ diff --git a/harbour/doc/en/string.txt b/harbour/doc/en/string.txt index 3daa2bdea3..06d27e7cf2 100644 --- a/harbour/doc/en/string.txt +++ b/harbour/doc/en/string.txt @@ -20,1466 +20,1466 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ISALPHA() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Checks if leftmost character in a string is an alphabetic character - * $SYNTAX$ - * ISALPHA( ) --> lAlpha - * $ARGUMENTS$ - * Any character string - * $RETURNS$ - * lAlpha Logical true (.T.) or false (.F.). - * $DESCRIPTION$ - * This function return a logical true (.T.) if the first character - * in is an alphabetic character. If not, the function will - * return a logical false (.F.). - * $EXAMPLES$ - * ? 'isalpha( "hello" ) = ', isalpha( "hello" ) - * ? 'isalpha( "12345" ) = ', isalpha( "12345" ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ISDIGIT(),ISLOWER(),ISUPPER(),LOWER(),UPPER() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ISALPHA() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Checks if leftmost character in a string is an alphabetic character + $SYNTAX$ + ISALPHA( ) --> lAlpha + $ARGUMENTS$ + Any character string + $RETURNS$ + lAlpha Logical true (.T.) or false (.F.). + $DESCRIPTION$ + This function return a logical true (.T.) if the first character + in is an alphabetic character. If not, the function will + return a logical false (.F.). + $EXAMPLES$ + ? 'isalpha( "hello" ) = ', isalpha( "hello" ) + ? 'isalpha( "12345" ) = ', isalpha( "12345" ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + ISDIGIT(),ISLOWER(),ISUPPER(),LOWER(),UPPER() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ISDIGIT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Checks if leftmost character is a digit character - * $SYNTAX$ - * ISDIGIT( ) --> lDigit - * $ARGUMENTS$ - * Any character string - * $RETURNS$ - * lDigit Logical true (.T.) or false (.F.). - * $DESCRIPTION$ - * This function takes the character string and checks to - * see if the leftmost character is a digit, from 1 to 9. If so, the - * function will return a logical true (.T.); otherwise, it will - * return a logical false (.F.). - * $EXAMPLES$ - * ? ISDIGIT( "12345" ) // .T. - * ? ISDIGIT( "abcde" ) // .F. - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ISALPHA(),ISLOWER(),ISUPPER(),LOWER(),UPPER() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ISDIGIT() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Checks if leftmost character is a digit character + $SYNTAX$ + ISDIGIT( ) --> lDigit + $ARGUMENTS$ + Any character string + $RETURNS$ + lDigit Logical true (.T.) or false (.F.). + $DESCRIPTION$ + This function takes the character string and checks to + see if the leftmost character is a digit, from 1 to 9. If so, the + function will return a logical true (.T.); otherwise, it will + return a logical false (.F.). + $EXAMPLES$ + ? ISDIGIT( "12345" ) // .T. + ? ISDIGIT( "abcde" ) // .F. + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + ISALPHA(),ISLOWER(),ISUPPER(),LOWER(),UPPER() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ISUPPER() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Checks if leftmost character is an uppercased letter. - * $SYNTAX$ - * ISUPPER( ) --> lUpper - * $ARGUMENTS$ - * Any character string - * $RETURNS$ - * lUpper Logical true (.T.) or false (.F.). - * $DESCRIPTION$ - * This function checks to see if the leftmost character - * if is a uppercased letter. If so, the - * function will return a logical true (.T.); otherwise, it will - * return a logical false (.F.). - * $EXAMPLES$ - * ? ISUPPER( "Abcde" ) // .T. - * ? ISUPPER( "abcde" ) // .F. - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ISALPHA(),ISLOWER(),ISDIGIT(),LOWER(),UPPER() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ISUPPER() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Checks if leftmost character is an uppercased letter. + $SYNTAX$ + ISUPPER( ) --> lUpper + $ARGUMENTS$ + Any character string + $RETURNS$ + lUpper Logical true (.T.) or false (.F.). + $DESCRIPTION$ + This function checks to see if the leftmost character + if is a uppercased letter. If so, the + function will return a logical true (.T.); otherwise, it will + return a logical false (.F.). + $EXAMPLES$ + ? ISUPPER( "Abcde" ) // .T. + ? ISUPPER( "abcde" ) // .F. + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + ISALPHA(),ISLOWER(),ISDIGIT(),LOWER(),UPPER() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ISLOWER() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Checks if leftmost character is an lowercased letter. - * $SYNTAX$ - * ISLOWER( ) --> lLower - * $ARGUMENTS$ - * Any character string - * $RETURNS$ - * lLower Logical true (.T.) or false (.F.). - * $DESCRIPTION$ - * This function takes the character string and checks to - * see if the leftmost character is a lowercased letter. If so, the - * function will return a logical true (.T.); otherwise, it will - * return a logical false (.F.). - * $EXAMPLES$ - * ? islower( "ABCde" ) // .F. - * ? islower( "aBCde" ) // .T. - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ISALPHA(),ISDIGIT(),ISUPPER(),LOWER(),UPPER() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ISLOWER() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Checks if leftmost character is an lowercased letter. + $SYNTAX$ + ISLOWER( ) --> lLower + $ARGUMENTS$ + Any character string + $RETURNS$ + lLower Logical true (.T.) or false (.F.). + $DESCRIPTION$ + This function takes the character string and checks to + see if the leftmost character is a lowercased letter. If so, the + function will return a logical true (.T.); otherwise, it will + return a logical false (.F.). + $EXAMPLES$ + ? islower( "ABCde" ) // .F. + ? islower( "aBCde" ) // .T. + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + ISALPHA(),ISDIGIT(),ISUPPER(),LOWER(),UPPER() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * LTRIM() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Removes leading spaces from a string - * $SYNTAX$ - * LTRIM( ) --> cReturn - * $ARGUMENTS$ - * Character expression with leading spaces - * $RETURNS$ - * LTRIM() returns a copy of the original string with leading spaces - * removed. - * $DESCRIPTION$ - * This function trims the leading space blank - * $EXAMPLES$ - * ? LTRIM( "HELLO " ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * TRIM(),RTRIM(),ALLTRIM() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + LTRIM() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Removes leading spaces from a string + $SYNTAX$ + LTRIM( ) --> cReturn + $ARGUMENTS$ + Character expression with leading spaces + $RETURNS$ + LTRIM() returns a copy of the original string with leading spaces + removed. + $DESCRIPTION$ + This function trims the leading space blank + $EXAMPLES$ + ? LTRIM( "HELLO " ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + TRIM(),RTRIM(),ALLTRIM() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * AT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Locates the position of a substring in a main string. - * $SYNTAX$ - * AT( , , [], [] ) --> nPos - * $ARGUMENTS$ - * Substring to search for - * - * Main string - * - * First position to search in cString, by default 1 - * - * End position to search, by default cString length - * $RETURNS$ - * AT() return the starting position of the first occurrence of the - * substring in the main string - * $DESCRIPTION$ - * This function searches the string for the characters in - * the first string . If the substring is not contained within - * the second expression, the function will return 0. The third and fourth - * parameters lets you indicate a starting and end offset to search in. - * $EXAMPLES$ - * ? 'At( "cde", "abcdefgfedcba" ) = ' +; - * At( "cde", "abcsefgfedcba" ) - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is sensitive to HB_CLP_STRICT settings during build. - * - * and are Harbour extensions and do not exist if - * HB_CLP_STRICT is defined. In that case, the whole string is searched. - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * RAT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + AT() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Locates the position of a substring in a main string. + $SYNTAX$ + AT( , , [], [] ) --> nPos + $ARGUMENTS$ + Substring to search for + + Main string + + First position to search in cString, by default 1 + + End position to search, by default cString length + $RETURNS$ + AT() return the starting position of the first occurrence of the + substring in the main string + $DESCRIPTION$ + This function searches the string for the characters in + the first string . If the substring is not contained within + the second expression, the function will return 0. The third and fourth + parameters lets you indicate a starting and end offset to search in. + $EXAMPLES$ + ? 'At( "cde", "abcdefgfedcba" ) = ' +; + At( "cde", "abcsefgfedcba" ) + $STATUS$ + R + $COMPLIANCE$ + This function is sensitive to HB_CLP_STRICT settings during build. + + and are Harbour extensions and do not exist if + HB_CLP_STRICT is defined. In that case, the whole string is searched. + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + RAT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * RAT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Searches for a substring from the right side of a string. - * $SYNTAX$ - * RAT( , ) --> nPos - * $ARGUMENTS$ - * Substring to search for - * - * Main string - * $RETURNS$ - * RAT() return the location of beginning position. - * $DESCRIPTION$ - * This function searches through for the first existence - * of . The search operation is performed from the right side - * of to the left. If the function is unable to find any - * occurrence of in , the return value is 0. - * $EXAMPLES$ - * ? 'RAt( "cde", "abcdefgfedcba" ) = ' +; - * RAt( "cde", "abcsefgfedcba" ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All(64K) - * $FILES$ - * Library is rtl - * $SEEALSO$ - * AT(), SUBSTR(), RIGHT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + RAT() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Searches for a substring from the right side of a string. + $SYNTAX$ + RAT( , ) --> nPos + $ARGUMENTS$ + Substring to search for + + Main string + $RETURNS$ + RAT() return the location of beginning position. + $DESCRIPTION$ + This function searches through for the first existence + of . The search operation is performed from the right side + of to the left. If the function is unable to find any + occurrence of in , the return value is 0. + $EXAMPLES$ + ? 'RAt( "cde", "abcdefgfedcba" ) = ' +; + RAt( "cde", "abcsefgfedcba" ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All(64K) + $FILES$ + Library is rtl + $SEEALSO$ + AT(), SUBSTR(), RIGHT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * LEFT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Extract the leftmost substring of a character expression - * $SYNTAX$ - * LEFT( , ) --> cReturn - * $ARGUMENTS$ - * Main character to be parsed - * - * Number of bytes to return beginning at the leftmost position - * $RETURNS$ - * Substring of evaluation - * $DESCRIPTION$ - * This functions returns the leftmost characters of . - * It is equivalent to the following expression: - * - * SUBSTR( , 1, ) - * $EXAMPLES$ - * ? LEFT( "HELLO HARBOUR", 5 ) // HELLO - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * SUBSTR(),RIGHT(),AT(),RAT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + LEFT() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Extract the leftmost substring of a character expression + $SYNTAX$ + LEFT( , ) --> cReturn + $ARGUMENTS$ + Main character to be parsed + + Number of bytes to return beginning at the leftmost position + $RETURNS$ + Substring of evaluation + $DESCRIPTION$ + This functions returns the leftmost characters of . + It is equivalent to the following expression: + + SUBSTR( , 1, ) + $EXAMPLES$ + ? LEFT( "HELLO HARBOUR", 5 ) // HELLO + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + SUBSTR(),RIGHT(),AT(),RAT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * RIGHT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Extract the rightmost substring of a character expression - * $SYNTAX$ - * RIGHT( , ) --> cReturn - * $ARGUMENTS$ - * Character expression to be parsed - * - * Number of bytes to return beginning at the rightmost position - * $RETURNS$ - * Substring of evaluation - * $DESCRIPTION$ - * This functions returns the rightmost characters of . - * It is equivalent to the following expressions: - * - * SUBSTR( , - ) - * - * SUBSTR( , LEN( ) - + 1, ) - * $EXAMPLES$ - * ? RIGHT( "HELLO HARBOUR", 5 ) // RBOUR - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * SUBSTR(),LEFT(),AT(),RAT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + RIGHT() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Extract the rightmost substring of a character expression + $SYNTAX$ + RIGHT( , ) --> cReturn + $ARGUMENTS$ + Character expression to be parsed + + Number of bytes to return beginning at the rightmost position + $RETURNS$ + Substring of evaluation + $DESCRIPTION$ + This functions returns the rightmost characters of . + It is equivalent to the following expressions: + + SUBSTR( , - ) + + SUBSTR( , LEN( ) - + 1, ) + $EXAMPLES$ + ? RIGHT( "HELLO HARBOUR", 5 ) // RBOUR + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + SUBSTR(),LEFT(),AT(),RAT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SUBSTR() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Returns a substring from a main string - * $SYNTAX$ - * SUBSTR( , , [] ) --> cReturn - * $ARGUMENTS$ - * Character expression to be parsed - * - * Start position - * - * Number of characters to return - * $RETURNS$ - * Substring of evaluation - * $DESCRIPTION$ - * This functions returns a character string formed from , - * starting at the position of and continuing on for a - * length of characters. If is not specified, the value - * will be all remaining characters from the position of . +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SUBSTR() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Returns a substring from a main string + $SYNTAX$ + SUBSTR( , , [] ) --> cReturn + $ARGUMENTS$ + Character expression to be parsed - * The value of may be negative. If it is, the direction of - * operation is reversed from a default of left-to-right to right-to-left - * for the number of characters specified in . If the number of - * characters from to the end of the string is less than - * the rest are ignored. - * $EXAMPLES$ - * ? SUBSTR( "HELLO HARBOUR" , 7, 4 ) // HARB - * ? SUBSTR( "HELLO HARBOUR" , -3, 3 ) // OUR - * ? SUBSTR( "HELLO HARBOUR" , 7 ) // HARBOUR - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All(64K) - * $FILES$ - * Library is rtl - * $SEEALSO$ - * LEFT(),AT(),RIGHT() - * $END$ + Start position + + Number of characters to return + $RETURNS$ + Substring of evaluation + $DESCRIPTION$ + This functions returns a character string formed from , + starting at the position of and continuing on for a + length of characters. If is not specified, the value + will be all remaining characters from the position of . + + The value of may be negative. If it is, the direction of + operation is reversed from a default of left-to-right to right-to-left + for the number of characters specified in . If the number of + characters from to the end of the string is less than + the rest are ignored. + $EXAMPLES$ + ? SUBSTR( "HELLO HARBOUR" , 7, 4 ) // HARB + ? SUBSTR( "HELLO HARBOUR" , -3, 3 ) // OUR + ? SUBSTR( "HELLO HARBOUR" , 7 ) // HARBOUR + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All(64K) + $FILES$ + Library is rtl + $SEEALSO$ + LEFT(),AT(),RIGHT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * STR() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Convert a numeric expression to a character string. - * $SYNTAX$ - * STR( , [], [] ) --> cNumber - * $ARGUMENTS$ - * is the numeric expression to be converted to a character - * string. - * - * is the length of the character string to return, including - * decimal digits, decimal point, and sign. - * - * is the number of decimal places to return. - * $RETURNS$ - * STR() returns formatted as a character string. If the - * optional length and decimal arguments are not specified, STR() - * returns the character string according to the following rules: - * - * Results of STR() with No Optional Arguments - * - * - * Expression Return Value Length - * - * Field Variable Field length plus decimals - * Expressions/constants Minimum of 10 digits plus decimals - * VAL() Minimum of 3 digits - * MONTH()/DAY() 3 digits - * YEAR() 5 digits - * RECNO() 7 digits - *
- * $DESCRIPTION$ - * STR() is a numeric conversion function that converts numeric values - * to character strings. It is commonly used to concatenate numeric - * values to character strings. STR() has applications displaying - * numbers, creating codes such as part numbers from numeric values, - * and creating index keys that combine numeric and character data. - * - * STR() is like TRANSFORM(), which formats numeric values as character - * strings using a mask instead of length and decimal specifications. - * - * The inverse of STR() is VAL(), which converts character numbers to - * numerics. - * - * * If is less than the number of whole number digits in - * , STR() returns asterisks instead of the number. - * - * * If is less than the number of decimal digits - * required for the decimal portion of the returned string, Harbour - * rounds the number to the available number of decimal places. - * - * * If is specified but is omitted (no - * decimal places), the return value is rounded to an integer. - * $EXAMPLES$ - * ? STR( 10, 6, 2 ) // " 10.00" - * ? STR( -10, 8, 2 ) // " -10.00" - * $TESTS$ - * See the regression test suit for comprehensive tests. - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * STRZERO(),TRANSFORM(),VAL() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + STR() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Convert a numeric expression to a character string. + $SYNTAX$ + STR( , [], [] ) --> cNumber + $ARGUMENTS$ + is the numeric expression to be converted to a character + string. + + is the length of the character string to return, including + decimal digits, decimal point, and sign. + + is the number of decimal places to return. + $RETURNS$ + STR() returns formatted as a character string. If the + optional length and decimal arguments are not specified, STR() + returns the character string according to the following rules: + + Results of STR() with No Optional Arguments + + le> + Expression Return Value Length + + Field Variable Field length plus decimals + Expressions/constants Minimum of 10 digits plus decimals + VAL() Minimum of 3 digits + MONTH()/DAY() 3 digits + YEAR() 5 digits + RECNO() 7 digits + + $DESCRIPTION$ + STR() is a numeric conversion function that converts numeric values + to character strings. It is commonly used to concatenate numeric + values to character strings. STR() has applications displaying + numbers, creating codes such as part numbers from numeric values, + and creating index keys that combine numeric and character data. + + STR() is like TRANSFORM(), which formats numeric values as character + strings using a mask instead of length and decimal specifications. + + The inverse of STR() is VAL(), which converts character numbers to + numerics. + + * If is less than the number of whole number digits in + , STR() returns asterisks instead of the number. + + * If is less than the number of decimal digits + required for the decimal portion of the returned string, Harbour + rounds the number to the available number of decimal places. + + * If is specified but is omitted (no + decimal places), the return value is rounded to an integer. + $EXAMPLES$ + ? STR( 10, 6, 2 ) // " 10.00" + ? STR( -10, 8, 2 ) // " -10.00" + $TESTS$ + See the regression test suit for comprehensive tests. + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + STRZERO(),TRANSFORM(),VAL() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * STRZERO() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Convert a numeric expression to a character string, zero padded. - * $SYNTAX$ - * STRZERO( , [], [] ) --> cNumber - * $ARGUMENTS$ - * is the numeric expression to be converted to a character - * string. - * - * is the length of the character string to return, including - * decimal digits, decimal point, and sign. - * - * is the number of decimal places to return. - * $RETURNS$ - * STRZERO() returns formatted as a character string. If the - * optional length and decimal arguments are not specified, STRZERO() - * returns the character string according to the following rules: - * - * Results of STRZERO() with No Optional Arguments - * - * - * Expression Return Value Length - * - * Field Variable Field length plus decimals - * Expressions/constants Minimum of 10 digits plus decimals - * VAL() Minimum of 3 digits - * MONTH()/DAY() 3 digits - * YEAR() 5 digits - * RECNO() 7 digits - *
- * $DESCRIPTION$ - * STRZERO() is a numeric conversion function that converts numeric - * values to character strings. It is commonly used to concatenate - * numeric values to character strings. STRZERO() has applications - * displaying numbers, creating codes such as part numbers from numeric - * values, and creating index keys that combine numeric and character - * data. - * - * STRZERO() is like TRANSFORM(), which formats numeric values as - * character strings using a mask instead of length and decimal - * specifications. - * - * The inverse of STRZERO() is VAL(), which converts character numbers - * to numerics. - * - * * If is less than the number of whole number digits in - * , STR() returns asterisks instead of the number. - * - * * If is less than the number of decimal digits - * required for the decimal portion of the returned string, Harbour - * rounds the number to the available number of decimal places. - * - * * If is specified but is omitted (no - * decimal places), the return value is rounded to an integer. - * - * The STRZERO() function was part of the CA-Cl*pper samples. - * $EXAMPLES$ - * ? STRZERO( 10, 6, 2 ) // "010.00" - * ? STRZERO( -10, 8, 2 ) // "-0010.00" - * $TESTS$ - * see the regression test suit for comprehensive tests. - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * STR() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + STRZERO() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Convert a numeric expression to a character string, zero padded. + $SYNTAX$ + STRZERO( , [], [] ) --> cNumber + $ARGUMENTS$ + is the numeric expression to be converted to a character + string. + + is the length of the character string to return, including + decimal digits, decimal point, and sign. + + is the number of decimal places to return. + $RETURNS$ + STRZERO() returns formatted as a character string. If the + optional length and decimal arguments are not specified, STRZERO() + returns the character string according to the following rules: + + Results of STRZERO() with No Optional Arguments + + + Expression Return Value Length + + Field Variable Field length plus decimals + Expressions/constants Minimum of 10 digits plus decimals + VAL() Minimum of 3 digits + MONTH()/DAY() 3 digits + YEAR() 5 digits + RECNO() 7 digits +
+ $DESCRIPTION$ + STRZERO() is a numeric conversion function that converts numeric + values to character strings. It is commonly used to concatenate + numeric values to character strings. STRZERO() has applications + displaying numbers, creating codes such as part numbers from numeric + values, and creating index keys that combine numeric and character + data. + + STRZERO() is like TRANSFORM(), which formats numeric values as + character strings using a mask instead of length and decimal + specifications. + + The inverse of STRZERO() is VAL(), which converts character numbers + to numerics. + + * If is less than the number of whole number digits in + , STR() returns asterisks instead of the number. + + * If is less than the number of decimal digits + required for the decimal portion of the returned string, Harbour + rounds the number to the available number of decimal places. + + * If is specified but is omitted (no + decimal places), the return value is rounded to an integer. + + The STRZERO() function was part of the CA-Cl*pper samples. + $EXAMPLES$ + ? STRZERO( 10, 6, 2 ) // "010.00" + ? STRZERO( -10, 8, 2 ) // "-0010.00" + $TESTS$ + see the regression test suit for comprehensive tests. + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + STR() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_VALTOSTR() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Converts any scalar type to a string. - * $SYNTAX$ - * HB_VALTOSTR( ) --> cString - * $ARGUMENTS$ - * is any scalar argument. - * $RETURNS$ - * A string representation of using default - * conversions. - * $DESCRIPTION$ - * HB_VALTOSTR can be used to convert any scalar value to a string. - * $EXAMPLES$ - * ? HB_VALTOSTR( 4 ) - * ? HB_VALTOSTR( "String" ) - * $TESTS$ - * ? HB_VALTOSTR( 4 ) == " 4" - * ? HB_VALTOSTR( 4.0 / 2 ) == " 2.00" - * ? HB_VALTOSTR( "String" ) == "String" - * ? HB_VALTOSTR( STOD( "20010101" ) ) == "01/01/01" - * ? HB_VALTOSTR( NIL ) == "NIL" - * ? HB_VALTOSTR( .F. ) == ".F." - * ? HB_VALTOSTR( .T. ) == ".T." - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is rtl - * $SEEALSO$ - * STR() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_VALTOSTR() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Converts any scalar type to a string. + $SYNTAX$ + HB_VALTOSTR( ) --> cString + $ARGUMENTS$ + is any scalar argument. + $RETURNS$ + A string representation of using default + conversions. + $DESCRIPTION$ + HB_VALTOSTR can be used to convert any scalar value to a string. + $EXAMPLES$ + ? HB_VALTOSTR( 4 ) + ? HB_VALTOSTR( "String" ) + $TESTS$ + ? HB_VALTOSTR( 4 ) == " 4" + ? HB_VALTOSTR( 4.0 / 2 ) == " 2.00" + ? HB_VALTOSTR( "String" ) == "String" + ? HB_VALTOSTR( STOD( "20010101" ) ) == "01/01/01" + ? HB_VALTOSTR( NIL ) == "NIL" + ? HB_VALTOSTR( .F. ) == ".F." + ? HB_VALTOSTR( .T. ) == ".T." + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is rtl + $SEEALSO$ + STR() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * LEN() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Variable management - * $ONELINER$ - * Returns size of a string or size of an array. - * $SYNTAX$ - * LEN( | ) --> - * $ARGUMENTS$ - * is a character string or the array to check. - * $RETURNS$ - * The length of the string or the number of elements that contains - * an array. - * $DESCRIPTION$ - * This function returns the string length or the size of an array or the - * size of a hash table. If it is used with a multidimensional array it - * returns the size of the first dimension. - * $EXAMPLES$ - * ? LEN( "Harbour" ) // 7 - * ? LEN( { "One", "Two" } ) // 2 - * $TESTS$ - * PROCEDURE Test() - * LOCAL cName := "" - * ACCEPT "Enter your name: " TO cName - * ? LEN( cName ) - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * EMPTY(),RTRIM(),LTRIM(),AADD(),ASIZE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + LEN() + $CATEGORY$ + API + $SUBCATEGORY$ + Variable management + $ONELINER$ + Returns size of a string or size of an array. + $SYNTAX$ + LEN( | ) --> + $ARGUMENTS$ + is a character string or the array to check. + $RETURNS$ + The length of the string or the number of elements that contains + an array. + $DESCRIPTION$ + This function returns the string length or the size of an array or the + size of a hash table. If it is used with a multidimensional array it + returns the size of the first dimension. + $EXAMPLES$ + ? LEN( "Harbour" ) // 7 + ? LEN( { "One", "Two" } ) // 2 + $TESTS$ + PROCEDURE Test() + LOCAL cName := "" + ACCEPT "Enter your name: " TO cName + ? LEN( cName ) + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + EMPTY(),RTRIM(),LTRIM(),AADD(),ASIZE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * EMPTY() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Variable management - * $ONELINER$ - * Checks if the passed argument is empty. - * $SYNTAX$ - * EMPTY( ) --> lIsEmpty - * $ARGUMENTS$ - * is any valid expression. - * $RETURNS$ - * A logical value. It is true (.T.) if the passed argument is empty - * otherwise it is false (.F.). - * $DESCRIPTION$ - * This function checks if an expression has empty value and returns a - * logical indicating whether it the expression is empty or not. - * $EXAMPLES$ - * ? EMPTY( "I'm not empty" ) // .F. - * $TESTS$ - * PROCEDURE Test() - * ? EMPTY( NIL ) // .T. - * ? EMPTY( 0 ) // .T. - * ? EMPTY( .F. ) // .T. - * ? EMPTY( "" ) // .T. - * ? EMPTY( 1 ) // .F. - * ? EMPTY( .T. ) // .F. - * ? EMPTY( "smile" ) // .F. - * ? EMPTY( Date() ) // .F. - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * LEN() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + EMPTY() + $CATEGORY$ + API + $SUBCATEGORY$ + Variable management + $ONELINER$ + Checks if the passed argument is empty. + $SYNTAX$ + EMPTY( ) --> lIsEmpty + $ARGUMENTS$ + is any valid expression. + $RETURNS$ + A logical value. It is true (.T.) if the passed argument is empty + otherwise it is false (.F.). + $DESCRIPTION$ + This function checks if an expression has empty value and returns a + logical indicating whether it the expression is empty or not. + $EXAMPLES$ + ? EMPTY( "I'm not empty" ) // .F. + $TESTS$ + PROCEDURE Test() + ? EMPTY( NIL ) // .T. + ? EMPTY( 0 ) // .T. + ? EMPTY( .F. ) // .T. + ? EMPTY( "" ) // .T. + ? EMPTY( 1 ) // .F. + ? EMPTY( .T. ) // .F. + ? EMPTY( "smile" ) // .F. + ? EMPTY( Date() ) // .F. + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + LEN() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * DESCEND() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Conversion - * $ONELINER$ - * Inverts an expression of string, logical, date or numeric type. - * $SYNTAX$ - * DESCEND( ) --> xExpInverted - * $ARGUMENTS$ - * is any valid expression. - * $RETURNS$ - * Inverted value of the same type as passed. - * $DESCRIPTION$ - * This function converts an expression in his inverted form. It is - * useful to build descending indexes. - * $EXAMPLES$ - * // Seek for Smith in a descending index - * SEEK DESCEND( "SMITH" ) - * $TESTS$ - * DATA->( DBSEEK( DESCEND( "SMITH" ) ) ) - * will seek "SMITH" into a descending index. - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * INDEX, SEEK - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + DESCEND() + $CATEGORY$ + API + $SUBCATEGORY$ + Conversion + $ONELINER$ + Inverts an expression of string, logical, date or numeric type. + $SYNTAX$ + DESCEND( ) --> xExpInverted + $ARGUMENTS$ + is any valid expression. + $RETURNS$ + Inverted value of the same type as passed. + $DESCRIPTION$ + This function converts an expression in his inverted form. It is + useful to build descending indexes. + $EXAMPLES$ + // Seek for Smith in a descending index + SEEK DESCEND( "SMITH" ) + $TESTS$ + DATA->( DBSEEK( DESCEND( "SMITH" ) ) ) + will seek "SMITH" into a descending index. + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + INDEX, SEEK + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * LOWER() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Universally lowercases a character string expression. - * $SYNTAX$ - * LOWER( ) --> cLowerString - * $ARGUMENTS$ - * Any character expression. - * $RETURNS$ - * Lowercased value of - * $DESCRIPTION$ - * This function converts any character expression passes as - * to its lowercased representation. Any non alphabetic character withing - * will remain unchanged. - * $EXAMPLES$ - * ? LOWER( "HARBOUR" ) // harbour - * ? LOWER( "Hello All" ) // hello all - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * UPPER(),ISLOWER(),ISUPPER() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + LOWER() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Universally lowercases a character string expression. + $SYNTAX$ + LOWER( ) --> cLowerString + $ARGUMENTS$ + Any character expression. + $RETURNS$ + Lowercased value of + $DESCRIPTION$ + This function converts any character expression passes as + to its lowercased representation. Any non alphabetic character withing + will remain unchanged. + $EXAMPLES$ + ? LOWER( "HARBOUR" ) // harbour + ? LOWER( "Hello All" ) // hello all + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + UPPER(),ISLOWER(),ISUPPER() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * UPPER() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Converts a character expression to uppercase format - * $SYNTAX$ - * UPPER( ) --> cUpperString - * $ARGUMENTS$ - * Any character expression. - * $RETURNS$ - * Uppercased value of - * $DESCRIPTION$ - * This function converts all alpha characters in to upper - * case values and returns that formatted character expression. - * $EXAMPLES$ - * ? UPPER( "harbour" ) // HARBOUR - * ? UPPER( "Harbour" ) // HARBOUR - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * LOWER(),ISUPPER(),ISLOWER() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + UPPER() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Converts a character expression to uppercase format + $SYNTAX$ + UPPER( ) --> cUpperString + $ARGUMENTS$ + Any character expression. + $RETURNS$ + Uppercased value of + $DESCRIPTION$ + This function converts all alpha characters in to upper + case values and returns that formatted character expression. + $EXAMPLES$ + ? UPPER( "harbour" ) // HARBOUR + ? UPPER( "Harbour" ) // HARBOUR + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + LOWER(),ISUPPER(),ISLOWER() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * CHR() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Converts an ASCII value to it character value - * $SYNTAX$ - * CHR( ) --> cReturn - * $ARGUMENTS$ - * Any ASCII character code. - * $RETURNS$ - * Character expression of that ASCII value - * $DESCRIPTION$ - * This function returns the ASCII character code for . The - * number expressed must be an integer value within the range of 0 to - * 255 inclusive. The CHR() function will send the character returned - * to whatever device is presently set. - * - * The CHR() function may be used for printing special codes as well - * as normal and graphics character codes. - * $EXAMPLES$ - * ? CHR( 32 ) - * ? chr( 215 ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ASC(), INKEY() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + CHR() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Converts an ASCII value to it character value + $SYNTAX$ + CHR( ) --> cReturn + $ARGUMENTS$ + Any ASCII character code. + $RETURNS$ + Character expression of that ASCII value + $DESCRIPTION$ + This function returns the ASCII character code for . The + number expressed must be an integer value within the range of 0 to + 255 inclusive. The CHR() function will send the character returned + to whatever device is presently set. + + The CHR() function may be used for printing special codes as well + as normal and graphics character codes. + $EXAMPLES$ + ? CHR( 32 ) + ? chr( 215 ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + ASC(), INKEY() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ASC() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Returns the ASCII value of a character - * $SYNTAX$ - * ASC( ) --> nAscNumber - * $ARGUMENTS$ - * Any character expression - * $RETURNS$ - * ASCII value - * $DESCRIPTION$ - * This function return the ASCII value of the leftmost character of - * any character expression passed as . - * $EXAMPLES$ - * ? ASC( "A" ) - * ? ASC( "¹" ) - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * CHR() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ASC() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Returns the ASCII value of a character + $SYNTAX$ + ASC( ) --> nAscNumber + $ARGUMENTS$ + Any character expression + $RETURNS$ + ASCII value + $DESCRIPTION$ + This function return the ASCII value of the leftmost character of + any character expression passed as . + $EXAMPLES$ + ? ASC( "A" ) + ? ASC( "¹" ) + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + CHR() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * PADC() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Centers an expression for a given width - * $SYNTAX$ - * PADC( , , ) --> cString - * $ARGUMENTS$ - * A Number, Character or Date value to pad - * - * Width of output string - * - * Character to fill in the string - * $RETURNS$ - * The Center string of - * $DESCRIPTION$ - * This function takes an date, number or character expression - * and attempt to center the expression within a string of a given width - * expressed as . The default character used to pad either side - * of will be a blank space. This character may be explicitly - * specified the value of . - * - * If the length of is longer then , this function will - * truncate the string from the leftmost side to the length of - * . - * $EXAMPLES$ - * ? PADC( "Harbour", 20 ) - * ? PADC( 34.5142, 20 ) - * ? PADC( Date(), 35 ) - * $TESTS$ - * See Examples - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ALLTRIM(),PADL(),PADR() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + PADC() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Centers an expression for a given width + $SYNTAX$ + PADC( , , ) --> cString + $ARGUMENTS$ + A Number, Character or Date value to pad + + Width of output string + + Character to fill in the string + $RETURNS$ + The Center string of + $DESCRIPTION$ + This function takes an date, number or character expression + and attempt to center the expression within a string of a given width + expressed as . The default character used to pad either side + of will be a blank space. This character may be explicitly + specified the value of . + + If the length of is longer then , this function will + truncate the string from the leftmost side to the length of + . + $EXAMPLES$ + ? PADC( "Harbour", 20 ) + ? PADC( 34.5142, 20 ) + ? PADC( Date(), 35 ) + $TESTS$ + See Examples + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + ALLTRIM(),PADL(),PADR() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * PADL() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Left-justifies an expression for a given width - * $SYNTAX$ - * PADL( , , ) --> cString - * $ARGUMENTS$ - * An number,Character or date to pad - * - * Width of output string - * - * Character to fill in the string - * $RETURNS$ - * The left-justifies string of - * $DESCRIPTION$ - * This function takes an date,number,or character expression - * and attempt to left-justify it within a string of a given width - * expressed as . The default character used to pad left side - * of will be an blank space; however, this character may be - * explicitly specified the value of . - * - * If the length of is longer then , this function will - * truncate the string from the leftmost side to the length of - * . - * $EXAMPLES$ - * ? PADL( "Harbour", 20 ) - * ? PADL( 34.5142, 20 ) - * ? PADL( Date(), 35 ) - * $TESTS$ - * See examples - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ALLTRIM(),PADC(),PADR() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + PADL() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Left-justifies an expression for a given width + $SYNTAX$ + PADL( , , ) --> cString + $ARGUMENTS$ + An number,Character or date to pad + + Width of output string + + Character to fill in the string + $RETURNS$ + The left-justifies string of + $DESCRIPTION$ + This function takes an date,number,or character expression + and attempt to left-justify it within a string of a given width + expressed as . The default character used to pad left side + of will be an blank space; however, this character may be + explicitly specified the value of . + + If the length of is longer then , this function will + truncate the string from the leftmost side to the length of + . + $EXAMPLES$ + ? PADL( "Harbour", 20 ) + ? PADL( 34.5142, 20 ) + ? PADL( Date(), 35 ) + $TESTS$ + See examples + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + ALLTRIM(),PADC(),PADR() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * PADR() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Right-justifies an expression for a given width - * $SYNTAX$ - * PADR( , , ) --> cString - * $ARGUMENTS$ - * A Number, Character or Date value to pad - * - * Width of output string - * - * Character to fill in the string - * $RETURNS$ - * The right-justifies string of - * $DESCRIPTION$ - * This function takes an date,number,or character expression - * and attempt to right-justify it within a string of a given width - * expressed as . The default character used to pad right side - * of will be an blank space; however, this character may be - * explicitly specified the value of . - * - * If the length of is longer then , this function will - * truncate the string from the leftmost side to the length of - * . - * $EXAMPLES$ - * ? PADR( "Harbour", 20 ) - * ? PADR( 34.5142, 20 ) - * ? PADR( Date(), 35 ) - * $TESTS$ - * See examples - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ALLTRIM(),PADC(),PADL() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + PADR() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Right-justifies an expression for a given width + $SYNTAX$ + PADR( , , ) --> cString + $ARGUMENTS$ + A Number, Character or Date value to pad + + Width of output string + + Character to fill in the string + $RETURNS$ + The right-justifies string of + $DESCRIPTION$ + This function takes an date,number,or character expression + and attempt to right-justify it within a string of a given width + expressed as . The default character used to pad right side + of will be an blank space; however, this character may be + explicitly specified the value of . + + If the length of is longer then , this function will + truncate the string from the leftmost side to the length of + . + $EXAMPLES$ + ? PADR( "Harbour", 20 ) + ? PADR( 34.5142, 20 ) + ? PADR( Date(), 35 ) + $TESTS$ + See examples + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + ALLTRIM(),PADC(),PADL() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ALLTRIM() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Removes leading and trailing blank spaces from a string - * $SYNTAX$ - * ALLTRIM( ) --> cExpression - * $ARGUMENTS$ - * Any character string - * $RETURNS$ - * An string will all blank spaces removed from - * $DESCRIPTION$ - * This function returns the string will all leading and - * trailing blank spaces removed. - * $EXAMPLES$ - * ? ALLTRIM( "HELLO HARBOUR" ) - * ? ALLTRIM( " HELLO HARBOUR" ) - * ? ALLTRIM( "HELLO HARBOUR " ) - * ? ALLTRIM( " HELLO HARBOUR " ) - * $TESTS$ - * See Examples - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * LTRIM(),RTRIM(),TRIM() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ALLTRIM() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Removes leading and trailing blank spaces from a string + $SYNTAX$ + ALLTRIM( ) --> cExpression + $ARGUMENTS$ + Any character string + $RETURNS$ + An string will all blank spaces removed from + $DESCRIPTION$ + This function returns the string will all leading and + trailing blank spaces removed. + $EXAMPLES$ + ? ALLTRIM( "HELLO HARBOUR" ) + ? ALLTRIM( " HELLO HARBOUR" ) + ? ALLTRIM( "HELLO HARBOUR " ) + ? ALLTRIM( " HELLO HARBOUR " ) + $TESTS$ + See Examples + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + LTRIM(),RTRIM(),TRIM() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * RTRIM() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Remove trailing spaces from a string. - * $SYNTAX$ - * RTRIM( ) --> cString - * $ARGUMENTS$ - * Any character expression - * $RETURNS$ - * A formatted string with out any blank spaced. - * $DESCRIPTION$ - * This function returns the value of with any trailing blank - * removed. - * - * This function is identical to RTRIM() and the opposite of LTRIM(). - * Together with LTRIM(), this function equated to the ALLTRIM() - * function. - * $EXAMPLES$ - * ? RTRIM( "HELLO" ) // "HELLO" - * ? RTRIM( "" ) // "" - * ? RTRIM( "UA " ) // "UA" - * ? RTRIM( " UA" ) // " UA" - * $TESTS$ - * See Examples - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ALLTRIM(),LTRIM(),TRIM() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + RTRIM() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Remove trailing spaces from a string. + $SYNTAX$ + RTRIM( ) --> cString + $ARGUMENTS$ + Any character expression + $RETURNS$ + A formatted string with out any blank spaced. + $DESCRIPTION$ + This function returns the value of with any trailing blank + removed. + + This function is identical to RTRIM() and the opposite of LTRIM(). + Together with LTRIM(), this function equated to the ALLTRIM() + function. + $EXAMPLES$ + ? RTRIM( "HELLO" ) // "HELLO" + ? RTRIM( "" ) // "" + ? RTRIM( "UA " ) // "UA" + ? RTRIM( " UA" ) // " UA" + $TESTS$ + See Examples + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + ALLTRIM(),LTRIM(),TRIM() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * TRIM() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Remove trailing spaces from a string. - * $SYNTAX$ - * TRIM( ) --> cString - * $ARGUMENTS$ - * Any character expression - * $RETURNS$ - * A formatted string with out any blank spaced. - * $DESCRIPTION$ - * This function returns the value of with any trailing blank - * removed. - * - * This function is identical to RTRIM() and the opposite of LTRIM(). - * Together with LTRIM(), this function equated to the ALLTRIM() - * function. - * $EXAMPLES$ - * ? TRIM( "HELLO" ) // "HELLO" - * ? TRIM( "" ) // "" - * ? TRIM( "UA " ) // "UA" - * ? TRIM( " UA" ) // " UA" - * $TESTS$ - * See Examples - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * RTRIM(),LTRIM(),ALLTRIM() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + TRIM() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Remove trailing spaces from a string. + $SYNTAX$ + TRIM( ) --> cString + $ARGUMENTS$ + Any character expression + $RETURNS$ + A formatted string with out any blank spaced. + $DESCRIPTION$ + This function returns the value of with any trailing blank + removed. + + This function is identical to RTRIM() and the opposite of LTRIM(). + Together with LTRIM(), this function equated to the ALLTRIM() + function. + $EXAMPLES$ + ? TRIM( "HELLO" ) // "HELLO" + ? TRIM( "" ) // "" + ? TRIM( "UA " ) // "UA" + ? TRIM( " UA" ) // " UA" + $TESTS$ + See Examples + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + RTRIM(),LTRIM(),ALLTRIM() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * REPLICATE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Repeats a single character expression - * $SYNTAX$ - * REPLICATE( , ) --> cReplicateString - * $ARGUMENTS$ - * Character string to be replicated - * - * Number of times to replicate - * $RETURNS$ - * A character expression contain the - * fill character. - * $DESCRIPTION$ - * This function returns a string composed of repetitions of - * . The length of the character string returned by this - * function is limited to the memory available. - * - * A value of 0 for will return a NULL string. - * $EXAMPLES$ - * ? REPLICATE( "a", 10 ) // aaaaaaaaaa - * ? REPLICATE( "b", 100000 ) - * $TESTS$ - * See Examples - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All(64K) - * $FILES$ - * Library is rtl - * $SEEALSO$ - * SPACE(),PADC(),PADL(),PADR() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + REPLICATE() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Repeats a single character expression + $SYNTAX$ + REPLICATE( , ) --> cReplicateString + $ARGUMENTS$ + Character string to be replicated + + Number of times to replicate + $RETURNS$ + A character expression contain the + fill character. + $DESCRIPTION$ + This function returns a string composed of repetitions of + . The length of the character string returned by this + function is limited to the memory available. + + A value of 0 for will return a NULL string. + $EXAMPLES$ + ? REPLICATE( "a", 10 ) // aaaaaaaaaa + ? REPLICATE( "b", 100000 ) + $TESTS$ + See Examples + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All(64K) + $FILES$ + Library is rtl + $SEEALSO$ + SPACE(),PADC(),PADL(),PADR() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * SPACE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Returns a string of blank spaces - * $SYNTAX$ - * SPACE( ) --> cString - * $ARGUMENTS$ - * The length of the string - * $RETURNS$ - * A string containing blank spaces - * $DESCRIPTION$ - * This function returns a string consisting of blank spaces. - * If the value of is 0, a NULL string ( "" ) will be returned. - * - * This function is useful to declare the length of a character memory - * variable. - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL cBigString - * LOCAL cFirst - * LOCAL cString := Space( 20 ) // Create an character memory variable - * // with length 20 - * ? Len( cString ) // 20 - * cBigString := space( 100000 ) // create a memory variable with 100000 - * // blank spaces - * ? Len( cBigString ) - * USE tests NEW - * cFirst := MakeEmpty( 1 ) - * ? Len( cFirst ) - * RETURN - * - * FUNCTION MakeEmpty( xField ) - * LOCAL nRecord - * LOCAL xRetValue - * - * IF ! Empty( Alias() ) - * nRecord := RecNo() - * dbgoto( 0 ) - * IF ValType( xField ) == "C" - * xField := AScan( dbstruct(), {| aFields | aFields[ 1 ] == Upper( xfield ) } ) - * ELSE - * DEFAULT xField TO 0 - * IF xField < 1 .OR. xField > FCount() - * xfield := 0 - * ENDIF - * ENDIF - * IF !( xfield == 0 ) - * xRetvalue := FieldGet( xfield ) - * ENDIF - * dbgoto( nrecord ) - * ENDIF - * RETURN xRetvalue - * $TESTS$ - * See examples - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All(64K) - * $FILES$ - * Library is rtl - * $SEEALSO$ - * PADC(),PADL(),PADR(),REPLICATE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + SPACE() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Returns a string of blank spaces + $SYNTAX$ + SPACE( ) --> cString + $ARGUMENTS$ + The length of the string + $RETURNS$ + A string containing blank spaces + $DESCRIPTION$ + This function returns a string consisting of blank spaces. + If the value of is 0, a NULL string ( "" ) will be returned. + + This function is useful to declare the length of a character memory + variable. + $EXAMPLES$ + PROCEDURE Main() + LOCAL cBigString + LOCAL cFirst + LOCAL cString := Space( 20 ) // Create an character memory variable + // with length 20 + ? Len( cString ) // 20 + cBigString := space( 100000 ) // create a memory variable with 100000 + // blank spaces + ? Len( cBigString ) + USE tests NEW + cFirst := MakeEmpty( 1 ) + ? Len( cFirst ) + RETURN + + FUNCTION MakeEmpty( xField ) + LOCAL nRecord + LOCAL xRetValue + + IF ! Empty( Alias() ) + nRecord := RecNo() + dbgoto( 0 ) + IF ValType( xField ) == "C" + xField := AScan( dbstruct(), {| aFields | aFields[ 1 ] == Upper( xfield ) } ) + ELSE + DEFAULT xField TO 0 + IF xField < 1 .OR. xField > FCount() + xfield := 0 + ENDIF + ENDIF + IF !( xfield == 0 ) + xRetvalue := FieldGet( xfield ) + ENDIF + dbgoto( nrecord ) + ENDIF + RETURN xRetvalue + $TESTS$ + See examples + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All(64K) + $FILES$ + Library is rtl + $SEEALSO$ + PADC(),PADL(),PADR(),REPLICATE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * VAL() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Convert a number from a character type to numeric - * $SYNTAX$ - * VAL( ) --> nNumber - * $ARGUMENTS$ - * Any valid character string of numbers. - * $RETURNS$ - * The numeric value of - * $DESCRIPTION$ - * This function converts any number previously defined as an character - * expression into a numeric expression. - * - * This functions is the oppose of the STR() function. - * $EXAMPLES$ - * ? VAL( "31421" ) // 31421 - * $TESTS$ - * See regression test - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * STR(),TRANSFORM() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + VAL() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Convert a number from a character type to numeric + $SYNTAX$ + VAL( ) --> nNumber + $ARGUMENTS$ + Any valid character string of numbers. + $RETURNS$ + The numeric value of + $DESCRIPTION$ + This function converts any number previously defined as an character + expression into a numeric expression. + + This functions is the oppose of the STR() function. + $EXAMPLES$ + ? VAL( "31421" ) // 31421 + $TESTS$ + See regression test + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + STR(),TRANSFORM() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * STRTRAN() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Translate substring value with a main string - * $SYNTAX$ - * STRTRAN( , , [], [], - * [] ) --> cReturn - * $ARGUMENTS$ - * The main string to search - * - * The string to locate in the main string - * - * The string to replace the - * - * The first occurrence to be replaced - * - * Number of occurrence to replace - * $RETURNS$ - * Formated string - * $DESCRIPTION$ - * This function searches for any occurrence of in - * and replaces it with . If is not specified, a - * NULL byte will replace . - * - * If is used, its value defines the first occurrence to be - * replaced. The default value is 1. Additionally, if used, the value of - * tell the function how many occurrences of - * in are to the replaced. The default of is - * all occurrences. - * $EXAMPLES$ - * ? STRTRAN( "Harbour Power", " ", " " ) // Harbour Power - * // Harbour Power The future of xBase - * ? STRTRAN( "Harbour Power The Future of xBase", " ", " " ,, 2 ) - * $TESTS$ - * See regression test - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All(64K) - * $FILES$ - * Libraty is rtl - * $SEEALSO$ - * SUBSTR(),AT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + STRTRAN() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Translate substring value with a main string + $SYNTAX$ + STRTRAN( , , [], [], + [] ) --> cReturn + $ARGUMENTS$ + The main string to search + + The string to locate in the main string + + The string to replace the + + The first occurrence to be replaced + + Number of occurrence to replace + $RETURNS$ + Formated string + $DESCRIPTION$ + This function searches for any occurrence of in + and replaces it with . If is not specified, a + NULL byte will replace . + + If is used, its value defines the first occurrence to be + replaced. The default value is 1. Additionally, if used, the value of + tell the function how many occurrences of + in are to the replaced. The default of is + all occurrences. + $EXAMPLES$ + ? STRTRAN( "Harbour Power", " ", " " ) // Harbour Power + // Harbour Power The future of xBase + ? STRTRAN( "Harbour Power The Future of xBase", " ", " " ,, 2 ) + $TESTS$ + See regression test + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All(64K) + $FILES$ + Libraty is rtl + $SEEALSO$ + SUBSTR(),AT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * TRANSFORM() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Strings - * $ONELINER$ - * Formats a value based on a specific picture template. - * $SYNTAX$ - * Transform( , ) --> cFormatted - * $ARGUMENTS$ - * Any expression to be formated. - * - * Character string with picture template - * $RETURNS$ - * Formatted expression in character format - * $DESCRIPTION$ - * This function returns in the format of the picture - * expression passed to the function as . - * - * Their are two components that can make up : a function - * string and a template string. Function strings are those functions - * that globally tell what the format of should be. These - * functions are represented by a single character precede by the - * @ symbol. - * - * There are a couple of rules to follow when using function strings - * and template strings: - * - * - First, a single space must fall between the function template - * and the template string if they are used in conjunction with - * one another. - * - * - Second, if both components make up the value of , the - * function string must precede the template string. Otherwise, the - * function string may appear with out the template string and - * vice versa. - * - * The table below shows the possible function strings available with - * the TRANSFORM() function. - * - * - * @B Left justify the string within the format. - * @C Issue a CR after format is numbers are positive. - * @D Put dates in SET DATE format. - * @E Put dates in BRITISH format. - * @L Make a zero padded string out of the number. - * @R Insert non template characters. - * @X Issue a DB after format is numbers are negative. - * @Z Display any zero as blank spaces. - * @( Quotes around negative numbers - * @! Convert alpha characters to uppercased format. - *
- * - * The second part of consists of the format string. Each - * character in the string may be formatted based on using the follow - * characters as template markers for the string. - * - * - * A,N,X,9,# Any data type - * L Shows logical as "T" or "F" - * Y Shows logical as "Y" or "N" - * ! Convert to uppercase - * $ Dollar sing in place of leading spaces in numeric expression - * * Asterisks in place of leading spaces in numeric expression - * , Commas position - * . Decimal point position - *
- * $EXAMPLES$ - * LOCAL cString := "This is harbour" - * LOCAL nNumber := 9923.34 - * LOCAL nNumber1 := -95842.00 - * LOCAL lValue := .T. - * LOCAL dDate := Date() - * ? "working with String" - * ? "Current String is", cString - * ? "All uppercased", Transform( cString, "@!" ) - * ? "Date is", ddate - * ? "Date is ", Transform( ddate, "@D" ) - * ? Transform( nNumber, "@L 99999999" ) // "009923.34" - * ? Transform( 0 , "@L 9999" ) // "0000" - * $TESTS$ - * See regression Test - * $STATUS$ - * R - * $COMPLIANCE$ - * The @L function template is a FoxPro/Xbase++ Extension - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * @...SAY,DEVOUTPICT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + TRANSFORM() + $CATEGORY$ + API + $SUBCATEGORY$ + Strings + $ONELINER$ + Formats a value based on a specific picture template. + $SYNTAX$ + Transform( , ) --> cFormatted + $ARGUMENTS$ + Any expression to be formated. + + Character string with picture template + $RETURNS$ + Formatted expression in character format + $DESCRIPTION$ + This function returns in the format of the picture + expression passed to the function as . + + Their are two components that can make up : a function + string and a template string. Function strings are those functions + that globally tell what the format of should be. These + functions are represented by a single character precede by the + @ symbol. + + There are a couple of rules to follow when using function strings + and template strings: + + - First, a single space must fall between the function template + and the template string if they are used in conjunction with + one another. + + - Second, if both components make up the value of , the + function string must precede the template string. Otherwise, the + function string may appear with out the template string and + vice versa. + + The table below shows the possible function strings available with + the TRANSFORM() function. + + + @B Left justify the string within the format. + @C Issue a CR after format is numbers are positive. + @D Put dates in SET DATE format. + @E Put dates in BRITISH format. + @L Make a zero padded string out of the number. + @R Insert non template characters. + @X Issue a DB after format is numbers are negative. + @Z Display any zero as blank spaces. + @( Quotes around negative numbers + @! Convert alpha characters to uppercased format. +
+ + The second part of consists of the format string. Each + character in the string may be formatted based on using the follow + characters as template markers for the string. + + + A,N,X,9,# Any data type + L Shows logical as "T" or "F" + Y Shows logical as "Y" or "N" + ! Convert to uppercase + $ Dollar sing in place of leading spaces in numeric expression + * Asterisks in place of leading spaces in numeric expression + , Commas position + . Decimal point position +
+ $EXAMPLES$ + LOCAL cString := "This is harbour" + LOCAL nNumber := 9923.34 + LOCAL nNumber1 := -95842.00 + LOCAL lValue := .T. + LOCAL dDate := Date() + ? "working with String" + ? "Current String is", cString + ? "All uppercased", Transform( cString, "@!" ) + ? "Date is", ddate + ? "Date is ", Transform( ddate, "@D" ) + ? Transform( nNumber, "@L 99999999" ) // "009923.34" + ? Transform( 0 , "@L 9999" ) // "0000" + $TESTS$ + See regression Test + $STATUS$ + R + $COMPLIANCE$ + The @L function template is a FoxPro/Xbase++ Extension + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + @...SAY,DEVOUTPICT() + $END$ */ diff --git a/harbour/doc/en/strotype.txt b/harbour/doc/en/strotype.txt index 9157d50637..0477fa83fa 100644 --- a/harbour/doc/en/strotype.txt +++ b/harbour/doc/en/strotype.txt @@ -2,101 +2,101 @@ * $Id$ */ -/* $DOC$ - * $TEMPLATE$ - * Document - * $NAME$ - * Strong Typing - * $CATEGORY$ - * Document - * $SUBCATEGORY$ - * Compiler - * $ONELINER$ - * Compile-Time type checking - * $DESCRIPTION$ - * Strong Type Checking could also be described as "Compile-Time Type - * Checking". - * - * CA-Cl*pper generates a Run-Time Error - * ("Type Mismatch") at an attempt to perform some operations with - * the wrong type of Variable. - * - * Examples: - * - * LOCAL Var1 := "A" - * - * ? Var1 * 3 // Error here. - * - * @ Var1, 7 SAY 'Hello' // Error here. - * - * ? SubStr( "Hello", Var1 ) // Error here. - * - * The above 3 lines would all result in Run-Time Error, because Var1 is - * of type CHARACTER but the above lines used it as if it was of type - * NUMERIC. - * - * Using Strong Type Checking, or Compile-Time Type Checking, the above - * problem would have been discovered and reported in COMPILE-TIME, - * rather than waiting for the inevitable problem to be discovered when - * we finally execute the program. - * - * Strong Typed Languages allow the programmer to "tell" the compiler (declare) - * what is the type of a each Variable, so that the Compiler in return can warn - * the programmer, when ever such Declared (Strong Typed) Variable, is used in - * a context which is incompatible with its declared type. - * - * For instance, if we "told" the compiler that Var1 above is of type - * CHARACTER (LOCAL Var1 AS CHARACTER) the Harbour Compiler could, in - * return, warn us if we attempted to perform the calculation: - * - * Var1 * 3 - * - * because the Compiler knows we can't perform a multiplication of a - * Character. (we might allow it in some context, but this is beyond - * the scope of this discussion). Similarly we would have been warned - * when attempting to use Var1 as a Row Number ( @ Var1 ), or as the - * 2nd operand of the SubStr() function SubStr( "Hello", Var1) ), - * because the Compiler knows that these operations require a NUMERIC - * rather than CHARACTER type. - * - * The above may save us lots of time, by pointing a problem, we can not - * escape, since such code will never perform correctly once executed. - * So rather than wait to the testing cycle, for such problems to be - * discovered, (and some times even later, after we may have - * distributed our applications) instead we may know of such problems - * as soon as we type HARBOUR ProgName -w3 - * - * Harbour also offers a hybrid mode, where it can report such type - * mismatch problems, even without requiring the programmer to declare - * the type of variables. This feature, is referred to as Adaptive Type - * Checking. The programmer is not required to make any changes in his - * code to take advantage of this feature. All of the above 3 errors - * would have been reported just as effectively as if the programmer - * Strong Typed (declared) Var1. Harbour would have been able to report - * such problems at compile time because the assignment Var1 := "A" - * implied that Var1 is of type CHARACTER,until it will be assigned - * another value. Therefore Harbour will "remember" that Var1 "adapted" - * type CHARACTER, and thus the subsequent multiplication Var1 * 3, will - * be reported as an error, as soon as you attempt to compile such code. - * - * The nice aspect of this hybrid mode, is that unlike Strong Typed - * Variables,you don't have to declare the type, so no code changes - * are need, the Type instead is assumed by implication (type of the - * assigned value). The other benefit, is that it is completely OK to - * assign a new value of different type, any time, to such undeclared - * (variant) variable. As soon as we assign a new type, the Compiler - * will than protect us from using the Variable in an incompatible - * context, since the variable "adapted" this type as soon as we - * assigned a value which implies a type. - * - * While Adapted Type Checking may be fairly effective in reporting many - * common mistakes, to take full benefits of such Compile-Time checking, - * it is recommended to do declare the Type of Variables, when ever - * possible. - * - * The Harbour Strong Type features, also allows the declaration of the - * expected parameters (including optionals) of User Defined Functions, - * as well as their return Type. Similarly, you may declare the Type of - * any Class Variables, Methods, and Methods Parameters. - * $END$ +/* $DOC$ + $TEMPLATE$ + Document + $NAME$ + Strong Typing + $CATEGORY$ + Document + $SUBCATEGORY$ + Compiler + $ONELINER$ + Compile-Time type checking + $DESCRIPTION$ + Strong Type Checking could also be described as "Compile-Time Type + Checking". + + CA-Cl*pper generates a Run-Time Error + ("Type Mismatch") at an attempt to perform some operations with + the wrong type of Variable. + + Examples: + + LOCAL Var1 := "A" + + ? Var1 * 3 // Error here. + + @ Var1, 7 SAY 'Hello' // Error here. + + ? SubStr( "Hello", Var1 ) // Error here. + + The above 3 lines would all result in Run-Time Error, because Var1 is + of type CHARACTER but the above lines used it as if it was of type + NUMERIC. + + Using Strong Type Checking, or Compile-Time Type Checking, the above + problem would have been discovered and reported in COMPILE-TIME, + rather than waiting for the inevitable problem to be discovered when + we finally execute the program. + + Strong Typed Languages allow the programmer to "tell" the compiler (declare) + what is the type of a each Variable, so that the Compiler in return can warn + the programmer, when ever such Declared (Strong Typed) Variable, is used in + a context which is incompatible with its declared type. + + For instance, if we "told" the compiler that Var1 above is of type + CHARACTER (LOCAL Var1 AS CHARACTER) the Harbour Compiler could, in + return, warn us if we attempted to perform the calculation: + + Var1 * 3 + + because the Compiler knows we can't perform a multiplication of a + Character. (we might allow it in some context, but this is beyond + the scope of this discussion). Similarly we would have been warned + when attempting to use Var1 as a Row Number ( @ Var1 ), or as the + 2nd operand of the SubStr() function SubStr( "Hello", Var1) ), + because the Compiler knows that these operations require a NUMERIC + rather than CHARACTER type. + + The above may save us lots of time, by pointing a problem, we can not + escape, since such code will never perform correctly once executed. + So rather than wait to the testing cycle, for such problems to be + discovered, (and some times even later, after we may have + distributed our applications) instead we may know of such problems + as soon as we type HARBOUR ProgName -w3 + + Harbour also offers a hybrid mode, where it can report such type + mismatch problems, even without requiring the programmer to declare + the type of variables. This feature, is referred to as Adaptive Type + Checking. The programmer is not required to make any changes in his + code to take advantage of this feature. All of the above 3 errors + would have been reported just as effectively as if the programmer + Strong Typed (declared) Var1. Harbour would have been able to report + such problems at compile time because the assignment Var1 := "A" + implied that Var1 is of type CHARACTER,until it will be assigned + another value. Therefore Harbour will "remember" that Var1 "adapted" + type CHARACTER, and thus the subsequent multiplication Var1 * 3, will + be reported as an error, as soon as you attempt to compile such code. + + The nice aspect of this hybrid mode, is that unlike Strong Typed + Variables,you don't have to declare the type, so no code changes + are need, the Type instead is assumed by implication (type of the + assigned value). The other benefit, is that it is completely OK to + assign a new value of different type, any time, to such undeclared + (variant) variable. As soon as we assign a new type, the Compiler + will than protect us from using the Variable in an incompatible + context, since the variable "adapted" this type as soon as we + assigned a value which implies a type. + + While Adapted Type Checking may be fairly effective in reporting many + common mistakes, to take full benefits of such Compile-Time checking, + it is recommended to do declare the Type of Variables, when ever + possible. + + The Harbour Strong Type features, also allows the declaration of the + expected parameters (including optionals) of User Defined Functions, + as well as their return Type. Similarly, you may declare the Type of + any Class Variables, Methods, and Methods Parameters. + $END$ */ diff --git a/harbour/doc/en/subcodes.txt b/harbour/doc/en/subcodes.txt index ff7f578cfc..0a07a787b1 100644 --- a/harbour/doc/en/subcodes.txt +++ b/harbour/doc/en/subcodes.txt @@ -1,1494 +1,1477 @@ /* * $Id$ */ -/* - Proposition: - -* If the error is raised in the same condition as in CA-Cl*pper then the same -subcode number should be used. - -* Errors specific to the Harbour and generated in RTL modules should -start from 3000 - -* Errors generated in tools functions should start from 4000 -*/ -/* ************************************************************************** */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1003 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Attempt to access nonexisting or hidden variable - * $DESCRIPTION$ - * The specified variable was not found. - * - * If it is a database field ensure that the required database is open. - * - * If it is a private or public variable then it must be first created - * using PRIVATE or PUBLIC statement. - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1068 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid type of argument - * $DESCRIPTION$ - * The used data is not of logical type. - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1068 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Bound error in array access - * $DESCRIPTION$ - * The attempt to retrieve data from non-array value. - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1069 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Bound error in array access - * $DESCRIPTION$ - * The attempt to set data to non-array value. - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1078 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid type of arguments - * $DESCRIPTION$ - * The type of compared arguments do not match. - * $EXAMPLES$ - * == - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1072 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid type of arguments - * $DESCRIPTION$ - * The type of compared arguments do not match. - * $EXAMPLES$ - * <> - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1073 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid type of arguments - * $DESCRIPTION$ - * The type of compared argument do not match. - * $EXAMPLES$ - * < - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1074 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid type of arguments - * $DESCRIPTION$ - * The type of compared arguments do not match. - * $EXAMPLES$ - * <= - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1075 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid type of arguments - * $DESCRIPTION$ - * The type of compared arguments do not match. - * $EXAMPLES$ - * > - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1076 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid type of arguments - * $DESCRIPTION$ - * The type of compared arguments do not match. - * $EXAMPLES$ - * >= - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1077 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid type of arguments - * $DESCRIPTION$ - * Operation is not allowed for passed argument. The argument is not - * a logical value. - * $EXAMPLES$ - * ! - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1078 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid type of arguments - * $DESCRIPTION$ - * The type of one or both arguments is not a logical. - * $EXAMPLES$ - * .AND. - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1079 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid type of arguments - * $DESCRIPTION$ - * The type of one or both arguments is not a logical. - * $EXAMPLES$ - * .OR. - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1076 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid type of arguments - * $DESCRIPTION$ - * The value of argument cannot be incremented. - * $EXAMPLES$ - * ++ - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1081 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid type of arguments - * $DESCRIPTION$ - * The plus operation is not allowed for used arguments. - * $EXAMPLES$ - * + - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1082 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid type of arguments - * $DESCRIPTION$ - * The minus operation is not allowed for used arguments. - * $EXAMPLES$ - * - - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1100 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Incorrect type of argument - * $DESCRIPTION$ - * The specified argument is not a string. - * $EXAMPLES$ - * RTRIM, TRIM - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1101 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Incorrect type of argument - * $DESCRIPTION$ - * The specified argument is not a string. - * $EXAMPLES$ - * LTRIM - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1102 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The first argument passed to a function is not a string. - * $EXAMPLES$ - * UPPER - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1103 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The first argument passed to a function is not a string. - * $EXAMPLES$ - * LOWER - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1104 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Incorrect type of argument - * $DESCRIPTION$ - * The specified argument is not a numeric value. - * $EXAMPLES$ - * CHR - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1105 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The arguments passed to a function are of incorrect type. - * $EXAMPLES$ - * SPACE - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1106 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The arguments passed to a function are of incorrect type. - * $EXAMPLES$ - * REPLICATE - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1107 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Incorrect type of argument - * $DESCRIPTION$ - * The specified argument is not a string. - * $EXAMPLES$ - * ASC - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1108 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Incorrect type of argument - * $DESCRIPTION$ - * The specified argument is not a string. - * $EXAMPLES$ - * AT - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1076 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid type of arguments - * $DESCRIPTION$ - * The arguments of '$' operator are not a strings. - * $EXAMPLES$ - * $ - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1110 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The first argument passed to a function is not a string. - * $EXAMPLES$ - * SUBSTR - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1110 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The passed argument is neither a string nor an array. - * $EXAMPLES$ - * LEN - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1112 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The argument (or arguments) passed to a function are of incorrect - * type - * $EXAMPLES$ - * YEAR - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1113 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The argument (or arguments) passed to a function are of incorrect - * type - * $EXAMPLES$ - * MONTH - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1114 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The argument (or arguments) passed to a function are of incorrect - * type - * $EXAMPLES$ - * DAY - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1115 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The argument (or arguments) passed to a function are of incorrect - * type - * $EXAMPLES$ - * DOW - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1116 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The argument (or arguments) passed to a function are of incorrect - * type - * $EXAMPLES$ - * CMONTH - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1117 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The argument (or arguments) passed to a function is of incorrect - * type - * $EXAMPLES$ - * CDOW - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1120 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The argument (or arguments) passed to a function is of incorrect - * type - * $EXAMPLES$ - * DTOS - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1122 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Incorrect type of argument - * $DESCRIPTION$ - * The argument (or arguments) passed to a function is of incorrect - * type - * $EXAMPLES$ - * TRANSFORM - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1124 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Incorrect type of argument - * $DESCRIPTION$ - * The first argument is not a string. - * $EXAMPLES$ - * LEFT - * $COMPLIANCE$ - * C - * $SEEALSO$ - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1126 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The first arguments passed to a function is not a string. - * $EXAMPLES$ - * STRTRAN - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1132 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Bound error in array access - * $DESCRIPTION$ - * The specified index into an array was greater then the number of - * elements in the array. - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1133 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Bound error in array assignment - * $DESCRIPTION$ - * The specified index into an array was greater then the number of - * elements in the array. - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1068 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Bound error in array element assignment - * $DESCRIPTION$ - * The specified index into an array was greater then the number of - * elements in the array. - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1085 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The argument (or arguments) passed to a function is not an numeric - * value - * $EXAMPLES$ - * MOD - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1089 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The argument (or arguments) passed to a function is not an numeric - * value - * $EXAMPLES$ - * ABS - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1090 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The argument (or arguments) passed to a function is not an numeric - * value - * $EXAMPLES$ - * INT - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1092 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The argument (or arguments) passed to a function is not an numeric - * value - * $EXAMPLES$ - * MIN - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1093 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The argument (or arguments) passed to a function is not an numeric - * value - * $EXAMPLES$ - * MAX - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1094 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The argument (or arguments) passed to a function is not an numeric - * value - * $EXAMPLES$ - * ROUND - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1095 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The argument (or arguments) passed to a function is not an numeric - * value - * $EXAMPLES$ - * LOG - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1096 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The argument (or arguments) passed to a function is not an numeric - * value - * $EXAMPLES$ - * EXP - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1097 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The argument (or arguments) passed to a function is not an numeric - * value - * $EXAMPLES$ - * SQRT - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1098 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The argument (or arguments) passed to a function is not a string - * value - * $EXAMPLES$ - * VAL - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/1099 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The argument (or arguments) passed to a function is not a numeric - * value - * $EXAMPLES$ - * STR - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* ************************************************************************** */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/2010 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Incorrect arguments type - * $DESCRIPTION$ - * Passed Run time errors was not strings with filenames to copy/ - * $EXAMPLES$ - * __COPYFILE - * $COMPLIANCE$ - * H - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/2012 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * File error - * $DESCRIPTION$ - * An error has occurred during the attempt to open, create or write - * during copy operation - * $EXAMPLES$ - * __COPYFILE - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/2017 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to a function - * $DESCRIPTION$ - * The first argument is not an array or/and the second argument - * is not a code block - * $EXAMPLES$ - * AEVAL - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/2020 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The passed value is negative. Only values > 0 are allowed. - * $EXAMPLES$ - * SET DECIMALS - * SET EPOCH - * SET MARGIN - * SET MESSAGE - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ - */ - -/* ************************************************************************** */ - - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/3001 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Incorrect argument type - * $DESCRIPTION$ - * The passed argument is not an object. Only data of type OBJECT - * can be cloned by this function - * $EXAMPLES$ - * OCLONE - * $COMPLIANCE$ - * H - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/3002 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Super class does not return an object - * $DESCRIPTION$ - * Passed argument is not a name of defined class or specified class - * doesn't have a super class - * $EXAMPLES$ - * __INSTSUPER - * $COMPLIANCE$ - * H - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/3003 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Cannot find super class - * $DESCRIPTION$ - * Passed argument is not a name of defined class - * $EXAMPLES$ - * __INSTSUPER - * $COMPLIANCE$ - * H - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/3004 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Cannot modify a DATA item in a class - * $DESCRIPTION$ - * The attempt to modify a data member of a class was made. - * Only INLINE and METHOD can be modified - * $EXAMPLES$ - * CLASSMOD - * $COMPLIANCE$ - * H - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/3005 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Incorrect arguments type - * $DESCRIPTION$ - * Either the first argument was not an object or the second argument - * wasn't a string. - * $EXAMPLES$ - * ISMESSAGE, OSEND - * $COMPLIANCE$ - * H - * $SEEALSO$ - * - * $END$ - */ - - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/3007 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid type of argument - * $DESCRIPTION$ - * The passed arguments are causing conflict in handling of the request. - * There is no point in waiting forever for no input events! - * $EXAMPLES$ - * INKEY - * $COMPLIANCE$ - * H - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/3008 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid type of argument - * $DESCRIPTION$ - * The passed argument(s) is not a string. It should be a string with - * a variable name or an one-dimensional array of strings. - * $EXAMPLES$ - * __MVPRIVATE, __MVPUBLIC - * $COMPLIANCE$ - * H - * $SEEALSO$ - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/3009 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Incorrect argument passed to __MVGET function - * $DESCRIPTION$ - * __MVGET function expects only one argument: a string with a name - * of variable. The value of this variable will be returned. - * $EXAMPLES$ - * __MVGET - * $COMPLIANCE$ - * H - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/3010 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Incorrect argument passed to __MVPUT function - * $DESCRIPTION$ - * __MVPUT function expects at least one argument: a string with a name - * of variable. The value of this variable will be set. - * $EXAMPLES$ - * __MVPUT - * $COMPLIANCE$ - * H - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/3011 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to a function - * $DESCRIPTION$ - * The attempt to retrieve the function argument that was not passed. - * The number of requested argument is greater then the number of - * passed arguments. - * $EXAMPLES$ - * PVALUE - * $COMPLIANCE$ - * H - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/3012 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to a function - * $DESCRIPTION$ - * The first argument is not a string with function/procedure name - * that should be called. - * $EXAMPLES$ - * DO - * $COMPLIANCE$ - * H - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/3101 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to an object/class function - * $DESCRIPTION$ - * One passed argument is not of the required type. - * $EXAMPLES$ - * __OBJ*() - * $COMPLIANCE$ - * H - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/3102 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * A symbol should be modified or deleted from a class, but the symbol - * doesn't exist. - * $DESCRIPTION$ - * A symbol should be modified or deleted from a class, but the symbol - * doesn't exist. - * $EXAMPLES$ - * __OBJ*() - * $COMPLIANCE$ - * H - * $SEEALSO$ - * - * $END$ - */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * BASE/3103 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * A symbol should be added to a class, but the symbol already exists. - * $DESCRIPTION$ - * A symbol should be added to a class, but the symbol already exists. - * $EXAMPLES$ - * __OBJ*() - * $COMPLIANCE$ - * H - * $SEEALSO$ - * - * $END$ - */ - - /* ************************************************************************** */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * TOOLS/4001 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Invalid argument passed to function - * $DESCRIPTION$ - * The second arguments passed to a function is not a string. - * $EXAMPLES$ - * ISLEAPYEAR - * $COMPLIANCE$ - * H - * $SEEALSO$ - * - * $END$ - */ - -/* ************************************************************************** */ - -/* $DOC$ - * $TEMPLATE$ - * Run time error - * $NAME$ - * TERM/2013 - * $CATEGORY$ - * Run time errors - * $ONELINER$ - * Create error - * $DESCRIPTION$ - * The specified file cannot be created due some OS error. - * $EXAMPLES$ - * SET, SET ALTERNATE TO - * $COMPLIANCE$ - * C - * $SEEALSO$ - * - * $END$ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1003 + $CATEGORY$ + Run time errors + $ONELINER$ + Attempt to access nonexisting or hidden variable + $DESCRIPTION$ + The specified variable was not found. + + If it is a database field ensure that the required database is open. + + If it is a private or public variable then it must be first created + using PRIVATE or PUBLIC statement. + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1068 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid type of argument + $DESCRIPTION$ + The used data is not of logical type. + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1068 + $CATEGORY$ + Run time errors + $ONELINER$ + Bound error in array access + $DESCRIPTION$ + The attempt to retrieve data from non-array value. + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1069 + $CATEGORY$ + Run time errors + $ONELINER$ + Bound error in array access + $DESCRIPTION$ + The attempt to set data to non-array value. + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1078 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid type of arguments + $DESCRIPTION$ + The type of compared arguments do not match. + $EXAMPLES$ + == + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1072 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid type of arguments + $DESCRIPTION$ + The type of compared arguments do not match. + $EXAMPLES$ + <> + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1073 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid type of arguments + $DESCRIPTION$ + The type of compared argument do not match. + $EXAMPLES$ + < + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1074 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid type of arguments + $DESCRIPTION$ + The type of compared arguments do not match. + $EXAMPLES$ + <= + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1075 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid type of arguments + $DESCRIPTION$ + The type of compared arguments do not match. + $EXAMPLES$ + > + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1076 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid type of arguments + $DESCRIPTION$ + The type of compared arguments do not match. + $EXAMPLES$ + >= + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1077 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid type of arguments + $DESCRIPTION$ + Operation is not allowed for passed argument. The argument is not + a logical value. + $EXAMPLES$ + ! + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1078 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid type of arguments + $DESCRIPTION$ + The type of one or both arguments is not a logical. + $EXAMPLES$ + .AND. + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1079 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid type of arguments + $DESCRIPTION$ + The type of one or both arguments is not a logical. + $EXAMPLES$ + .OR. + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1076 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid type of arguments + $DESCRIPTION$ + The value of argument cannot be incremented. + $EXAMPLES$ + ++ + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1081 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid type of arguments + $DESCRIPTION$ + The plus operation is not allowed for used arguments. + $EXAMPLES$ + + + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1082 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid type of arguments + $DESCRIPTION$ + The minus operation is not allowed for used arguments. + $EXAMPLES$ + - + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1100 + $CATEGORY$ + Run time errors + $ONELINER$ + Incorrect type of argument + $DESCRIPTION$ + The specified argument is not a string. + $EXAMPLES$ + RTRIM, TRIM + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1101 + $CATEGORY$ + Run time errors + $ONELINER$ + Incorrect type of argument + $DESCRIPTION$ + The specified argument is not a string. + $EXAMPLES$ + LTRIM + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1102 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The first argument passed to a function is not a string. + $EXAMPLES$ + UPPER + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1103 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The first argument passed to a function is not a string. + $EXAMPLES$ + LOWER + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1104 + $CATEGORY$ + Run time errors + $ONELINER$ + Incorrect type of argument + $DESCRIPTION$ + The specified argument is not a numeric value. + $EXAMPLES$ + CHR + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1105 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The arguments passed to a function are of incorrect type. + $EXAMPLES$ + SPACE + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1106 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The arguments passed to a function are of incorrect type. + $EXAMPLES$ + REPLICATE + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1107 + $CATEGORY$ + Run time errors + $ONELINER$ + Incorrect type of argument + $DESCRIPTION$ + The specified argument is not a string. + $EXAMPLES$ + ASC + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1108 + $CATEGORY$ + Run time errors + $ONELINER$ + Incorrect type of argument + $DESCRIPTION$ + The specified argument is not a string. + $EXAMPLES$ + AT + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1076 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid type of arguments + $DESCRIPTION$ + The arguments of '$' operator are not a strings. + $EXAMPLES$ + + $$ + + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1110 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The first argument passed to a function is not a string. + $EXAMPLES$ + SUBSTR + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1110 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The passed argument is neither a string nor an array. + $EXAMPLES$ + LEN + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1112 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The argument (or arguments) passed to a function are of incorrect + type + $EXAMPLES$ + YEAR + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1113 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The argument (or arguments) passed to a function are of incorrect + type + $EXAMPLES$ + MONTH + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1114 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The argument (or arguments) passed to a function are of incorrect + type + $EXAMPLES$ + DAY + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1115 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The argument (or arguments) passed to a function are of incorrect + type + $EXAMPLES$ + DOW + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1116 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The argument (or arguments) passed to a function are of incorrect + type + $EXAMPLES$ + CMONTH + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1117 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The argument (or arguments) passed to a function is of incorrect + type + $EXAMPLES$ + CDOW + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1120 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The argument (or arguments) passed to a function is of incorrect + type + $EXAMPLES$ + DTOS + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1122 + $CATEGORY$ + Run time errors + $ONELINER$ + Incorrect type of argument + $DESCRIPTION$ + The argument (or arguments) passed to a function is of incorrect + type + $EXAMPLES$ + TRANSFORM + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1124 + $CATEGORY$ + Run time errors + $ONELINER$ + Incorrect type of argument + $DESCRIPTION$ + The first argument is not a string. + $EXAMPLES$ + LEFT + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1126 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The first arguments passed to a function is not a string. + $EXAMPLES$ + STRTRAN + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1132 + $CATEGORY$ + Run time errors + $ONELINER$ + Bound error in array access + $DESCRIPTION$ + The specified index into an array was greater then the number of + elements in the array. + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1133 + $CATEGORY$ + Run time errors + $ONELINER$ + Bound error in array assignment + $DESCRIPTION$ + The specified index into an array was greater then the number of + elements in the array. + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1068 + $CATEGORY$ + Run time errors + $ONELINER$ + Bound error in array element assignment + $DESCRIPTION$ + The specified index into an array was greater then the number of + elements in the array. + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1085 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The argument (or arguments) passed to a function is not an numeric + value + $EXAMPLES$ + MOD + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1089 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The argument (or arguments) passed to a function is not an numeric + value + $EXAMPLES$ + ABS + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1090 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The argument (or arguments) passed to a function is not an numeric + value + $EXAMPLES$ + INT + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1092 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The argument (or arguments) passed to a function is not an numeric + value + $EXAMPLES$ + MIN + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1093 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The argument (or arguments) passed to a function is not an numeric + value + $EXAMPLES$ + MAX + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1094 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The argument (or arguments) passed to a function is not an numeric + value + $EXAMPLES$ + ROUND + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1095 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The argument (or arguments) passed to a function is not an numeric + value + $EXAMPLES$ + LOG + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1096 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The argument (or arguments) passed to a function is not an numeric + value + $EXAMPLES$ + EXP + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1097 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The argument (or arguments) passed to a function is not an numeric + value + $EXAMPLES$ + SQRT + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1098 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The argument (or arguments) passed to a function is not a string + value + $EXAMPLES$ + VAL + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/1099 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The argument (or arguments) passed to a function is not a numeric + value + $EXAMPLES$ + STR + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/2010 + $CATEGORY$ + Run time errors + $ONELINER$ + Incorrect arguments type + $DESCRIPTION$ + Passed Run time errors was not strings with filenames to copy/ + $EXAMPLES$ + __COPYFILE + $COMPLIANCE$ + H + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/2012 + $CATEGORY$ + Run time errors + $ONELINER$ + File error + $DESCRIPTION$ + An error has occurred during the attempt to open, create or write + during copy operation + $EXAMPLES$ + __COPYFILE + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/2017 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to a function + $DESCRIPTION$ + The first argument is not an array or/and the second argument + is not a code block + $EXAMPLES$ + AEVAL + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/2020 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The passed value is negative. Only values > 0 are allowed. + $EXAMPLES$ + SET DECIMALS + SET EPOCH + SET MARGIN + SET MESSAGE + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/3001 + $CATEGORY$ + Run time errors + $ONELINER$ + Incorrect argument type + $DESCRIPTION$ + The passed argument is not an object. Only data of type OBJECT + can be cloned by this function + $EXAMPLES$ + OCLONE + $COMPLIANCE$ + H + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/3002 + $CATEGORY$ + Run time errors + $ONELINER$ + Super class does not return an object + $DESCRIPTION$ + Passed argument is not a name of defined class or specified class + doesn't have a super class + $EXAMPLES$ + __INSTSUPER + $COMPLIANCE$ + H + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/3003 + $CATEGORY$ + Run time errors + $ONELINER$ + Cannot find super class + $DESCRIPTION$ + Passed argument is not a name of defined class + $EXAMPLES$ + __INSTSUPER + $COMPLIANCE$ + H + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/3004 + $CATEGORY$ + Run time errors + $ONELINER$ + Cannot modify a DATA item in a class + $DESCRIPTION$ + The attempt to modify a data member of a class was made. + Only INLINE and METHOD can be modified + $EXAMPLES$ + CLASSMOD + $COMPLIANCE$ + H + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/3005 + $CATEGORY$ + Run time errors + $ONELINER$ + Incorrect arguments type + $DESCRIPTION$ + Either the first argument was not an object or the second argument + wasn't a string. + $EXAMPLES$ + ISMESSAGE, OSEND + $COMPLIANCE$ + H + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/3007 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid type of argument + $DESCRIPTION$ + The passed arguments are causing conflict in handling of the request. + There is no point in waiting forever for no input events! + $EXAMPLES$ + INKEY + $COMPLIANCE$ + H + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/3008 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid type of argument + $DESCRIPTION$ + The passed argument(s) is not a string. It should be a string with + a variable name or an one-dimensional array of strings. + $EXAMPLES$ + __MVPRIVATE, __MVPUBLIC + $COMPLIANCE$ + H + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/3009 + $CATEGORY$ + Run time errors + $ONELINER$ + Incorrect argument passed to __MVGET function + $DESCRIPTION$ + __MVGET function expects only one argument: a string with a name + of variable. The value of this variable will be returned. + $EXAMPLES$ + __MVGET + $COMPLIANCE$ + H + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/3010 + $CATEGORY$ + Run time errors + $ONELINER$ + Incorrect argument passed to __MVPUT function + $DESCRIPTION$ + __MVPUT function expects at least one argument: a string with a name + of variable. The value of this variable will be set. + $EXAMPLES$ + __MVPUT + $COMPLIANCE$ + H + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/3011 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to a function + $DESCRIPTION$ + The attempt to retrieve the function argument that was not passed. + The number of requested argument is greater then the number of + passed arguments. + $EXAMPLES$ + PVALUE + $COMPLIANCE$ + H + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/3012 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to a function + $DESCRIPTION$ + The first argument is not a string with function/procedure name + that should be called. + $EXAMPLES$ + DO + $COMPLIANCE$ + H + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/3101 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to an object/class function + $DESCRIPTION$ + One passed argument is not of the required type. + $EXAMPLES$ + __OBJ*() + $COMPLIANCE$ + H + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/3102 + $CATEGORY$ + Run time errors + $ONELINER$ + A symbol should be modified or deleted from a class, but the symbol + doesn't exist. + $DESCRIPTION$ + A symbol should be modified or deleted from a class, but the symbol + doesn't exist. + $EXAMPLES$ + __OBJ*() + $COMPLIANCE$ + H + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + BASE/3103 + $CATEGORY$ + Run time errors + $ONELINER$ + A symbol should be added to a class, but the symbol already exists. + $DESCRIPTION$ + A symbol should be added to a class, but the symbol already exists. + $EXAMPLES$ + __OBJ*() + $COMPLIANCE$ + H + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + TOOLS/4001 + $CATEGORY$ + Run time errors + $ONELINER$ + Invalid argument passed to function + $DESCRIPTION$ + The second arguments passed to a function is not a string. + $EXAMPLES$ + ISLEAPYEAR + $COMPLIANCE$ + H + $SEEALSO$ + + $END$ + */ + +/* $DOC$ + $TEMPLATE$ + Run time error + $NAME$ + TERM/2013 + $CATEGORY$ + Run time errors + $ONELINER$ + Create error + $DESCRIPTION$ + The specified file cannot be created due some OS error. + $EXAMPLES$ + SET, SET ALTERNATE TO + $COMPLIANCE$ + C + $SEEALSO$ + + $END$ */ diff --git a/harbour/doc/en/tbrowse.txt b/harbour/doc/en/tbrowse.txt index 7ad912934e..6c6cc72b6f 100644 --- a/harbour/doc/en/tbrowse.txt +++ b/harbour/doc/en/tbrowse.txt @@ -2,309 +2,308 @@ * $Id$ */ -/* $DOC$ - * $TEMPLATE$ - * Class - * $NAME$ - * TBROWSENew() - * $CATEGORY$ - * TBrowse class - * $ONELINER$ - * Create a Browse Object - * $CONSTRUCTOR$ - * TBROWSENew(,,,) --> - * $ARGUMENTS$ - * Top Row - - * Top Left Column - - * Bottom Row - - * Bottom Right Column - * $RETURNS$ - * An new Browse Object - * $DESCRIPTION$ - * This function set up a browsing window at top-left coordinates of - * , to bottom-right coordinates of ,. - * To browse Database files use TBROWSEDB() function insted. - * $DATANOLINK$ - * :aColumns Array to hold all browse columns - - * :autoLite Logical value to control highlighting - - * :cargo User-definable variable - - * :colorSpec Color table for the TBrowse display - - * :colPos Current cursor column position - - * :colSep Column separator character - - * :footSep Footing separator character - - * :freeze Number of columns to freeze - - * :goBottomBlock Code block executed by TBrowse:goBottom() - - * :goTopBlock Code block executed by TBrowse:goTop() - - * :headSep Heading separator character - - * :hitBottom Indicates the end of available data - - * :hitTop Indicates the beginning of available data - - * :leftVisible Indicates position of leftmost unfrozen column - * in display - - * :nBottom Bottom row number for the TBrowse display - - * :nLeft Leftmost column for the TBrowse display - - * :nRight Rightmost column for the TBrowse display - - * :nTop Top row number for the TBrowse display - - * :rightVisible Indicates position of rightmost unfrozen column - * in display - - * :rowCount Number of visible data rows in the TBrowse - * display - - * :rowPos Current cursor row position - - * :skipBlock Code block used to reposition data source - - * :stable Indicates if the TBrowse object is stable - * - * :aRedraw Array of logical items indicating, is appropriate - * row need to be redraw - - * :RelativePos Indicates record position relatively position of - * first record on the screen - - * :lHeaders Internal variable which indicates whether there - * are column footers to paint - - * :lFooters Internal variable which indicates whether there - * are column footers to paint - - * :aRect The rectangle specified with ColorRect() - - * :aRectColor The color positions to use in the rectangle - * specified with ColorRect() - - * :aKeys Holds the Default movement keys - * $METHODSLINK$ - * AddColumn() Adds an new TBColumn object to the current Browse - * - * Applykey() Perform the Browse Key movement - * - * SetKey() Add an New key to the Keyboard dictionary - * $METHODSNOLINK$ - * New(nTop, nLeft, nBottom, nRight) Create an new Browse class and set the - * default values - * - * Down() Moves the cursor down one row - * - * End() Moves the cursor to the rightmost visible data column - * - * GoBottom() Repositions the data source to the bottom of file - * - * GoTop() Repositions the data source to the top of file - * - * Home() Moves the cursor to the leftmost visible data column - * - * Left() Moves the cursor left one column - * - * PageDown() Repositions the data source downward - * - * PageUp() Repositions the data source upward - * - * PanEnd() Moves the cursor to the rightmost data column - * - * PanHome() Moves the cursor to the leftmost visible data column - * - * PanLeft() Pans left without changing the cursor position - * - * PanRight() Pans right without changing the cursor position - * - * Right() Moves the cursor right one column - * - * Up() Moves the cursor up one row - * - * ColCount() Return the Current number of Columns - * - * ColorRect() Alters the color of a rectangular group of cells - * - * ColWidth( nColumn ) Returns the display width of a particular column - * - * Configure( nMode ) Reconfigures the internal settings of the TBrowse - * object nMode is an undocumented parameter in CA-Cl*pper - * - * LeftDetermine() Determine leftmost unfrozen column in display - * - * DeHilite() Dehighlights the current cell - * - * DelColumn( nPos ) Delete a column object from a browse - * - * ForceStable() Performs a full stabilization - * - * GetColumn( nColumn ) Gets a specific TBColumn object - * - * Hilite() Highlights the current cell - * - * InsColumn( nPos, oCol ) Insert a column object in a browse - * - * Invalidate() Forces entire redraw during next stabilization - * - * RefreshAll() Causes all data to be recalculated during the next - * stabilize - * - * RefreshCurrent() Causes the current row to be refilled and repainted - * on next stabilize - * - * SetColumn( nColumn, oCol ) Replaces one TBColumn object with another - * - * Stabilize() Performs incremental stabilization - * - * DispCell( nColumn, cColor ) Displays a single cell - * $EXAMPLES$ - * See tests/testbrw.prg - * $TESTS$ - * See tests/testbrw.prg - * $STATUS$ - * S - * $COMPLIANCE$ - * This functions is Compatible with CA-Cl*pper 5.2. The applykey() and - * Setkey() methods are only visible if HB_COMPAT_C53 is defined. - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * TBROWSENEW(),TBCOLUMNNEW() - * $END$ +/* $DOC$ + $TEMPLATE$ + Class + $NAME$ + TBROWSENew() + $CATEGORY$ + TBrowse class + $ONELINER$ + Create a Browse Object + $CONSTRUCTOR$ + TBROWSENew(,,,) --> + $ARGUMENTS$ + Top Row + + Top Left Column + + Bottom Row + + Bottom Right Column + $RETURNS$ + An new Browse Object + $DESCRIPTION$ + This function set up a browsing window at top-left coordinates of + , to bottom-right coordinates of ,. + To browse Database files use TBROWSEDB() function insted. + $DATANOLINK$ + :aColumns Array to hold all browse columns + + :autoLite Logical value to control highlighting + + :cargo User-definable variable + + :colorSpec Color table for the TBrowse display + + :colPos Current cursor column position + + :colSep Column separator character + + :footSep Footing separator character + + :freeze Number of columns to freeze + + :goBottomBlock Code block executed by TBrowse:goBottom() + + :goTopBlock Code block executed by TBrowse:goTop() + + :headSep Heading separator character + + :hitBottom Indicates the end of available data + + :hitTop Indicates the beginning of available data + + :leftVisible Indicates position of leftmost unfrozen column + in display + + :nBottom Bottom row number for the TBrowse display + + :nLeft Leftmost column for the TBrowse display + + :nRight Rightmost column for the TBrowse display + + :nTop Top row number for the TBrowse display + + :rightVisible Indicates position of rightmost unfrozen column + in display + + :rowCount Number of visible data rows in the TBrowse + display + + :rowPos Current cursor row position + + :skipBlock Code block used to reposition data source + + :stable Indicates if the TBrowse object is stable + + :aRedraw Array of logical items indicating, is appropriate + row need to be redraw + + :RelativePos Indicates record position relatively position of + first record on the screen + + :lHeaders Internal variable which indicates whether there + are column footers to paint + + :lFooters Internal variable which indicates whether there + are column footers to paint + + :aRect The rectangle specified with ColorRect() + + :aRectColor The color positions to use in the rectangle + specified with ColorRect() + + :aKeys Holds the Default movement keys + $METHODSLINK$ + AddColumn() Adds an new TBColumn object to the current Browse + + Applykey() Perform the Browse Key movement + + SetKey() Add an New key to the Keyboard dictionary + $METHODSNOLINK$ + New(nTop, nLeft, nBottom, nRight) Create an new Browse class and set the + default values + + Down() Moves the cursor down one row + + End() Moves the cursor to the rightmost visible data column + + GoBottom() Repositions the data source to the bottom of file + + GoTop() Repositions the data source to the top of file + + Home() Moves the cursor to the leftmost visible data column + + Left() Moves the cursor left one column + + PageDown() Repositions the data source downward + + PageUp() Repositions the data source upward + + PanEnd() Moves the cursor to the rightmost data column + + PanHome() Moves the cursor to the leftmost visible data column + + PanLeft() Pans left without changing the cursor position + + PanRight() Pans right without changing the cursor position + + Right() Moves the cursor right one column + + Up() Moves the cursor up one row + + ColCount() Return the Current number of Columns + + ColorRect() Alters the color of a rectangular group of cells + + ColWidth( nColumn ) Returns the display width of a particular column + + Configure( nMode ) Reconfigures the internal settings of the TBrowse + object nMode is an undocumented parameter in CA-Cl*pper + + LeftDetermine() Determine leftmost unfrozen column in display + + DeHilite() Dehighlights the current cell + + DelColumn( nPos ) Delete a column object from a browse + + ForceStable() Performs a full stabilization + + GetColumn( nColumn ) Gets a specific TBColumn object + + Hilite() Highlights the current cell + + InsColumn( nPos, oCol ) Insert a column object in a browse + + Invalidate() Forces entire redraw during next stabilization + + RefreshAll() Causes all data to be recalculated during the next + stabilize + + RefreshCurrent() Causes the current row to be refilled and repainted + on next stabilize + + SetColumn( nColumn, oCol ) Replaces one TBColumn object with another + + Stabilize() Performs incremental stabilization + + DispCell( nColumn, cColor ) Displays a single cell + $EXAMPLES$ + See tests/testbrw.prg + $TESTS$ + See tests/testbrw.prg + $STATUS$ + S + $COMPLIANCE$ + This functions is Compatible with CA-Cl*pper 5.2. The applykey() and + Setkey() methods are only visible if HB_COMPAT_C53 is defined. + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + TBROWSENEW(),TBCOLUMNNEW() + $END$ */ - -/* $DOC$ - * $TEMPLATE$ - * Class - * $METHOD$ - * SetKey() - * $CATEGORY$ - * TBrowse Method - * $ONELINER$ - * Get an optionaly Set an new Code block associated to a inkey value - * $SYNTAX$ - * SetKey([,]) --> bOldBlock - * $ARGUMENTS$ - * An valid inkey Code - * - * An optional action to associate to the inkey value. - * $RETURNS$ - * If an Keypress has it code block changes, it will return - * the previus one; otherwise, it will return the current one - * $DESCRIPTION$ - * This method Get an optionaly set an code block that is associated to - * an inkey value. - * The table below show the default keypress/Code Block definitions - * - * - * Inkey Value Code Block - * - * K_DOWN {| oB, nKey | oB:Down(), 0 } - * K_END {| oB, nKey | oB:End(), 0 } - * K_CTRL_PGDN {| oB, nKey | oB:GoBottom(), 0 } - * K_CTRL_PGUP {| oB, nKey | oB:GoTop(), 0 } - * K_HOME {| oB, nKey | oB:Home(), 0 } - * K_LEFT {| oB, nKey | oB:Left(), 0 } - * K_PGDN {| oB, nKey | oB:PageDown(), 0 } - * K_PGUP {| oB, nKey | oB:PageUp(), 0 } - * K_CTRL_END {| oB, nKey | oB:PanEnd(), 0 } - * K_CTRL_HOME {| oB, nKey | oB:PanHome(), 0 } - * K_CTRL_LEFT {| oB, nKey | oB:PanLeft(), 0 } - * K_CTRL_RIGHT {| oB, nKey | oB:PanRight(), 0 } - * K_RIGHT {| oB, nKey | oB:Right(), 0 } - * K_UP {| oB, nKey | oB:Up(), 0 } - * K_ESC {| oB, nKey | -1 } - *
- * - * The keys handlers can be queried,added and replace an removed from - * the internal keyboard dictionary. See the example. - * - * oTb:SETKEY( K_TAB, {| oTb, nKey | -1 } ) - * - * An default key handler can be declared by specifyin a value of 0 - * for . It associate code block will be evaluated each time - * TBrowse:Applykey() is called with an key value that is not contained - * in the dictionary. For example - * - * oTb:SetKey( 0, {| oTb, nKey | DefKeyHandler( otb, nkey } ) - * This call the a function named DefKeyHandler() when nKey is not - * contained in the dictionary. - * - * To remove an keypress/code block definition, specify NIL for - * oTb:SetKey( K_ESC, NIL ) - * $EXAMPLES$ - * oTb:SeyKey( K_F10, {| otb, nkey | ShowListByname( otb ) } - * $END$ +/* $DOC$ + $TEMPLATE$ + Class + $METHOD$ + SetKey() + $CATEGORY$ + TBrowse Method + $ONELINER$ + Get an optionaly Set an new Code block associated to a inkey value + $SYNTAX$ + SetKey([,]) --> bOldBlock + $ARGUMENTS$ + An valid inkey Code + + An optional action to associate to the inkey value. + $RETURNS$ + If an Keypress has it code block changes, it will return + the previus one; otherwise, it will return the current one + $DESCRIPTION$ + This method Get an optionaly set an code block that is associated to + an inkey value. + The table below show the default keypress/Code Block definitions + + + Inkey Value Code Block + + K_DOWN {| oB, nKey | oB:Down(), 0 } + K_END {| oB, nKey | oB:End(), 0 } + K_CTRL_PGDN {| oB, nKey | oB:GoBottom(), 0 } + K_CTRL_PGUP {| oB, nKey | oB:GoTop(), 0 } + K_HOME {| oB, nKey | oB:Home(), 0 } + K_LEFT {| oB, nKey | oB:Left(), 0 } + K_PGDN {| oB, nKey | oB:PageDown(), 0 } + K_PGUP {| oB, nKey | oB:PageUp(), 0 } + K_CTRL_END {| oB, nKey | oB:PanEnd(), 0 } + K_CTRL_HOME {| oB, nKey | oB:PanHome(), 0 } + K_CTRL_LEFT {| oB, nKey | oB:PanLeft(), 0 } + K_CTRL_RIGHT {| oB, nKey | oB:PanRight(), 0 } + K_RIGHT {| oB, nKey | oB:Right(), 0 } + K_UP {| oB, nKey | oB:Up(), 0 } + K_ESC {| oB, nKey | -1 } +
+ + The keys handlers can be queried,added and replace an removed from + the internal keyboard dictionary. See the example. + + oTb:SETKEY( K_TAB, {| oTb, nKey | -1 } ) + + An default key handler can be declared by specifyin a value of 0 + for . It associate code block will be evaluated each time + TBrowse:Applykey() is called with an key value that is not contained + in the dictionary. For example + + oTb:SetKey( 0, {| oTb, nKey | DefKeyHandler( otb, nkey } ) + This call the a function named DefKeyHandler() when nKey is not + contained in the dictionary. + + To remove an keypress/code block definition, specify NIL for + oTb:SetKey( K_ESC, NIL ) + $EXAMPLES$ + oTb:SeyKey( K_F10, {| otb, nkey | ShowListByname( otb ) } + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Class - * $METHOD$ - * Applykey() - * $CATEGORY$ - * TBrowse Method - * $ONELINER$ - * Evaluates an code block associated with an specific key - * $SYNTAX$ - * ApplyKey() --> nResult - * $ARGUMENTS$ - * An valid Inkey code - * $RETURNS$ - * Value returned from the evaluated Code Block - * See Table Below - * - * - * Value Meaning - * -1 User request for the browse lost input focus - * 0 Code block associated with was evaluated - * 1 Unable to locate in the dictionary,Key was not processed - *
- * $DESCRIPTION$ - * This method evaluate an code block associated with that is - * contained in the TBrowse:setkey() dictionary. - * $EXAMPLES$ - * DO WHILE .T. - * oTb:forceStable() - * IF oTb:applykey( Inkey( 0 ) ) == -1 - * EXIT - * ENDIF - * ENDDO - * $END$ +/* $DOC$ + $TEMPLATE$ + Class + $METHOD$ + Applykey() + $CATEGORY$ + TBrowse Method + $ONELINER$ + Evaluates an code block associated with an specific key + $SYNTAX$ + ApplyKey() --> nResult + $ARGUMENTS$ + An valid Inkey code + $RETURNS$ + Value returned from the evaluated Code Block + See Table Below + + + Value Meaning + -1 User request for the browse lost input focus + 0 Code block associated with was evaluated + 1 Unable to locate in the dictionary,Key was not processed +
+ $DESCRIPTION$ + This method evaluate an code block associated with that is + contained in the TBrowse:setkey() dictionary. + $EXAMPLES$ + DO WHILE .T. + oTb:forceStable() + IF oTb:applykey( Inkey( 0 ) ) == -1 + EXIT + ENDIF + ENDDO + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Class - * $METHOD$ - * AddColumn() - * $CATEGORY$ - * TBrowse Method - * $ONELINER$ - * Add an New Column to an TBrowse Object - * $SYNTAX$ - * AddColumn(oCol) --> Self - * $ARGUMENTS$ - * Is an TbColumn object - * $RETURNS$ - * The Current object - * $DESCRIPTION$ - * This method add an new column object specified as to the - * assigned browsing object. - * $END$ +/* $DOC$ + $TEMPLATE$ + Class + $METHOD$ + AddColumn() + $CATEGORY$ + TBrowse Method + $ONELINER$ + Add an New Column to an TBrowse Object + $SYNTAX$ + AddColumn(oCol) --> Self + $ARGUMENTS$ + Is an TbColumn object + $RETURNS$ + The Current object + $DESCRIPTION$ + This method add an new column object specified as to the + assigned browsing object. + $END$ */ diff --git a/harbour/doc/en/tclass.txt b/harbour/doc/en/tclass.txt index f882015ab5..6d8116eeb0 100644 --- a/harbour/doc/en/tclass.txt +++ b/harbour/doc/en/tclass.txt @@ -13,63 +13,63 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HBClass() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Classes - * $ONELINER$ - * HBClass() is used in the creation of all classes - * $SYNTAX$ - * oClass := HBClass():New("TMyClass") - * - * -or- - * - * HBClass() is usually accessed by defining a class with the commands - * defined in hbclass.h: - * - * CLASS HBGetList // Calls HBClass() to create the HBGetList class - * ... - * ENDCLASS - * $ARGUMENTS$ - * - * $RETURNS$ - * An instance of the HBClass Class. This special object's :New() - * method can then create the classes you define. - * $DESCRIPTION$ - * HBClass is a class that ... - * The class methods are as follows: - * - * New() Create a new instance of the class - * $EXAMPLES$ - * FUNCTION TestObject() - * LOCAL oObject - * - * oObject := HBClass():New("TMyClass") - * oObject:End() - * - * RETURN NIL - * $STATUS$ - * R - * $COMPLIANCE$ - * Object Oriented syntax in Harbour is compatible with CA-Cl*pper. +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HBClass() + $CATEGORY$ + API + $SUBCATEGORY$ + Classes + $ONELINER$ + HBClass() is used in the creation of all classes + $SYNTAX$ + oClass := HBClass():New("TMyClass") - * However CA-Cl*pper only allowed creation of objects from a few standard - * classes, and did not let the programmer create new classes. + -or- - * In Harbour, you can create your own classes--complete with - * Methods, Instance Variables, Class Variables and Inheritance. - * Entire applications can be designed and coded in Object Oriented - * style. - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * __objHasData(),Object Oriented Programming,CLASS - * $END$ + HBClass() is usually accessed by defining a class with the commands + defined in hbclass.h: + + CLASS HBGetList // Calls HBClass() to create the HBGetList class + ... + ENDCLASS + $ARGUMENTS$ + + $RETURNS$ + An instance of the HBClass Class. This special object's :New() + method can then create the classes you define. + $DESCRIPTION$ + HBClass is a class that ... + The class methods are as follows: + + New() Create a new instance of the class + $EXAMPLES$ + FUNCTION TestObject() + LOCAL oObject + + oObject := HBClass():New("TMyClass") + oObject:End() + + RETURN NIL + $STATUS$ + R + $COMPLIANCE$ + Object Oriented syntax in Harbour is compatible with CA-Cl*pper. + + However CA-Cl*pper only allowed creation of objects from a few standard + classes, and did not let the programmer create new classes. + + In Harbour, you can create your own classes--complete with + Methods, Instance Variables, Class Variables and Inheritance. + Entire applications can be designed and coded in Object Oriented + style. + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + __objHasData(),Object Oriented Programming,CLASS + $END$ */ diff --git a/harbour/doc/en/terminal.txt b/harbour/doc/en/terminal.txt index 55ee379fdc..fd65d949c2 100644 --- a/harbour/doc/en/terminal.txt +++ b/harbour/doc/en/terminal.txt @@ -27,880 +27,884 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * __XSaveScreen() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Save whole screen image and coordinate to an internal buffer - * $SYNTAX$ - * __XSaveScreen() - * $ARGUMENTS$ - * none. - * $DESCRIPTION$ - * __XSaveScreen() save the image of the whole screen into an internal - * buffer, it also save current cursor position. The information could - * later be restored by __XRestScreen(). Each call to __XSaveScreen() - * overwrite the internal buffer. - * - * SAVE SCREEN command is preprocessed into __XSaveScreen() function - * during compile time. Note that SAVE SCREEN TO is preprocessed into - * SAVESCREEN() function. - * - * __XSaveScreen() is a compatibility function, it is superseded by - * SAVESCREEN() which allow you to save part or all the screen into a - * variable. - * $EXAMPLES$ - * // save the screen, display list of files than restore the screen - * SAVE SCREEN - * DIR *.* - * WAIT - * RESTORE SCREEN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All(GT) - * $FILES$ - * Library is rtl - * $SEEALSO$ - * RESTORE SCREEN,RESTSCREEN(),SAVESCREEN() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + __XSaveScreen() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Save whole screen image and coordinate to an internal buffer + $SYNTAX$ + __XSaveScreen() + $ARGUMENTS$ + none. + $DESCRIPTION$ + __XSaveScreen() save the image of the whole screen into an internal + buffer, it also save current cursor position. The information could + later be restored by __XRestScreen(). Each call to __XSaveScreen() + overwrite the internal buffer. + + SAVE SCREEN command is preprocessed into __XSaveScreen() function + during compile time. Note that SAVE SCREEN TO is preprocessed into + SAVESCREEN() function. + + __XSaveScreen() is a compatibility function, it is superseded by + SAVESCREEN() which allow you to save part or all the screen into a + variable. + $EXAMPLES$ + // save the screen, display list of files than restore the screen + SAVE SCREEN + DIR *.* + WAIT + RESTORE SCREEN + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All(GT) + $FILES$ + Library is rtl + $SEEALSO$ + RESTORE SCREEN,RESTSCREEN(),SAVESCREEN() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * SAVE SCREEN - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * Save whole screen image and coordinate to an internal buffer - * $SYNTAX$ - * SAVE SCREEN - * $ARGUMENTS$ - * none. - * $DESCRIPTION$ - * SAVE SCREEN save the image of the whole screen into an internal - * buffer, it also save current cursor position. The information could - * later be restored by REST SCREEN. Each call to SAVE SCREEN - * overwrite the internal buffer. - * - * SAVE SCREEN command is preprocessed into __XSaveScreen() function - * during compile time. Note that SAVE SCREEN TO is preprocessed into - * SAVESCREEN() function. - * $EXAMPLES$ - * // save the screen, display list of files than restore the screen - * SAVE SCREEN - * DIR *.* - * WAIT - * RESTORE SCREEN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All(GT) - * $SEEALSO$ - * RESTORE SCREEN,__XRESTSCREEN(),__XSAVESCREEN() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + SAVE SCREEN + $CATEGORY$ + API + $SUBCATEGORY$ + Terminal + $ONELINER$ + Save whole screen image and coordinate to an internal buffer + $SYNTAX$ + SAVE SCREEN + $ARGUMENTS$ + none. + $DESCRIPTION$ + SAVE SCREEN save the image of the whole screen into an internal + buffer, it also save current cursor position. The information could + later be restored by REST SCREEN. Each call to SAVE SCREEN + overwrite the internal buffer. + + SAVE SCREEN command is preprocessed into __XSaveScreen() function + during compile time. Note that SAVE SCREEN TO is preprocessed into + SAVESCREEN() function. + $EXAMPLES$ + // save the screen, display list of files than restore the screen + SAVE SCREEN + DIR *.* + WAIT + RESTORE SCREEN + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All(GT) + $SEEALSO$ + RESTORE SCREEN,__XRESTSCREEN(),__XSAVESCREEN() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * __XRestScreen() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Restore screen image and coordinate from an internal buffer - * $SYNTAX$ - * __XRestScreen() - * $ARGUMENTS$ - * none. - * $DESCRIPTION$ - * __XRestScreen() restore saved image of the whole screen from an - * internal buffer that was saved by __XSaveScreen(), it also restore - * cursor position. After a call to __XRestScreen() the internal buffer - * is cleared. - * - * RESTORE SCREEN command is preprocessed into __XRestScreen() function - * during compile time. Note that RESTORE SCREEN FROM is preprocessed - * into RESTSCREEN() function. - * - * __XRestScreen() is a compatibility function, it is superseded by - * RESTSCREEN() which allow you to restore the screen from a variable. - * $EXAMPLES$ - * // save the screen, display list of files than restore the screen - * SAVE SCREEN - * DIR *.* - * WAIT - * RESTORE SCREEN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All(GT) - * $FILES$ - * Library is rtl - * $SEEALSO$ - * __XRESTSCREEN(),SAVE SCREEN,__XSAVESCREEN() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + __XRestScreen() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Restore screen image and coordinate from an internal buffer + $SYNTAX$ + __XRestScreen() + $ARGUMENTS$ + none. + $DESCRIPTION$ + __XRestScreen() restore saved image of the whole screen from an + internal buffer that was saved by __XSaveScreen(), it also restore + cursor position. After a call to __XRestScreen() the internal buffer + is cleared. + + RESTORE SCREEN command is preprocessed into __XRestScreen() function + during compile time. Note that RESTORE SCREEN FROM is preprocessed + into RESTSCREEN() function. + + __XRestScreen() is a compatibility function, it is superseded by + RESTSCREEN() which allow you to restore the screen from a variable. + $EXAMPLES$ + // save the screen, display list of files than restore the screen + SAVE SCREEN + DIR *.* + WAIT + RESTORE SCREEN + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All(GT) + $FILES$ + Library is rtl + $SEEALSO$ + __XRESTSCREEN(),SAVE SCREEN,__XSAVESCREEN() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * RESTORE SCREEN - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * Restore screen image and coordinate from an internal buffer - * $SYNTAX$ - * RESTORE SCREEN - * $ARGUMENTS$ - * none. - * $DESCRIPTION$ - * Rest Screen restore saved image of the whole screen from an - * internal buffer that was saved by Save Screen, it also restore - * cursor position. After a call to Rest Screen the internal buffer - * is cleared. - * - * RESTORE SCREEN command is preprocessed into __XRestScreen() function - * during compile time. Note that RESTORE SCREEN FROM is preprocessed - * into RESTSCREEN() function. - * $EXAMPLES$ - * // save the screen, display list of files than restore the screen - * SAVE SCREEN - * DIR *.* - * WAIT - * RESTORE SCREEN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All(GT) - * $SEEALSO$ - * __XRESTSCREEN(),SAVE SCREEN,__XSAVESCREEN() - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + RESTORE SCREEN + $CATEGORY$ + API + $SUBCATEGORY$ + Terminal + $ONELINER$ + Restore screen image and coordinate from an internal buffer + $SYNTAX$ + RESTORE SCREEN + $ARGUMENTS$ + none. + $DESCRIPTION$ + Rest Screen restore saved image of the whole screen from an + internal buffer that was saved by Save Screen, it also restore + cursor position. After a call to Rest Screen the internal buffer + is cleared. + + RESTORE SCREEN command is preprocessed into __XRestScreen() function + during compile time. Note that RESTORE SCREEN FROM is preprocessed + into RESTSCREEN() function. + $EXAMPLES$ + // save the screen, display list of files than restore the screen + SAVE SCREEN + DIR *.* + WAIT + RESTORE SCREEN + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All(GT) + $SEEALSO$ + __XRESTSCREEN(),SAVE SCREEN,__XSAVESCREEN() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ALERT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Display a dialog box with a message - * $SYNTAX$ - * ALERT( , [], [], [] ) --> nChoice or NIL - * $ARGUMENTS$ - * Message to display in the dialog box. can be - * of any Harbour type. - * If is an array of Character strings, each element would - * be displayed in a new line. If is a Character - * string, you could split the message to several lines by placing - * a semicolon (;) in the desired places. - * - * Array with available response. Each element should be - * Character string. If omitted, default is { "Ok" }. - * - * Color string to paint the dialog box with. - * If omitted, default color is "W+/R". - * - * Number of seconds to wait to user response before abort. - * Default value is 0, that wait forever. - * $RETURNS$ - * ALERT() return Numeric value representing option number chosen. - * - * If ESC was pressed, return value is zero. - * - * The return value is NIL - * if ALERT() is called with no parameters, or if type is - * not Character and HB_CLP_STRICT option was used. If seconds - * had passed without user response, the return value is 1. - * $DESCRIPTION$ - * ALERT() display simple dialog box on screen and let the user select - * one option. The user can move the highlight bar using arrow keys or - * TAB key. To select an option the user can press ENTER, SPACE or the - * first letter of the option. - * - * If the program is executed with the //NOALERT command line switch, - * nothing is displayed and it simply returns NIL. This switch could - * be overridden with __NONOALERT(). - * - * If the GT system is linked in, ALERT() display the message using - * the full screen I/O system, if not, the information is printed to - * the standard output using OUTSTD(). - * $EXAMPLES$ - * LOCAL cMessage, aOptions, nChoice - * - * // harmless message - * cMessage := "Major Database Corruption Detected!;" + ; - * "(deadline in few hours);;" + ; - * "where DO you want to go today?" - * - * // define response option - * aOptions := { "Ok", "www.jobs.com", "Oops" } - * - * // show message and let end user select panic level - * nChoice := ALERT( cMessage, aOptions ) - * DO CASE - * CASE nChoice == 0 - * // do nothing, blame it on some one else - * CASE nChoice == 1 - * ? "Please call home and tell them you're gonn'a be late" - * CASE nChoice == 2 - * // make sure your resume is up to date - * CASE nChoice == 3 - * ? "Oops mode is not working in this version" - * ENDCASE - * $STATUS$ - * R - * $COMPLIANCE$ - * This function is sensitive to HB_CLP_STRICT settings during the - * compilation of src/rtl/alert.prg - * - * defined: accept Character values only and return - * NIL if other types are passed. - * - * undefined: could be any type, and internally - * converted to Character string. If type is Array, multi-line message - * is displayed. - * - * defined: Only the first four valid are taken. - * - * undefined: could contain as many as needed options. - * - * If HB_COMPAT_C53 was define during compilation of - * src/rtl/alert.prg the Left-Mouse button could be used to select - * an option. - * - * The interpretation of the //NOALERT command line switch is done only - * if HB_CLP_UNDOC was define during compilation of src/rtl/alert.prg - * - * is a Harbour extension, or at least un-documented - * in Clipper 5.2 NG. - * - * is a Harbour extension. - * $FILES$ - * Library is rtl - * $SEEALSO$ - * @...PROMPT,MENU TO,OUTSTD(),__NONOALERT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ALERT() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Display a dialog box with a message + $SYNTAX$ + ALERT( , [], [], [] ) --> nChoice or NIL + $ARGUMENTS$ + Message to display in the dialog box. can be + of any Harbour type. + If is an array of Character strings, each element would + be displayed in a new line. If is a Character + string, you could split the message to several lines by placing + a semicolon (;) in the desired places. + + Array with available response. Each element should be + Character string. If omitted, default is { "Ok" }. + + Color string to paint the dialog box with. + If omitted, default color is "W+/R". + + Number of seconds to wait to user response before abort. + Default value is 0, that wait forever. + $RETURNS$ + ALERT() return Numeric value representing option number chosen. + + If ESC was pressed, return value is zero. + + The return value is NIL + if ALERT() is called with no parameters, or if type is + not Character and HB_CLP_STRICT option was used. If seconds + had passed without user response, the return value is 1. + $DESCRIPTION$ + ALERT() display simple dialog box on screen and let the user select + one option. The user can move the highlight bar using arrow keys or + TAB key. To select an option the user can press ENTER, SPACE or the + first letter of the option. + + If the program is executed with the //NOALERT command line switch, + nothing is displayed and it simply returns NIL. This switch could + be overridden with __NONOALERT(). + + If the GT system is linked in, ALERT() display the message using + the full screen I/O system, if not, the information is printed to + the standard output using OUTSTD(). + $EXAMPLES$ + LOCAL cMessage, aOptions, nChoice + + // harmless message + cMessage := "Major Database Corruption Detected!;" + ; + "(deadline in few hours);;" + ; + "where DO you want to go today?" + + // define response option + aOptions := { "Ok", "www.jobs.com", "Oops" } + + // show message and let end user select panic level + nChoice := ALERT( cMessage, aOptions ) + DO CASE + CASE nChoice == 0 + // do nothing, blame it on some one else + CASE nChoice == 1 + ? "Please call home and tell them you're gonn'a be late" + CASE nChoice == 2 + // make sure your resume is up to date + CASE nChoice == 3 + ? "Oops mode is not working in this version" + ENDCASE + $STATUS$ + R + $COMPLIANCE$ + This function is sensitive to HB_CLP_STRICT settings during the + compilation of src/rtl/alert.prg + + defined: accept Character values only and return + NIL if other types are passed. + + undefined: could be any type, and internally + converted to Character string. If type is Array, multi-line message + is displayed. + + defined: Only the first four valid are taken. + + undefined: could contain as many as needed options. + + If HB_COMPAT_C53 was define during compilation of + src/rtl/alert.prg the Left-Mouse button could be used to select + an option. + + The interpretation of the //NOALERT command line switch is done only + if HB_CLP_UNDOC was define during compilation of src/rtl/alert.prg + + is a Harbour extension, or at least un-documented + in Clipper 5.2 NG. + + is a Harbour extension. + $FILES$ + Library is rtl + $SEEALSO$ + @...PROMPT,MENU TO,OUTSTD(),__NONOALERT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * __NONOALERT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Override //NOALERT command line switch - * $SYNTAX$ - * __NONOALERT() - * $ARGUMENTS$ - * This function takes no arguments. - * $DESCRIPTION$ - * The //NOALERT command line switch cause Clipper to ignore calls to - * the ALERT() function, this function override this behavior - * and always display ALERT() dialog box. - * $EXAMPLES$ - * // make sure alert are been displayed - * __NONOALERT() - * $STATUS$ - * R - * $FILES$ - * Library is rtl - * $COMPLIANCE$ - * C52U - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + __NONOALERT() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Override //NOALERT command line switch + $SYNTAX$ + __NONOALERT() + $ARGUMENTS$ + This function takes no arguments. + $DESCRIPTION$ + The //NOALERT command line switch cause Clipper to ignore calls to + the ALERT() function, this function override this behavior + and always display ALERT() dialog box. + $EXAMPLES$ + // make sure alert are been displayed + __NONOALERT() + $STATUS$ + R + $FILES$ + Library is rtl + $COMPLIANCE$ + C52U + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_eol() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Environment - * $ONELINER$ - * Returns the newline character(s) to use with the current OS - * $SYNTAX$ - * hb_eol() --> cString - * $RETURNS$ - * A character string containing the character or characters - * required to move the screen cursor or print head to the start of a - * new line. - * $DESCRIPTION$ - * Returns a character string containing the character or characters - * required to move the screen cursor or print head to the start of a - * new line for the operating system that the program is running on - * (or thinks it is running on, if an OS emulator is being used). - * - * Under HB_OS_UNIX operating system the return value is the - * Line-Feed character (0x0a, Chr( 10 ) ); with other operating systems - * (like DOS) the return value is the Carriage-Return plus Line-Feed - * characters (0x0d 0x0a, Chr( 13 ) + Chr( 10 )). - * $EXAMPLES$ - * // Get the newline character(s) for the current OS. - * // Get the newline character(s) for the current OS. - * STATIC s_cNewLine - * ... - * s_cNewLine := hb_eol() - * ... - * OutStd( "Hello World!" + s_cNewLine ) - * $TESTS$ - * ? ValType( hb_eol() ) == "C" - * ? Len( hb_eol() ) == 1 - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * OS(),OUTSTD(),OUTERR() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_eol() + $CATEGORY$ + API + $SUBCATEGORY$ + Environment + $ONELINER$ + Returns the newline character(s) to use with the current OS + $SYNTAX$ + hb_eol() --> cString + $RETURNS$ + A character string containing the character or characters + required to move the screen cursor or print head to the start of a + new line. + $DESCRIPTION$ + Returns a character string containing the character or characters + required to move the screen cursor or print head to the start of a + new line for the operating system that the program is running on + (or thinks it is running on, if an OS emulator is being used). + + Under HB_OS_UNIX operating system the return value is the + Line-Feed character (0x0a, Chr( 10 ) ); with other operating systems + (like DOS) the return value is the Carriage-Return plus Line-Feed + characters (0x0d 0x0a, Chr( 13 ) + Chr( 10 )). + $EXAMPLES$ + // Get the newline character(s) for the current OS. + // Get the newline character(s) for the current OS. + STATIC s_cNewLine + ... + s_cNewLine := hb_eol() + ... + OutStd( "Hello World!" + s_cNewLine ) + $TESTS$ + ? ValType( hb_eol() ) == "C" + ? Len( hb_eol() ) == 1 + $STATUS$ + R + $COMPLIANCE$ + H + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + OS(),OUTSTD(),OUTERR() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * hb_ColorIndex() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * Extract one color from a full colorspec string. - * $SYNTAX$ - * hb_ColorIndex( , ) --> - * $ARGUMENTS$ - * is a color list - * - * is the position of the color item to be extracted, the - * first position is the zero. - * $RETURNS$ - * The selected color string, or if anything goes wrong, an empty - * string. - * $DESCRIPTION$ - * CA-Cl*pper has a color spec string, which has more than one - * color in it, separated with commas. - * - * This function will extract - * a given item from this list. You may use the manifest constants - * defined in color.ch to identify and extract common colors. - * $EXAMPLES$ - * ? hb_ColorIndex( "W/N, N/W", CLR_ENHANCED ) // "N/W" - * $TESTS$ - * see the regression test suit for comprehensive tests. - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ColorSelect() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + hb_ColorIndex() + $CATEGORY$ + API + $SUBCATEGORY$ + Terminal + $ONELINER$ + Extract one color from a full colorspec string. + $SYNTAX$ + hb_ColorIndex( , ) --> + $ARGUMENTS$ + is a color list + + is the position of the color item to be extracted, the + first position is the zero. + $RETURNS$ + The selected color string, or if anything goes wrong, an empty + string. + $DESCRIPTION$ + CA-Cl*pper has a color spec string, which has more than one + color in it, separated with commas. + + This function will extract + a given item from this list. You may use the manifest constants + defined in color.ch to identify and extract common colors. + $EXAMPLES$ + ? hb_ColorIndex( "W/N, N/W", CLR_ENHANCED ) // "N/W" + $TESTS$ + see the regression test suit for comprehensive tests. + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is rtl + $SEEALSO$ + ColorSelect() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * DEVOUTPICT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * Displays a value to a device using a picture template - * $SYNTAX$ - * DEVOUTPICT( , , [] ) - * $ARGUMENTS$ - * is any valid expression. - * - * is any picture transformation that TRANSFORM() can use. - * - * is an optional string that specifies a screen color to - * use in place of the default color when the output goes to the screen. - * $DESCRIPTION$ - * Outputs any expression using a picture transformation instead of - * using the default transformation for the type of expression. - * $EXAMPLES$ - * // Output a negative dollar amount using debit notation. - * DEVOUTPICT( -1.25, "@D$ 99,999.99 ) - * $TESTS$ - * @ 3, 1 SAY -1.25 PICTURE "@D$ 99,999.99" - * will display "$( 1.25)" starting on row four, column two of the - * current device (without the double quotation marks, of course). - * $STATUS$ - * R - * $COMPLIANCE$ - * DEVOUTPICT() is mostly CA-Cl*pper compliant. Any differences are due - * to enhancements in the Harbour TRANSFORM() over CA-Cl*pper. - * $FILES$ - * Library is rtl - * $SEEALSO$ - * DEVOUT(),TRANSFORM() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + DEVOUTPICT() + $CATEGORY$ + API + $SUBCATEGORY$ + Terminal + $ONELINER$ + Displays a value to a device using a picture template + $SYNTAX$ + DEVOUTPICT( , , [] ) + $ARGUMENTS$ + is any valid expression. + + is any picture transformation that TRANSFORM() can use. + + is an optional string that specifies a screen color to + use in place of the default color when the output goes to the screen. + $DESCRIPTION$ + Outputs any expression using a picture transformation instead of + using the default transformation for the type of expression. + $EXAMPLES$ + // Output a negative dollar amount using debit notation. + DEVOUTPICT( -1.25, "@D$ 99,999.99 ) + $TESTS$ + @ 3, 1 SAY -1.25 PICTURE "@D$ 99,999.99" + will display "$( 1.25)" starting on row four, column two of the + current device (without the double quotation marks, of course). + $STATUS$ + R + $COMPLIANCE$ + DEVOUTPICT() is mostly CA-Cl*pper compliant. Any differences are due + to enhancements in the Harbour TRANSFORM() over CA-Cl*pper. + $FILES$ + Library is rtl + $SEEALSO$ + DEVOUT(),TRANSFORM() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __INPUT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Stops application - * $SYNTAX$ - * __INPUT( ) --> - * $ARGUMENTS$ - * is any valid expression. - * $RETURNS$ - * input value macroed - * $DESCRIPTION$ - * This function waits for a console input and returns macroed - * expression entered. - * $STATUS$ - * S - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * __WAIT(),__ACCEPT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __INPUT() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Stops application + $SYNTAX$ + __INPUT( ) --> + $ARGUMENTS$ + is any valid expression. + $RETURNS$ + input value macroed + $DESCRIPTION$ + This function waits for a console input and returns macroed + expression entered. + $STATUS$ + S + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + __WAIT(),__ACCEPT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * __TextSave() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Internal - * $ONELINER$ - * Redirect console output to printer or file and save old settings - * $SYNTAX$ - * __TextSave( ) - * $ARGUMENTS$ - * is either "PRINTER" (note the uppercase) in which console - * output is SET to PRINTER, or a name of a text file with a default - * ".txt" extension, that is used to redirect console output. - * $DESCRIPTION$ - * __TextSave() is used in the preprocessing of the TEXT TO command to - * redirect the console output while saving old settings that can be - * restored later by __TextRestore(). - * $STATUS$ - * R - * $COMPLIANCE$ - * C52U - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * SET(),SET ALTERNATE,SET PRINTER,TEXT,__TextRestore() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + __TextSave() + $CATEGORY$ + API + $SUBCATEGORY$ + Internal + $ONELINER$ + Redirect console output to printer or file and save old settings + $SYNTAX$ + __TextSave( ) + $ARGUMENTS$ + is either "PRINTER" (note the uppercase) in which console + output is SET to PRINTER, or a name of a text file with a default + ".txt" extension, that is used to redirect console output. + $DESCRIPTION$ + __TextSave() is used in the preprocessing of the TEXT TO command to + redirect the console output while saving old settings that can be + restored later by __TextRestore(). + $STATUS$ + R + $COMPLIANCE$ + C52U + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + SET(),SET ALTERNATE,SET PRINTER,TEXT,__TextRestore() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * __TextRestore() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Internal - * $ONELINER$ - * Restore console output settings as saved by __TextSave() - * $SYNTAX$ - * __TextRestore() - * $ARGUMENTS$ - * none. - * $DESCRIPTION$ - * __TextRestore() is used in the preprocessing of the TEXT TO command - * to restore console output settings that were previously saved by - * __TextSave(). - * $STATUS$ - * R - * $COMPLIANCE$ - * C52U - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * SET(),SET ALTERNATE,SET PRINTER,TEXT,__TextSave() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + __TextRestore() + $CATEGORY$ + API + $SUBCATEGORY$ + Internal + $ONELINER$ + Restore console output settings as saved by __TextSave() + $SYNTAX$ + __TextRestore() + $ARGUMENTS$ + none. + $DESCRIPTION$ + __TextRestore() is used in the preprocessing of the TEXT TO command + to restore console output settings that were previously saved by + __TextSave(). + $STATUS$ + R + $COMPLIANCE$ + C52U + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + SET(),SET ALTERNATE,SET PRINTER,TEXT,__TextSave() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __WAIT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Events - * $ONELINER$ - * Stops the application until a key is pressed. - * $SYNTAX$ - * __WAIT( ) --> - * $ARGUMENTS$ - * is a string. - * $RETURNS$ - * Pressed key. - * $DESCRIPTION$ - * This function stops the application until a key is pressed. The key - * must be in the range 32..255. Control keys are not processed. - * $EXAMPLES$ - * // Wait for a key stroke - * __Wait( "Press a key to continue" ) - * $TESTS$ - * DO WHILE !( cKey == "Q" ) - * cKey := __Wait( "Press 'Q' to continue" ) - * ENDDO - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $FILES$ - * Library is rtl - * $SEEALSO$ - * __ACCEPT(),__INPUT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __WAIT() + $CATEGORY$ + API + $SUBCATEGORY$ + Events + $ONELINER$ + Stops the application until a key is pressed. + $SYNTAX$ + __WAIT( ) --> + $ARGUMENTS$ + is a string. + $RETURNS$ + Pressed key. + $DESCRIPTION$ + This function stops the application until a key is pressed. The key + must be in the range 32..255. Control keys are not processed. + $EXAMPLES$ + // Wait for a key stroke + __Wait( "Press a key to continue" ) + $TESTS$ + DO WHILE !( cKey == "Q" ) + cKey := __Wait( "Press 'Q' to continue" ) + ENDDO + $STATUS$ + R + $COMPLIANCE$ + C + $FILES$ + Library is rtl + $SEEALSO$ + __ACCEPT(),__INPUT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * OUTSTD() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Write a list of values to the standard output device - * $SYNTAX$ - * OUTSTD( ) - * $ARGUMENTS$ - * is a list of expressions to display. Expressions are any - * mixture of Harbour data types. - * $DESCRIPTION$ - * OUTSTD() write one or more values into the standard output device. - * Character and Memo values are printed as is, Dates are printed - * according to the SET DATE FORMAT, Numeric values are converted to - * strings, Logical values are printed as .T. or .F., NIL are printed - * as NIL, values of any other kind are printed as empty string. There - * is one space separating each two values. Note that Numeric value can - * take varying length when converted into string depending on its - * source (see STR() for detail). - * - * OUTSTD() is similar to QQOUT() with the different that QQOUT() send - * its output to the Harbour console stream, which can or can not be - * redirected according with the screen driver, and OUTSTD() send its - * output to the standard output device (STDOUT) and can be redirected. - * $EXAMPLES$ - * OUTSTD( "Hello" ) // Result: Hello - * - * OUTSTD( 1, .T., NIL, "A" ) - * OUTSTD( "B" ) // Result: 1 .T. NIL AB - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ?,??,DEVOUT(),DEVOUTPICT(),DISPOUT(),DISPOUTAT(),OUTERR(),QOUT(),QQOUT(),STR() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + OUTSTD() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Write a list of values to the standard output device + $SYNTAX$ + OUTSTD( ) + $ARGUMENTS$ + is a list of expressions to display. Expressions are any + mixture of Harbour data types. + $DESCRIPTION$ + OUTSTD() write one or more values into the standard output device. + Character and Memo values are printed as is, Dates are printed + according to the SET DATE FORMAT, Numeric values are converted to + strings, Logical values are printed as .T. or .F., NIL are printed + as NIL, values of any other kind are printed as empty string. There + is one space separating each two values. Note that Numeric value can + take varying length when converted into string depending on its + source (see STR() for detail). + + OUTSTD() is similar to QQOUT() with the different that QQOUT() send + its output to the Harbour console stream, which can or can not be + redirected according with the screen driver, and OUTSTD() send its + output to the standard output device (STDOUT) and can be redirected. + $EXAMPLES$ + OUTSTD( "Hello" ) // Result: Hello + + OUTSTD( 1, .T., NIL, "A" ) + OUTSTD( "B" ) // Result: 1 .T. NIL AB + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + + $FILES$ + Library is rtl + $SEEALSO$ + ?,??,DEVOUT(),DEVOUTPICT(),DISPOUT(),DISPOUTAT(),OUTERR(),QOUT(),QQOUT(),STR() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * OUTERR() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Write a list of values to the standard error device - * $SYNTAX$ - * OUTERR( ) - * $ARGUMENTS$ - * is a list of expressions to display. Expressions are any - * mixture of Harbour data types. - * $DESCRIPTION$ - * OUTERR() write one or more values into the standard error device. - * Character and Memo values are printed as is, Dates are printed - * according to the SET DATE FORMAT, Numeric values are converted to - * strings, Logical values are printed as .T. or .F., NIL are printed - * as NIL, values of any other kind are printed as empty string. There - * is one space separating each two values. Note that Numeric value can - * take varying length when converted into string depending on its - * source (see STR() for detail). - * - * There is an undocumented CA-Cl*pper command line switch //STDERR - * which can set the file handle to write output from OUTERR(). If not - * specified the default STDERR is used, //STDERR or //STDERR:0 set - * OUTERR() to output to the same file handle as OUTSTD(), //STDERR:n - * set output to file handle n. Like other undocumented features this - * switch is available only if src/rtl/console.c was compiled with - * the HB_CLP_UNDOC flag. - * $EXAMPLES$ - * // write error log information - * OUTERR( DATE(), TIME(), "Core meltdown detected" ) - * $TESTS$ - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ?,??,DEVOUT(),DEVOUTPICT(),DISPOUT(),DISPOUTAT(),OUTSTD(),QOUT(),QQOUT(),STR() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + OUTERR() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Write a list of values to the standard error device + $SYNTAX$ + OUTERR( ) + $ARGUMENTS$ + is a list of expressions to display. Expressions are any + mixture of Harbour data types. + $DESCRIPTION$ + OUTERR() write one or more values into the standard error device. + Character and Memo values are printed as is, Dates are printed + according to the SET DATE FORMAT, Numeric values are converted to + strings, Logical values are printed as .T. or .F., NIL are printed + as NIL, values of any other kind are printed as empty string. There + is one space separating each two values. Note that Numeric value can + take varying length when converted into string depending on its + source (see STR() for detail). + + There is an undocumented CA-Cl*pper command line switch //STDERR + which can set the file handle to write output from OUTERR(). If not + specified the default STDERR is used, //STDERR or //STDERR:0 set + OUTERR() to output to the same file handle as OUTSTD(), //STDERR:n + set output to file handle n. Like other undocumented features this + switch is available only if src/rtl/console.c was compiled with + the HB_CLP_UNDOC flag. + $EXAMPLES$ + // write error log information + OUTERR( DATE(), TIME(), "Core meltdown detected" ) + $TESTS$ + + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + + $FILES$ + Library is rtl + $SEEALSO$ + ?,??,DEVOUT(),DEVOUTPICT(),DISPOUT(),DISPOUTAT(),OUTSTD(),QOUT(),QQOUT(),STR() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Procedure - * $NAME$ - * EJECT - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Printer - * $ONELINER$ - * Issue an command to advance the printer to the top of the form - * $SYNTAX$ - * EJECT - * $ARGUMENTS$ - * None - * $DESCRIPTION$ - * This command issue an form-feed command to the printer. If the printer - * is not properly hooked up to the computer,an error will not be - * generated and the command will be ignored. - * - * Once completed,the values of PROW() and PCOL(),the row and column - * indicators to the printer,will be set to 0. Their values,however,may - * be manipulated before or after ussuing an EJECT by using the DEVPOS() - * function. - * - * On compile time this command is translated into __EJECT() function. - * $EXAMPLES$ - * Use Clientes New - * Set Device to Printer - * CurPos:=0 - * While !Eof() - * ? Clientes->nome,Clientes->endereco - * Curpos++ - * if Curpos >59 - * Curpos:=0 - * Eject - * Endif - * Enddo - * Set Device to Screen - * Use - * $TESTS$ - * See examples - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $SEEALSO$ - * DEVPOS(),SET PRINTER,PROW(),PCOL() - * $END$ +/* $DOC$ + $TEMPLATE$ + Procedure + $NAME$ + EJECT + $CATEGORY$ + Command + $SUBCATEGORY$ + Printer + $ONELINER$ + Issue an command to advance the printer to the top of the form + $SYNTAX$ + EJECT + $ARGUMENTS$ + None + $DESCRIPTION$ + This command issue an form-feed command to the printer. If the printer + is not properly hooked up to the computer,an error will not be + generated and the command will be ignored. + + Once completed,the values of PROW() and PCOL(),the row and column + indicators to the printer,will be set to 0. Their values,however,may + be manipulated before or after ussuing an EJECT by using the DEVPOS() + function. + + On compile time this command is translated into __EJECT() function. + $EXAMPLES$ + Use Clientes New + Set Device to Printer + CurPos:=0 + While !Eof() + ? Clientes->nome,Clientes->endereco + Curpos++ + if Curpos >59 + Curpos:=0 + Eject + Endif + Enddo + Set Device to Screen + Use + $TESTS$ + See examples + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $SEEALSO$ + DEVPOS(),SET PRINTER,PROW(),PCOL() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * COL() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * Returns the current screen column position - * $SYNTAX$ - * COL() --> nPosition - * $ARGUMENTS$ - * None. - * $RETURNS$ - * Current column position - * $DESCRIPTION$ - * This function returns the current cursor column position. The value - * for this function can range between 0 and MAXCOL(). - * $EXAMPLES$ - * ? Col() - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ROW(),MAXROW(),MAXCOL() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + COL() + $CATEGORY$ + API + $SUBCATEGORY$ + Terminal + $ONELINER$ + Returns the current screen column position + $SYNTAX$ + COL() --> nPosition + $ARGUMENTS$ + None. + $RETURNS$ + Current column position + $DESCRIPTION$ + This function returns the current cursor column position. The value + for this function can range between 0 and MAXCOL(). + $EXAMPLES$ + ? Col() + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + ROW(),MAXROW(),MAXCOL() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * ROW() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * Returns the current screen row position - * $SYNTAX$ - * ROW() --> nPosition - * $ARGUMENTS$ - * None. - * $RETURNS$ - * Current screen row position - * $DESCRIPTION$ - * This function returns the current cursor row location. The value - * for this function can range between 0 and MAXCOL(). - * $EXAMPLES$ - * ? Row() - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * COL(),MAXROW(),MAXCOL() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + ROW() + $CATEGORY$ + API + $SUBCATEGORY$ + Terminal + $ONELINER$ + Returns the current screen row position + $SYNTAX$ + ROW() --> nPosition + $ARGUMENTS$ + None. + $RETURNS$ + Current screen row position + $DESCRIPTION$ + This function returns the current cursor row location. The value + for this function can range between 0 and MAXCOL(). + $EXAMPLES$ + ? Row() + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + COL(),MAXROW(),MAXCOL() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * MAXCOL() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * Returns the maximun number of columns in the current video mode - * $SYNTAX$ - * MAXCOL() --> nPosition - * $ARGUMENTS$ - * None. - * $RETURNS$ - * The maximun number of columns possible in current video - * mode - * $DESCRIPTION$ - * This function returns the current cursor column position. The value - * for this function can range between 0 and MAXCOL(). - * $EXAMPLES$ - * ? MAXCol() - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * Linux(GT),OS2(GT),Win(GT) - * $FILES$ - * Library is rtl - * $SEEALSO$ - * ROW(),MAXROW(),COL() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + MAXCOL() + $CATEGORY$ + API + $SUBCATEGORY$ + Terminal + $ONELINER$ + Returns the maximun number of columns in the current video mode + $SYNTAX$ + MAXCOL() --> nPosition + $ARGUMENTS$ + None. + $RETURNS$ + The maximun number of columns possible in current video + mode + $DESCRIPTION$ + This function returns the current cursor column position. The value + for this function can range between 0 and MAXCOL(). + $EXAMPLES$ + ? MAXCol() + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + Linux(GT),OS2(GT),Win(GT) + $FILES$ + Library is rtl + $SEEALSO$ + ROW(),MAXROW(),COL() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * MAXROW() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Terminal - * $ONELINER$ - * Returns the current screen row position - * $SYNTAX$ - * MAXROW() --> nPosition - * $ARGUMENTS$ - * None. - * $RETURNS$ - * The maximun number of rows possible in current video - * mode - * $DESCRIPTION$ - * This function returns the current cursor row location. The value - * for this function can range between 0 and MAXCOL(). - * $EXAMPLES$ - * ? MAXROW() - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * Linux(GT),OS2(GT),Win(GT) - * $FILES$ - * Library is rtl - * $SEEALSO$ - * COL(),ROW(),MAXCOL() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + MAXROW() + $CATEGORY$ + API + $SUBCATEGORY$ + Terminal + $ONELINER$ + Returns the current screen row position + $SYNTAX$ + MAXROW() --> nPosition + $ARGUMENTS$ + None. + $RETURNS$ + The maximun number of rows possible in current video + mode + $DESCRIPTION$ + This function returns the current cursor row location. The value + for this function can range between 0 and MAXCOL(). + $EXAMPLES$ + ? MAXROW() + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + Linux(GT),OS2(GT),Win(GT) + $FILES$ + Library is rtl + $SEEALSO$ + COL(),ROW(),MAXCOL() + $END$ */ diff --git a/harbour/doc/en/tgetlist.txt b/harbour/doc/en/tgetlist.txt index db207218ae..e69375deea 100644 --- a/harbour/doc/en/tgetlist.txt +++ b/harbour/doc/en/tgetlist.txt @@ -13,57 +13,57 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * READVAR() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * User interface - * $ONELINER$ - * Return variable name of current GET or MENU - * $SYNTAX$ - * READVAR( [] ) --> cOldVarName - * $ARGUMENTS$ - * is a new variable name to set. - * $RETURNS$ - * READVAR() return the old variable name. If no variable previously - * was set, READVAR() return "". - * $DESCRIPTION$ - * READVAR() is set inside a READ or MENU TO command to hold the - * uppercase name of the GET / MENU TO variable, and re-set back to old - * value when those commands finished. You should not normally set a - * variable name but rather use it to retrieve the name of a GET - * variable when executing a VALID or WHEN clause, or during SET KEY - * execution and you are inside a READ or MENU TO. - * $EXAMPLES$ - * // display a menu, press F1 to view the MENU TO variable name - * CLS - * @ 1, 10 PROMPT "blood sucking insect that infect beds " - * @ 2, 10 PROMPT "germ; virus infection " - * @ 3, 10 PROMPT "defect; snag; (source of) malfunctioning" - * @ 4, 10 PROMPT "small hidden microphone " - * @ 6, 10 SAY "(Press F1 for a hint)" - * SET KEY 28 TO ShowVar - * MENU TO What_Is_Bug - * - * PROCEDURE ShowVar - * Alert( ReadVar() ) // WHAT_IS_BUG in red ALERT() box - * $STATUS$ - * R - * $COMPLIANCE$ - * READVAR() works exactly like CA-Cl*pper's READKEY(). - * - * Note however, - * that the parameter is not documented and used internally - * by CA-Cl*pper. - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * @...GET,@...PROMPT,MENU TO,READ,SET KEY,__AtPrompt(),__MenuTo() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + READVAR() + $CATEGORY$ + API + $SUBCATEGORY$ + User interface + $ONELINER$ + Return variable name of current GET or MENU + $SYNTAX$ + READVAR( [] ) --> cOldVarName + $ARGUMENTS$ + is a new variable name to set. + $RETURNS$ + READVAR() return the old variable name. If no variable previously + was set, READVAR() return "". + $DESCRIPTION$ + READVAR() is set inside a READ or MENU TO command to hold the + uppercase name of the GET / MENU TO variable, and re-set back to old + value when those commands finished. You should not normally set a + variable name but rather use it to retrieve the name of a GET + variable when executing a VALID or WHEN clause, or during SET KEY + execution and you are inside a READ or MENU TO. + $EXAMPLES$ + // display a menu, press F1 to view the MENU TO variable name + CLS + @ 1, 10 PROMPT "blood sucking insect that infect beds " + @ 2, 10 PROMPT "germ; virus infection " + @ 3, 10 PROMPT "defect; snag; (source of) malfunctioning" + @ 4, 10 PROMPT "small hidden microphone " + @ 6, 10 SAY "(Press F1 for a hint)" + SET KEY 28 TO ShowVar + MENU TO What_Is_Bug + + PROCEDURE ShowVar + Alert( ReadVar() ) // WHAT_IS_BUG in red ALERT() box + $STATUS$ + R + $COMPLIANCE$ + READVAR() works exactly like CA-Cl*pper's READKEY(). + + Note however, + that the parameter is not documented and used internally + by CA-Cl*pper. + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + @...GET,@...PROMPT,MENU TO,READ,SET KEY,__AtPrompt(),__MenuTo() + $END$ */ diff --git a/harbour/doc/en/tlabel.txt b/harbour/doc/en/tlabel.txt index 685e131c61..c106319a64 100644 --- a/harbour/doc/en/tlabel.txt +++ b/harbour/doc/en/tlabel.txt @@ -13,71 +13,71 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * LABEL FORM - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Legacy - * $ONELINER$ - * Displays labels to the screen or an alternate device - * $SYNTAX$ - * LABEL FORM [TO PRINTER] [TO FILE ] [] - * [WHILE ] [FOR ] [SAMPLE] [NOCONSOLE] - * $ARGUMENTS$ - * Name of label file - * Name of an alternate file - * Expression of a scoping condition - * WHILE condition - * FOR condition - * $DESCRIPTION$ - * This command allows labels to be printed based on the format - * outlined in LBL file specified as . By default, output - * will go to the screen however this output may be rerouted with - * either the TO PRINTER or the TO FILE clause. - * - * If the TO FILE clause is specified, the name of the ASCII text file - * containing the generated labels will be . - * - * If no file extension is specified a .txt extension is added. - * is the scope condition for this command. Valid scopes - * include NEXT (number of records to be displayed, where - * is the number of records), RECORD (a specific record to be - * printed), REST (all records starting from the current record - * position,and ALL (all records). The default is ALL. - * - * Both logical expression may work ill conjunction with one another - * where is the logical expression for the FOR condition (for - * records to be displayed whitin a given value range) and for - * the WHILE condition (for records to be displayed until they fail to - * meet the condition). - * - * If the SAMPLE clause is specified, test labels will be generated. - * - * If the NOCONSOLE clause is specified,the console will be turned off - * while this command is being executed. - * - * This command follows the search criteria outlined in the SET PATH TO - * command. The path may be specified, along, with (the drive letter, - * in - * $EXAMPLES$ - * PROCEDURE Main() - * USE test NEW - * LABEL FORM EE - * USE - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * REPORT FORM - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + LABEL FORM + $CATEGORY$ + Command + $SUBCATEGORY$ + Legacy + $ONELINER$ + Displays labels to the screen or an alternate device + $SYNTAX$ + LABEL FORM [TO PRINTER] [TO FILE ] [] + [WHILE ] [FOR ] [SAMPLE] [NOCONSOLE] + $ARGUMENTS$ + Name of label file + Name of an alternate file + Expression of a scoping condition + WHILE condition + FOR condition + $DESCRIPTION$ + This command allows labels to be printed based on the format + outlined in LBL file specified as . By default, output + will go to the screen however this output may be rerouted with + either the TO PRINTER or the TO FILE clause. + + If the TO FILE clause is specified, the name of the ASCII text file + containing the generated labels will be . + + If no file extension is specified a .txt extension is added. + is the scope condition for this command. Valid scopes + include NEXT (number of records to be displayed, where + is the number of records), RECORD (a specific record to be + printed), REST (all records starting from the current record + position,and ALL (all records). The default is ALL. + + Both logical expression may work ill conjunction with one another + where is the logical expression for the FOR condition (for + records to be displayed whitin a given value range) and for + the WHILE condition (for records to be displayed until they fail to + meet the condition). + + If the SAMPLE clause is specified, test labels will be generated. + + If the NOCONSOLE clause is specified,the console will be turned off + while this command is being executed. + + This command follows the search criteria outlined in the SET PATH TO + command. The path may be specified, along, with (the drive letter, + in + $EXAMPLES$ + PROCEDURE Main() + USE test NEW + LABEL FORM EE + USE + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + REPORT FORM + $END$ */ diff --git a/harbour/doc/en/treport.txt b/harbour/doc/en/treport.txt index daff397611..7f4cfd5d51 100644 --- a/harbour/doc/en/treport.txt +++ b/harbour/doc/en/treport.txt @@ -13,99 +13,99 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Command - * $NAME$ - * REPORT FORM - * $CATEGORY$ - * Command - * $SUBCATEGORY$ - * Legacy - * $ONELINER$ - * Display a report - * $SYNTAX$ - * REPORT FORM [TO PRINTER] [TO FILE ] [] - * [WHILE ] [FOR ] - * [PLAIN |HEADING ] [NOEJECT] [SUMMARY] - * [NOCONSOLE] - * $ARGUMENTS$ - * Name of report file - * - * Name of alternate file - * - * Scope. - * - * Logical expression of WHILE condition . - * - * Logical expression of FOR condition. - * - * Report heading - * $DESCRIPTION$ - * This command prints out the report named , which is a - * standard FRM file. The file extension is not required because .frm - * will be assumed. The SET PATH TO and SET DEFAULT TO commands affect - * the search for the file ; unless a drive and path are - * specified in , REPORT will search the path specified in - * the SET PATH command if it cannot find the report form in the - * current directory. - * - * The output of the report will be offset based on the setting of the - * SET MARGIN TO value. - * - * By default, output will go to the console; however, it may be - * controlled via either the TO PRINTER or TO FILE clause. If the - * output is to go to the file, the name of the alternate file is - * specified in . Unless specified in , the default file - * extension will be TXT. - * - * is the scope for this command. Valid scopes include - * NEXT (where is the number of records), RECORD - * (a specific record to be displayed), REST (all records from the - * current record position), and ALL (all records). The default is ALL. - * - * Both logical expressions may work in conjuntion with one another, - * where is the logical expression for the FOR condition (for - * records to be displayed within a given range) and for the - * WHILE condition (for records to be displayed until the condition - * fails). - * - * If the PLAIN clause is specified, date and page numbers are - * suppressed. In addition, there is no automatic page breaking, and - * the report title and column headings appear only once at the top of - * the form. - * - * If the HEADING clause is used, is displayed on the first - * title of each report page. The value of is evaluated only - * once before executing the report; varying the values of - * is not allowed. The PLAIN clause will take precedence over the - * HEADING clause if both are included. - * - * If the NOEJECT clause is used, the initial page eject on the report - * will not be issued when the output clause TO PRINTER is specified. - * Otherwise, this clause has no effect. - * - * If the SUMMARY Clause is specified, the report will contain only - * groups, subgroups, and grand total information. The detailed title - * item information will be ignored. - * - * If the NOCONSOLE clause is specified,output to the console will be - * turned off while this command is being executed. - * $EXAMPLES$ - * PROCEDURE Main() - * USE test NEW - * REPORT FORM EE - * USE - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $PLATFORMS$ - * All - * $FILES$ - * Library is rtl - * $SEEALSO$ - * LABEL FORM - * $END$ +/* $DOC$ + $TEMPLATE$ + Command + $NAME$ + REPORT FORM + $CATEGORY$ + Command + $SUBCATEGORY$ + Legacy + $ONELINER$ + Display a report + $SYNTAX$ + REPORT FORM [TO PRINTER] [TO FILE ] [] + [WHILE ] [FOR ] + [PLAIN |HEADING ] [NOEJECT] [SUMMARY] + [NOCONSOLE] + $ARGUMENTS$ + Name of report file + + Name of alternate file + + Scope. + + Logical expression of WHILE condition . + + Logical expression of FOR condition. + + Report heading + $DESCRIPTION$ + This command prints out the report named , which is a + standard FRM file. The file extension is not required because .frm + will be assumed. The SET PATH TO and SET DEFAULT TO commands affect + the search for the file ; unless a drive and path are + specified in , REPORT will search the path specified in + the SET PATH command if it cannot find the report form in the + current directory. + + The output of the report will be offset based on the setting of the + SET MARGIN TO value. + + By default, output will go to the console; however, it may be + controlled via either the TO PRINTER or TO FILE clause. If the + output is to go to the file, the name of the alternate file is + specified in . Unless specified in , the default file + extension will be TXT. + + is the scope for this command. Valid scopes include + NEXT (where is the number of records), RECORD + (a specific record to be displayed), REST (all records from the + current record position), and ALL (all records). The default is ALL. + + Both logical expressions may work in conjuntion with one another, + where is the logical expression for the FOR condition (for + records to be displayed within a given range) and for the + WHILE condition (for records to be displayed until the condition + fails). + + If the PLAIN clause is specified, date and page numbers are + suppressed. In addition, there is no automatic page breaking, and + the report title and column headings appear only once at the top of + the form. + + If the HEADING clause is used, is displayed on the first + title of each report page. The value of is evaluated only + once before executing the report; varying the values of + is not allowed. The PLAIN clause will take precedence over the + HEADING clause if both are included. + + If the NOEJECT clause is used, the initial page eject on the report + will not be issued when the output clause TO PRINTER is specified. + Otherwise, this clause has no effect. + + If the SUMMARY Clause is specified, the report will contain only + groups, subgroups, and grand total information. The detailed title + item information will be ignored. + + If the NOCONSOLE clause is specified,output to the console will be + turned off while this command is being executed. + $EXAMPLES$ + PROCEDURE Main() + USE test NEW + REPORT FORM EE + USE + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $PLATFORMS$ + All + $FILES$ + Library is rtl + $SEEALSO$ + LABEL FORM + $END$ */ diff --git a/harbour/doc/en/var.txt b/harbour/doc/en/var.txt index 6427f2fdc6..9aa7e068e0 100644 --- a/harbour/doc/en/var.txt +++ b/harbour/doc/en/var.txt @@ -25,899 +25,899 @@ * */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __MVPUBLIC() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Variable management - * $ONELINER$ - * This function creates a PUBLIC variable - * $SYNTAX$ - * __MVPUBLIC( ) - * $ARGUMENTS$ - * = either a string that contains the variable's name or - * an one-dimensional array of strings with variable names - * No skeleton are allowed here. - * $RETURNS$ - * Nothing - * $DESCRIPTION$ - * This function can be called either by the harbour compiler or by user. - * The compiler always passes the item of IT_SYMBOL type that stores the - * name of variable. - * If a variable with the same name exists already then the new - * variable is not created - the previous value remains unchanged. - * If it is first variable with this name then the variable is - * initialized with .T. value. - * $EXAMPLES$ - * None Avaliable - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is vm - * $SEEALSO$ - * - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __MVPUBLIC() + $CATEGORY$ + API + $SUBCATEGORY$ + Variable management + $ONELINER$ + This function creates a PUBLIC variable + $SYNTAX$ + __MVPUBLIC( ) + $ARGUMENTS$ + = either a string that contains the variable's name or + an one-dimensional array of strings with variable names + No skeleton are allowed here. + $RETURNS$ + Nothing + $DESCRIPTION$ + This function can be called either by the harbour compiler or by user. + The compiler always passes the item of IT_SYMBOL type that stores the + name of variable. + If a variable with the same name exists already then the new + variable is not created - the previous value remains unchanged. + If it is first variable with this name then the variable is + initialized with .T. value. + $EXAMPLES$ + None Avaliable + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is vm + $SEEALSO$ + + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __MVPRIVATE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Variable management - * $ONELINER$ - * This function creates a PRIVATE variable - * $SYNTAX$ - * __MVPRIVATE( ) - * $ARGUMENTS$ - * = either a string that contains the variable's name or - * an one-dimensional array of strings with variable names - * No skeleton are allowed here. - * $RETURNS$ - * Nothing - * $DESCRIPTION$ - * This function can be called either by the harbour compiler or by user. - * The compiler always passes the item of IT_SYMBOL type that stores the - * name of variable. - * If a variable with the same name exists already then the value of old - * variable is hidden until the new variable is released. The new variable - * is always initialized to NIL value. - * $EXAMPLES$ - * None Avaliable - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is vm - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __MVPRIVATE() + $CATEGORY$ + API + $SUBCATEGORY$ + Variable management + $ONELINER$ + This function creates a PRIVATE variable + $SYNTAX$ + __MVPRIVATE( ) + $ARGUMENTS$ + = either a string that contains the variable's name or + an one-dimensional array of strings with variable names + No skeleton are allowed here. + $RETURNS$ + Nothing + $DESCRIPTION$ + This function can be called either by the harbour compiler or by user. + The compiler always passes the item of IT_SYMBOL type that stores the + name of variable. + If a variable with the same name exists already then the value of old + variable is hidden until the new variable is released. The new variable + is always initialized to NIL value. + $EXAMPLES$ + None Avaliable + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is vm + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __MVXRELEASE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Variable management - * $ONELINER$ - * This function releases value stored in PRIVATE or PUBLIC variable - * $SYNTAX$ - * __MVXRELEASE( ) - * $ARGUMENTS$ - * = either a string that contains the variable's name or - * an one-dimensional array of strings with variable names - * No skeleton are allowed here. - * $RETURNS$ - * Nothing - * $DESCRIPTION$ - * This function releases values stored in memory variable. It shouldn't - * be called directly, rather it should be placed into RELEASE command. - * If the released variable is a PRIVATE variable then previously hidden - * variable with the same name becomes visible after exit from the - * procedure where released variable was created. If you access - * the released variable in the same function/procedure where it - * was created the the NIL value is returned. You can however assign - * a new value to released variable without any side effects. - * - * It releases variable even if this variable was created in different - * procedure - * $EXAMPLES$ - * PROCEDURE Main() - * PRIVATE mPrivate - * - * mPrivate :="PRIVATE from MAIN()" - * ? mPrivate //PRIVATE from MAIN() - * Test() - * ? mPrivate //PRIVATE from MAIN() - * - * RETURN - * - * PROCEDURE Test() - * PRIVATE mPrivate - * - * mPrivate :="PRIVATE from Test()" - * ? mPrivate //PRIVATE from TEST() - * RELEASE mPrivate - * ? mPrivate //NIL - * mPrivate :="Again in Test()" - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is vm - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __MVXRELEASE() + $CATEGORY$ + API + $SUBCATEGORY$ + Variable management + $ONELINER$ + This function releases value stored in PRIVATE or PUBLIC variable + $SYNTAX$ + __MVXRELEASE( ) + $ARGUMENTS$ + = either a string that contains the variable's name or + an one-dimensional array of strings with variable names + No skeleton are allowed here. + $RETURNS$ + Nothing + $DESCRIPTION$ + This function releases values stored in memory variable. It shouldn't + be called directly, rather it should be placed into RELEASE command. + If the released variable is a PRIVATE variable then previously hidden + variable with the same name becomes visible after exit from the + procedure where released variable was created. If you access + the released variable in the same function/procedure where it + was created the the NIL value is returned. You can however assign + a new value to released variable without any side effects. + + It releases variable even if this variable was created in different + procedure + $EXAMPLES$ + PROCEDURE Main() + PRIVATE mPrivate + + mPrivate :="PRIVATE from MAIN()" + ? mPrivate //PRIVATE from MAIN() + Test() + ? mPrivate //PRIVATE from MAIN() + + RETURN + + PROCEDURE Test() + PRIVATE mPrivate + + mPrivate :="PRIVATE from Test()" + ? mPrivate //PRIVATE from TEST() + RELEASE mPrivate + ? mPrivate //NIL + mPrivate :="Again in Test()" + + RETURN + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is vm + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __MVRELEASE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Variable management - * $ONELINER$ - * This function releases PRIVATE variables - * $SYNTAX$ - * __MVRELEASE( , ) - * $ARGUMENTS$ - * = string that contains the wildcard mask for variables' names - * that will be released. Supported wildcards: '*' and '?' - * = logical value that specifies if variables - * that match passed skeleton should be either included in deletion - * (if .T.) or excluded from deletion (if .F.) - * $RETURNS$ - * Nothing - * $DESCRIPTION$ - * This function releases values stored in memory variables. It shouldn't - * be called directly, it should be placed into RELEASE ALL command. - * If the released variable is a PRIVATE variable then previously hidden - * variable with the same name becomes visible after exit from the - * procedure where released variable was created. If you access - * the released variable in the same function/procedure where it - * was created the the NIL value is returned. You can however assign - * a new value to released variable without any side effects. - * PUBLIC variables are not changed by this function. - * $EXAMPLES$ - * None Avaliable - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is vm - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __MVRELEASE() + $CATEGORY$ + API + $SUBCATEGORY$ + Variable management + $ONELINER$ + This function releases PRIVATE variables + $SYNTAX$ + __MVRELEASE( , ) + $ARGUMENTS$ + = string that contains the wildcard mask for variables' names + that will be released. Supported wildcards: '*' and '?' + = logical value that specifies if variables + that match passed skeleton should be either included in deletion + (if .T.) or excluded from deletion (if .F.) + $RETURNS$ + Nothing + $DESCRIPTION$ + This function releases values stored in memory variables. It shouldn't + be called directly, it should be placed into RELEASE ALL command. + If the released variable is a PRIVATE variable then previously hidden + variable with the same name becomes visible after exit from the + procedure where released variable was created. If you access + the released variable in the same function/procedure where it + was created the the NIL value is returned. You can however assign + a new value to released variable without any side effects. + PUBLIC variables are not changed by this function. + $EXAMPLES$ + None Avaliable + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is vm + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __MVSCOPE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Variable management - * $ONELINER$ - * If variable exists then returns its scope. - * $SYNTAX$ - * __MVSCOPE( ) - * $ARGUMENTS$ - * = a string with a variable name to check - * $RETURNS$ - * The symbolic values are defined in include/hbmemvar.ch - * HB_MV_NOT_FOUND =variable is not declared (not found in symbol table) - * HB_MV_UNKNOWN =if variable doesn't exist (but found in symbol table) - * HB_MV_ERROR =if information cannot be obtained (memory error - * or argument error) - * HB_MV_PUBLIC =for public variables - * HB_MV_PRIVATE_GLOBAL =for private variables declared outside of current - * function/procedure - * HB_MV_PRIVATE_LOCAL =for private variables declared in current - * function/procedure - * $EXAMPLES$ - * PROCEDURE Main() - * PUBLIC mPublic - * PRIVATE mPrivateGlobal - * - * CallProc() - * ? __mvScope( "mPrivateLocal" ) //HB_MV_UNKNOWN - * - * RETURN - * - * PROCEDURE CallProc() - * PRIVATE mPrivateLocal - * - * ? __mvScope( "mPublic" ) //HB_MV_PUBLIC - * ? __mvScope( "mPrivateGlobal" ) //HB_MV_PRIVATE_GLOBAL - * ? __mvScope( "mPrivateLocal" ) //HB_MV_PRIVATE_LOCAL - * ? __mvScope( "mFindMe" ) //HB_MV_NOT_FOUND - * - * IF __mvScope( "mPublic" ) > HB_MV_ERROR - * ? "Variable exists" - * ELSE - * ? "Variable not created yet" - * ENDIF - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is vm - * $SEEALSO$ - * include/hbmemvar.ch - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __MVSCOPE() + $CATEGORY$ + API + $SUBCATEGORY$ + Variable management + $ONELINER$ + If variable exists then returns its scope. + $SYNTAX$ + __MVSCOPE( ) + $ARGUMENTS$ + = a string with a variable name to check + $RETURNS$ + The symbolic values are defined in include/hbmemvar.ch + HB_MV_NOT_FOUND =variable is not declared (not found in symbol table) + HB_MV_UNKNOWN =if variable doesn't exist (but found in symbol table) + HB_MV_ERROR =if information cannot be obtained (memory error + or argument error) + HB_MV_PUBLIC =for public variables + HB_MV_PRIVATE_GLOBAL =for private variables declared outside of current + function/procedure + HB_MV_PRIVATE_LOCAL =for private variables declared in current + function/procedure + $EXAMPLES$ + PROCEDURE Main() + PUBLIC mPublic + PRIVATE mPrivateGlobal + + CallProc() + ? __mvScope( "mPrivateLocal" ) //HB_MV_UNKNOWN + + RETURN + + PROCEDURE CallProc() + PRIVATE mPrivateLocal + + ? __mvScope( "mPublic" ) //HB_MV_PUBLIC + ? __mvScope( "mPrivateGlobal" ) //HB_MV_PRIVATE_GLOBAL + ? __mvScope( "mPrivateLocal" ) //HB_MV_PRIVATE_LOCAL + ? __mvScope( "mFindMe" ) //HB_MV_NOT_FOUND + + IF __mvScope( "mPublic" ) > HB_MV_ERROR + ? "Variable exists" + ELSE + ? "Variable not created yet" + ENDIF + + RETURN + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is vm + $SEEALSO$ + include/hbmemvar.ch + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __MVCLEAR() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Variable management - * $ONELINER$ - * This function releases all PRIVATE and PUBLIC variables - * $SYNTAX$ - * __MVCLEAR() - * $ARGUMENTS$ - * None - * $RETURNS$ - * Nothing - * $DESCRIPTION$ - * This function releases all PRIVATE and PUBLIC variables. - * It is used to implement CLEAR MEMORY statement. - * The memory occupied by all visible variables are released - any - * attempt to access the variable will result in a runtime error. - * You have to reuse PRIVATE or PUBLIC statement to create again - * the variable that was cleared by this function. - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is vm - * $SEEALSO$ - * __MVPUBLIC() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __MVCLEAR() + $CATEGORY$ + API + $SUBCATEGORY$ + Variable management + $ONELINER$ + This function releases all PRIVATE and PUBLIC variables + $SYNTAX$ + __MVCLEAR() + $ARGUMENTS$ + None + $RETURNS$ + Nothing + $DESCRIPTION$ + This function releases all PRIVATE and PUBLIC variables. + It is used to implement CLEAR MEMORY statement. + The memory occupied by all visible variables are released - any + attempt to access the variable will result in a runtime error. + You have to reuse PRIVATE or PUBLIC statement to create again + the variable that was cleared by this function. + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is vm + $SEEALSO$ + __MVPUBLIC() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __MVDBGINFO() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Internal - * $ONELINER$ - * This function returns the information about the variables for debugger - * $SYNTAX$ - * __MVDBGINFO( [, [, @] ] ) - * $ARGUMENTS$ - * = the scope of variables for which an information is asked - * Supported values (defined in hbmemvar.ch) - * HB_MV_PUBLIC - * HB_MV_PRIVATE (or any other value) - * = the position of asked variable on the list of variables - * with specified scope - it should start from position 1 - * = the value is filled with a variable name if passed by - * reference and is specified - * $RETURNS$ - * The return value depends on the number of arguments passed - * $DESCRIPTION$ - * This function retrieves the information about memvar variables. - * It returns either the number of variables with given scope (when the - * first argument is passed only) or a value of variable identified by its - * position in the variables' list (when second argument is passed). - * It also returns the name of a variable if optional third argument - * is passed by reference. - * - * If requested variable doesn't exist (requested position is - * greater then the number of defined variables) then NIL value is - * returned and variable name is set to "?" - * - * The dynamic symbols table is used to find a PUBLIC variable then - * the PUBLIC variables are always sorted alphabetically. The PRIVATE - * variables are sorted in the creation order. - * - * Note: - * - * Due to dynamic nature of memvar variables there is no guarantee that - * successive calls to retrieve the value of PUBLIC variable will - * return the value of the same variable. - * $EXAMPLES$ - * #include "hbmemvar.ch" - * - * LOCAL nCount, i, xValue, cName - * - * nCount := _mvDBGINFO( HB_MV_PUBLIC ) - * FOR i := 1 TO nCount - * xValue := __mvDBGINFO( HB_MV_PUBLIC, i, @cName ) - * ? i, cName, xValue - * NEXT - * $TESTS$ - * #include "hbmemvar.ch" - * PROCEDURE Main() - * - * ? "PUBLIC=", __mvDBGINFO( HB_MV_PUBLIC ) - * ? "PRIVATE=", __mvDBGINFO( HB_MV_PRIVATE ) - * - * PUBLIC cPublic := "cPublic in MAIN" - * - * ? "PUBLIC=", __mvDBGINFO( HB_MV_PUBLIC ) - * ? "PRIVATE=", __mvDBGINFO( HB_MV_PRIVATE ) - * - * PRIVATE cPrivate := "cPrivate in MAIN" - * - * ? "PUBLIC=", __mvDBGINFO( HB_MV_PUBLIC ) - * ? "PRIVATE=", __mvDBGINFO( HB_MV_PRIVATE ) - * - * CountMemvars() - * - * ? "Back in Main" - * ? "PUBLIC=", __mvDBGINFO( HB_MV_PUBLIC ) - * ? "PRIVATE=", __mvDBGINFO( HB_MV_PRIVATE ) - * - * RETURN - * - * PROCEDURE CountMemvars() - * LOCAL i, nCnt, xVal, cName - * PUBLIC ccPublic := "ccPublic" - * PRIVATE ccPrivate := "ccPrivate" - * - * ? "In CountMemvars" - * ? "PUBLIC=", __mvDBGINFO( HB_MV_PUBLIC ) - * ? "PRIVATE=", __mvDBGINFO( HB_MV_PRIVATE ) - * - * PRIVATE cPublic := "cPublic" - * - * ? "PUBLIC=", __mvDBGINFO( HB_MV_PUBLIC ) - * ? "PRIVATE=", __mvDBGINFO( HB_MV_PRIVATE ) - * - * nCnt := __mvDBGINFO( HB_MV_PRIVATE ) + 1 - * FOR i := 1 TO nCnt - * xVal := __mvDBGINFO( HB_MV_PRIVATE, i, @cName ) - * ? i, "=", cName, xVal - * NEXT - * - * nCnt := __mvDBGINFO( HB_MV_PUBLIC ) + 1 - * FOR i := 1 TO nCnt - * xVal := __mvDBGINFO( HB_MV_PUBLIC, i, @cName ) - * ? i, "=", cName, xVal - * NEXT - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * This function should be called from the debugger only. - * $FILES$ - * Library is vm - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __MVDBGINFO() + $CATEGORY$ + API + $SUBCATEGORY$ + Internal + $ONELINER$ + This function returns the information about the variables for debugger + $SYNTAX$ + __MVDBGINFO( [, [, @] ] ) + $ARGUMENTS$ + = the scope of variables for which an information is asked + Supported values (defined in hbmemvar.ch) + HB_MV_PUBLIC + HB_MV_PRIVATE (or any other value) + = the position of asked variable on the list of variables + with specified scope - it should start from position 1 + = the value is filled with a variable name if passed by + reference and is specified + $RETURNS$ + The return value depends on the number of arguments passed + $DESCRIPTION$ + This function retrieves the information about memvar variables. + It returns either the number of variables with given scope (when the + first argument is passed only) or a value of variable identified by its + position in the variables' list (when second argument is passed). + It also returns the name of a variable if optional third argument + is passed by reference. + + If requested variable doesn't exist (requested position is + greater then the number of defined variables) then NIL value is + returned and variable name is set to "?" + + The dynamic symbols table is used to find a PUBLIC variable then + the PUBLIC variables are always sorted alphabetically. The PRIVATE + variables are sorted in the creation order. + + Note: + + Due to dynamic nature of memvar variables there is no guarantee that + successive calls to retrieve the value of PUBLIC variable will + return the value of the same variable. + $EXAMPLES$ + #include "hbmemvar.ch" + + LOCAL nCount, i, xValue, cName + + nCount := _mvDBGINFO( HB_MV_PUBLIC ) + FOR i := 1 TO nCount + xValue := __mvDBGINFO( HB_MV_PUBLIC, i, @cName ) + ? i, cName, xValue + NEXT + $TESTS$ + #include "hbmemvar.ch" + PROCEDURE Main() + + ? "PUBLIC=", __mvDBGINFO( HB_MV_PUBLIC ) + ? "PRIVATE=", __mvDBGINFO( HB_MV_PRIVATE ) + + PUBLIC cPublic := "cPublic in MAIN" + + ? "PUBLIC=", __mvDBGINFO( HB_MV_PUBLIC ) + ? "PRIVATE=", __mvDBGINFO( HB_MV_PRIVATE ) + + PRIVATE cPrivate := "cPrivate in MAIN" + + ? "PUBLIC=", __mvDBGINFO( HB_MV_PUBLIC ) + ? "PRIVATE=", __mvDBGINFO( HB_MV_PRIVATE ) + + CountMemvars() + + ? "Back in Main" + ? "PUBLIC=", __mvDBGINFO( HB_MV_PUBLIC ) + ? "PRIVATE=", __mvDBGINFO( HB_MV_PRIVATE ) + + RETURN + + PROCEDURE CountMemvars() + LOCAL i, nCnt, xVal, cName + PUBLIC ccPublic := "ccPublic" + PRIVATE ccPrivate := "ccPrivate" + + ? "In CountMemvars" + ? "PUBLIC=", __mvDBGINFO( HB_MV_PUBLIC ) + ? "PRIVATE=", __mvDBGINFO( HB_MV_PRIVATE ) + + PRIVATE cPublic := "cPublic" + + ? "PUBLIC=", __mvDBGINFO( HB_MV_PUBLIC ) + ? "PRIVATE=", __mvDBGINFO( HB_MV_PRIVATE ) + + nCnt := __mvDBGINFO( HB_MV_PRIVATE ) + 1 + FOR i := 1 TO nCnt + xVal := __mvDBGINFO( HB_MV_PRIVATE, i, @cName ) + ? i, "=", cName, xVal + NEXT + + nCnt := __mvDBGINFO( HB_MV_PUBLIC ) + 1 + FOR i := 1 TO nCnt + xVal := __mvDBGINFO( HB_MV_PUBLIC, i, @cName ) + ? i, "=", cName, xVal + NEXT + + RETURN + $STATUS$ + R + $COMPLIANCE$ + This function should be called from the debugger only. + $FILES$ + Library is vm + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __MVEXIST() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Variable management - * $ONELINER$ - * Determine if a given name is a PUBLIC or PRIVATE memory variable - * $SYNTAX$ - * __MVEXIST( ) --> - * $ARGUMENTS$ - * - string that specifies the name of variable to check - * $RETURNS$ - * __MVEXIST() return TRUE (.T.) if a MEMVAR named exist. - * $DESCRIPTION$ - * This function determine if a PUBLIC or PRIVATE variable with the - * name exist or not. - * $EXAMPLES$ - * LOCAL TheLocal - * STATIC TheStatic - * PUBLIC ThePublic - * PRIVATE ThePrivate - * ? __MVEXIST( "NotExist" ) // .F. - * ? __MVEXIST( "TheLocal" ) // .F. - * ? __MVEXIST( "TheStatic" ) // .F. - * ? __MVEXIST( "ThePublic" ) // .T. - * ? __MVEXIST( "ThePrivate" ) // .T. - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $SEEALSO$ - * MEMVAR, PRIVATE, PUBLIC - * $FILES$ - * Library is vm - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __MVEXIST() + $CATEGORY$ + API + $SUBCATEGORY$ + Variable management + $ONELINER$ + Determine if a given name is a PUBLIC or PRIVATE memory variable + $SYNTAX$ + __MVEXIST( ) --> + $ARGUMENTS$ + - string that specifies the name of variable to check + $RETURNS$ + __MVEXIST() return TRUE (.T.) if a MEMVAR named exist. + $DESCRIPTION$ + This function determine if a PUBLIC or PRIVATE variable with the + name exist or not. + $EXAMPLES$ + LOCAL TheLocal + STATIC TheStatic + PUBLIC ThePublic + PRIVATE ThePrivate + ? __MVEXIST( "NotExist" ) // .F. + ? __MVEXIST( "TheLocal" ) // .F. + ? __MVEXIST( "TheStatic" ) // .F. + ? __MVEXIST( "ThePublic" ) // .T. + ? __MVEXIST( "ThePrivate" ) // .T. + $STATUS$ + R + $COMPLIANCE$ + H + $SEEALSO$ + MEMVAR, PRIVATE, PUBLIC + $FILES$ + Library is vm + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __MVGET() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Variable management - * $ONELINER$ - * This function returns value of memory variable - * $SYNTAX$ - * __MVGET( ) --> - * $ARGUMENTS$ - * - string that specifies the name of variable - * $RETURNS$ - * The value of variable - * $DESCRIPTION$ - * This function returns the value of PRIVATE or PUBLIC variable if - * this variable exists otherwise it generates a runtime error. - * The variable is specified by its name passed as the function parameter. - * $EXAMPLES$ - * FUNCTION MEMVARBLOCK( cMemvar ) - * RETURN {| x | ; - * iif( PCOUNT() == 0, ; - * __MVGET( cMemvar ),; - * __MVPUT( cMemvar, x ) ) } - * $STATUS$ - * R - * $COMPLIANCE$ - * H - * $SEEALSO$ - * __MVPUT() - * $FILES$ - * Library is vm - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __MVGET() + $CATEGORY$ + API + $SUBCATEGORY$ + Variable management + $ONELINER$ + This function returns value of memory variable + $SYNTAX$ + __MVGET( ) --> + $ARGUMENTS$ + - string that specifies the name of variable + $RETURNS$ + The value of variable + $DESCRIPTION$ + This function returns the value of PRIVATE or PUBLIC variable if + this variable exists otherwise it generates a runtime error. + The variable is specified by its name passed as the function parameter. + $EXAMPLES$ + FUNCTION MEMVARBLOCK( cMemvar ) + RETURN {| x | ; + iif( PCOUNT() == 0, ; + __MVGET( cMemvar ),; + __MVPUT( cMemvar, x ) ) } + $STATUS$ + R + $COMPLIANCE$ + H + $SEEALSO$ + __MVPUT() + $FILES$ + Library is vm + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * __MVPUT() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Variable management - * $ONELINER$ - * This function set the value of memory variable - * $SYNTAX$ - * __MVGET( [, ] ) --> - * $ARGUMENTS$ - * - string that specifies the name of variable - * - a value of any type that will be set - if it is not - * specified then NIL is assumed - * $RETURNS$ - * A value assigned to the given variable. - * $DESCRIPTION$ - * This function sets the value of PRIVATE or PUBLIC variable if - * this variable exists otherwise it generates a runtime error. - * The variable is specified by its name passed as the function - * parameter. - * If a value is not specified then the NIL is assumed - * $EXAMPLES$ - * FUNCTION MEMVARBLOCK( cMemvar ) - * RETURN {| x | ; - * iif( PCOUNT() == 0, ; - * __MVGET( cMemvar ),; - * __MVPUT( cMemvar, x ) ) } -* $STATUS$ - * R - * $COMPLIANCE$ - * H - * $FILES$ - * Library is vm - * $SEEALSO$ - * __MVPUT() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + __MVPUT() + $CATEGORY$ + API + $SUBCATEGORY$ + Variable management + $ONELINER$ + This function set the value of memory variable + $SYNTAX$ + __MVGET( [, ] ) --> + $ARGUMENTS$ + - string that specifies the name of variable + - a value of any type that will be set - if it is not + specified then NIL is assumed + $RETURNS$ + A value assigned to the given variable. + $DESCRIPTION$ + This function sets the value of PRIVATE or PUBLIC variable if + this variable exists otherwise it generates a runtime error. + The variable is specified by its name passed as the function + parameter. + If a value is not specified then the NIL is assumed + $EXAMPLES$ + FUNCTION MEMVARBLOCK( cMemvar ) + RETURN {| x | ; + iif( PCOUNT() == 0, ; + __MVGET( cMemvar ),; + __MVPUT( cMemvar, x ) ) } + $STATUS$ + R + $COMPLIANCE$ + H + $FILES$ + Library is vm + $SEEALSO$ + __MVPUT() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * MEMVARBLOCK() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Variable management - * $ONELINER$ - * Returns a codeblock that sets/gets a value of memvar variable - * $SYNTAX$ - * MEMVARBLOCK( ) --> - * $ARGUMENTS$ - * - a string that contains the name of variable - * $RETURNS$ - * a codeblock that sets/get the value of variable - * $DESCRIPTION$ - * This function returns a codeblock that sets/gets the value of - * PRIVATE or PUBLIC variable. When this codeblock is evaluated - * without any parameters passed then it returns the current value - * of given variable. If the second parameter is passed for - * the codeblock evaluation then its value is used to set the new - * value of given variable - the passed value is also returned - * as a value of the codeblock evaluation. - * $EXAMPLES$ - * PROCEDURE Main() - * LOCAL cbSetGet - * PUBLIC xPublic - * - * cbSetGet := MEMVARBLOCK( "xPublic" ) - * EVAL( cbSetGet, "new value" ) - * ? "Value of xPublic variable", EVAL( cbSetGet ) - * - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * C - * $SEEALSO$ - * __MVGET(),__MVPUT() - * $FILES$ - * Library is rtl - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + MEMVARBLOCK() + $CATEGORY$ + API + $SUBCATEGORY$ + Variable management + $ONELINER$ + Returns a codeblock that sets/gets a value of memvar variable + $SYNTAX$ + MEMVARBLOCK( ) --> + $ARGUMENTS$ + - a string that contains the name of variable + $RETURNS$ + a codeblock that sets/get the value of variable + $DESCRIPTION$ + This function returns a codeblock that sets/gets the value of + PRIVATE or PUBLIC variable. When this codeblock is evaluated + without any parameters passed then it returns the current value + of given variable. If the second parameter is passed for + the codeblock evaluation then its value is used to set the new + value of given variable - the passed value is also returned + as a value of the codeblock evaluation. + $EXAMPLES$ + PROCEDURE Main() + LOCAL cbSetGet + PUBLIC xPublic + + cbSetGet := MEMVARBLOCK( "xPublic" ) + EVAL( cbSetGet, "new value" ) + ? "Value of xPublic variable", EVAL( cbSetGet ) + + RETURN + $STATUS$ + R + $COMPLIANCE$ + C + $SEEALSO$ + __MVGET(),__MVPUT() + $FILES$ + Library is rtl + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * FIELDBLOCK() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * Return a code block that sets/gets a value for a given field - * $SYNTAX$ - * FIELDBLOCK( ) --> bFieldBlock - * $ARGUMENTS$ - * is a string that contain the field name. - * $RETURNS$ - * FIELDBLOCK() return a code block that when evaluate could retrieve - * a field value or assigning a new value to the field. If - * is not specified or from type other than character, FIELDBLOCK() - * return NIL. - * $DESCRIPTION$ - * FIELDBLOCK() return a code block that sets/gets the value of field. - * When this code block is evaluated without any parameters passed then - * it returns the current value of the given field. If the code block - * is evaluated with a parameter, than its value is used to set a new - * value to the field, this value is also return by the block. If the - * block is evaluate and there is no field with the name - * in the current work area, the code block return NIL. - * - * Note that FIELDBLOCK() works on the current work area, if you need - * a specific work area code block use FIELDWBLOCK() instead. - * $EXAMPLES$ - * // open a file named Test that have a field named "name" - * LOCAL bField - * bFiled := FIELDBLOCK( "name" ) - * USE Test - * ? "Original value of field 'name' :", EVAL( bField ) - * EVAL( bField, "Mr X new name" ) - * ? "New value for the field 'name' :", EVAL( bField ) - * $STATUS$ - * R - * $COMPLIANCE$ - * If the block is evaluate and there is no field with the name - * in the current work area, the code block return NIL. - * - * CA-Cl*pper would raise BASE/1003 error if the field does not exist. - * $FILES$ - * Library is rtl - * $SEEALSO$ - * EVAL(),FIELDWBLOCK(),MEMVARBLOCK() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + FIELDBLOCK() + $CATEGORY$ + API + $SUBCATEGORY$ + RDD + $ONELINER$ + Return a code block that sets/gets a value for a given field + $SYNTAX$ + FIELDBLOCK( ) --> bFieldBlock + $ARGUMENTS$ + is a string that contain the field name. + $RETURNS$ + FIELDBLOCK() return a code block that when evaluate could retrieve + a field value or assigning a new value to the field. If + is not specified or from type other than character, FIELDBLOCK() + return NIL. + $DESCRIPTION$ + FIELDBLOCK() return a code block that sets/gets the value of field. + When this code block is evaluated without any parameters passed then + it returns the current value of the given field. If the code block + is evaluated with a parameter, than its value is used to set a new + value to the field, this value is also return by the block. If the + block is evaluate and there is no field with the name + in the current work area, the code block return NIL. + + Note that FIELDBLOCK() works on the current work area, if you need + a specific work area code block use FIELDWBLOCK() instead. + $EXAMPLES$ + // open a file named Test that have a field named "name" + LOCAL bField + bFiled := FIELDBLOCK( "name" ) + USE Test + ? "Original value of field 'name' :", EVAL( bField ) + EVAL( bField, "Mr X new name" ) + ? "New value for the field 'name' :", EVAL( bField ) + $STATUS$ + R + $COMPLIANCE$ + If the block is evaluate and there is no field with the name + in the current work area, the code block return NIL. + + CA-Cl*pper would raise BASE/1003 error if the field does not exist. + $FILES$ + Library is rtl + $SEEALSO$ + EVAL(),FIELDWBLOCK(),MEMVARBLOCK() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * FIELDWBLOCK() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * RDD - * $ONELINER$ - * Return a sets/gets code block for field in a given work area - * $SYNTAX$ - * FIELDWBLOCK( , ) --> bFieldBlock - * $ARGUMENTS$ - * is a string that contain the field name. - * - * is the work area number in which exist. - * $RETURNS$ - * FIELDWBLOCK() return a code block that when evaluate could retrieve - * field value or assigning a new value for a field in a given work - * area. If is not specified or from type other than - * character, or if is not specified or is not numeric - * FIELDWBLOCK() return NIL. - * $DESCRIPTION$ - * FIELDWBLOCK() return a code block that sets/gets the value of field - * from a given work area. When this code block is evaluated without - * any parameters passed then it returns the current value of the given - * field. If the code block is evaluated with a parameter, than its - * value is used to set a new value to the field, this value is also - * return by the block. If the block is evaluate and there is no field - * with the name in work area number , the code - * block return NIL. - * $EXAMPLES$ - * LOCAL bField - * // this block work on the field "name" that exist on work area 2 - * bFiled := FIELDBLOCK( "name", 2 ) - * // open a file named One in work area 1 - * // that have a field named "name" - * SELECT 1 - * USE one - * // open a file named Two in work area 2 - * // it also have a field named "name" - * SELECT 2 - * USE two - * SELECT 1 - * ? "Original names: ", One->name, Two->name - * ? "Name value for file Two :", EVAL( bField ) - * EVAL( bField, "Two has new name" ) - * ? "and now: ", One->name, Two->name - * $STATUS$ - * R - * $COMPLIANCE$ - * If the block is evaluate and there is no field with the name - * in the given work area, the code block return NIL. - * - * CA-Cl*pper would raise BASE/1003 error if the field does not exist. - * $FILES$ - * Library is rtl - * $SEEALSO$ - * EVAL(),FIELDBLOCK(),MEMVARBLOCK() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + FIELDWBLOCK() + $CATEGORY$ + API + $SUBCATEGORY$ + RDD + $ONELINER$ + Return a sets/gets code block for field in a given work area + $SYNTAX$ + FIELDWBLOCK( , ) --> bFieldBlock + $ARGUMENTS$ + is a string that contain the field name. + + is the work area number in which exist. + $RETURNS$ + FIELDWBLOCK() return a code block that when evaluate could retrieve + field value or assigning a new value for a field in a given work + area. If is not specified or from type other than + character, or if is not specified or is not numeric + FIELDWBLOCK() return NIL. + $DESCRIPTION$ + FIELDWBLOCK() return a code block that sets/gets the value of field + from a given work area. When this code block is evaluated without + any parameters passed then it returns the current value of the given + field. If the code block is evaluated with a parameter, than its + value is used to set a new value to the field, this value is also + return by the block. If the block is evaluate and there is no field + with the name in work area number , the code + block return NIL. + $EXAMPLES$ + LOCAL bField + // this block work on the field "name" that exist on work area 2 + bFiled := FIELDBLOCK( "name", 2 ) + // open a file named One in work area 1 + // that have a field named "name" + SELECT 1 + USE one + // open a file named Two in work area 2 + // it also have a field named "name" + SELECT 2 + USE two + SELECT 1 + ? "Original names: ", One->name, Two->name + ? "Name value for file Two :", EVAL( bField ) + EVAL( bField, "Two has new name" ) + ? "and now: ", One->name, Two->name + $STATUS$ + R + $COMPLIANCE$ + If the block is evaluate and there is no field with the name + in the given work area, the code block return NIL. + + CA-Cl*pper would raise BASE/1003 error if the field does not exist. + $FILES$ + Library is rtl + $SEEALSO$ + EVAL(),FIELDBLOCK(),MEMVARBLOCK() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * TYPE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Variable management - * $ONELINER$ - * Retrieves the type of an expression - * $SYNTAX$ - * TYPE( ) --> - * $ARGUMENTS$ - * must be a character expression. - * $RETURNS$ - * a string indicating the type of the passed expression. - * - * - * Meaning - * - * "A" Array - * "B" Block - * "C" Character (string) - * "D" Date - * "L" Logical - * "M" Memo - * "N" Numeric - * "O" Object - * "P" Pointer - * "S" Symbol - * "U" NIL, local or static variable, or not linked-in function - * "UE" syntax error in the expression or invalid arguments - * "UI" function with non-reserved name was requested - *
- * $DESCRIPTION$ - * This function returns a string which represents the data type - * of the argument. The argument can be any valid Harbour expression. - * If there is a syntax error in passed expression then "UE" is returned. - * If there is a call for any non-reserved Harbour function then "UI" - * is returned (in other words there is no call for passed UDF function - * during a data type determination - this is CA-Cl*pper compatible - * behavior). Additionally if requested user defined function is not - * linked into executable then "U" is returned. - * - * The data type of expression is checked by invoking a macro compiler - * and by evaluation of generated code (if there is no syntax errors). - * This causes that TYPE() cannot determine a type of local or static - * variables - only symbols visible at runtime can be checked. - * - * Notice the subtle difference between TYPE and VALTYPE functions. - * VALTYPE() function doesn't call a macro compiler - it simply checks - * the type of passed argument of any type. TYPE() requires a string - * argument with a valid Harbour expression - the data type of this - * expression is returned. - * $EXAMPLES$ - * ? TYPE( "{ 1, 2 }" ) // prints "A" - * ? TYPE( "iif( .T., SubStr( "TYPE", 2, 1 ), .F. )" ) // prints "C" - * ? TYPE( "At( "OK", MyUDF() ) > 0" ) // prints "UI" - * ? TYPE( "{ 1, 2 }[ 5 ]" ) // prints "UE" - * - * //-------------------------------------------------------- - * - * LOCAL c - * PRIVATE a := "A", b := "B" - * ? TYPE( "a + b + c" ) // prints: "U" ('C' variable is a local one) - * - * //-------------------------------------------------------- - * - * LOCAL cFilter := Space( 60 ) - * ACCEPT "Enter filter expression:" TO cFilter - * IF TYPE( cFilter ) $ "CDLMN" - * // this is a valid expression - * SET FILTER TO &cFilter - * ENDIF - * $STATUS$ - * R - * $COMPLIANCE$ - * - Incompatibility with CA-Cl*pper: - * In the following code: - * - * PRIVATE lCond := 0 - * ? TYPE( "iof( lCond, 'true', MyUDF() )" ) - * - * CA-Cl*pper will print "UE" - in Harbour the output will be "UI" - * - * - If "UI" is returned then the syntax of the expression is - * correct. However invalid arguments can be passed to - * function/procedure that will cause runtime errors during - * evaluation of expression. - * - * - Harbour supports two new types (Pointer and Symbol) which does - * not exists in CA-Cl*pper. - * $FILES$ - * Library is rtl - * $SEEALSO$ - * VALTYPE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + TYPE() + $CATEGORY$ + API + $SUBCATEGORY$ + Variable management + $ONELINER$ + Retrieves the type of an expression + $SYNTAX$ + TYPE( ) --> + $ARGUMENTS$ + must be a character expression. + $RETURNS$ + a string indicating the type of the passed expression. + + + Meaning + + "A" Array + "B" Block + "C" Character (string) + "D" Date + "L" Logical + "M" Memo + "N" Numeric + "O" Object + "P" Pointer + "S" Symbol + "U" NIL, local or static variable, or not linked-in function + "UE" syntax error in the expression or invalid arguments + "UI" function with non-reserved name was requested +
+ $DESCRIPTION$ + This function returns a string which represents the data type + of the argument. The argument can be any valid Harbour expression. + If there is a syntax error in passed expression then "UE" is returned. + If there is a call for any non-reserved Harbour function then "UI" + is returned (in other words there is no call for passed UDF function + during a data type determination - this is CA-Cl*pper compatible + behavior). Additionally if requested user defined function is not + linked into executable then "U" is returned. + + The data type of expression is checked by invoking a macro compiler + and by evaluation of generated code (if there is no syntax errors). + This causes that TYPE() cannot determine a type of local or static + variables - only symbols visible at runtime can be checked. + + Notice the subtle difference between TYPE and VALTYPE functions. + VALTYPE() function doesn't call a macro compiler - it simply checks + the type of passed argument of any type. TYPE() requires a string + argument with a valid Harbour expression - the data type of this + expression is returned. + $EXAMPLES$ + ? TYPE( "{ 1, 2 }" ) // prints "A" + ? TYPE( "iif( .T., SubStr( "TYPE", 2, 1 ), .F. )" ) // prints "C" + ? TYPE( "At( "OK", MyUDF() ) > 0" ) // prints "UI" + ? TYPE( "{ 1, 2 }[ 5 ]" ) // prints "UE" + + //-------------------------------------------------------- + + LOCAL c + PRIVATE a := "A", b := "B" + ? TYPE( "a + b + c" ) // prints: "U" ('C' variable is a local one) + + //-------------------------------------------------------- + + LOCAL cFilter := Space( 60 ) + ACCEPT "Enter filter expression:" TO cFilter + IF TYPE( cFilter ) $ "CDLMN" + // this is a valid expression + SET FILTER TO &cFilter + ENDIF + $STATUS$ + R + $COMPLIANCE$ + - Incompatibility with CA-Cl*pper: + In the following code: + + PRIVATE lCond := 0 + ? TYPE( "iof( lCond, 'true', MyUDF() )" ) + + CA-Cl*pper will print "UE" - in Harbour the output will be "UI" + + - If "UI" is returned then the syntax of the expression is + correct. However invalid arguments can be passed to + function/procedure that will cause runtime errors during + evaluation of expression. + + - Harbour supports two new types (Pointer and Symbol) which does + not exists in CA-Cl*pper. + $FILES$ + Library is rtl + $SEEALSO$ + VALTYPE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * VALTYPE() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Variable management - * $ONELINER$ - * Retrieves the data type of an expression - * $SYNTAX$ - * VALTYPE( ) --> - * $ARGUMENTS$ - * is any valid expression. - * $RETURNS$ - * a character indicating the type of the passed expression. - * - * - * Meaning - * - * "A" Array - * "B" Block - * "C" Character (string) - * "D" Date - * "L" Logical - * "M" Memo - * "N" Numeric - * "O" Object - * "P" Pointer - * "S" Symbol - * "U" NIL - *
- * $DESCRIPTION$ - * This function returns one character which represents the data type - * of the argument. - * $EXAMPLES$ - * See Test(s) - * $TESTS$ - * PROCEDURE Test() - * ? ValType( Array( 1 ) ) // "A" - * ? ValType( {|| 1 + 1 } ) // "B" - * ? ValType( "HARBOUR" ) // "C" - * ? ValType( Date() ) // "D" - * ? ValType( .T. ) // "L" - * ? ValType( 1 ) // "N" - * ? ValType( TBrowse() ) // "O" - * ? ValType( hb_idleadd() ) // "P" Harbour extension - * ? ValType( @QOut() ) // "S" Harbour extension - * ? ValType( NIL ) // "U" - * RETURN - * $STATUS$ - * R - * $COMPLIANCE$ - * VALTYPE() is CA-Cl*pper compliant, with the addition of the new - * Harbour types: Pointer and Symbol. - * $FILES$ - * Library is rtl - * $SEEALSO$ - * TYPE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + VALTYPE() + $CATEGORY$ + API + $SUBCATEGORY$ + Variable management + $ONELINER$ + Retrieves the data type of an expression + $SYNTAX$ + VALTYPE( ) --> + $ARGUMENTS$ + is any valid expression. + $RETURNS$ + a character indicating the type of the passed expression. + + + Meaning + + "A" Array + "B" Block + "C" Character (string) + "D" Date + "L" Logical + "M" Memo + "N" Numeric + "O" Object + "P" Pointer + "S" Symbol + "U" NIL +
+ $DESCRIPTION$ + This function returns one character which represents the data type + of the argument. + $EXAMPLES$ + See Test(s) + $TESTS$ + PROCEDURE Test() + ? ValType( Array( 1 ) ) // "A" + ? ValType( {|| 1 + 1 } ) // "B" + ? ValType( "HARBOUR" ) // "C" + ? ValType( Date() ) // "D" + ? ValType( .T. ) // "L" + ? ValType( 1 ) // "N" + ? ValType( TBrowse() ) // "O" + ? ValType( hb_idleadd() ) // "P" Harbour extension + ? ValType( @QOut() ) // "S" Harbour extension + ? ValType( NIL ) // "U" + RETURN + $STATUS$ + R + $COMPLIANCE$ + VALTYPE() is CA-Cl*pper compliant, with the addition of the new + Harbour types: Pointer and Symbol. + $FILES$ + Library is rtl + $SEEALSO$ + TYPE() + $END$ */ -/* $DOC$ - * $TEMPLATE$ - * Function - * $NAME$ - * HB_ISBYREF() - * $CATEGORY$ - * API - * $SUBCATEGORY$ - * Variable management - * $ONELINER$ - * Determine if a variable is passed by reference. - * $SYNTAX$ - * HB_ISBYREF( @ ) --> - * $ARGUMENTS$ - * @ is the variable to test; it must be passed by reference. - * $RETURNS$ - * a logical value indicating if the variable is passed - * by reference to actual function or procedure. - * $DESCRIPTION$ - * This function return a logical value indicating if the variable - * is passed by reference to actual function or procedure. - * - * ATTENTION: The variable to test must be passed by reference. - * If the variable is not passed by reference, the function return NIL. - * This function is based on the form that Harbour manages to the - * variables for reference. When a variable is passed by reference, - * what receives the function or procedure is, a pointer to the - * previous variable, be this the container variable of the data or - * a pointer to another variable. The function observes if the - * variable passed points to a common variable or to a variable - * passed by reference. - * $EXAMPLES$ - * See Tests - * $TESTS$ - * PROCEDURE Main() - * LOCAL cVar := "Test local" - * PRIVATE nVar := 0 - * - * Test( @cVar, @nVar, cVar, nVar ) - * RETURN - * - * PROCEDURE Test( Arg1, Arg2, Arg3, Arg4 ) - * ? hb_isbyref( @Arg1 ) // .T. - * ? hb_isbyref( @Arg2 ) // .T. - * ? hb_isbyref( @Arg3 ) // .F. - * ? hb_isbyref( @Arg4 ) // .F. - * RETURN - * $STATUS$ - * S - * $COMPLIANCE$ - * H - * $FILES$ - * Library is rtl - * $SEEALSO$ - * VALTYPE() - * $END$ +/* $DOC$ + $TEMPLATE$ + Function + $NAME$ + HB_ISBYREF() + $CATEGORY$ + API + $SUBCATEGORY$ + Variable management + $ONELINER$ + Determine if a variable is passed by reference. + $SYNTAX$ + HB_ISBYREF( @ ) --> + $ARGUMENTS$ + @ is the variable to test; it must be passed by reference. + $RETURNS$ + a logical value indicating if the variable is passed + by reference to actual function or procedure. + $DESCRIPTION$ + This function return a logical value indicating if the variable + is passed by reference to actual function or procedure. + + ATTENTION: The variable to test must be passed by reference. + If the variable is not passed by reference, the function return NIL. + This function is based on the form that Harbour manages to the + variables for reference. When a variable is passed by reference, + what receives the function or procedure is, a pointer to the + previous variable, be this the container variable of the data or + a pointer to another variable. The function observes if the + variable passed points to a common variable or to a variable + passed by reference. + $EXAMPLES$ + See Tests + $TESTS$ + PROCEDURE Main() + LOCAL cVar := "Test local" + PRIVATE nVar := 0 + + Test( @cVar, @nVar, cVar, nVar ) + RETURN + + PROCEDURE Test( Arg1, Arg2, Arg3, Arg4 ) + ? hb_isbyref( @Arg1 ) // .T. + ? hb_isbyref( @Arg2 ) // .T. + ? hb_isbyref( @Arg3 ) // .F. + ? hb_isbyref( @Arg4 ) // .F. + RETURN + $STATUS$ + S + $COMPLIANCE$ + H + $FILES$ + Library is rtl + $SEEALSO$ + VALTYPE() + $END$ */ diff --git a/harbour/src/rtl/hbdoc.prg b/harbour/src/rtl/hbdoc.prg index e032d4d68d..07928d1a58 100644 --- a/harbour/src/rtl/hbdoc.prg +++ b/harbour/src/rtl/hbdoc.prg @@ -266,17 +266,17 @@ FUNCTION __hbdoc_ToSource( aEntry ) IF HB_ISARRAY( aEntry ) FOR EACH hEntry IN aEntry cSource += hb_eol() - cSource += "/* $DOC$" + hb_eol() + cSource += "/* $DOC$" + hb_eol() FOR EACH item IN hEntry IF HB_ISSTRING( item ) .AND. ; !( Left( item:__enumKey(), 1 ) == "_" ) - cSource += " * $" + item:__enumKey() + "$" + hb_eol() + cSource += " $" + item:__enumKey() + "$" + hb_eol() FOR EACH cLine IN hb_ATokens( StrTran( item, Chr( 13 ) ), Chr( 10 ) ) - cSource += " * " + iif( Len( cLine ) == 0, "", Space( 4 ) + cLine ) + hb_eol() + cSource += " " + iif( Len( cLine ) == 0, "", Space( 4 ) + cLine ) + hb_eol() NEXT ENDIF NEXT - cSource += " * $END$" + hb_eol() + cSource += " $END$" + hb_eol() cSource += " */" + hb_eol() NEXT ENDIF diff --git a/harbour/src/rtl/tlabel.prg b/harbour/src/rtl/tlabel.prg index d604e42d68..7ef998c9e6 100644 --- a/harbour/src/rtl/tlabel.prg +++ b/harbour/src/rtl/tlabel.prg @@ -157,7 +157,7 @@ METHOD New( cLBLName, lPrinter, cAltFile, lNoConsole, bFor, ; lConsoleOn := Set( _SET_CONSOLE ) Set( _SET_CONSOLE, ! ( lNoConsole .OR. ! lConsoleOn ) ) - IF !Empty( cAltFile ) // To file + IF ! Empty( cAltFile ) // To file lExtraState := Set( _SET_EXTRA, .T. ) cExtraFile := Set( _SET_EXTRAFILE, cAltFile ) ENDIF @@ -208,7 +208,7 @@ METHOD New( cLBLName, lPrinter, cAltFile, lNoConsole, bFor, ; Set( _SET_PRINTER, lPrintOn ) // Set the printer back to prior state Set( _SET_CONSOLE, lConsoleOn ) // Set the console back to prior state - IF !Empty( cAltFile ) // Set extrafile back + IF ! Empty( cAltFile ) // Set extrafile back Set( _SET_EXTRAFILE, cExtraFile ) Set( _SET_EXTRA, lExtraState ) ENDIF @@ -412,21 +412,21 @@ METHOD LoadLabel( cLblFile ) CLASS HBLabelForm IF nFileError == 0 // Load label dimension into aLabel - aLabel[ LBL_REMARK ] := SubStr( cBuff, REMARKOFFSET, REMARKSIZE ) - aLabel[ LBL_HEIGHT ] := BIN2W( SubStr( cBuff, HEIGHTOFFSET, HEIGHTSIZE ) ) - aLabel[ LBL_WIDTH ] := BIN2W( SubStr( cBuff, WIDTHOFFSET, WIDTHSIZE ) ) - aLabel[ LBL_LMARGIN ] := BIN2W( SubStr( cBuff, LMARGINOFFSET, LMARGINSIZE ) ) - aLabel[ LBL_LINES ] := BIN2W( SubStr( cBuff, LINESOFFSET, LINESSIZE ) ) - aLabel[ LBL_SPACES ] := BIN2W( SubStr( cBuff, SPACESOFFSET, SPACESSIZE ) ) - aLabel[ LBL_ACROSS ] := BIN2W( SubStr( cBuff, ACROSSOFFSET, ACROSSSIZE ) ) + aLabel[ LBL_REMARK ] := hb_BSubStr( cBuff, REMARKOFFSET, REMARKSIZE ) + aLabel[ LBL_HEIGHT ] := BIN2W( hb_BSubStr( cBuff, HEIGHTOFFSET, HEIGHTSIZE ) ) + aLabel[ LBL_WIDTH ] := BIN2W( hb_BSubStr( cBuff, WIDTHOFFSET, WIDTHSIZE ) ) + aLabel[ LBL_LMARGIN ] := BIN2W( hb_BSubStr( cBuff, LMARGINOFFSET, LMARGINSIZE ) ) + aLabel[ LBL_LINES ] := BIN2W( hb_BSubStr( cBuff, LINESOFFSET, LINESSIZE ) ) + aLabel[ LBL_SPACES ] := BIN2W( hb_BSubStr( cBuff, SPACESOFFSET, SPACESSIZE ) ) + aLabel[ LBL_ACROSS ] := BIN2W( hb_BSubStr( cBuff, ACROSSOFFSET, ACROSSSIZE ) ) FOR i := 1 TO aLabel[ LBL_HEIGHT ] // Get the text of the expression - cFieldText := RTrim( SubStr( cBuff, nOffset, FIELDSIZE ) ) + cFieldText := RTrim( hb_BSubStr( cBuff, nOffset, FIELDSIZE ) ) nOffset := nOffSet + 60 - IF !Empty( cFieldText ) + IF ! Empty( cFieldText ) AAdd( aLabel[ LBL_FIELDS ], {} ) diff --git a/harbour/src/rtl/treport.prg b/harbour/src/rtl/treport.prg index 87a5513f7e..252c678a03 100644 --- a/harbour/src/rtl/treport.prg +++ b/harbour/src/rtl/treport.prg @@ -239,7 +239,7 @@ METHOD New( cFrmName AS STRING,; ::lFormFeeds := .F. ENDIF - IF !Empty(cAltFile) // To file + IF ! Empty( cAltFile ) // To file lExtraState := Set( _SET_EXTRA, .T. ) cExtraFile := Set( _SET_EXTRAFILE, cAltFile ) ENDIF @@ -321,7 +321,7 @@ METHOD New( cFrmName AS STRING,; ENDIF NEXT - IF !lAnySubTotals + IF ! lAnySubTotals LOOP // NOTE ENDIF @@ -429,9 +429,9 @@ METHOD New( cFrmName AS STRING,; // clean up Set( _SET_PRINTER, lPrintOn ) // Set the printer back to prior state - Set( _SET_CONSOLE, lConsoleOn ) // Set the console back to prior state + Set( _SET_CONSOLE, lConsoleOn ) // Set the console back to prior state - IF !Empty(cAltFile) // Set extrafile back + IF ! Empty( cAltFile ) // Set extrafile back Set( _SET_EXTRAFILE, cExtraFile ) Set( _SET_EXTRA, lExtraState ) ENDIF @@ -472,12 +472,12 @@ METHOD ReportHeader() CLASS HBReportForm nRPageSize := ::aReportData[ RPT_WIDTH ] - ::aReportData[ RPT_RMARGIN ] - IF !::aReportData[ RPT_PLAIN ] + IF ! ::aReportData[ RPT_PLAIN ] IF ::aReportData[ RPT_HEADING ] == "" AAdd( aPageHeader, __NatMsg( _RFRM_PAGENO ) + Str( ::nPageNumber, 6 ) ) ELSE - aTempPgHeader:=ParseHeader( ::aReportData[ RPT_HEADING ],; + aTempPgHeader := ParseHeader( ::aReportData[ RPT_HEADING ],; Occurs( ";", ::aReportData[ RPT_HEADING ] ) + 1 ) FOR nLine := 1 to Len( aTempPgHeader) @@ -513,10 +513,10 @@ METHOD ReportHeader() CLASS HBReportForm NEXT - AADD( aPageHeader, "" ) // S87 compat. + AAdd( aPageHeader, "" ) // S87 compat. nLinesInHeader := Len( aPageHeader) - nMaxColLength :=0 + nMaxColLength := 0 FOR nCol := 1 TO Len( ::aReportData[ RPT_COLUMNS ] ) nMaxColLength := Max( Len( ::aReportData[ RPT_COLUMNS, nCol, RCT_HEADER ] ), ; nMaxColLength ) @@ -590,7 +590,7 @@ METHOD ExecuteReport() CLASS HBReportForm // Determine if any of the groups have changed. If so, add the appropriate // line to aRecordHeader for totaling out the previous records - IF !::lFirstPass // Don't bother first time through + IF ! ::lFirstPass // Don't bother first time through // Make a pass through all the groups FOR nGroup := Len( ::aReportData[ RPT_GROUPS ] ) TO 1 STEP -1 @@ -609,7 +609,7 @@ METHOD ExecuteReport() CLASS HBReportForm lEjectGrp := ::aReportData[ RPT_GROUPS, nGroup, RGT_AEJECT ] ENDIF - IF !lAnySubTotals + IF ! lAnySubTotals LOOP // NOTE ENDIF @@ -762,7 +762,7 @@ METHOD ExecuteReport() CLASS HBReportForm NEXT // Only run through the record detail if this is NOT a summary report - IF !::aReportData[ RPT_SUMMARY ] + IF ! ::aReportData[ RPT_SUMMARY ] // Determine the max number of lines needed by each expression nMaxLines := 1 FOR nCol := 1 TO Len( ::aReportData[ RPT_COLUMNS ] ) @@ -925,7 +925,7 @@ METHOD LoadReportFile( cFrmFile AS STRING ) CLASS HBReportForm // Open the report file nFrmHandle := FOpen( cFrmFile ) - IF !Empty( nFileError := FError() ) .AND. !( "\" $ cFrmFile .OR. ":" $ cFrmFile ) + IF ! Empty( nFileError := FError() ) .AND. !( "\" $ cFrmFile .OR. ":" $ cFrmFile ) // Search through default path; attempt to open report file cDefPath := Set( _SET_DEFAULT ) + ";" + Set( _SET_PATH ) @@ -977,8 +977,8 @@ METHOD LoadReportFile( cFrmFile AS STRING ) CLASS HBReportForm IF nFileError == F_OK // Is this a .frm type file (2 at start and end of file) - IF BIN2W( SubStr( cFileBuff, 1, 2 ) ) == 2 .AND.; - BIN2W( SubStr( cFileBuff, SIZE_FILE_BUFF - 1, 2 ) ) == 2 + IF BIN2W( hb_BSubStr( cFileBuff, 1, 2 ) ) == 2 .AND.; + BIN2W( hb_BSubStr( cFileBuff, SIZE_FILE_BUFF - 1, 2 ) ) == 2 nFileError := F_OK ELSE @@ -990,7 +990,7 @@ METHOD LoadReportFile( cFrmFile AS STRING ) CLASS HBReportForm ENDIF // Close file - IF !FClose( nFrmHandle ) + IF ! FClose( nFrmHandle ) nFileError := FError() ENDIF @@ -1000,39 +1000,39 @@ METHOD LoadReportFile( cFrmFile AS STRING ) CLASS HBReportForm IF nFileError == F_OK // Fill processing buffers - ::cLengthsBuff := SubStr( cFileBuff, LENGTHS_OFFSET, SIZE_LENGTHS_BUFF ) - ::cOffSetsBuff := SubStr( cFileBuff, OFFSETS_OFFSET, SIZE_OFFSETS_BUFF ) - ::cExprBuff := SubStr( cFileBuff, EXPR_OFFSET, SIZE_EXPR_BUFF ) - cFieldsBuff := SubStr( cFileBuff, FIELDS_OFFSET, SIZE_FIELDS_BUFF ) - cParamsBuff := SubStr( cFileBuff, PARAMS_OFFSET, SIZE_PARAMS_BUFF ) + ::cLengthsBuff := hb_BSubStr( cFileBuff, LENGTHS_OFFSET, SIZE_LENGTHS_BUFF ) + ::cOffSetsBuff := hb_BSubStr( cFileBuff, OFFSETS_OFFSET, SIZE_OFFSETS_BUFF ) + ::cExprBuff := hb_BSubStr( cFileBuff, EXPR_OFFSET, SIZE_EXPR_BUFF ) + cFieldsBuff := hb_BSubStr( cFileBuff, FIELDS_OFFSET, SIZE_FIELDS_BUFF ) + cParamsBuff := hb_BSubStr( cFileBuff, PARAMS_OFFSET, SIZE_PARAMS_BUFF ) // Process report attributes // Report width - aReport[ RPT_WIDTH ] := BIN2W( SubStr( cParamsBuff, PAGE_WIDTH_OFFSET, 2 ) ) + aReport[ RPT_WIDTH ] := BIN2W( hb_BSubStr( cParamsBuff, PAGE_WIDTH_OFFSET, 2 ) ) // Lines per page - aReport[ RPT_LINES ] := BIN2W( SubStr( cParamsBuff, LNS_PER_PAGE_OFFSET, 2 ) ) + aReport[ RPT_LINES ] := BIN2W( hb_BSubStr( cParamsBuff, LNS_PER_PAGE_OFFSET, 2 ) ) // Page offset (left margin) - aReport[ RPT_LMARGIN ] := BIN2W( SubStr( cParamsBuff, LEFT_MRGN_OFFSET, 2 ) ) + aReport[ RPT_LMARGIN ] := BIN2W( hb_BSubStr( cParamsBuff, LEFT_MRGN_OFFSET, 2 ) ) // Page right margin (not used) - aReport[ RPT_RMARGIN ] := BIN2W( SubStr( cParamsBuff, RIGHT_MGRN_OFFSET, 2 ) ) + aReport[ RPT_RMARGIN ] := BIN2W( hb_BSubStr( cParamsBuff, RIGHT_MGRN_OFFSET, 2 ) ) - nColCount := BIN2W( SubStr( cParamsBuff, COL_COUNT_OFFSET, 2 ) ) + nColCount := BIN2W( hb_BSubStr( cParamsBuff, COL_COUNT_OFFSET, 2 ) ) // Line spacing // Spacing is 1, 2, or 3 - aReport[ RPT_SPACING ] := iif( SubStr( cParamsBuff, ; + aReport[ RPT_SPACING ] := iif( hb_BSubStr( cParamsBuff, ; DBL_SPACE_OFFSET, 1 ) $ "YyTt", 2, 1 ) // Summary report flag - aReport[ RPT_SUMMARY ] := iif( SubStr( cParamsBuff, ; + aReport[ RPT_SUMMARY ] := iif( hb_BSubStr( cParamsBuff, ; SUMMARY_RPT_OFFSET, 1 ) $ "YyTt", .T., .F. ) // Process report eject and plain attributes option byte - cOptionByte := Asc( SubStr( cParamsBuff, OPTION_OFFSET, 1 ) ) + cOptionByte := Asc( hb_BSubStr( cParamsBuff, OPTION_OFFSET, 1 ) ) IF Int( cOptionByte / 4 ) == 1 aReport[ RPT_PLAIN ] := .T. // Plain page @@ -1050,7 +1050,7 @@ METHOD LoadReportFile( cFrmFile AS STRING ) CLASS HBReportForm ENDIF // Page heading, report title - nPointer := BIN2W( SubStr( cParamsBuff, PAGE_HDR_OFFSET, 2 ) ) + nPointer := BIN2W( hb_BSubStr( cParamsBuff, PAGE_HDR_OFFSET, 2 ) ) // Retrieve the header stored in the .frm file nHeaderIndex := 4 @@ -1070,9 +1070,9 @@ METHOD LoadReportFile( cFrmFile AS STRING ) CLASS HBReportForm // Process Groups // Group - nPointer := BIN2W( SubStr( cParamsBuff, GRP_EXPR_OFFSET, 2 ) ) + nPointer := BIN2W( hb_BSubStr( cParamsBuff, GRP_EXPR_OFFSET, 2 ) ) - IF !Empty( cGroupExp := ::GetExpr( nPointer ) ) + IF ! Empty( cGroupExp := ::GetExpr( nPointer ) ) // Add a new group array AAdd( aReport[ RPT_GROUPS ], Array( RGT_COUNT ) ) @@ -1086,19 +1086,19 @@ METHOD LoadReportFile( cFrmFile AS STRING ) CLASS HBReportForm ENDIF // Group header - nPointer := BIN2W( SubStr( cParamsBuff, GRP_HDR_OFFSET, 2 ) ) + nPointer := BIN2W( hb_BSubStr( cParamsBuff, GRP_HDR_OFFSET, 2 ) ) aReport[ RPT_GROUPS ][ 1 ][ RGT_HEADER ] := ::GetExpr( nPointer ) // Page eject after group - aReport[ RPT_GROUPS ][ 1 ][ RGT_AEJECT ] := iif( SubStr( cParamsBuff, ; + aReport[ RPT_GROUPS ][ 1 ][ RGT_AEJECT ] := iif( hb_BSubStr( cParamsBuff, ; PE_OFFSET, 1) $ "YyTt", .T., .F. ) ENDIF // Subgroup - nPointer := BIN2W( SubStr( cParamsBuff, SUB_EXPR_OFFSET, 2 ) ) + nPointer := BIN2W( hb_BSubStr( cParamsBuff, SUB_EXPR_OFFSET, 2 ) ) - IF !Empty( cSubGroupExp := ::GetExpr( nPointer ) ) + IF ! Empty( cSubGroupExp := ::GetExpr( nPointer ) ) // Add new group array AAdd( aReport[ RPT_GROUPS ], Array( RGT_COUNT ) ) @@ -1112,7 +1112,7 @@ METHOD LoadReportFile( cFrmFile AS STRING ) CLASS HBReportForm ENDIF // Subgroup header - nPointer := BIN2W( SubStr( cParamsBuff, SUB_HDR_OFFSET, 2 ) ) + nPointer := BIN2W( hb_BSubStr( cParamsBuff, SUB_HDR_OFFSET, 2 ) ) aReport[ RPT_GROUPS ][ 2 ][ RGT_HEADER ] := ::GetExpr( nPointer ) // Page eject after subgroup @@ -1164,8 +1164,8 @@ METHOD GetExpr( nPointer AS NUMERIC ) CLASS HBReportForm nOffsetOffset := ( nPointer * 2 ) - 1 ENDIF - nExprOffset := BIN2W( SubStr( ::cOffsetsBuff, nOffsetOffset, 2 ) ) - nExprLength := BIN2W( SubStr( ::cLengthsBuff, nOffsetOffset, 2 ) ) + nExprOffset := BIN2W( hb_BSubStr( ::cOffsetsBuff, nOffsetOffset, 2 ) ) + nExprLength := BIN2W( hb_BSubStr( ::cLengthsBuff, nOffsetOffset, 2 ) ) // EXPR_OFFSET points to a NULL, so add one (+1) to get the string // and subtract one (-1) from EXPR_LENGTH for correct length @@ -1174,11 +1174,11 @@ METHOD GetExpr( nPointer AS NUMERIC ) CLASS HBReportForm nExprLength-- // Extract string - cString := SubStr( ::cExprBuff, nExprOffset, nExprLength ) + cString := hb_BSubStr( ::cExprBuff, nExprOffset, nExprLength ) // dBASE does this so we must do it too // Character following character pointed to by pointer is NULL - IF Chr( 0 ) == SubStr( cString, 1, 1 ) .AND. Len( SubStr( cString, 1, 1 ) ) == 1 + IF Chr( 0 ) == hb_BLeft( cString, 1 ) .AND. Len( hb_BLeft( cString, 1 ) ) == 1 cString := "" ENDIF ENDIF @@ -1240,14 +1240,14 @@ STATIC FUNCTION ParseHeader( cHeaderString, nFields ) DO WHILE ++nItemCount <= nFields - cItem := SubStr( cHeaderString, 1, nHeaderLen ) + cItem := Left( cHeaderString, nHeaderLen ) // check for explicit delimiter nPos := At( ";", cItem ) IF ! Empty( nPos ) // delimiter present - AAdd( aPageHeader, SubStr( cItem, 1, nPos - 1 ) ) + AAdd( aPageHeader, Left( cItem, nPos - 1 ) ) ELSE IF Empty( cItem ) // empty string for S87 and 5.0 compatibility @@ -1283,29 +1283,29 @@ METHOD GetColumn( cFieldsBuffer AS STRING, nOffset AS NUMERIC ) CLASS HBReportFo LOCAL nPointer, aColumn[ RCT_COUNT ], cType, cExpr // Column width - aColumn[ RCT_WIDTH ] := BIN2W( SubStr( cFieldsBuffer, nOffset + ; + aColumn[ RCT_WIDTH ] := BIN2W( hb_BSubStr( cFieldsBuffer, nOffset + ; FIELD_WIDTH_OFFSET, 2 ) ) // Total column? - aColumn[ RCT_TOTAL ] := iif( SubStr( cFieldsBuffer, nOffset + ; + aColumn[ RCT_TOTAL ] := iif( hb_BSubStr( cFieldsBuffer, nOffset + ; FIELD_TOTALS_OFFSET, 1 ) $ "YyTt", .T., .F. ) // Decimals width - aColumn[ RCT_DECIMALS ] := BIN2W( SubStr( cFieldsBuffer, nOffset + ; + aColumn[ RCT_DECIMALS ] := BIN2W( hb_BSubStr( cFieldsBuffer, nOffset + ; FIELD_DECIMALS_OFFSET, 2 ) ) // Offset (relative to FIELDS_OFFSET), 'point' to // expression area via array OFFSETS[] // Content expression - nPointer := BIN2W( SubStr( cFieldsBuffer, nOffset +; + nPointer := BIN2W( hb_BSubStr( cFieldsBuffer, nOffset +; FIELD_CONTENT_EXPR_OFFSET, 2 ) ) aColumn[ RCT_TEXT ] := ::GetExpr( nPointer ) cExpr := aColumn[ RCT_TEXT ] aColumn[ RCT_EXP ] := hb_macroBlock( cExpr ) // Header expression - nPointer := BIN2W( SubStr( cFieldsBuffer, nOffset +; + nPointer := BIN2W( hb_BSubStr( cFieldsBuffer, nOffset +; FIELD_HEADER_EXPR_OFFSET, 2 ) ) aColumn[ RCT_HEADER ] := ListAsArray( ::GetExpr( nPointer ), ";" ) @@ -1318,7 +1318,7 @@ METHOD GetColumn( cFieldsBuffer AS STRING, nOffset AS NUMERIC ) CLASS HBReportFo SWITCH cType CASE "C" CASE "M" - aColumn[ RCT_PICT ] := Replicate("X", aColumn[ RCT_WIDTH ] ) + aColumn[ RCT_PICT ] := Replicate( "X", aColumn[ RCT_WIDTH ] ) EXIT CASE "D" aColumn[ RCT_PICT ] := "@D" @@ -1369,10 +1369,10 @@ STATIC FUNCTION ListAsArray( cList, cDelimiter ) IF SubStr( cList, nPos, 1 ) == cDelimiter lDelimLast := .T. - AAdd( aList, SubStr( cList, 1, nPos - 1 ) ) // Add a new element + AAdd( aList, Left( cList, nPos - 1 ) ) // Add a new element ELSE lDelimLast := .F. - AAdd( aList, SubStr( cList, 1, nPos ) ) // Add a new element + AAdd( aList, Left( cList, nPos ) ) // Add a new element ENDIF cList := SubStr( cList, nPos + 1 )