fivedev/harbour-core
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

see changelog 20000410 09:00

Browse Source
This commit is contained in:
Luiz Rafael Culik
2000-04-10 11:43:34 +00:00
parent bf2a6741b3
commit 65b2a17b70
13 changed files with 3607 additions and 3160 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
harbour/doc/en/binnum.txt
View File

@@ -306,7 +306,7 @@
* $FILES$
* Library is rtl.lib
* $SEEALSO$
* BIN2I,BIN2L(),BIN2U(),BIN2W(),L2BIN(),W2BIN(),WORD(),U2BIN(),FWRITE()
* BIN2I(),BIN2L(),BIN2U(),BIN2W(),L2BIN(),W2BIN(),WORD(),U2BIN(),FWRITE()
* $END$
*/
@@ -348,7 +348,7 @@
* $FILES$
* Library is rtl.lib
* $SEEALSO$
* BIN2I,BIN2L(),BIN2U(),BIN2W(),I2BIN(),L2BIN(),WORD(),U2BIN(),FWRITE()
* BIN2I(),BIN2L(),BIN2U(),BIN2W(),I2BIN(),L2BIN(),WORD(),U2BIN(),FWRITE()
* $END$
*/
@@ -387,7 +387,7 @@
* $FILES$
* Library is rtl.lib
* $SEEALSO$
* BIN2I,BIN2L(),BIN2U(),BIN2W(),I2BIN(),W2BIN(),WORD(),U2BIN(),FWRITE()
* BIN2I(),BIN2L(),BIN2U(),BIN2W(),I2BIN(),W2BIN(),WORD(),U2BIN(),FWRITE()
* $END$
*/
@@ -429,7 +429,7 @@
* $FILES$
* Library is rtl.lib
* $SEEALSO$
* BIN2I,BIN2L(),BIN2U(),BIN2W(),I2BIN(),L2BIN(),W2BIN(),WORD(),FWRITE()
* BIN2I(),BIN2L(),BIN2U(),BIN2W(),I2BIN(),L2BIN(),W2BIN(),WORD(),FWRITE()
* $END$
*/

4
harbour/doc/en/diskspac.txt
View File

@@ -64,7 +64,9 @@
* CA-Clipper will return an integer value which limits it's usefulness to
* drives less than 2 gigabytes. The Harbour version will return a
* floating point value with 0 decimals if the disk is > 2 gigabytes.
* <nType> is a Harbour extension.
* <nType> is a Harbour extension.
* $PLATFORMS$
* Dos,Windows and OS/2
* $FILES$
* Library is Rtl.lib
* Header is Fileio.ch

31
harbour/doc/en/file.txt
View File

@@ -875,3 +875,34 @@
* FILE()
* $END$
*/
/* $DOC$
* $FUNCNAME$
* COPY FILE
* $CATEGORY$
* Command
* $ONELINER$
* Copies a file.
* $SYNTAX$
* COPY FILE <cfile> TO <cfile1>
* $ARGUMENTS$
* <cFile> Filename of source file
* <cFile1> Filename of target file
* $DESCRIPTION$
* This command makes an exact copy of <cFile> and names it <cFile1>.
* 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.<cFile1> also can refer to a OS
* device (e.g. LPT1).This command does not obsert 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\utils\hbdoc\gennf.prg to LPT1
* $STATUS$
* R
* $COMPLIANCE$
* This command is Ca-Clipper compliant
* $SEEALSO$
* ERASE,RENAME,FRENAME(),FERASE()
* $END$
*/

40
harbour/doc/en/ht_conv.txt
View File

@@ -28,10 +28,10 @@
* <cNr> .T. IF THE STRING IS BYNARY,otherwise .F.
* $DESCRIPTION$
* check if the passed string is a bynary number or not
* $FILES$
* Library is Tools.lib
* $SEEALSO$
* ISOCTAL(),ISDEC(),ISHEXA()
* $Files$
* Library is Tools.lib
* $END$
*/
@@ -50,10 +50,10 @@
* <cNr> .T. IF THE STRING IS OCTAL;otherwise .F.
* $DESCRIPTION$
* check if the passed string is a octal number or not
* $FILES$
* Library is Tools.lib
* $SEEALSO$
* ISBIN(),ISDEC(),ISHEXA()
* $Files$
* Library is Tools.lib
* $END$
*/
@@ -72,10 +72,10 @@
* <cNr> .T. IF THE STRING IS DECIMAL;otherwise .F.
* $DESCRIPTION$
* check if the passed string is a decimal number or not
* $FILES$
* Library is Tools.lib
* $SEEALSO$
* ISOCTAL(),ISBIN(),ISHEXA()
* $Files$
* Library is Tools.lib
* $END$
*/
@@ -94,10 +94,10 @@
* <cNr> .T. IF THE STRING IS HEXA;otherwise .F.
* $DESCRIPTION$
* check if the passed string is a hexa number or not
* $FILES$
* Library is Tools.lib
* $SEEALSO$
* ISOCTAL(),ISDEC(),ISBIN()
* $Files$
* Library is Tools.lib
* $END$
*/
@@ -117,10 +117,10 @@
* $DESCRIPTION$
* This function converts a string <cN> from an decimal value
* to an binary value.
* $FILES$
* Library is Tools.lib
* $SEEALSO$
* Dectohexa(),dectooctal()
* $Files$
* Library is Tools.lib
* $END$
*/
@@ -140,10 +140,10 @@
* $DESCRIPTION$
* This function converts a string <cN> from an decimal value
* to an octal value.
* $FILES$
* Library is Tools.lib
* $SEEALSO$
* Dectohexa(),dectobin()
* $Files$
* Library is Tools.lib
* $END$
*/
@@ -163,10 +163,10 @@
* $DESCRIPTION$
* This function converts a string <cN> from an decimal value
* to an hexadecimal value.
* $FILES$
* Library is Tools.lib
* $SEEALSO$
* Dectobin(),dectooctal()
* $Files$
* Library is Tools.lib
* $END$
*/
@@ -186,10 +186,10 @@
* $DESCRIPTION$
* This function converts a string <cN> from an binary value
* to a numeric decimal value.
* $FILES$
* Library is Tools.lib
* $SEEALSO$
* OctaltoDec(),HexatoDec()
* $Files$
* Library is Tools.lib
* $END$
*/
@@ -209,10 +209,10 @@
* $DESCRIPTION$
* This function converts a string <cN> from an octal value
* to a numeric decimal value.
* $FILES$
* Library is Tools.lib
* $SEEALSO$
* BintoDec(),HexatoDec()
* $Files$
* Library is Tools.lib
* $END$
*/
@@ -232,10 +232,10 @@
* $DESCRIPTION$
* This function converts a string <cN> from an hexadecimal value
* to a numeric decimal value.
* $FILES$
* Library is Tools.lib
* $SEEALSO$
* OctaltoDec(),BintoDec()
* $Files$
* Library is Tools.lib
* $END$
*/

6
harbour/doc/en/hvm.txt
View File

@@ -6,6 +6,12 @@
* The following parts are Copyright of the individual authors.
* www - http://www.harbour-project.org
*
* Copyright 1999 Jose Lanin <dezac@corevia.com>
* Documentation for: PROCLINE(),PROCFILE(),PROCNAME()
*
* Copyright 1999 Eddie Ruina
* Documentation for: __VMVARLGET()
*
* Copyright 1999 Chen Kedem <niki@actcom.co.il>
* Documentation for: CLIPINIT(), __SETHELPK()
*

39
harbour/doc/en/math.txt
View File

@@ -8,7 +8,7 @@
*
* Copyright 2000 Luiz Rafael Culik <culik@sl.conex.net>
* Documentation for: ABS(),EXP(),LOG(),INT(),MAX()
* MIN(),SQRT()
* MIN(),SQRT(),ROUND()
* See doc/license.txt for licensing terms.
*
*/
@@ -302,3 +302,40 @@
* ROUND()
* $END$
*/
/* $DOC$
* $FUNCNAME$
* ROUND()
* $CATEGORY$
* Math
* $ONELINER$
* Rounds off a numeric expression
* $SYNTAX$
* ROUND( <nNumber>,<nPlace> ) --> <nResult>
* $ARGUMENTS$
* <nNumber> Any numeric value
*
* <nPlace> The number of places to round to
* $RETURNS$
* <nResult> Rounded number
* $DESCRIPTION$
* This function rounds off the value of <nNumber> to the number of
* decimal places specified by <nPlace>.If the value of <nPlace> is a
* negative number,the function will atempt to round <nNumber> 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$
* This function is CA-Clipper compliant.
* $PLATFORMS$
* All
* $FILES$
* Library is Rtl.lib
* $SEEALSO$
* INT(),STR(),VAL(),SET FIXED
* $END$
*/

75
harbour/doc/en/misc.txt
View File

@@ -23,14 +23,14 @@
* $CATEGORY$
* DOS
* $RETURNS$
* <cOperatinSystem> -> The Current operating system </par>
* <cOperatinSystem> -> The Current operating system
* $DESCRIPTION$
* This function will return the current operating system </par>
* This function will return the current operating system
* $EXAMPLES$
* ? OS()
* </fixed>
* $FILES$
* source/rtl/version.c </par>
* source/rtl/version.c
* $END$
*/
@@ -45,13 +45,13 @@
* VERSION([<xMode>] --> <cReturn>
* $ARGUMENTS$
* [<xMode>] Optional Parameter that enables the display
* of the C compiler version that HARBOUR was built with. </par>
* of the C compiler version that HARBOUR was built with.
* $RETURNS$
* <cReturn> String contining the Harbour Version or the Harbour
* and C compiler Version when the <nMode> parameter is used. </par>
* and C compiler Version when the <nMode> parameter is used.
* $DESCRIPTION$
* This function returns the HARBOUR Version or the Harbour Version+C
* compiler Version used to create the Harbour runtime library </par>
* compiler Version used to create the Harbour runtime library
* $EXAMPLES$
* ? QOUT(VERSION()) // Displays Harbour version only
* ? QOUT(VERSION(NIL)) // Displays Harbour and C Compiler versions
@@ -64,9 +64,9 @@
* the Version of the CA-Clipper Compiler. The Harbour version returns
* only the Harbour Version if called without the <nMode> parameter, but
* returns both the Harbour Version and the Version of the C compiler used
* to build Harbour when the <nMode> parameter is present. </par>
* to build Harbour when the <nMode> parameter is present.
* $FILES$
* source/rtl/version.c </par>
* source/rtl/version.c
* Library is Rtl.lib
* $SEEALSO$
* OS()
@@ -83,16 +83,16 @@
* $SYNTAX$
* GETENV(<cEnviroment>, <cDefaultValue> ) --> <cReturn>
* $ARGUMENTS$
* <cEnviroment> Enviromental variable to obtain </par>
* <cEnviroment> Enviromental variable to obtain
*
* <cDefaultValue> Optional value to return if <cEnvironment> is not found </par>
* <cDefaultValue> Optional value to return if <cEnvironment> is not found
* $RETURNS$
* <cReturn> Value of the Variable </par>
* <cReturn> Value of the Variable
* $DESCRIPTION$
* This function yields a string that is the value of the
* environmental variable <cEnviroment>, witch is stored at the
* level with the Set command. If no environmental variable
* can be found, the value of the function will be a empty string. </par>
* can be found, the value of the function will be a empty string.
* $EXAMPLES$
* ? QOUT(GETENV('PATH'))
* ? QOUT(GETENV('CONFIG'))
@@ -101,9 +101,9 @@
* $STATUS$
* R
* $COMPLIANCE$
* This functions is CA-CLIPPER compliant </par>
* This functions is CA-CLIPPER compliant
* $FILES$
* source/rtl/gete.c </par>
* source/rtl/gete.c
* Library is Rtl.lib
* $END$
*/
@@ -118,22 +118,22 @@
* $SYNTAX$
* __RUN( <cCommand> )
* $ARGUMENTS$
* <cCommand> Command to execute </par>
* <cCommand> 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. </par>
* 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 it cause several problems </par>
* (in case of DOS) since it cause 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. </par>
* Use the RUN command instead.
* $EXAMPLES$
* __Run( "edit " + cMyTextFile ) // Runs an external editor
* __Run( "command" ) // Gives a DOS shell (DOS only)
* </fixed>
* $FILES$
* source/rtl/run.c </par>
* source/rtl/run.c
* Library is Rtl.lib
* $SEEALSO$
* RUN
@@ -151,16 +151,16 @@
* TONE( <nFrequency>, <nDuration> ) --> NIL
* $ARGUMENTS$
* <nFrequency> is a non-negative numeric value that specifies the
* frequency of the tone in hertz. </par>
* frequency of the tone in hertz.
* <nDuration> is a positive numeric value which specifies the duration
* of the tone in 1/18 of a second units. </par>
* of the tone in 1/18 of a second units.
* $RETURNS$
* TONE() always return NIL. </par>
* TONE() always return 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 clamped to the range 0 to 32767 Hz. </par>
* is clamped to the range 0 to 32767 Hz.
* $EXAMPLES$
* If lOk // Good Sound
* TONE( 500, 1 )
@@ -185,10 +185,37 @@
* $STATUS$
* S
* $COMPLIANCE$
* TONE() works exactly like CA-Clipper's TONE(). </par>
* TONE() works exactly like CA-Clipper's TONE().
* $FILES$
* Library is Rtl.lib
* $SEEALSO$
* CHR(),SET BELL
* $END$
*/
/* $DOC$
* $FUNCNAME$
* RUN
* $CATEGORY$
* Command
* $ONELINER$
* Run a external program
* $SYNTAX$
* RUN <cCommand>
* $ARGUMENTS$
* <cCommand> 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 it cause several problems
* $EXAMPLES$
* Run "edit " + cMyTextFile // Runs an external editor
* Run "command" // Gives a DOS shell (DOS only)
* $FILES$
* source/rtl/run.c
* Library is Rtl.lib
* $SEEALSO$
* RUN
* $END$
*/

3109
harbour/doc/en/rdd.txt
View File

File diff suppressed because it is too large Load Diff

1318
harbour/doc/en/rdddb.txt Normal file
View File

File diff suppressed because it is too large Load Diff

1026
harbour/doc/en/rddmisc.txt Normal file
View File

File diff suppressed because it is too large Load Diff

814
harbour/doc/en/rddord.txt Normal file
View File

@@ -0,0 +1,814 @@
/*
* $Id$
*/
/*
* The following parts are Copyright of the individual authors.
* www - http://www.harbour-project.org
*
* Copyright 1999 Luiz Rafael Culik <culik@sl.conex.net>
* DB*() documentation
* ORD*() documentation
* RDD*() documentation
*
* See doc/license.txt for licensing terms.
*
*/
/* $DOC$
* $FUNCNAME$
* INDEXORD()
* $CATEGORY$
* Data Base
* $ONELINER$
* Return the order position of the controlling index
* $SYNTAX$
* INDEXORD() --> nOrder
* $RETURNS$
* <nOrder> an integer numeric value. The value returned is
* equal to the position of the controlling index in the list of open
* indexes for the current work area. A value of zero indicates that there
* is no controlling index and records are being accessed in natural order.
* If no database file is open, INDEXORD() will also return a zero.
* $DESCRIPTION$
* INDEXORD() is a database function that determines the position of the
* controlling index in the list of index files opened by the last
* USE...INDEX or SET INDEX TO in the current work area. It is often
* useful to save the last controlling index so it can be restored later.
*
* By default, INDEXORD() operates on the currently selected work area. It
* will operate on an unselected work area if you specify it as part of an
* aliased expression (see example below).
* $EXAMPLES$
* This example uses INDEXORD() to save the current order. After
* changing to a new order, it uses the saved value to restore the
* original order:
*
* USE Customer INDEX Name, Serial NEW
* nOrder := INDEXORD() // Result: 1
* SET ORDER TO 2
* ? INDEXORD() // Result: 2
* SET ORDER TO nOrder
* ? INDEXORD() // Result: 1
*
* This example uses an aliased expression to determine the order
* number of the controlling index in an unselected work area:
*
* USE Sales INDEX Salesman, CustNum NEW
* USE Customer INDEX Name, Serial NEW
* ? Sales->(INDEXORD()) // Result: 1
* $STATUS$
* S
* $COMPLIANCE$
* This function is CA Clipper compliant
* $FILES$
* Library is Rdd.lib
* $SEEALSO$
* INDEXKEY()
* $END$
*/
/* $DOC$
* $FUNCNAME$
* ORDBAGEXT()
* $CATEGORY$
* Data Base
* $ONELINER$
* Return the default Order Bag RDD extension
* $SYNTAX$
* ORDBAGEXT() --> cBagExt
* $RETURNS$
* <cBagExt> a character expression.
* $DESCRIPTION$
* ORDBAGEXT() is an Order management function that returns a character
* expression that is the default Order Bag extension of the current or
* aliased work area. cBagExt is determined by the RDD active in the
* current work area.
*
* ORDBAGEXT() supersedes the INDEXEXT() and is not recommended.
*
* $EXAMPLES$
* USE sample VIA "DBFNTX"
* ? ORDBAGEXT() // Returns .ntx
*
* $STATUS$
* S
* $COMPLIANCE$
* This function is CA Clipper compliant
* $SEEALSO$
* INDEXEXT(),ORDBAGNAME()
* $INCLUDE$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* ORDBAGNAME()
* $CATEGORY$
* Data Base
* $ONELINER$
* Return the Order Bag name of a specific Order
* $SYNTAX$
* ORDBAGNAME(<nOrder> | <cOrderName>) --> cOrderBagName
* $ARGUMENTS$
* <nOrder> is an integer that identifies the position in the Order
* List of the target Order whose Order Bag name is sought.
*
* <cOrderName> is a character string that represents the name of the
* target Order whose Order Bag name is sought.
*
* $RETURNS$
* ORDBAGNAME() returns a character string, the Order Bag name of the
* specific Order.
* $DESCRIPTION$
* ORDBAGNAME() is an Order management function that lets you access the
* name of the Order Bag in which <cOrderName> resides. You may identify
* the Order as a character string or with an integer that represents its
* position in the Order List. In case of duplicate names, ORDBAGNAME()
* only recognizes the first matching name.
* $EXAMPLES$
* The following example uses ORDBAGNAME() with the default
* DBFNTX driver:
*
* USE Customer VIA "DBFNTX" NEW
* SET INDEX TO CuAcct, CuName, CuZip
* ORDBAGNAME( 2 ) // Returns: CuName
* ORDBAGNAME( 1 ) // Returns: CuAcct
* ORDBAGNAME( 3 ) // Returns: CuZip
*
*
* In this example, Customer.cdx contains three orders named
* CuAcct, CuName, CuZip:
*
* USE Customer VIA "DBFCDX" NEW
* SET INDEX TO Customer
* ORDBAGNAME( "CuAcct" ) // Returns: Customer
* ORDBAGNAME( "CuName" ) // Returns: Customer
* ORDBAGNAME( "CuZip" ) // Returns: Customer
* $TESTS$
*
* $STATUS$
* S
* $COMPLIANCE$
*
* $SEEALSO$
* ORDBAGEXT()
* $INCLUDE$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* ORDCONDSET()
* $CATEGORY$
* Data Base
* $ONELINER$
* Set the Condition and scope for an order
* $SYNTAX$
* ORDCONSET([<cForCondition>],
* [<bForCondition>],
* [<lAll>],
* [<bWhileCondition>],
* [<bEval>],
* [<nInterval>],
* [<nStart>],
* [<nNext>],
* [<nRecord>],
* [<lRest>],
* [<lDescend>],
* [<lAdditive>],
* [<lCurrent>],
* [<lCustom>],
* [<lNoOptimize>])
* $ARGUMENTS$
* <cForCondition> is a string that specifies the FOR condition for the
* order.
* <bForCondition> 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.
* $RETURNS$
*
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $TESTS$
*
* $STATUS$
* S
* $COMPLIANCE$
* ORDCONDSET() is CA-Clipper compliant
* $SEEALSO$
*
* $INCLUDE$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* ORDCREATE()
* $CATEGORY$
* Data Base
* $ONELINER$
* Create an Order in an Order Bag
* $SYNTAX$
* ORDCREATE(<cOrderBagName>,[<cOrderName>], <cExpKey>,
* [<bExpKey>], [<lUnique>]) --> NIL
* $ARGUMENTS$
* <cOrderBagName> is the name of a disk file containing one or more
* Orders. You may specify <cOrderBagName> as the filename with or without
* the pathname or extension. If you do not include the extension as part
* of <cOrderBagName> HARBOUR uses the default extension of the current
* RDD.
*
* <cOrderName> is the name of the Order to be created.
*
* Note: Although both <cOrderBagName> and <cOrderName> are both
* optional, at least one of them must be specified.
*
* <cExpKey> is an expression that returns the key value to place in
* the Order for each record in the current work area. <cExpKey> can
* represent a character, date, logical, or numeric data type. The maximum
* length of the index key expression is determined by the database driver.
*
* <bExpKey> is a code block that evaluates to a key value that is
* placed in the Order for each record in the current work area. If you do
* not supply <bExpKey>, it is macro-compiled from <cExpKey>.
*
* <lUnique> is an optional logical value that specifies whether a
* unique Order is to be created. If <lUnique> is omitted, the current
* global _SET_UNIQUE setting is used.
* $RETURNS$
* ORDCREATE() always returns NIL.
* $DESCRIPTION$
* ORDCREATE() is an Order management function that creates an Order in the
* current work area. It works like DBCREATEINDEX() except that it lets
* you create Orders in RDDs that recognize multiple-Order Bags.
* ORDCREATE() supersedes the DBCREATEINDEX() function because of this
* capability, and is the preferred function.
*
* The active RDD determines the Order capacity of an Order Bag. The
* default DBFNTX and the DBFNDX drivers only support single-Order Bags,
* while other RDDs may support multiple-Order Bags (e.g., the DBFCDX and
* DBFMDX drivers).
*
* In RDDs that support production or structural indexes (e.g., DBFCDX,
* DBFMDX), if you specify a Tag but do not specify an Order Bag, the Tag is
* created and added to the index. If no production or structural index
* exists, it will be created and the Tag will be added to it. When using
* RDDs that support multiple Order Bags, you must explicitly SET ORDER (or
* ORDSETFOCUS()) to the desired controlling Order. If you do not specify
* a controlling Order, the data file will be viewed in natural Order.
*
* If <cOrderBagName> does not exist, it is created in accordance with the
* RDD in the current or specified work area.
*
* If <cOrderBagName> exists and the RDD specifies that Order Bags can only
* contain a single Order, <cOrderBagName> is erased and the new Order is
* added to the Order List in the current or specified work area.
*
* If <cOrderBagName> exists and the RDD specifies that Order Bags can
* contain multiple Tags, <cOrderName> is created if it does not already
* exist, otherwise <cOrderName> is replaced in <cOrderBagName> and the
* Order is added to the Order List in the current or specified work area.
* $EXAMPLES$
* The following example demonstrates ORDCREATE() with the DBFNDX
* driver:
*
* USE Customer VIA "DBFNDX" NEW
* ORDCREATE( "CuAcct",, "Customer->Acct" )
*
*
* The following example demonstrates ORDCREATE() with the
* default DBFNTX driver:
*
* USE Customer VIA "DBFNTX" NEW
* ORDCREATE( "CuAcct", "CuAcct", "Customer->Acct", ;
* {|| Customer->Acct } )
*
* The following example demonstrates ORDCREATE() with the FoxPro
* driver, DBFCDX:
*
* USE Customer VIA "DBFCDX" NEW
* ORDCREATE( "Customer", "CuAcct", "Customer->Acct" )
*
* This example creates the Order "CuAcct" and adds it to the
* production index (Order Bag) "Customer". The production index , will
* be created if it doesn't exist:
*
* USE Customer VIA "DBFMDX" NEW
* ORDCREATE( , "CuAcct", "Customer->Acct" )
* $TESTS$
*
* $STATUS$
* S
* $COMPLIANCE$
*
* $SEEALSO$
* DBCREATEINDEX()
* $INCLUDE$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* ORDDESTROY()
* $CATEGORY$
* Data Base
* $ONELINER$
* Remove a specified Order from an Order Bag
* $SYNTAX$
* ORDDESTROY(<cOrderName> [, <cOrderBagName> ]) --> NIL
* $ARGUMENTS$
* <cOrderName> is the name of the Order to be removed from the current
* or specified work area.
*
* <cOrderBagName> is the name of a disk file containing one or more
* Orders. You may specify <cOrderBagName> as the filename with or without
* the pathname or appropriate extension. If you do not include the
* extension as part of <cOrderBagName> HARBOUR uses the default
* extension of the current RDD.
* $RETURNS$
* ORDDESTROY() always returns NIL.
* $DESCRIPTION$
* ORDDESTROY() is an Order management function that removes a specified
* Order from multiple-Order Bags.
*
* The active RDD determines the Order capacity of an Order Bag. The
* default DBFNTX and the DBFNDX drivers only support single-Order Bags,
* while other RDDs may support multiple-Order Bags (e.g., the DBFCDX and
* DBPX drivers).
*
* Note: RDD suppliers may define specific behaviors for this command.
*
* Warning! ORDDESTROY() is not supported for DBFNDX and DBFNTX.
* $EXAMPLES$
* This example demonstrates ORDDESTROY() with the FoxPro driver,
* DBFCDX:
*
* USE Customer VIA "DBFCDX" NEW
* SET INDEX TO Customer, CustTemp
* ORDDESTROY( "CuAcct", "Customer" )
* $TESTS$
*
* $STATUS$
* S
* $COMPLIANCE$
*
* $SEEALSO$
* ORDCREATE()
* $INCLUDE$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* ORDFOR()
* $CATEGORY$
* Data Base
* $ONELINER$
* Return the FOR expression of an Order
* $SYNTAX$
* ORDFOR(<cOrderName> | <nOrder>
* [, <cOrderBagName>]) --> cForExp
*
* $ARGUMENTS$
* <cOrderName> is the name of the target Order, whose cForExp is
* sought.
*
* <nOrder> is an integer that identifies the position in the Order
* List of the target Order whose cForExp is sought.
*
* <cOrderBagName> is the name of an Order Bag containing one or more
* Orders. You may specify <cOrderBagName> as the filename with or without
* the pathname or appropriate extension. If you do not include the
* extension as part of <cOrderBagName> HARBOUR uses the default
* extension of the current RDD.
* $RETURNS$
* ORDFOR() returns a character expression, cForExp, that represents the
* FOR condition of the specified Order. If the Order was not created
* using the FOR clause the return value will be an empty string (""). If
* the database driver does not support the FOR condition, it may either
* return an empty string ("") or raise an "unsupported function" error,
* depending on the driver.
* $DESCRIPTION$
* ORDFOR() is an Order management function that returns the character
* string, cForExp, that represents the logical FOR condition of the Order,
* <cOrderName> or <nOrder>.
* $EXAMPLES$
* This example retrieves the FOR condition from an Order:
*
* USE Customer NEW
* INDEX ON Customer->Acct ;
* TO Customer ;
* FOR Customer->Acct > "AZZZZZ"
*
* ORDFOR( "Customer" ) // Returns: Customer->Acct > "AZZZZZ"
* $TESTS$
*
* $STATUS$
* S
* $COMPLIANCE$
*
* $SEEALSO$
* ORDKEY(),ORDCREATE(),ORDNAME(),ORDNUMBER()
* $INCLUDE$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* ORDKEY()
* $CATEGORY$
* Data Base
* $ONELINER$
* Return the key expression of an Order
* $SYNTAX$
* ORDKEY(<cOrderName> | <nOrder>
* [, <cOrderBagName>]) --> cExpKey
* $ARGUMENTS$
* <cOrderName> is the name of an Order, a logical ordering of a
* database.
*
* <nOrder> is an integer that identifies the position in the Order
* List of the target Order whose cExpKey is sought.
*
* <cOrderBagName> is the name of a disk file containing one or more
* Orders. You may specify <cOrderBagName> as the filename with or without
* the pathname or appropriate extension. If you do not include the
* extension as part of <cOrderBagName> HARBOUR uses the default
* extension of the current RDD.
* $RETURNS$
* Returns a character string, cExpKey.
* $DESCRIPTION$
* ORDKEY() is an Order management function that returns a character
* expression, cExpKey, that represents the key expression of the specified
* Order.
*
* You may specify the Order by name or with a number that represents its
* position in the Order List. Using the Order name is the preferred
* method.
*
* The active RDD determines the Order capacity of an Order Bag. The
* default DBFNTX and the DBFNDX drivers only support single-Order Bags,
* while other RDDs may support multiple-Order Bags (e.g., the DBFCDX and
* DBFMDX drivers).
* $EXAMPLES$
* This example retrieves the index expression from an Order:
*
* USE Customer NEW
* INDEX ON Customer->Acct ;
* TO Customer ;
* FOR Customer->Acct > "AZZZZZ"
*
* ORDKEY( "Customer" ) // Returns: Customer->Acct
* $TESTS$
*
* $STATUS$
* S
* $COMPLIANCE$
*
* $SEEALSO$
* ORDFOR(),ORDNAME(),ORDNUMBER()
* $INCLUDE$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* ORDLISTADD()
* $CATEGORY$
* Data Base
* $ONELINER$
* Add Orders to the Order List
* $SYNTAX$
* ORDLISTADD(<cOrderBagName>
* [, <cOrderName>]) --> NIL
* $ARGUMENTS$
* <cOrderBagName> is the name of a disk file containing one or more
* Orders. You may specify <cOrderBagName> as the filename with or without
* the pathname or appropriate extension. If you do not include the
* extension as part of <cOrderBagName> HARBOUR uses the default
* extension of the current RDD.
*
* <cOrderName> the name of the specific Order from the Order Bag to be
* added to the Order List of the current work area. If you do not specify
* <cOrderName>, all orders in the Order Bag are added to the Order List of
* the current work area.
* $RETURNS$
* ORDLISTADD() always returns NIL.
* $DESCRIPTION$
* ORDLISTADD() is an Order management function that adds the contents of
* an Order Bag , or a single Order in an Order Bag, to the Order List.
* This function lets you extend the Order List without issuing a SET INDEX
* command that, first, clears all the active Orders from the Order List.
*
* Any Orders already associated with the work area continue to be active.
* If the newly opened Order Bag contains the only Order associated with
* the work area, it becomes the controlling Order; otherwise, the
* controlling Order remains unchanged.
*
* After the new Orders are opened, the work area is positioned to the
* first logical record in the controlling Order.
*
* ORDLISTADD() is similar to the SET INDEX command or the INDEX clause of
* the USE command, except that it does not clear the Order List prior to
* adding the new order(s).
*
* ORDLISTADD() supersedes the DBSETINDEX() function.
*
* The active RDD determines the Order capacity of an Order Bag. The
* default DBFNTX and the DBFNDX drivers only support single-Order Bags,
* while other RDDs may support multiple-Order Bags (e.g., the DBFCDX and
* DBPX drivers). When using RDDs that support multiple Order Bags, you
* must explicitly SET ORDER (or ORDSETFOCUS()) to the desired controlling
* Order. If you do not specify a controlling Order, the data file will be
* viewed in natural Order.
* $EXAMPLES$
* In this example Customer.cdx contains three orders, CuAcct,
* CuName, and CuZip. ORDLISTADD() opens Customer.cdx but only uses the
* order named CuAcct:
*
* USE Customer VIA "DBFCDX" NEW
* ORDLISTADD( "Customer", "CuAcct" )
* $TESTS$
*
* $STATUS$
* S
* $COMPLIANCE$
*
* $SEEALSO$
* DBSETINDEX()
* $INCLUDE$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* ORDLISTCLEAR()
* $CATEGORY$
* Data Base
* $ONELINER$
* Clear the current Order List
* $SYNTAX$
* ORDLISTCLEAR() --> NIL
* $ARGUMENTS$
*
* $RETURNS$
* ORDLISTCLEAR() always returns NIL.
* $DESCRIPTION$
* ORDLISTCLEAR() is an Order management function that removes all Orders
* from the Order List for the current or aliased work area. When you are
* done, the Order List is empty.
*
* This function supersedes the function DBCLEARINDEX().
*
* $EXAMPLES$
* USE Sales NEW
* SET INDEX TO SaRegion, SaRep, SaCode
* .
* . < statements >
* .
* ORDLISTCLEAR() // Closes all the current indexes
* $TESTS$
*
* $STATUS$
* S
* $COMPLIANCE$
*
* $SEEALSO$
* DBCLEARINDEX()
* $INCLUDE$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* ORDLISTREBUILD()
* $CATEGORY$
* Data Base
* $ONELINER$
* Rebuild all Orders in the Order List of the current work area
* $SYNTAX$
* ORDLISTREBUILD() --> NIL
* $ARGUMENTS$
*
* $RETURNS$
* ORDLISTREBUILD() always returns NIL.
* $DESCRIPTION$
* ORDLISTREBUILD() is an Order management function that rebuilds all the
* orders in the current or aliased Order List.
*
* To only rebuild a single Order use the function ORDCREATE().
*
* Unlike ORDCREATE(), this function rebuilds all Orders in the Order List.
* It is equivalent to REINDEX.
*
* $EXAMPLES$
* USE Customer NEW
* SET INDEX TO CuAcct, CuName, CuZip
* ORDLISTREBUILD() // Causes CuAcct, CuName, CuZip to
* // be rebuilt
*
* $TESTS$
*
* $STATUS$
* S
* $COMPLIANCE$
*
* $SEEALSO$
* ORDCREATE()
* $INCLUDE$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* ORDNAME()
* $CATEGORY$
* Data Base
* $ONELINER$
* Return the name of an Order in the Order List
* $SYNTAX$
* ORDNAME(<nOrder>[,<cOrderBagName>])
* --> cOrderName
* $ARGUMENTS$
* <nOrder> is an integer that identifies the position in the Order
* List of the target Order whose database name is sought.
*
* <cOrderBagName> is the name of a disk file containing one or more
* Orders. You may specify <cOrderBagName> as the filename with or without
* the pathname or appropriate extension. If you do not include the
* extension as part of <xcOrderBagName> HARBOUR uses the default
* extension of the current RDD.
* $RETURNS$
* ORDNAME() returns the name of the specified Order in the current Order
* List or the specified Order Bag if opened in the Current Order list.
* $DESCRIPTION$
* ORDNAME() is an Order management function that returns the name of the
* specified Order in the current Order List.
*
* If <cOrderBagName> is an Order Bag that has been emptied into the
* current Order List, only those Orders in the Order List that correspond
* to <cOrderBagName> Order Bag are searched.
*
* The active RDD determines the Order capacity of an Order Bag. The
* default DBFNTX and the DBFNDX drivers only support single-Order Bags,
* while other RDDs may support multiple-Order Bags (e.g., the DBFCDX and
* DBPX drivers).
* $EXAMPLES$
* This example retrieves the name of an Order using its position
* in the order list:
*
* USE Customer NEW
* SET INDEX TO CuAcct, CuName, CuZip
* ORDNAME( 2 ) // Returns: CuName
*
* This example retrieves the name of an Order given its position
* within a specific Order Bag in the Order List:
*
* USE Customer NEW
* SET INDEX TO Temp, Customer
* // Assume Customer contains CuAcct, CuName, CuZip
* ORDNAME( 2, "Customer" ) // Returns: CuName
* $TESTS$
*
* $STATUS$
* S
* $COMPLIANCE$
*
* $SEEALSO$
* ORDFOR(),ORDKEY(),ORDNUMBER()
* $INCLUDE$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* ORDNUMBER()
* $CATEGORY$
* Data Base
* $ONELINER$
* Return the position of an Order in the current Order List
* $SYNTAX$
* ORDNUMBER(<cOrderName>
* [, <cOrderBagName>]) --> nOrderNo
* $ARGUMENTS$
* <cOrderName> the name of the specific Order whose position in the
* Order List is sought.
*
* <cOrderBagName> is the name of a disk file containing one or more
* Orders. You may specify <cOrderBagName> as the filename with or without
* the pathname or appropriate extension. If you do not include the
* extension as part of <cOrderBagName> HARBOUR uses the default
* extension of the current RDD.
* $RETURNS$
* Returns nOrderNo, an integer that represents the position of the
* specified Order in the Order List.
* $DESCRIPTION$
* ORDNUMBER() is an Order management function that lets you determine the
* position in the current Order List of the specified Order. ORDNUMBER()
* searches the Order List in the current work area and returns the
* position of the first Order that matches <cOrderName>. If
* <cOrderBagName> is the name of an Order Bag newly emptied into the
* current Order List, only those orders in the Order List that have been
* emptied from <cOrderBagName> are searched.
*
* If <cOrderName> is not found ORDNUMBER() raises a recoverable runtime
* error.
*
* The active RDD determines the Order capacity of an Order Bag. The
* default DBFNTX driver only supports single-Order Bags, while other RDDs
* may support multiple-Order Bags (e.g., the DBFCDX and DBPX drivers).
* $EXAMPLES$
* USE Customer VIA "DBFNTX" NEW
* SET INDEX TO CuAcct, CuName, CuZip
* ORDNUMBER( "CuName" ) // Returns: 2
* $TESTS$
*
* $STATUS$
* S
* $COMPLIANCE$
*
* $SEEALSO$
* INDEXORD()
* $INCLUDE$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* ORDSETFOCUS()
* $CATEGORY$
* Data Base
* $ONELINER$
* Set focus to an Order in an Order List
* $SYNTAX$
* ORDSETFOCUS([<cOrderName> | <nOrder>]
* [,<cOrderBagName>]) --> cPrevOrderNameInFocus
*
* $ARGUMENTS$
* <cOrderName> is the name of the selected Order, a logical ordering
* of a database. ORDSETFOCUS() ignores any invalid values of
* <cOrderName>.
*
* <nOrder> is a number representing the position in the Order List of
* the selected Order.
*
* <cOrderBagName> is the name of a disk file containing one or more
* Orders. You may specify <cOrderBagName> as the filename with or without
* the pathname or appropriate extension. If you do not include the
* extension as part of <cOrderBagName> HARBOUR uses the default
* extension of the current RDD.
* $RETURNS$
* ORDSETFOCUS() returns the Order Name of the previous controlling Order.
* $DESCRIPTION$
* ORDSETFOCUS() is an Order management function that returns the Order
* Name of the previous controlling Order and optionally sets the focus to
* an new Order.
*
* If you do not specify <cOrderName> or <nOrder>, the name of the
* currently controlling order is returned and the controlling order
* remains unchanged.
*
* All Orders in an Order List are properly updated no matter what
* <cOrderName> is the controlling Order. After a change of controlling
* Orders, the record pointer still points to the same record.
*
* The active RDD determines the Order capacity of an Order Bag. The
* default DBFNTX driver only supports single-Order Bags, while other RDDs
* may support multiple-Order Bags (e.g., the DBFCDX and DBPX drivers).
*
* ORDSETFOCUS() supersedes INDEXORD().
* $EXAMPLES$
*
* USE Customer VIA "DBFNTX" NEW
* SET INDEX TO CuAcct, CuName, CuZip
* ? ORDSETFOCUS( "CuName" ) // Displays: "CuAcct"
* ? ORDSETFOCUS() // Displays: "CuName"
* $TESTS$
*
* $STATUS$
* S
* $COMPLIANCE$
*
* $SEEALSO$
*
* $INCLUDE$
*
* $END$
*/

225
harbour/doc/en/set.txt
View File

@@ -24,7 +24,7 @@
* Documentation for: SET WRAP,SET DEFAULT,SET MESSAGE
* Documentation for: SET PATH,SET INTENSITY,SET ALTERNATE
* Documentation for: SET CENTURY,SET DATE,SET CONSOLE
* Documentation for: SET EPOCH
* Documentation for: SET EPOCH,SET PRINTER,SET FIXED
*
* See doc/license.txt for licensing terms.
*
@@ -1020,7 +1020,7 @@
* $CATEGORY$
* Command
* $ONELINER$
* Toggle the century digits in all ates display
* Toggle the century digits in all dates display
* $SYNTAX$
* SET CENTURY [ON / OFF] [(<lCent>)]
* $ARGUMENTS$
@@ -1091,3 +1091,224 @@
* SET DATE,SET EPOCH,CTOD(),DATE(),DTOC(),SET()
* $END$
*/
/* $DOC$
* $COMMANDNAME$
* SET EPOCH
* $CATEGORY$
* Command
* $ONELINER$
* Specifie a base year for interpreting dates
* $SYNTAX$
* SET EPOCH TO <nEpoch>
* $ARGUMENTS$
* <nEpoch> 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$
* This command is Ca-Clipper compliant
* $SEEALSO$
* SET DATE,SET CENTURY,CTOD(),DATE(),DTOC(),SET()
* $END$
/* $DOC$
* $COMMANDNAME$
* SET FIXED
* $CATEGORY$
* Command
* $ONELINER$
* Set the number of decimal position to be displayed
* $SYNTAX$
* SET FIXED [ON / OFF] [(<lFixed>)]
* $ARGUMENTS$
* <lFixed> 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 <lFixed> is
* a logical true (.T.),FIXED will be turned ON;otherwise it will be
* turned OFF.
*
* When SET DECIMALS OFF is used, the follow rules aply to the number
* of decimal placed displayed.
*
* <table>
* Addition Same as operand with the greatest number of decimal digits
* Subraction 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
* </table>
* $EXAMPLES$
* SET FIXED ON
* ? 25141251/362
* SET FIXED OFF
* $STATUS$
* R
* $COMPLIANCE$
* This command is Ca-Clipper compliant
* $SEEALSO$
* SET DECIMALS,EXP(),LOG(),SQRT(),VAL(),SET()
* $END$
/* $DOC$
* $COMMANDNAME$
* SET PRINTER
* $CATEGORY$
* Command
* $ONELINER$
* Toggles the printer and controls the printer device
* $SYNTAX$
* SET FIXED ON / OFF
* SET PRINTER (<lPrinter>)
* SET PRINTER TO [<cPrinter>] [ADDITIVE]
* $ARGUMENTS$
* <lFixed> Logical condition by which to toggle the printer
* <cPrinter> A device name or an alternate name
* $DESCRIPTION$
* This command can direct all output that is not controled by the
* @...SAY command and the DEVPOS() and DEVOUT() functions to the
* printer.If specified,the condition <lPrinter> 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 <cPrinter>, the outpur 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,<cPrinter> 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$
* This command is Ca-Clipper compliant
* $SEEALSO$
* SET DEVICE,SET CONSOLE,DEVOUT(),SET()
* $END$
/* $DOC$
* $COMMANDNAME$
* SET CONSOLE
* $CATEGORY$
* Command
* $ONELINER$
* Toggle the console display
* $SYNTAX$
* SET CONSOLE [ON / OFF] [(<lConsole>)]
* $ARGUMENTS$
* <lConsole> 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 <lConsole > 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$
* This command is Ca-Clipper compliant
* $SEEALSO$
* SET DEVICE,SET()
* $END$
*/
/* $DOC$
* $COMMANDNAME$
* SET DECIMALS
* $CATEGORY$
* Command
* $ONELINER$
* Toggle the console display
* $SYNTAX$
* SET DECIMALS TO [<nDecimal>]
* $ARGUMENTS$
* <nDecimal> 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$
* This command is Ca-Clipper compliant
* $SEEALSO$
* SET FIXED,SET()
* $END$
*/
/* $DOC$
* $COMMANDNAME$
* SET DEVICE
* $CATEGORY$
* Command
* $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 SCRENN
* ? 25141251/362
* SET DEVICE TO PRINTER
* SET PRINTER TO LPT1
* ? 214514.214/6325
* SET PRINTER OFF
* SET DEVICE TO SCREEN
* $STATUS$
* R
* $COMPLIANCE$
* This command is Ca-Clipper compliant
* $SEEALSO$
* @...SAY,SET PRINTER,SETPRC(),SET()
* $END$
*/

72
harbour/doc/en/string.txt
View File

@@ -24,7 +24,8 @@
* SUBSTR() Documentation
* UPPER() Documentation
* LOWER() Documentation
*
* ASC() Documentation
* CHR() Documentation
* See doc/license.txt for licensing terms.
*
*/
@@ -831,3 +832,72 @@
* $END$
*/
/* $DOC$
* $FUNCNAME$
* CHR()
* $CATEGORY$
* Strings
* $ONELINER$
* Converts an ASCII value to it character value
* $SYNTAX$
* CHR(<nAsciiNum>) --> cReturn
* $ARGUMENTS$
* <nAsciiNum> Any ASCII character code.
* $RETURNS$
* <cReturn> Character expression of that ASCII value
* $DESCRIPTION$
* This function returns the ASCII character code for <nAsciiNum>.The
* number expressed must be an interger 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$
* This function is Ca-Clipper compliant
* $PLATFORMS$
* All
* $FILES$
* Library is Rtl.lib
* $SEEALSO$
* ASC(),INKEY()
* $END$
*/
/* $DOC$
* $FUNCNAME$
* ASC()
* $CATEGORY$
* Strings
* $ONELINER$
* Returns the ASCII value of a character
* $SYNTAX$
* ASC( <cCharacter> ) --> nAscNumber
* $ARGUMENTS$
* <cCharacter> Any character expression
* $RETURNS$
* <nAscNumber> ASCII value
* $DESCRIPTION$
* This function return the ASCII value of the leftmost character of
* any character expression passed as <cCharacter>.
* $EXAMPLES$
* ? ASC("A")
* ? ASC("¹")
* $STATUS$
* R
* $COMPLIANCE$
* This function is Ca-Clipper compliant
* $PLATFORMS$
* All
* $FILES$
* Library is Rtl.lib
* $SEEALSO$
* CHR()
* $END$
*/