From bdedc8a862928dcef0bc1b59e13a2b38b7291a01 Mon Sep 17 00:00:00 2001 From: Luiz Rafael Culik Date: Tue, 11 Apr 2000 23:23:28 +0000 Subject: [PATCH] See changelog 20000411 20:30 --- harbour/doc/class_tp.txt | 131 +++++++++++++++++++++++++ harbour/doc/en/dbstrux.txt | 1 + harbour/doc/en/misc.txt | 53 +++++++--- harbour/doc/en/rdd.txt | 8 +- harbour/doc/en/rdddb.txt | 62 ++++++------ harbour/doc/en/rddmisc.txt | 91 ++++++++--------- harbour/doc/en/rddord.txt | 194 ++++++++++++++++++++++++------------- 7 files changed, 368 insertions(+), 172 deletions(-) create mode 100644 harbour/doc/class_tp.txt diff --git a/harbour/doc/class_tp.txt b/harbour/doc/class_tp.txt new file mode 100644 index 0000000000..7c5d77583f --- /dev/null +++ b/harbour/doc/class_tp.txt @@ -0,0 +1,131 @@ +/* + * $Id$ + */ + +/* NOTE: - Please use these template for your new files, replace parts + between curly braces {} with the appropriate text. + - You can find a history at the end of the file. */ + +FILE HEADER TEMPLATE +==================== + +/* + * Harbour Project source code: + * {one-liner description about the purpose of this source file} + * + * Copyright 2000 {list of individual authors and e-mail addresses} + * www - http://www.harbour-project.org + * + * 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 + * 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/). + * + */ + +FILE HEADER TEMPLATE (OPTIONAL ADDITION FOR PARTIAL COPYRIGHTS) +=============================================================== + +/* + * The following parts are Copyright of the individual authors. + * www - http://www.harbour-project.org + * + * Copyright 2000 {name} <{e-mail address}> + * {function or subsystem name} + * + * See doc/license.txt for licensing terms. + * + */ + + +CLASS HEADER TEMPLATE +======================== + +/* $CLASSDOC$ + * $FUNCNAME$ + * + * $CATEGORY$ + * + * $ONELINER$ + * + * $CONSTRUCTOR$ + * + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $DATALINK$ + * + * $DATANOLINK$ + * + * $METHODSLINK$ + * + * $METHODSNOLINK$ + * + * $EXAMPLES$ + * + * $TESTS$ + * + * $STATUS$ + * + * $COMPLIANCE$ + * + * $PLATFORMS$ + * + * $FILES$ + * + * $SEEALSO$ + * + * $END$ + */ + + +/* $CLASSDOC$ + * $METHOD$ + * + * $CATEGORY$ + * + * $ONELINER$ + * + * $SYNTAX$ + * + * $ARGUMENTS$ + * + * $RETURNS$ + * + * $DESCRIPTION$ + * + * $END$ + */ + +/* $CLASSDOC$ + * $DATA$ + * + * $CATEGORY$ + * + * $ONELINER$ + * + * $DESCRIPTION$ + * + * $END$ + */ + diff --git a/harbour/doc/en/dbstrux.txt b/harbour/doc/en/dbstrux.txt index b93a4490d3..51434caf64 100644 --- a/harbour/doc/en/dbstrux.txt +++ b/harbour/doc/en/dbstrux.txt @@ -174,6 +174,7 @@ * __dbCopyXStruct( "TestStru" ) * USE TestStru * LIST + * * $TESTS$ * $STATUS$ * R diff --git a/harbour/doc/en/misc.txt b/harbour/doc/en/misc.txt index 45cbca90c2..2a32f7c6dc 100644 --- a/harbour/doc/en/misc.txt +++ b/harbour/doc/en/misc.txt @@ -28,7 +28,13 @@ * This function will return the current operating system * $EXAMPLES$ * ? OS() - * + * $TESTS$ + * $STATUS$ + * R + * $COMPLIANCE$ + * This functions is Ca-Clipper compatible + * $PLATFORMS$ + * All * $FILES$ * source/rtl/version.c * $END$ @@ -42,29 +48,23 @@ * $ONELINER$ * Returns the HARBOUR Version or the Harbour/Compiler Version * $SYNTAX$ - * VERSION([] --> + * VERSION() --> * $ARGUMENTS$ - * [] Optional Parameter that enables the display - * of the C compiler version that HARBOUR was built with. + * None * $RETURNS$ * String contining the Harbour Version or the Harbour * and C compiler Version when the parameter is used. * $DESCRIPTION$ - * This function returns the HARBOUR Version or the Harbour Version+C - * compiler Version used to create the Harbour runtime library + * This function returns the current HARBOUR Version * $EXAMPLES$ * ? QOUT(VERSION()) // Displays Harbour version only - * ? QOUT(VERSION(NIL)) // Displays Harbour and C Compiler versions - * + * $TESTS$ * $STATUS$ * S * $COMPLIANCE$ - * This function is an enhanced version of the CA-Clipper VERSION function. - * The CA-Clipper version does not have a parameter and it only returns - * the Version of the CA-Clipper Compiler. The Harbour version returns - * only the Harbour Version if called without the parameter, but - * returns both the Harbour Version and the Version of the C compiler used - * to build Harbour when the parameter is present. + * This functions is Ca-Clipper compatible + * $PLATFORMS$ + * All * $FILES$ * source/rtl/version.c * Library is Rtl.lib @@ -98,10 +98,14 @@ * ? QOUT(GETENV('CONFIG')) * ? QOUT(GETENV('HARBOURCMD', '-n -l -es2')) * + * $TESTS$ + * This command is Ca-Clipper compliant * $STATUS$ * R * $COMPLIANCE$ - * This functions is CA-CLIPPER compliant + * The parameter is a harbour extension + * $PLATFORMS$ + * All * $FILES$ * source/rtl/gete.c * Library is Rtl.lib @@ -132,6 +136,13 @@ * __Run( "edit " + cMyTextFile ) // Runs an external editor * __Run( "command" ) // Gives a DOS shell (DOS only) * + * $TESTS$ + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant + * $PLATFORMS$ + * All * $FILES$ * source/rtl/run.c * Library is Rtl.lib @@ -152,7 +163,7 @@ * $ARGUMENTS$ * is a non-negative numeric value that specifies the * frequency of the tone in hertz. - + * * is a positive numeric value which specifies the duration * of the tone in 1/18 of a second units. * $RETURNS$ @@ -182,10 +193,13 @@ * TONE( -1 ) // 1/18.2 second delay * TONE( ) // 1/18.2 second delay * + * $TESTS$ * $STATUS$ * S * $COMPLIANCE$ * TONE() works exactly like CA-Clipper's TONE(). + * $PLATFORMS$ + * All * $FILES$ * Library is Rtl.lib * $SEEALSO$ @@ -212,6 +226,13 @@ * $EXAMPLES$ * Run "edit " + cMyTextFile // Runs an external editor * Run "command" // Gives a DOS shell (DOS only) + * $TESTS$ + * $STATUS$ + * R + * $COMPLIANCE$ + * This command is Ca-Clipper compliant + * $PLATFORMS$ + * All * $FILES$ * source/rtl/run.c * Library is Rtl.lib diff --git a/harbour/doc/en/rdd.txt b/harbour/doc/en/rdd.txt index 39f4c19b34..c60d73e2ae 100644 --- a/harbour/doc/en/rdd.txt +++ b/harbour/doc/en/rdd.txt @@ -20,7 +20,7 @@ * $FUNCNAME$ * RDDLIST() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Return an array of the available Replaceable Database Drivers * $SYNTAX$ @@ -95,7 +95,7 @@ * $FUNCNAME$ * RDDNAME() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Return the name of the currently active RDD * $SYNTAX$ @@ -135,7 +135,7 @@ * $FUNCNAME$ * RDDSETDEFAULT() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Set or return the default RDD for the application * $SYNTAX$ @@ -182,7 +182,7 @@ * $FUNCNAME$ * __RDDSETDEFAULT() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Set or return the default RDD for the application * $SYNTAX$ diff --git a/harbour/doc/en/rdddb.txt b/harbour/doc/en/rdddb.txt index 29c39f712a..4d336d6c9b 100644 --- a/harbour/doc/en/rdddb.txt +++ b/harbour/doc/en/rdddb.txt @@ -20,9 +20,9 @@ * $FUNCNAME$ * DBEVAL() * $CATEGORY$ - * DATA BASE + * Database * $ONELINER$ - * Performs a code block operation on the current DATA BASE + * Performs a code block operation on the current Database * $SYNTAX$ * DBEVAL( , * [], [], @@ -43,7 +43,7 @@ * $RETURNS$ * DBEVAL() always returns NIL * $DESCRIPTION$ - * Performs a code block operation on the current DATA BASE + * Performs a code block operation on the current Database * $EXAMPLES$ * FUNCTION Main() * LOCAL nCount @@ -73,7 +73,7 @@ * $FUNCNAME$ * DBF() * $CATEGORY$ - * DATA BASE + * Database * $ONELINER$ * Alias name of a work area * $SYNTAX$ @@ -109,7 +109,7 @@ * $FUNCNAME$ * DBAPPEND() * $CATEGORY$ - * DATA BASE + * Database * $ONELINER$ * Appends a new record to a database file. * $SYNTAX$ @@ -163,7 +163,7 @@ * $FUNCNAME$ * DBCLEARFILTER() * $CATEGORY$ - * DATA BASE + * Database * $ONELINER$ * Clears the current filter condiction in a work area * $SYNTAX$ @@ -202,7 +202,7 @@ * $FUNCNAME$ * DBCLOSEALL() * $CATEGORY$ - * DATA BASE + * Database * $ONELINER$ * Close all open files in all work areas. * $SYNTAX$ @@ -244,7 +244,7 @@ * $FUNCNAME$ * DBCLOSEAREA() * $CATEGORY$ - * DATA BASE + * Database * $ONELINER$ * Close a database file in a work area. * $SYNTAX$ @@ -281,7 +281,7 @@ * $FUNCNAME$ * DBCOMMIT() * $CATEGORY$ - * DATA BASE + * Database * $ONELINER$ * Updates all index and database buffers for a given workarea * $SYNTAX$ @@ -325,7 +325,7 @@ * $FUNCNAME$ * DBCOMMITALL() * $CATEGORY$ - * DATA BASE + * Database * $ONELINER$ * Flushes the memory buffer and performs a hard-disk write * $SYNTAX$ @@ -373,7 +373,7 @@ * $FUNCNAME$ * __DBCONTINUE() * $CATEGORY$ - * DATA BASE + * Database * $ONELINER$ * Resume a pending LOCATE * $SYNTAX$ @@ -443,7 +443,7 @@ * $FUNCNAME$ * DBCREATE() * $CATEGORY$ - * DATA BASE + * Database * $ONELINER$ * Creates an empty database from a array. * $SYNTAX$ @@ -524,7 +524,7 @@ * $FUNCNAME$ * DBDELETE() * $CATEGORY$ - * DATA BASE + * Database * $ONELINER$ * Marks records for deletion in a database. * $SYNTAX$ @@ -563,7 +563,7 @@ * $FUNCNAME$ * DBFILTER() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Return the filter expression in a work area * $SYNTAX$ @@ -598,7 +598,7 @@ * $FUNCNAME$ * DBGOBOTTOM() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Moves the record pointer to the bottom of the database. * $SYNTAX$ @@ -633,7 +633,7 @@ * $FUNCNAME$ * DBGOTO() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Position the record pointer to a specific location. * $SYNTAX$ @@ -682,7 +682,7 @@ * $FUNCNAME$ * DBGOTOP() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Moves the record pointer to the bottom of the database. * $SYNTAX$ @@ -717,7 +717,7 @@ * $FUNCNAME$ * DBRECALL() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Recalls a record previousy marked for deletion. * $SYNTAX$ @@ -754,7 +754,7 @@ * $FUNCNAME$ * DBRLOCK() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * This function locks the record basedon identify * $SYNTAX$ @@ -794,7 +794,7 @@ * $FUNCNAME$ * DBRLOCKLIST() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * This function return a list of records in the database work area * $SYNTAX$ @@ -836,7 +836,7 @@ * $FUNCNAME$ * DBRUNLOCK() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Unlocks a record base on its indentifier * $SYNTAX$ @@ -875,7 +875,7 @@ * $FUNCNAME$ * DBSEEK() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Searches for a value based on an active index. * $SYNTAX$ @@ -944,7 +944,7 @@ * $FUNCNAME$ * DBSELECTAREA() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Change to another work area * $SYNTAX$ @@ -991,7 +991,7 @@ * $FUNCNAME$ * DBSETDRIVER() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Establishes the name of replaceable daabas driver for a selected work area * $SYNTAX$ @@ -1023,7 +1023,7 @@ * $FUNCNAME$ * DBSKIP() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Moves the record pointer in the selected work area. * $SYNTAX$ @@ -1063,7 +1063,7 @@ * $FUNCNAME$ * DBSETFILTER() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Establishes a filter condition for a work area. * $SYNTAX$ @@ -1102,7 +1102,7 @@ * $FUNCNAME$ * DBSTRUCT() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Creates a multidimensional array of a database structure. * $SYNTAX$ @@ -1142,7 +1142,7 @@ * $FUNCNAME$ * DBUNLOCK() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Unlock a record or release a file lock * $SYNTAX$ @@ -1179,7 +1179,7 @@ * $FUNCNAME$ * DBUNLOCKALL() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Unlocks all records and releases all file locks in all work areas. * $SYNTAX$ @@ -1217,7 +1217,7 @@ * $FUNCNAME$ * DBUSEAREA() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Opens a work area and uses a database file. * $SYNTAX$ @@ -1277,7 +1277,7 @@ * $FUNCNAME$ * __DBZAP() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Remove all records from the current database file * $SYNTAX$ diff --git a/harbour/doc/en/rddmisc.txt b/harbour/doc/en/rddmisc.txt index efbb28258b..9330ccccef 100644 --- a/harbour/doc/en/rddmisc.txt +++ b/harbour/doc/en/rddmisc.txt @@ -19,7 +19,7 @@ * $FUNCNAME$ * AFIELDS() * $CATEGORY$ - * DATA BASE + * Database * $ONELINER$ * Fills referenced arrays with database field information * $SYNTAX$ @@ -71,7 +71,7 @@ * $FUNCNAME$ * ALIAS() * $CATEGORY$ - * DATA BASE + * Database * $ONELINER$ * Returns the alias name of a work area * $SYNTAX$ @@ -109,7 +109,7 @@ * $FUNCNAME$ * BOF() * $CATEGORY$ - * DATA BASE + * Database * $ONELINER$ * Test for the beggining-of-file condition * $SYNTAX$ @@ -175,7 +175,7 @@ * $FUNCNAME$ * DELETED() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Tests the record's deletion flag. * $SYNTAX$ @@ -210,7 +210,7 @@ * $FUNCNAME$ * EOF() * $CATEGORY$ - * DATA BASE + * Database * $ONELINER$ * Test for end-of-file condition. * $SYNTAX$ @@ -245,7 +245,7 @@ * $FUNCNAME$ * FCOUNT() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Counts the number of fields in an active database. * $SYNTAX$ @@ -277,7 +277,7 @@ * $FUNCNAME$ * FIELDGET() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Obtains the value of a specified field * $SYNTAX$ @@ -312,7 +312,7 @@ * $FUNCNAME$ * FIELDNAME() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Return the name of a field at a numeric field location. * $SYNTAX$ @@ -350,7 +350,7 @@ * $FUNCNAME$ * FIELDPOS() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Return the ordinal position of a field. * $SYNTAX$ @@ -385,7 +385,7 @@ * $FUNCNAME$ * FIELDPUT() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Set the value of a field variable * $SYNTAX$ @@ -421,7 +421,7 @@ * $FUNCNAME$ * FLOCK() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Locks a file * $SYNTAX$ @@ -455,7 +455,7 @@ * $FUNCNAME$ * FOUND() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Determine the success of a previous search operation. * $SYNTAX$ @@ -492,7 +492,7 @@ * $FUNCNAME$ * HEADER() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Return the length of a database file header * $SYNTAX$ @@ -524,45 +524,27 @@ * $FUNCNAME$ * LASTREC() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ - * Determine the number of records in the current (.dbf) file + * Returns the number of records in an active work area or database. * $SYNTAX$ * LASTREC() | RECCOUNT()* --> nRecords * $RETURNS$ - * the number of physical records in the current database - * file as an integer numeric value. Filtering commands such as SET FILTER - * or SET DELETED have no effect on the return value. LASTREC() returns - * zero if there is no database file in USE in the current work area. + * The number of records * $DESCRIPTION$ - * LASTREC() is a database function that determines the number of physical - * records in the current database file. LASTREC() is identical to - * RECCOUNT() which is supplied as a compatibility function. - * - * By default, LASTREC() 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). + * 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. * $EXAMPLES$ - * This example illustrates the relationship between LASTREC(), - * RECCOUNT(), and COUNT: - * - * USE Sales NEW - * ? LASTREC(), RECCOUNT() // Result: 84 84 - * // - * SET FILTER TO Salesman = "1001" - * COUNT TO nRecords - * ? nRecords, LASTREC() // Result: 14 84 - * - * This example uses an aliased expression to access the number - * of records in a open database file in an unselected work area: - * - * USE Sales NEW - * USE Customer NEW - * ? LASTREC(), Sales->(LASTREC()) + * USE Tests NEW + * ? LASTREC(), RECCOUNT() + * $TESTS$ * $STATUS$ * R * $COMPLIANCE$ * This function is CA Clipper compatible + * $PLATFORMS$ + * All * $FILES$ * Library is Rdd.lib * $SEEALSO$ @@ -574,13 +556,13 @@ * $FUNCNAME$ * LUPDATE() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Return the last modification date of a (.dbf) file * $SYNTAX$ * LUPDATE() --> dModification * $ARGUMENTS$ - * + * None * $RETURNS$ * the date of last change to the open database file in * the current work area. If there is no database file in USE, LUPDATE() @@ -612,12 +594,17 @@ * USE Sales NEW * USE Customer NEW * ? LUPDATE(), Sales->(LUPDATE()) + * $TESTS$ * $STATUS$ * R * $COMPLIANCE$ * This function is CA Clipper compliant + * $PLATFORMS$ + * All + * $FILES$ + * Library is Rdd.lib * $SEEALSO$ - * FIELDNAME(),LASTREC(),RECSIZE() + * FIELDNAME(),LASTREC(),RECSIZE() * $END$ */ @@ -625,7 +612,7 @@ * $FUNCNAME$ * NETERR() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Determine if a network command has failed * $SYNTAX$ @@ -688,7 +675,7 @@ * $FUNCNAME$ * RECCOUNT() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Determine the number of records in the current (.dbf) file * $SYNTAX$ @@ -742,7 +729,7 @@ * $FUNCNAME$ * RECNO() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Return the identity at the position of the record pointer * $SYNTAX$ @@ -789,7 +776,7 @@ * $FUNCNAME$ * RECSIZE() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Determine the record length of a database (.dbf) file * $SYNTAX$ @@ -846,7 +833,7 @@ * $FUNCNAME$ * RLOCK() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Lock the current record in the active work area * $SYNTAX$ @@ -937,7 +924,7 @@ * $FUNCNAME$ * SELECT() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Determine the work area number of a specified alias * $SYNTAX$ @@ -989,7 +976,7 @@ * $FUNCNAME$ * USED() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Determine whether a database file is in USE * $SYNTAX$ diff --git a/harbour/doc/en/rddord.txt b/harbour/doc/en/rddord.txt index 358cd6f980..e4b3d7ac44 100644 --- a/harbour/doc/en/rddord.txt +++ b/harbour/doc/en/rddord.txt @@ -15,64 +15,12 @@ * */ -/* $DOC$ - * $FUNCNAME$ - * INDEXORD() - * $CATEGORY$ - * Data Base - * $ONELINER$ - * Return the order position of the controlling index - * $SYNTAX$ - * INDEXORD() --> nOrder - * $RETURNS$ - * 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 + * Database * $ONELINER$ * Return the default Order Bag RDD extension * $SYNTAX$ @@ -106,7 +54,7 @@ * $FUNCNAME$ * ORDBAGNAME() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Return the Order Bag name of a specific Order * $SYNTAX$ @@ -117,7 +65,6 @@ * * 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. @@ -147,15 +94,12 @@ * ORDBAGNAME( "CuName" ) // Returns: Customer * ORDBAGNAME( "CuZip" ) // Returns: Customer * $TESTS$ - * * $STATUS$ * S * $COMPLIANCE$ * * $SEEALSO$ * ORDBAGEXT() - * $INCLUDE$ - * * $END$ */ @@ -163,7 +107,7 @@ * $FUNCNAME$ * ORDCONDSET() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Set the Condition and scope for an order * $SYNTAX$ @@ -213,7 +157,7 @@ * $FUNCNAME$ * ORDCREATE() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Create an Order in an Order Bag * $SYNTAX$ @@ -320,7 +264,7 @@ * $FUNCNAME$ * ORDDESTROY() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Remove a specified Order from an Order Bag * $SYNTAX$ @@ -372,7 +316,7 @@ * $FUNCNAME$ * ORDFOR() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Return the FOR expression of an Order * $SYNTAX$ @@ -428,7 +372,7 @@ * $FUNCNAME$ * ORDKEY() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Return the key expression of an Order * $SYNTAX$ @@ -487,7 +431,7 @@ * $FUNCNAME$ * ORDLISTADD() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Add Orders to the Order List * $SYNTAX$ @@ -557,7 +501,7 @@ * $FUNCNAME$ * ORDLISTCLEAR() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Clear the current Order List * $SYNTAX$ @@ -597,7 +541,7 @@ * $FUNCNAME$ * ORDLISTREBUILD() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Rebuild all Orders in the Order List of the current work area * $SYNTAX$ @@ -638,7 +582,7 @@ * $FUNCNAME$ * ORDNAME() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Return the name of an Order in the Order List * $SYNTAX$ @@ -700,7 +644,7 @@ * $FUNCNAME$ * ORDNUMBER() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Return the position of an Order in the current Order List * $SYNTAX$ @@ -754,7 +698,7 @@ * $FUNCNAME$ * ORDSETFOCUS() * $CATEGORY$ - * Data Base + * Database * $ONELINER$ * Set focus to an Order in an Order List * $SYNTAX$ @@ -812,3 +756,115 @@ * * $END$ */ + +/* $DOC$ + * $FUNCNAME$ + * INDEXEXT() + * $CATEGORY$ + * 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 + * $TESTS$ + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant + * $PLATFORMS$ + * All + * $FILES$ + * Library is Rdd.lib + * $SEEALSO$ + * INDEXKEY(),INDEXORD() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * INDEXKEY() + * $CATEGORY$ + * 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) + * $TESTS$ + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant + * $PLATFORMS$ + * All + * $FILES$ + * Library is Rdd.lib + * $SEEALSO$ + * INDEXORD() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * INDEXORD() + * $CATEGORY$ + * 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 + * $TESTS$ + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant + * $PLATFORMS$ + * All + * $FILES$ + * Library is Rdd.lib + * $SEEALSO$ + * INDEXKEY() + * $END$ + */