diff --git a/harbour/doc/en/array.txt b/harbour/doc/en/array.txt index 61efc8b7ca..490d47e68a 100644 --- a/harbour/doc/en/array.txt +++ b/harbour/doc/en/array.txt @@ -26,13 +26,18 @@ * $SYNTAX$ * ARRAY( [, ...]) --> aArray * $ARGUMENTS$ - * is the number of elements in the specified dimension. + * is the number of elements in the specified dimension. * $RETURNS$ - * an array of specified dimensions. + * 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. + * 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. + * 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$ * FUNCTION Main() @@ -42,13 +47,15 @@ * aArray[x]:=Array(x) * NEXT * Return Nil - + * $STATUS$ * R * $SEEALSO$ * AADD(),ADEL(),AFILL(),AINS() * $COMPLIANCE$ - * This function is CA-CLIPPER Compliant in all Cases, except that arrays in Harbour can have an unlimited number of dimensions, while Clipper has a limit of 4096 array elements. + * This function is CA-CLIPPER Compliant in all Cases, except that + * arrays in Harbour can have an unlimited number of dimensions, while + * Clipper has a limit of 4096 array elements. * $END$ */ @@ -62,14 +69,18 @@ * $SYNTAX$ * AADD([, ]) --> Value * $ARGUMENTS$ - * The name of an array - * Element to add to array + * The name of an array + * Element to add to array * $RETURNS$ - * if specified , will return , otherwise this function returns a NIL value. + * 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. + * 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. + * may be an array reference pointer, which in turn may be + * stored to an array's subscript position. * $EXAMPLES$ * LOCAL aArray:={} @@ -82,7 +93,6 @@ * R * $SEEALSO$ * AINS(),ASIZE() - * * $END$ */ @@ -96,14 +106,18 @@ * $SYNTAX$ * ASIZE(, ) --> aTarget * $ARGUMENTS$ - * Name of array to be dynamically altered - * Numeric value representing the new size of + * Name of array to be dynamically altered + * Numeric value representing the new size of * $RETURNS$ - * an array pointer reference to . + * 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. + * 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. + * 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$ * aArray := { 1 } // Result: aArray is { 1 } @@ -112,7 +126,8 @@ * $STATUS$ * R * $COMPLIANCE$ - * If HB_COMPAT_C53 is defined, the function generates an Error, else it will return the array itself. + * If HB_COMPAT_C53 is defined, the function generates an Error, + * else it will return the array itself. * $SEEALSO$ * AADD(),ADEL(),AFILL(),AINS() * $INCLUDE$ @@ -130,11 +145,13 @@ * $SYNTAX$ * ATAIL() --> Element * $ARGUMENTS$ - * is the array. + * is the array. * $RETURNS$ - * the expression of the last element in the array. + * 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. + * 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 array:= {"Harbour", "is", "Supreme", "Power"} @@ -159,14 +176,21 @@ * $SYNTAX$ * AINS(, ) --> aTarget * $ARGUMENTS$ - * Array name. - * Subscript position in + * Array name. + * Subscript position in * $RETURNS$ - * an array pointer reference. + * an array pointer reference. * $DESCRIPTION$ - * This function inserts a NIL value in the array named at the th position. + * 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. + * 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!","!!!"} @@ -175,7 +199,7 @@ * $STATUS$ * R * $COMPLIANCE$ - * This function is CA Clipper compliant + * This function is CA Clipper compliant * $SEEALSO$ * AADD(),ACOPY(),ADEL(),AEVAL(),AFILL(),ASIZE() * $INCLUDE$ @@ -193,12 +217,18 @@ * $SYNTAX$ * ADEL(, ) --> aTarget * $ARGUMENTS$ - * Name of array from which an element is to be removed. - * Subscript of the element to be removed. + * Name of array from which an element is to be removed. + * Subscript of the element to be removed. * $RETURNS$ - * an array pointer reference. + * 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. + * 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 @@ -209,7 +239,7 @@ * $STATUS$ * R * $COMPLIANCE$ - * This function is CA Clipper compliant + * This function is CA Clipper compliant * $SEEALSO$ * ACOPY(),AINS(),AFILL() * @@ -226,16 +256,25 @@ * $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 + * 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. + * 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 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. + * 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} @@ -244,7 +283,7 @@ * $STATUS$ * R * $COMPLIANCE$ - * This function is CA Clipper compliant + * This function is CA Clipper compliant * $SEEALSO$ * AADD(),AEVAL(),DBSTRUCT(),DIRECTORY() * $END$ @@ -260,29 +299,40 @@ * $SYNTAX$ * ASCAN(, ,[], []) --> nStoppedAt * $ARGUMENTS$ - * Name of array to be scanned. - * Expression to search for in - * Beginning subscript position at which to start the search. - * Number of elements to scan with . + * Name of 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. + * A numeric value of subscript position where was 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. + * 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 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 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. + * 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$ - + * aDir:=Directory("*.prg") * AScan(aDir,,,{|x,y| x[1]="Test.prg"}) * $STATUS$ * R * $COMPLIANCE$ - * This function is not CA-Clipper compatible. Clipper ASCAN() is affected by the SET EXACT ON/OFF Condition + * This function is not CA-Clipper compatible. Clipper ASCAN() is affected by the SET EXACT ON/OFF Condition * $SEEALSO$ * AEVAL() * $END$ @@ -298,22 +348,31 @@ * $SYNTAX$ * AEVAL(, , [], []) --> aArray * $ARGUMENTS$ - * Is the array to be evaluated. - * Is a code block to evaluate for each element processed. - * The beginning array element to evaluate. - * The number of elements to process. + * Is the array to be evaluated. + * Is a code block to evaluate for each element processed. + * The beginning array element to evaluate. + * The number of elements to process. * $RETURNS$ - * an array pointer reference. + * 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. + * 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. + * 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. + * 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$ - * This function is CA Clipper compliant + * This function is CA Clipper compliant * $SEEALSO$ * EVAL(),DBEVAL() * $END$ @@ -329,26 +388,37 @@ * $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. + * 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 + * an array pointer reference * $DESCRIPTION$ - * This function copies array elements from to . is the beginning element to be copied from ; the default is 1. + * 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 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 + * 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 . + * 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. + * 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. + * 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 @@ -359,7 +429,7 @@ * $STATUS$ * R * $COMPLIANCE$ - * This function is CA Clipper compliant + * This function is CA Clipper compliant * $SEEALSO$ * ACLONE(),ADEL(),AEVAL(),AFILL(),AINS(),ASORT() * $END$ @@ -375,11 +445,15 @@ * $SYNTAX$ * ACLONE() --> aDuplicate * $ARGUMENTS$ - * Name of the array to be cloned. + * Name of the array to be cloned. * $RETURNS$ - * A new array pointer reference complete with nested array values. + * 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 orifical array + * 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 @@ -391,7 +465,7 @@ * $STATUS$ * R * $COMPLIANCE$ - * Clipper will return NIL if the parameter is not an array. + * Clipper will return NIL if the parameter is not an array. * $SEEALSO$ * ACOPY(),ADEL(),AINS(),ASIZE() * $END$ @@ -407,16 +481,31 @@ * $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. + * 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. + * 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. + * 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. + * 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 @@ -435,7 +524,11 @@ * $STATUS$ * R * $COMPLIANCE$ - * For speed we are checking the return type of the passed code block. This will result in a small incompatibility since the code block will be called one more time for the first logical element than in Clipper. But this is block calling frequency and order differs from Clipper anyway, since they use different sorting algorithm. + * For speed we are checking the return type of the passed code block. + * This will result in a small incompatibility since the code block + * will be called one more time for the first logical element than + * in Clipper. But this is block calling frequency and order differs + * from Clipper anyway, since they use different sorting algorithm. * $SEEALSO$ * ASCAN(),EVAL(),SORT * $END$ diff --git a/harbour/doc/en/command.txt b/harbour/doc/en/command.txt index 6e8389c218..f546a868bb 100644 --- a/harbour/doc/en/command.txt +++ b/harbour/doc/en/command.txt @@ -158,12 +158,12 @@ * Use the "INIT " clause to initialize that DATA to * whenever the class is first used. * $EXAMPLES$ - + * CLASS TWindow * DATA hWnd, nOldProc * CLASSDATA lRegistered AS LOGICAL * ENDCLASS - + * $STATUS$ * R * $COMPLIANCE$ @@ -245,7 +245,7 @@ * Use this syntax only for defining a full method after * the ENDCLASS command. * $EXAMPLES$ - + * CLASS TWindow * DATA hWnd, nOldProc * METHOD New( ) CONSTRUCTOR @@ -262,9 +262,11 @@ * ... ... * ... ... * RETURN Self - + * $TESTS$ + * TestOp.prg + * $STATUS$ * R * $COMPLIANCE$ diff --git a/harbour/doc/en/file.txt b/harbour/doc/en/file.txt index fa51ffa02a..ffc5959025 100644 --- a/harbour/doc/en/file.txt +++ b/harbour/doc/en/file.txt @@ -27,20 +27,16 @@ * $SYNTAX$ * FOPEN( , [] ) --> nHandle * $ARGUMENTS$ - * Name of file to open - * Dos file open mode - * file is to be accessed. The open mode is composed of elements from the - * two types of modes described in the tables below. If just the Access - * Mode is used, the file is opened non-sharable. The default open mode is - * zero, which indicates non-sharable and read-only. + * Name of file to open + * Dos file open mode * $RETURNS$ - * a DOS file handle + * a DOS file handle * $DESCRIPTION$ * This function opens a file expressed as and returns a DOS * 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 DOS file open modes are as the follows: - * + * the default value is 0. The DOS file open modes are as the follows: + * * 0 Read only * 1 Write only * 2 Read/write @@ -56,22 +52,24 @@ * 64 Share read only * 65 Share write only * 66 Share read/write - * + *
* 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. + * with the file that is to be opened. * If an error has occured, see the returns values from FERROR() for - * possible reasons for the error. + * possible reasons for the error. * $EXAMPLES$ + * IF (nH:=FOPEN('X.TXT',66)<0 * ? 'File cann't be open' * ENDIF + * * $STATUS$ * R * $COMPLIANCE$ - * This function is CA-Clipper compliant + * This function is CA-Clipper compliant * $SEEALSO$ * FCREATE(),FERROR(),FCLOSE() * $END$ @@ -87,11 +85,11 @@ * $SYNTAX$ * FCREATE( , [] ) --> nHandle * $ARGUMENTS$ - * is the name of the file to create. + * is the name of the file to create. * - * Numeric code for the DOS file attribute + * Numeric code for the DOS file attribute * $RETURNS$ - * Numeric expression + * Numeric expression * $DESCRIPTION$ * This function creates a new file with a filename of . The * default value of is 0 and is used to set the DOS @@ -99,28 +97,30 @@ * The return value will be DOS 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 + * will be -1. + * * If the file already exists, the existing file will be - * truncated to a file lenght of 0 bytes. + * truncated to a file lenght of 0 bytes. + * If specified, the folowing table shows the value for * and their related meaning to the file being created by - * this Function. - * + * this Function. + * * File Attribute * 0 Normal/Default,Read/Write - * 1 Read-only,Attempting to open for - * | output returns an error + * 1 Read-only,Attempting to open for output returns an error * 2 Hidden,Excluded from normal DIR search * 4 Create,Excluded from normal DIR search - * + *
* $EXAMPLES$ * IF (nh:=FCREATE("TEST.TXT") <0 * ? "Can not create file" * ENDIF + * * $STATUS$ * R * $COMPLIANCE$ - * This function is CA-Clipper compliant + * This function is CA-Clipper compliant * $SEEALSO$ * FCLOSE(),FOPEN(),FWRITE(),FREAD(),FERROR() * $END$ @@ -136,22 +136,25 @@ * $SYNTAX$ * FREAD( , @, ) --> nBytes * $ARGUMENTS$ - * Dos file handle - * Character expression passed by reference - * Number of bytes to read. + * Dos file handle + * Character expression passed by reference + * Number of bytes to read. * $RETURNS$ * the number of bytes successfyly read from the file - * + * * $DESCRIPTION$ * This function reads the characters from a DOS file whose file handle * is into it character memory variable expressed as . * The function returns the number of bytes successfully read into - * . + * . + * The value of is obtained from either it call to the FOPEN() - * or the FCREATE() function. + * 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 . + * length as . + * is the number of bytes to read, starting at the current DOS * file pointer position. If this function is successful in reading * the characters from the file, the length of or the number @@ -160,7 +163,7 @@ * ssive read.The return value is the number of byte 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. + * value in an end-of-file condition has been reached. * $EXAMPLES$ * cBuffer:=SPACE(500) * IF (nH:=FOPEN('X.TXT))>0 @@ -168,11 +171,12 @@ * ? cbuffer * ENDIF * FCLOSE(nH) + * * $STATUS$ * R * $COMPLIANCE$ * This function is not CA-Clipper compliant since may can read - * strings greather the 65K depending of platform. + * strings greather the 65K depending of platform. * $SEEALSO$ * BIN2I(),BIN2L(),BIN2W(),FERROR(),FWRITE() * $END$ @@ -188,37 +192,41 @@ * $SYNTAX$ * FWRITE( , , [] ) --> nBytesWritten * $ARGUMENTS$ - * DOS file handle number. - * Character expression to be written. - * The number of bytes to write. + * DOS file handle number. + * Character expression to be written. + * The number of bytes to write. * $RETURNS$ - * the number of bytes successfully written. + * 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 + * bytes in to write. + + * The returned value is the number of bytes successfully written to the * DOS 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 . + * by FWRITE() is equal to either LEN( ) or . + * The value of is the string or variable to be written to the - * open DOS file . + * open DOS 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. + * 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$ * This function is not CA-Clipper compatile since - * it can writes strings greather the 64K + * it can writes strings greather the 64K * $SEEALSO$ * FCLOSE(),FCREATE(),FERROR(),FOPEN(),I2BIN(),L2BIN() * $END$ @@ -235,33 +243,34 @@ * FERROR() --> * $RETURNS$ * Value of the DOS error last encountered by a - * low-level file function. + * low-level file function. * - * FERROR() Return Values + * 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 + * 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 informationon 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. + * of possibles values returned by the FERROR() function. * $EXAMPLES$ * #include "Fileio.ch" * // @@ -269,10 +278,11 @@ * IF FERROR() != 0 * ? "Cannot create file, DOS error ", FERROR() * ENDIF + * * $STATUS$ * R * $COMPLIANCE$ - * This function is CA-Clipper compatible + * This function is CA-Clipper compatible * $SEEALSO$ * FCLOSE(),FERASE(),FOPEN(),FWRITE() * $END$ @@ -288,22 +298,23 @@ * $SYNTAX$ * FCLOSE( ) --> * $ARGUMENTS$ - * DOS file handle + * DOS file handle * $RETURNS$ - * Logical TRUE (.T.) or FALSE (.F.) + * Logical TRUE (.T.) or FALSE (.F.) * $DESCRIPTION$ * This function closes an open file with a dos file handle * of and writes the associated DOS buffer to the * disk. The value is derived from the FCREATE() - * or FOPEN() function. + * or FOPEN() function. * $EXAMPLES$ * nHandle:=FOPEN('x.txt') * ? FSEEK(nHandle0,2) * FCLOSE(nHandle) + * * $STATUS$ * R * $COMPLIANCE$ - * This function is CA-Clipper compliant + * This function is CA-Clipper compliant * $SEEALSO$ * FOPEN(),FCREATE(),FREAD(),FWRITE(),FERROR() * $END$ @@ -319,22 +330,23 @@ * $SYNTAX$ * FERASE( ) --> nSuccess * $ARGUMENTS$ - * Name of file to erase. + * Name of file to erase. * $RETURNS$ - * 0 if successful, -1 if not + * 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 - * direcytory on the logged drive. + * direcytory 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 successfu, aditional information may be - * obtained by calling the FERROR() function. - * Note: Any file to be removed by FERASE() must still be closed. + * obtained by calling the FERROR() function. + * + * Note: Any file to be removed by FERASE() must still be closed. * * $EXAMPLES$ * IF (FERASE("TEST.TXT")==0) @@ -342,10 +354,11 @@ * ELSE * ? "File can not be deleted" * ENDIF + * * $STATUS$ * R * $COMPLIANCE$ - * This function is CA-Clipper Compatible + * This function is CA-Clipper Compatible * $SEEALSO$ * FERROR(),FRENAME() * $END$ @@ -361,39 +374,42 @@ * $SYNTAX$ * FRENAME( , ) --> nSuccess * $ARGUMENTS$ - * Old filenarne to he changed - * New filename + * Old filenarne to he changed + * New filename * $RETURNS$ * If sucessful, a 0 will he returned otherwise, - * a -1 will be returned. + * 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. + * 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 DOS PATH statement. + * or by the DOS PATH statement. + * 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. + * mation about any error found. * $EXAMPLES$ * nResult:=FRENAME("x.txt","x1.txt") * IF nResult <0 * ? "File could not be renamed." * ENDIF + * * $STATUS$ * R * $COMPLIANCE$ - * This function is CA-Clipper compliant + * This function is CA-Clipper compliant * $SEEALSO$ * ERASE,FERASE(),FERROR(),FILE(),RENAME * $END$ @@ -409,32 +425,35 @@ * $SYNTAX$ * FSEEK( , , [] ) --> nPosition * $ARGUMENTS$ - * DOS file handle. - * The number of bytes to move. - * The relative position in the file. + * DOS file handle. + * The number of bytes to move. + * The relative position in the file. * $RETURNS$ - * the current position relative to begin-of-file + * the current position relative to begin-of-file * $DESCRIPTION$ * This function sets the file pointer in the file whose DOS 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. + * marker once the operation has been completed. + * is the file handle number. It is obtained from the FOPEN() - * or FCREATE() function. + * 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. + * 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: - * + * file pointer should he moved, as shown in the following table: + * * File position * 0 Beginning of file * 1 Current file pointer position * 2 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. + * moves the file pointer from the beginning of the file. * $EXAMPLES$ * // here is a function that read one text line from an open file * @@ -456,10 +475,11 @@ * FSEEK( nH, nSavePos + nEol + 1, FS_SET ) * ENDIF * RETURN nNumRead != 0 + * * $STATUS$ * R * $COMPLIANCE$ - * This function is CA-Clipper compliant. + * This function is CA-Clipper compliant. * $SEEALSO$ * FCREATE(),FERROR(),FOPEN(),FREAD(),FREADSTR(),FWRITE() * $INCLUDE$ @@ -477,26 +497,28 @@ * $SYNTAX$ * FILE( ) --> lExists * $ARGUMENTS$ - * Dos Skeleton or file name to find. + * Dos Skeleton or file name to find. * $RETURNS$ * a logical true (.T.) if the file exists or logical - * false (.F.). + * false (.F.). * $DESCRIPTION$ * This function return a logical true (.T.) if the given filename - * exist. + * exist. + * Dos skeletons symbols may be used in the filename in , * as may the drive and/or path name. If a drive are not explicity * specified,FILE() will first search the current drive and directory, * and will look for the file in the directories specified by SET PATH * TO and SET DEFAULT TO commands.However, this command does not look - * at the values in the DOS PATH command. + * at the values in the DOS PATH command. * $EXAMPLES$ * ? file('c:\harbour\doc\compiler.txt") * ? file('c:/harbour/doc/subcodes.txt") + * * $STATUS$ * R * $COMPLIANCE$ - * This function is CA-Clipper compatible. + * This function is CA-Clipper compatible. * $SEEALSO$ * SET PATH,SET DEFAULT,SET() * $END$ @@ -512,37 +534,41 @@ * $SYNTAX$ * FREADSTR(, ) --> cString * $ARGUMENTS$ - * DOS file handle number. + * DOS file handle number. * - * Number of bytes to read. + * Number of bytes to read. * $RETURNS$ - * an characted expression + * an characted expression * $DESCRIPTION$ * This function returns a character string of bytes from a - * file whose DOS file handle is . + * file whose DOS file handle is . + * The value of the file handle is obtained from either the - * FOPEN() or FCREATE() functions. + * FOPEN() or FCREATE() functions. + * 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. + * 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. + * function. * $EXAMPLES$ * IF ( nH := FOPEN("x.txt") ) > 0 * cStr := Freadstr(nH,100) * ? cStr * ENDIF * FCLOSE(nH) + * * $STATUS$ * R * $COMPLIANCE$ * This function is not CA-Clipper compliant since may read - * strings greather the 65K depending of platform. + * strings greather the 65K depending of platform. * $SEEALSO$ * BIN2I(),BIN2L(),BIN2W(),FERROR(),FREAD(),FSEEK() * $END$ @@ -558,24 +584,26 @@ * $ONELINER$ * Changes the name of a specified file * $SYNTAX$ - * RENAME TO + * RENAME TO * $ARGUMENTS$ - * Old filename - * New Filename + * 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 directoy designaters must be specified if either file is in a - * directory other then the default drive and directory. + * 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. + * command will not perform the desired operation. * $EXAMPLES$ * RENAME c:\autoexec.bat to c:\autoexec.old + * * $STATUS$ * R * $COMPLIANCE$ - * This command is CA-Clipper compatible + * This command is CA-Clipper compatible * $SEEALSO$ * CURDIR(),ERASE,FILE(),FERASE(),FRENAME() * $END$ @@ -591,21 +619,23 @@ * $SYNTAX$ * ERASE * $ARGUMENTS$ - * Name of file to remove + * 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. + * commands do not affect this command. + * The file must be considered closed by the operating system before it - * may be deleted. + * may be deleted. * $EXAMPLES$ * Erase c:\autoexec.bat * Erase c:/temp/read.txt + * * $STATUS$ * R * $COMPLIANCE$ - * This command is CA-Clipper compatible + * This command is CA-Clipper compatible * $SEEALSO$ * CURDIR(),FILE(),FERASE(),DELETE FILE * $END$ @@ -621,21 +651,23 @@ * $SYNTAX$ * DELETE FILE * $ARGUMENTS$ - * Name of file to remove + * 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. + * commands do not affect this command. + * The file must be considered closed by the operating system before it - * may be deleted. + * may be deleted. * $EXAMPLES$ * Erase c:\autoexec.bat * Erase c:/temp/read.txt + * * $STATUS$ * R * $COMPLIANCE$ - * This command is CA-Clipper compatible + * This command is CA-Clipper compatible * $SEEALSO$ * CURDIR(),FILE(),FERASE(),ERASE * $END$ @@ -652,27 +684,27 @@ * __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). + * 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.). + * printer (.T.), the default is (.F.). * $RETURNS$ - * __TYPEFILE() always return NIL. + * __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 formating. + * file is displayed as is without any headings or formating. * * 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. + * 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. + * 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. + * 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 @@ -687,10 +719,11 @@ * SET CONSOLE OFF * __TYPEFILE( "MyText.DAT", .T. ) * SET CONSOLE ON + * * $STATUS$ * R * $COMPLIANCE$ - * __TYPEFILE() works exactly like CA-Clipper's __TYPEFILE() + * __TYPEFILE() works exactly like CA-Clipper's __TYPEFILE() * $SEEALSO$ * COPY FILE,SET DEFAULT,SET PATH,SET PRINTER,TYPE * $END$ @@ -709,30 +742,30 @@ * 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. + * expression enclosed in parentheses. * * TO PRINTER is an optional keyword that specifies that the output - * should go to both the screen and printer. + * 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. + * 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 formating. + * or formating. * * 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. + * directories. If can not be found a run-time error occur. * * If contain no path it is created in the SET DEFAULT - * directory. + * directory. * - * Use SET CONSOLE OFF to suppress screen output. - * You can pause the output using Ctrl-S, press any key to resume. + * 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 @@ -750,10 +783,11 @@ * * // display MyText.DAT file on screen and into a file MyReport.txt * TYPE MyText.DAT TO FILE MyReport + * * $STATUS$ * R * $COMPLIANCE$ - * TYPE works exactly like CA-Clipper's TYPE + * TYPE works exactly like CA-Clipper's TYPE * $SEEALSO$ * COPY FILE,SET DEFAULT,SET PATH,SET PRINTER,__TYPEFILE() * $END$ @@ -769,26 +803,29 @@ * $SYNTAX$ * CURDIR( [] ) --> cPath * $ARGUMENTS$ - * OS drive letter + * OS drive letter * $RETURNS$ - * Name of directory + * Name of directory * $DESCRIPTION$ * This function yields the name of the current OS directory on a * specified drive.If is not speficied,the currently logged - * drive will be used. + * drive will be used. + * This function should not return the leading and trailing - * (back)slashes. + * (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. + * byte. * $EXAMPLES$ * ? Curdir() + * * $STATUS$ * R * $COMPLIANCE$ - * This function is Ca-Clipper Compatible + * This function is Ca-Clipper Compatible * $PLATFORMS$ - * ALL + * ALL * $SEEALSO$ * FILE() * $END$ diff --git a/harbour/doc/en/ht_class.txt b/harbour/doc/en/ht_class.txt index 6594ce32c9..1f57e6f2a5 100644 --- a/harbour/doc/en/ht_class.txt +++ b/harbour/doc/en/ht_class.txt @@ -23,36 +23,36 @@ * $SYNTAX$ * oFile := TFileRead():New( [, ] ) * $ARGUMENTS$ - * cFileName is the required name of the file to be read. - * nReadSize is the optional size to use when reading from the file. + * 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. + * Any value outside of this range causes the default value to be used. * $RETURNS$ - * An instance of the File Reader class + * 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. + * 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. + * 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. + * 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. + * Error() Returns .T. if an error has occurred. + * ErrorNo() Returns the current error code. + * ErrorMsg([]) Returns a formatted error message. * $EXAMPLES$ * #ifdef __HARBOUR__ * #define NEW_LINE CHR( 10 ) @@ -75,12 +75,14 @@ * oFile:Close() * END IF * QUIT + * * $TESTS$ * See Examples + * * $STATUS$ * R * $COMPLIANCE$ - * This is a new Harbour Tools class + * This is a new Harbour Tools class * $SEEALSO$ * TClass() * $END$ diff --git a/harbour/doc/en/hvm.txt b/harbour/doc/en/hvm.txt index dd102f4d39..1fee29c6af 100644 --- a/harbour/doc/en/hvm.txt +++ b/harbour/doc/en/hvm.txt @@ -26,15 +26,16 @@ * $SYNTAX$ * PROCNAME( ) --> * $ARGUMENTS$ - * is the function level required. + * is the function level required. * $RETURNS$ - * Return the name of the function that it is being executed. + * The name of the function that it is being executed. * $DESCRIPTION$ * This function look 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 . + * 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. @@ -44,10 +45,11 @@ * ? ProcName( n++ ) * end do * return nil + * * $STATUS$ * R * $COMPLIANCE$ - * PROCNAME() is fully CA-Clipper compliant. + * PROCNAME() is fully CA-Clipper compliant. * $SEEALSO$ * PROCLINE(),PROCFILE() * $END$ @@ -63,25 +65,27 @@ * $SYNTAX$ * PROCLINE( ) --> * $ARGUMENTS$ - * is the function level required. + * is the function level required. * $RETURNS$ - * Return the line number of the function that it is being executed. + * The line number of the function that it is being executed. * $DESCRIPTION$ * This function look at the top of the stack and gets the current * line number of executed function if no arguments are passed. * Otherwise it returns the line number of the function or procedure - * at . + * at . * $EXAMPLES$ * See Test + * * $TESTS$ * function Test() * ? ProcLine( 0 ) * ? ProcName( 2 ) * return nil + * * $STATUS$ * R * $COMPLIANCE$ - * PROCLINE() is fully CA-Clipper compliant. + * PROCLINE() is fully CA-Clipper compliant. * $SEEALSO$ * PROCNAME(),PROCFILE() * $END$ @@ -97,24 +101,26 @@ * $SYNTAX$ * PROCFILE( ) --> * $ARGUMENTS$ - * is any valid type. + * is any valid type. * $RETURNS$ - * Return and empty string + * Return an empty string * $DESCRIPTION$ * This function is added to the RTL for full compatibility. It allways - * returns an empty string. + * returns an empty string. * $EXAMPLES$ * ? ProcFile() + * * $TESTS$ * function Test() * ? ProcFile() * ? ProcFile( NIL ) * ? ProcFile( 2 ) * return nil + * * $STATUS$ * R * $COMPLIANCE$ - * PROCFILE() is fully CA-Clipper compliant. + * PROCFILE() is fully CA-Clipper compliant. * $SEEALSO$ * PROCNAME(),PROCLINE() * $END$ @@ -130,13 +136,14 @@ * $SYNTAX$ * HB_PVALUE( ) --> * $ARGUMENTS$ - * A number that indicates the argument to check. + * A number that indicates the argument to check. * $RETURNS$ - * Returns the value stored by an argument. + * Returns the value stored by an argument. * $DESCRIPTION$ - * This function is useful to check the value stored in an argument. + * This function is useful to check the value stored in an argument. * $EXAMPLES$ * See Test + * * $TESTS$ * function Test( nValue, cString ) * if PCount() == 2 @@ -144,10 +151,11 @@ * ? hb_PValue( 2 ), cString * endif * return nil + * * $STATUS$ * R * $COMPLIANCE$ - * HB_PVALUE() is a new function and hence not CA-Clipper compliant. + * HB_PVALUE() is a new function and hence not CA-Clipper compliant. * $SEEALSO$ * PCOUNT() * $END$ @@ -161,17 +169,18 @@ * $ONELINER$ * Retrieves the number of arguments passed to a function. * $SYNTAX$ - * PCOUNT() --> + * PCOUNT() --> * $ARGUMENTS$ - * None + * None * $RETURNS$ - * Returns a number that indicates the number of arguments - * passed to a function or procedure. + * 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. + * has received the required number of arguments. * $EXAMPLES$ * See Test + * * $TESTS$ * function Test( xExp ) * if PCount() == 0 @@ -180,10 +189,11 @@ * ? xExp * endif * return nil + * * $STATUS$ * R * $COMPLIANCE$ - * PCOUNT() is fully CA-Clipper compliant. + * PCOUNT() is fully CA-Clipper compliant. * $SEEALSO$ * HB_PVALUE() * $END$ @@ -199,24 +209,26 @@ * $SYNTAX$ * __QUIT() --> NIL * $ARGUMENTS$ - * None + * None * $RETURNS$ - * NIL + * NIL * $DESCRIPTION$ * This function terminates the current application and returns - * to the system. + * to the system. * $EXAMPLES$ * See Test + * * $TESTS$ * function EndApp( lYesNo ) * if lYesNo * __Quit() * endif * return nil + * * $STATUS$ * R * $COMPLIANCE$ - * __QUIT() is fully CA-Clipper compliant. + * __QUIT() is fully CA-Clipper compliant. * $SEEALSO$ * QUIT * $END$ @@ -232,22 +244,22 @@ * $SYNTAX$ * CLIPINIT() --> NIL * $ARGUMENTS$ - * none. + * none. * $RETURNS$ - * CLIPINIT() always return NIL. + * 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 activate the * default error handler, and (at least for the moment) call the - * function that set the default help key. + * function that set the default help key. * $STATUS$ * R * $COMPLIANCE$ * It is said that CLIPINIT() should not call that function that set - * the default help key since CA-Clipper do it in some other place. + * the default help key since CA-Clipper do it in some other place. * $PLATFORMS$ - * $FILES$ + * All * $SEEALSO$ * INIT PROCEDURE * $END$ @@ -263,16 +275,16 @@ * $SYNTAX$ * __SetHelpK() --> NIL * $ARGUMENTS$ - * none. + * none. * $RETURNS$ - * __SetHelpK() always return NIL. + * __SetHelpK() always return NIL. * $DESCRIPTION$ * Set F1 to execute a function called HELP if such a function is - * linked into the program. + * linked into the program. * $STATUS$ * R * $COMPLIANCE$ - * __SetHelpK() works exactly like CA-Clipper's __SetHelpK() + * __SetHelpK() works exactly like CA-Clipper's __SetHelpK() * $SEEALSO$ * __XHelp(),SET KEY,SETKEY() * $END$ @@ -289,18 +301,19 @@ * BREAK( ) --> NIL * $ARGUMENTS$ * is any valid expression. It is always required. - * If do not want to pass any argument, just use NIL. + * If do not want to pass any argument, just use NIL. * $RETURNS$ - * NIL + * NIL * $DESCRIPTION$ * This function passes control to the RECOVER statement in a - * BEGIN SEQUENCE block. + * BEGIN SEQUENCE block. * $EXAMPLES$ * Break( NIL ) + * * $STATUS$ * R * $COMPLIANCE$ - * BREAK() is fully CA-Clipper compliant. + * BREAK() is fully CA-Clipper compliant. * $SEEALSO$ * BEGIN SEQUENCE * $END$ @@ -317,20 +330,20 @@ * DO( [, ] ) * $ARGUMENTS$ * = Either a string with a function/procedure name to be called - * or a codeblock to evaluate + * or a codeblock to evaluate * = arguments passed to a called function/procedure or to - * a codeblock + * a codeblock * $RETURNS$ - * A value that was returned from called function + * 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. + * name of procedure specified in DO WITH ... statement. * If called procedure/function doesn't exist then the runtime error - * is generated. + * 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 + * In this case is of type HB_SYMB * $EXAMPLES$ * cbCode ={|x| MyFunc( x )} * DO( cbCode, 1 ) @@ -340,7 +353,7 @@ * * Old style (slower): * DO &cFunction WITH 3 - * + * * $END$ */ @@ -356,11 +369,11 @@ * $ARGUMENTS$ * Is the procedure level, same as used in ProcName() * and ProcLine(), from which a local variable containts is going to - * be retrieved. - * Is the index of the local variable to retrieve. + * be retrieved. + * Is the index of the local variable to retrieve. * $RETURNS$ - * The containts of a specific local variable + * The containts of a specific local variable * $DESCRIPTION$ - * This function is used from the debugger + * This function is used from the debugger * $END$ */ diff --git a/harbour/doc/en/input.txt b/harbour/doc/en/input.txt index 45c1d3693d..040ae993b4 100644 --- a/harbour/doc/en/input.txt +++ b/harbour/doc/en/input.txt @@ -30,23 +30,23 @@ * 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. + * treated as if it were not present. * - * is an optional mask of input events that are to be enabled. + * is an optional mask of input events that are to be enabled. * If omitted, defaults to hb_set.HB_SET_EVENTMASK. Valid input maks 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_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 + * type of input event, simply add the various mask names together. + * 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 * If the parameter is not numeric, it will be treated as if it were set - * to hb_set.HB_SET_EVENTMASK. + * to hb_set.HB_SET_EVENTMASK. * $RETURNS$ * 0 in case of timeout with no input event, otherwise returns a value * in the range -39 to 386 for keyboard events or the range 1001 to 1007 @@ -55,7 +55,7 @@ * 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. + * vary based on hardware and nationality. * $DESCRIPTION$ * INKEY() can be used to detect input events, such as keypress, mouse * movement, or mouse key clicks (up and/or down). @@ -64,8 +64,10 @@ * ? "Please press the ESC key." * WHILE INKEY( 0.1 ) != K_ESC * END + * * $TESTS$ * KEYBOARD "AB"; ? INKEY(), INKEY() ==> 65 66 + * * $STATUS$ * S * $COMPLIANCE$ @@ -74,7 +76,7 @@ * 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 Clipper, this also blocks SET KEY events). + * for no events (Note: In Clipper, this also blocks SET KEY events). * $SEEALSO$ * inkey.ch * $END$ @@ -94,27 +96,29 @@ * $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-Clipper feature). + * to CHR(13) (this is an undocumented CA-Clipper feature). * $RETURNS$ - * There is no return value + * There is no return value * $DESCRIPTION$ * Clears the Harbour keyboard typeahead buffer and then inserts an - * optional string into it. + * 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-Clipper 5.3 + * __KEYBOARD() is compliant with CA-Clipper 5.3 * $SEEALSO$ - * CLEAR TYPEAHEAD, KEYBOARD + * CLEAR TYPEAHEAD,KEYBOARD * $END$ */ @@ -129,25 +133,27 @@ * HB_keyPut( ) * $ARGUMENTS$ * is the inkey code, which should be inserted into the - * keyboard buffer. + * keyboard buffer. * $RETURNS$ - * There is no return value + * 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. + * 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$ - * Was not part of Clipper + * Was not part of Clipper * $SEEALSO$ * KEYBOARD,CLEAR TYPEAHEAD,INKEY() * $END$ @@ -163,12 +169,12 @@ * $SYNTAX$ * NEXTKEY() --> nKey * $ARGUMENTS$ - * None + * None * $RETURNS$ - * There is no return value + * There is no return value * $DESCRIPTION$ * Returns the value of the next key in the Harbour keyboard buffer - * without extracting it. + * without extracting it. * $EXAMPLES$ * // Use NEXTKEY() with INKEY() to change display character or by * // itself to exit the loop, so that the caller can detect the Esc. @@ -184,12 +190,14 @@ * END IF * END IF * END WHILE + * * $TESTS$ * KEYBOARD "AB"; ? NEXTKEY(), NEXTKEY() ==> 65 65 + * * $STATUS$ * R * $COMPLIANCE$ - * NEXTKEY() is compliant with CA-Clipper 5.3 + * NEXTKEY() is compliant with CA-Clipper 5.3 * $SEEALSO$ * INKEY(),LASTKEY() * $END$ @@ -205,12 +213,12 @@ * $SYNTAX$ * LASTKEY() --> nKey * $ARGUMENTS$ - * None + * None * $RETURNS$ - * There is no return value + * There is no return value * $DESCRIPTION$ * Returns the value of the last key exttracted from the Harbour - * keyboard buffer + * keyboard buffer * $EXAMPLES$ * // Continue looping unless the ESC key was pressed in MainFunc() * WHILE TRUE @@ -219,12 +227,14 @@ * EXIT * END IF * END WHILE + * * $TESTS$ * KEYBOARD "AB"; ? INKEY(), LASTKEY() ==> 65 65 + * * $STATUS$ * R * $COMPLIANCE$ - * LASTKEY() is compliant with CA-Clipper 5.3 + * LASTKEY() is compliant with CA-Clipper 5.3 * $SEEALSO$ * INKEY(),LASTKEY() * $END$ @@ -239,30 +249,32 @@ * $ONELINER$ * Stuffs the keyboard with a string * $SYNTAX$ - * KEYBOARD + * KEYBOARD * $ARGUMENTS$ * String to be processed, one character at a time, - * by the Harbour keyboard processor + * by the Harbour keyboard processor * $DESCRIPTION$ * This command stuff the input buffer with . The * number of character that can be stuffed into the keyboard * buffer is controled by SET TYPEAHEAD command and may range * from 0 to 32,622, with each character appearing in the ASCII * range of 0 to 255. None of the extended keys may be stuffed - * in the keyboard buffer. - * Issuing a KEYBOARD " " will clear the keyboard buffer. + * in 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-Clipper 5.3 + * __KEYBOARD() is compliant with CA-Clipper 5.3 * $SEEALSO$ * CLEAR TYPEAHEAD,__KEYBOARD() * $END$ @@ -278,39 +290,39 @@ * $SYNTAX$ * READKEY() --> nKeyCode * $ARGUMENTS$ - * none. + * none. * $RETURNS$ * READKEY() return a numeric code representing the key that cause READ - * to terminate. + * 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. + * to the return code. * - * Exit key Return code Return code - * (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 + * Exit key Return code Return code + * (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 + * Key >= 32 15 271 + * otherwise 0 0 * * READKEY() is a compatibility function so try not use it. READKEY() * is superseded by LASTKEY() which return INKEY() code for that key, * UPDATED() could be use to find if the get buffer was changed during - * READ. + * READ. * $STATUS$ * R * $COMPLIANCE$ - * READKEY() works exactly like CA-Clipper's READKEY(). + * READKEY() works exactly like CA-Clipper's READKEY(). * $SEEALSO$ * @...GET,INKEY(),LASTKEY(),READ,READEXIT(),UPDATED() * $END$ @@ -324,23 +336,24 @@ * $ONELINER$ * Returns the mouse cursor row position * $SYNTAX$ - * MRow() --> nMouseColumn + * MRow() --> nMouseRow * $ARGUMENTS$ - * None + * None * $RETURNS$ - * The mouse cursor column position + * The mouse cursor row position * $DESCRIPTION$ * $EXAMPLES$ * local nKey * nKey = InKey( 0 ) * do case * case nKey == + * * $STATUS$ * R * $COMPLIANCE$ - * This function is a Harbour Specific + * This function is a Harbour Specific * $PLATFORMS$ - * This function is Windows Specific + * This function is Windows Specific * $SEEALSO$ * MCOL() * $END$ @@ -356,21 +369,22 @@ * $SYNTAX$ * MCol() --> nMouseColumn * $ARGUMENTS$ - * None + * None * $RETURNS$ - * The mouse cursor column position + * The mouse cursor column position * $DESCRIPTION$ * $EXAMPLES$ * local nKey * nKey = InKey( 0 ) * do case * case nKey == + * * $STATUS$ * R * $COMPLIANCE$ - * This function is a Harbour Specific + * This function is a Harbour Specific * $PLATFORMS$ - * This function is Windows Specific + * This function is Windows Specific * $SEEALSO$ * MROW() * $END$ diff --git a/harbour/doc/en/math.txt b/harbour/doc/en/math.txt new file mode 100644 index 0000000000..847f978786 --- /dev/null +++ b/harbour/doc/en/math.txt @@ -0,0 +1,253 @@ +/* + * $Id$ + */ + +/* + * The following parts are Copyright of the individual authors. + * www - http://www.harbour-project.org + * + * Copyright 2000 Luiz Rafael Culik + * Documentation for: ABS(),EXP(),LOG(),INT(),MAX() + * MIN() + * See doc/license.txt for licensing terms. + * + */ + +/* $DOC$ + * $FUNCNAME$ + * ABS() + * $CATEGORY$ + * Math + * $ONELINER$ + * Return the absolute value of a number. + * $SYNTAX$ + * ABS() --> + * $ARGUMENTS$ + * Any number + * $RETURNS$ + * The absolute numeric value + * $DESCRIPTION$ + * This function yeilds the absolute value of the numeric value or + * expression + * $EXAMPLES$ + * Proc Main() + * + * Local nNumber:=50 + * Local nNumber1:=27 + * cls + * + * qout(nNumber-nNumber1) + * qout(nNumber1-nNumber) + * qout(ABS(nNumber-nNumber1)) + * qout(ABSnNumber1-nNumber)) + * qout(ABS( -1 * 345)) + * + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is CA-Clipper compliant + * $PLATFORMS$ + * All + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * EXP() + * $CATEGORY$ + * Math + * $ONELINER$ + * Calculates the exponential of a real number + * $SYNTAX$ + * EXP( ) --> + * $ARGUMENTS$ + * Any real number + * $RETURNS$ + * The expoent number of + * $DESCRIPTION$ + * This function returns the exponential of any given real number + * + * $EXAMPLES$ + * ? EXP(632512) + * + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is CA-Clipper compliant. + * $PLATFORMS$ + * All + * $SEEALSO$ + * LOG() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * INT() + * $CATEGORY$ + * 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 convert a numeric expression to an integer. all decimals + * digit are truncated.This function does not round a value upward or + * downward;it merely truncated a numeric expression. + * $EXAMPLES$ + * SET Decimal to 5 + * ? INT(632512.62541) + * ? INT(845414111.91440) + * + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is CA-Clipper compliant. + * $PLATFORMS$ + * All + * $SEEALSO$ + * ROUND(),STRZERO() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * LOG() + * $CATEGORY$ + * Math + * $ONELINER$ + * Returns the natural logarithm of a number + * $SYNTAX$ + * LOG( ) --> + * $ARGUMENTS$ + * Any numeric expression + * $RETURNS$ + * The natural logaritmh of + * $DESCRIPTION$ + * This function will return the natural logarithm of the number . + * If is 0 or is less them 0,a numeric overflow condition exist, + * witch is depicted on the display device as a series of asterisks. + * This functions is the inverse of EXP() function. + * $EXAMPLES$ + * ? LOG(632512) + * + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is CA-Clipper compliant. + * $PLATFORMS$ + * All + * $SEEALSO$ + * EXP() + * $END$ + */ + + +/* $DOC$ + * $FUNCNAME$ + * MAX() + * $CATEGORY$ + * MATH + * $ONELINER$ + * Returns the maximum of either two number or two dates. + * $SYNTAX$ + * MAX(,) --> + * $ARGUMENTS$ + * Any date or numeric value. + * Any date or numeric value. + * $RETURNS$ + * Eighter a numeric or 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 for this function will be a date + * data type as well;it will be the latest of the two dates passed to it. + * $EXAMPLES$ + * ? MAX(214514214,6251242142) + * ? MAX(CTOD('11/11/2000'),CTOD('21/06/2014') + * + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant + * $PLATFORMS$ + * All + * $SEEALSO$ + * Min() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * MIN() + * $CATEGORY$ + * MATH + * $ONELINER$ + * Determines a minumum value or dates. + * $SYNTAX$ + * MIN(,) --> + * $ARGUMENTS$ + * Any date or numeric value. + * Any date or numeric value. + * $RETURNS$ + * Eighter a numeric or date value + * $DESCRIPTION$ + * This function returns the smaller of the two passed espressions. The + * value of this function will be the result of this comparasion.If + * is a numeric data type, must so be a numeric data type.The + * same may be said if is a date data type. + * $EXAMPLES$ + * ? MIN(214514214,6251242142) + * ? MIN(CTOD('11/11/2000'),CTOD('21/06/2014') + * + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant + * $PLATFORMS$ + * All + * $SEEALSO$ + * MAX() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * MOD() + * $CATEGORY$ + * Math + * $ONELINER$ + * Return the modulus of two numbers + * $SYNTAX$ + * MOD( ,) --> + * $ARGUMENTS$ + * Numerator in a divisional expression + * Denominator in a divisional expression + * $RETURNS$ + * Remind from the division + * $DESCRIPTION$ + * This functuion will return a value that is correspondent to the + * reminder of one number divided by another + * $EXAMPLES$ + * ? MOD(12,8.521) + * ? Mod(12,0) + * ? Mod(62412.5142,4522114.12014) + * + * $STATUS$ + * R + * $COMPLIANCE$ + * This Function is Ca-Clipper compliant + * $PLATFORMS$ + * All + * $SEEALSO$ + * % + * $END$ + */ diff --git a/harbour/doc/en/memo.txt b/harbour/doc/en/memo.txt index e0d458d2d7..460e9a032a 100644 --- a/harbour/doc/en/memo.txt +++ b/harbour/doc/en/memo.txt @@ -24,26 +24,28 @@ * $SYNTAX$ * MEMOTRAN( , , ) --> * $ARGUMENTS$ - * is a string of chars to convert. + * is a string of chars to convert. * is the character to replace hard carriages with. If not - * specified defaults to semicolon. + * specified defaults to semicolon. * is the character to replace soft carriages with. If not - * specified defaults to single space. + * specified defaults to single space. * $RETURNS$ - * Trasformed string. + * Trasformed string. * $DESCRIPTION$ * Returns a string/memo with carriage chars converted to specified - * chars. + * 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$ - * MEMOTRAN() is fully CA-Clipper compliant. + * MEMOTRAN() is fully CA-Clipper compliant. * $SEEALSO$ * HARDCR(),STRTRAN() * $END$ @@ -59,22 +61,24 @@ * $SYNTAX$ * HARDCR( ) --> * $ARGUMENTS$ - * is a string of chars to convert. + * is a string of chars to convert. * $RETURNS$ - * Trasformed string. + * Trasformed string. * $DESCRIPTION$ * Returns a string/memo with soft carriages chars converted to - * hard carraige char. + * hard carraige char. * $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$ - * HARDCR() is fully CA-Clipper compliant. + * HARDCR() is fully CA-Clipper compliant. * $SEEALSO$ * MEMOTRAN(),STRTRAN() * $END$ diff --git a/harbour/doc/en/misc.txt b/harbour/doc/en/misc.txt index bb6ecde0b0..d54a4625b3 100644 --- a/harbour/doc/en/misc.txt +++ b/harbour/doc/en/misc.txt @@ -23,13 +23,14 @@ * $CATEGORY$ * DOS * $RETURNS$ - * -> The Current operating system + * -> The Current operating system * $DESCRIPTION$ - * This function will return the current operating system + * This function will return the current operating system * $EXAMPLES$ * ? OS() + * * $FILES$ - * source/rtl/environ.c + * source/rtl/environ.c * $END$ */ @@ -44,16 +45,17 @@ * VERSION([] --> * $ARGUMENTS$ * [] Optional Parameter that enables the display - * of the C compiler version that HARBOUR was built with. + * of the C compiler version that HARBOUR was built with. * $RETURNS$ * String contining the Harbour Version or the Harbour - * and C compiler Version when the parameter is used. + * 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 + * 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 + * * $STATUS$ * S * $COMPLIANCE$ @@ -62,9 +64,9 @@ * 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. + * to build Harbour when the parameter is present. * $FILES$ - * source/rtl/environ.c + * source/rtl/environ.c * $SEEALSO$ * OS() * $END$ @@ -80,25 +82,26 @@ * $SYNTAX$ * GETENV(, ) --> * $ARGUMENTS$ - * Enviromental variable to obtain - * Optional value to return if is not found + * Enviromental variable to obtain + * Optional value to return if is not found * $RETURNS$ - * Value of the Variable + * Value of the Variable * $DESCRIPTION$ * This function yields a string that is the value of the * environmental variable , 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. + * can be found, the value of the function will be a empty string. * $EXAMPLES$ * ? QOUT(GETENV('PATH')) * ? QOUT(GETENV('CONFIG')) * ? QOUT(GETENV('HARBOURCMD', '-n -l -es2')) + * * $STATUS$ * R * $COMPLIANCE$ - * This functions is CA-CLIPPER compliant + * This functions is CA-CLIPPER compliant * $FILES$ - * source/rtl/environ.c + * source/rtl/environ.c * $END$ */ @@ -111,24 +114,23 @@ * Run a external program * $SYNTAX$ * __RUN( ) - * $CATEGORY$ - * DOS * $ARGUMENTS$ - * Command to execute + * 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. + * 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 + * (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. + * Use the RUN command instead. * $EXAMPLES$ * __Run( "edit " + cMyTextFile ) // Runs an external editor * __Run( "command" ) // Gives a DOS shell (DOS only) + * * $FILES$ - * source/rtl/environ.c + * source/rtl/environ.c * $SEEALSO$ * RUN * $END$ @@ -145,15 +147,15 @@ * TONE( , ) --> NIL * $ARGUMENTS$ * is a non-negative numeric value that specifies the - * frequency of the tone in hertz. + * 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. + * of the tone in 1/18 of a second units. * $RETURNS$ - * TONE() always return NIL. + * 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. + * is clamped to the range 0 to 32767 Hz. * $EXAMPLES$ * If lOk // Good Sound * TONE( 500, 1 ) @@ -164,6 +166,7 @@ * TONE( 499, 5 ) * TONE( 700, 5 ) * EndIf + * * $TESTS$ * TONE( 800, 1 ) // same as ? CHR(7) * TONE( 32000, 200 ) // any dogs around yet? @@ -173,10 +176,11 @@ * TONE( 10, 18.2 ) // 1 second delay * TONE( -1 ) // 1/18.2 second delay * TONE( ) // 1/18.2 second delay + * * $STATUS$ * S * $COMPLIANCE$ - * TONE() works exactly like CA-Clipper's TONE(). + * TONE() works exactly like CA-Clipper's TONE(). * $SEEALSO$ * CHR(),SET BELL * $END$ diff --git a/harbour/doc/en/nation.txt b/harbour/doc/en/nation.txt index 2a80f469fd..9fe00e1dba 100644 --- a/harbour/doc/en/nation.txt +++ b/harbour/doc/en/nation.txt @@ -25,22 +25,23 @@ * $SYNTAX$ * ISAFFIRM( ) --> * $ARGUMENTS$ - * is a char or string of chars + * is a char or string of chars * $RETURNS$ * True if passed char is an affirmation char,otherwise - * false + * false * $DESCRIPTION$ * This function it is used to check if a user input is true or not - * regarding of the msgxxx module used. + * regarding of the msgxxx module used. * $EXAMPLES$ * // Wait until user enters Y * DO WHILE !ISAFFIRM( cYesNo ) * ACCEPT "Sure: " TO cYesNo * END DO + * * $STATUS$ * R * $COMPLIANCE$ - * ISAFFIRM() is fully CA-Clipper compliant. + * ISAFFIRM() is fully CA-Clipper compliant. * $SEEALSO$ * ISNEGATIVE(),NATIONMSG() * $END$ @@ -56,22 +57,23 @@ * $SYNTAX$ * ISNEGATIVE( ) --> * $ARGUMENTS$ - * is a char or string of chars + * is a char or string of chars * $RETURNS$ * True if passed char is a negation char,otherwise - * false + * false * $DESCRIPTION$ * This function it is used to check if a user input is true or not - * regarding of the msgxxx module used. + * regarding of the msgxxx module used. * $EXAMPLES$ * // Wait until user enters N * DO WHILE !ISNEGATIVE( cYesNo ) * ACCEPT "Sure: " TO cYesNo * END DO + * * $STATUS$ * R * $COMPLIANCE$ - * ISNEGATIVE() is fully CA-Clipper compliant. + * ISNEGATIVE() is fully CA-Clipper compliant. * $SEEALSO$ * ISAFFIRM(),NATIONMSG() * $END$ @@ -87,23 +89,24 @@ * $SYNTAX$ * NATIONMSG( ) --> * $ARGUMENTS$ - * is the message number you want to get + * is the message number you want to get * $RETURNS$ * If is a valid message selector return the message, * if is nil returns "Invalid Argument" and if is any - * other type it returns an empty string. + * other type it returns an empty string. * $DESCRIPTION$ - * This functions returns international message descriptions. + * This functions 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 * END DO + * * $STATUS$ * C * $COMPLIANCE$ - * NATIONMSG() is fully CA-Clipper compliant. + * NATIONMSG() is fully CA-Clipper compliant. * $SEEALSO$ * ISAFFIRM(),ISNEGATIVE() * $END$ diff --git a/harbour/doc/en/objfunc.txt b/harbour/doc/en/objfunc.txt index a8e1f3f3cd..60f149b84e 100644 --- a/harbour/doc/en/objfunc.txt +++ b/harbour/doc/en/objfunc.txt @@ -28,24 +28,25 @@ * $SYNTAX$ * __objHasData( , ) --> lExist * $ARGUMENTS$ - * is an object to scan. + * is an object to scan. * - * is the name of the symbol to look for. + * is the name of the symbol to look for. * $RETURNS$ * __objHasData() return .T. if the given exist as DATA - * (instance variable) in object * $DESCRIPTION$ * __objHasData() is a low level class support function that let you - * find out if a symbol is an instance variable in a given object. + * find out if a symbol is an instance variable in a given object. * $EXAMPLES$ * oB := TBrowseNew( 0, 0, 24, 79 ) * ? __objHasData( oB, "nLeft" ) // this should return .T. * ? __objHasData( oB, "lBugFree" ) // hopefully this should be .F. * ? __objHasData( oB, "Left" ) // .F. since this is a METHOD + * * $STATUS$ * R * $COMPLIANCE$ - * __objHasData() is a Harbour extension. + * __objHasData() is a Harbour extension. * $SEEALSO$ * __ObjGetMethodList(),__objGetMsgList(),__objHasMethod() * $END$ @@ -61,24 +62,25 @@ * $SYNTAX$ * __objHasMethod( , ) --> lExist * $ARGUMENTS$ - * is an object to scan. + * is an object to scan. * - * is the name of the symbol to look for. + * is the name of the symbol to look for. * $RETURNS$ * __objHasMethod() return .T. if the given exist as METHOD - * (class function) in object * $DESCRIPTION$ * __objHasMethod() is a low level class support function that let you - * find out if a symbol is a class function in a given object. + * find out if a symbol is a class function in a given object. * $EXAMPLES$ * oB := TBrowseNew( 0, 0, 24, 79 ) * ? __objHasMethod( oB, "nLeft" ) // .F. since this is a DATA * ? __objHasMethod( oB, "FixBugs" ) // hopefully this should be .F. * ? __objHasMethod( oB, "Left" ) // this should return .T. + * * $STATUS$ * R * $COMPLIANCE$ - * __objHasMethod() is a Harbour extension. + * __objHasMethod() is a Harbour extension. * $SEEALSO$ * __ObjGetMethodList(),__objGetMsgList(),__objHasData() * $END$ @@ -94,21 +96,21 @@ * $SYNTAX$ * __objGetMsgList( , [] ) --> aNames * $ARGUMENTS$ - * is an object to scan. + * 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 DATA names, .F. return list of all METHOD names. Default value - * is .T. + * is .T. * $RETURNS$ * __objGetMsgList() return an array of character stings with all DATA * 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. + * the requested information. * $DESCRIPTION$ * __objGetMsgList() is a low level class support function that let you * find all instance variable or class functions names for a given - * object. + * object. * $EXAMPLES$ * // show information about TBrowse class * oB := TBrowseNew( 0, 0, 24, 79 ) @@ -120,10 +122,11 @@ * FOR i = 1 to len ( aMethod ) * ? "METHOD name:", aMethod[ i ] * NEXT + * * $STATUS$ * R * $COMPLIANCE$ - * __objGetMsgList() is a Harbour extension. + * __objGetMsgList() is a Harbour extension. * $SEEALSO$ * __ObjGetMethodList(),__ObjGetValueList(),__objHasData(),__objHasMethod() * $END$ @@ -139,15 +142,15 @@ * $SYNTAX$ * __objGetMethodList( ) --> aMethodNames * $ARGUMENTS$ - * is an object to scan. + * 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. + * 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. ). + * 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 ) @@ -155,10 +158,11 @@ * FOR i = 1 to len ( aMethod ) * ? "METHOD name:", aMethod[ i ] * NEXT + * * $STATUS$ * R * $COMPLIANCE$ - * __objGetMethodList() is a Harbour extension. + * __objGetMethodList() is a Harbour extension. * $SEEALSO$ * __objGetMsgList(),__ObjGetValueList(),__objHasData(),__objHasMethod() * $END$ @@ -174,20 +178,20 @@ * $SYNTAX$ * __objGetValueList( , [] ) --> aData * $ARGUMENTS$ - * is an object to scan. + * is an object to scan. * * is an optional array with DATA names you want to exclude - * from the scan. + * from the scan. * $RETURNS$ * __objGetValueList() return a 2D array that contain pairs of a DATA * symbol name and the value of DATA. __objGetValueList() would return * an empty array {} if the given object does not contain the requested - * information. + * information. * $DESCRIPTION$ * __objGetValueList() is a low level class support function that * return an array with DATA 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 + * 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 ) @@ -196,12 +200,13 @@ * ? "DATA name:", aData[ i, HB_OO_DATA_SYMBOL ], ; * " value=", aData[ i, HB_OO_DATA_VALUE ] * NEXT + * * $STATUS$ * R * $COMPLIANCE$ - * __objGetValueList() is a Harbour extension. + * __objGetValueList() is a Harbour extension. * $FILES$ - * Header file is hboo.ch + * Header file is hboo.ch * $SEEALSO$ * __objGetMethodList(),__objGetMsgList(),__objHasData(),__objHasMethod(),__ObjSetValueList() * $END$ @@ -217,18 +222,18 @@ * $SYNTAX$ * __ObjSetValueList( , ) --> oObject * $ARGUMENTS$ - * is an object to set. + * is an object to set. * * is a 2D array with a pair of instance variables and values - * for setting those variable. + * for setting those variable. * $RETURNS$ - * __ObjSetValueList() return a reference to . + * __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. + * 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() @@ -246,12 +251,13 @@ * ? oB:nLeft // 10 * ? oB:nBottom // 20 * ? oB:nRight // 70 + * * $STATUS$ * R * $COMPLIANCE$ - * __ObjSetValueList() is a Harbour extension. + * __ObjSetValueList() is a Harbour extension. * $FILES$ - * Header file is hboo.ch + * Header file is hboo.ch * $SEEALSO$ * __ObjGetValueList() * $END$ @@ -267,20 +273,20 @@ * $SYNTAX$ * __objAddMethod( , , ) --> oObject * $ARGUMENTS$ - * is the object to work on. + * is the object to work on. * - * is the symbol name of the new METHOD to add. + * is the symbol name of the new METHOD to add. * - * is a pointer to a function to associate with the method. + * is a pointer to a function to associate with the method. * $RETURNS$ - * __objAddMethod() return a reference to . + * __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 . + * name already exist in . * * Note that is a special pointer to a function that was - * created using the @ operator, see example below. + * created using the @ operator, see example below. * $EXAMPLES$ * // create a new THappy class and add a Smile method * oHappy := TClass():New( "THappy" ) @@ -300,10 +306,11 @@ * cSmile := "*SMILE*" * ENDCASE * RETURN cSmile + * * $STATUS$ * R * $COMPLIANCE$ - * __objAddMethod() is a Harbour extension. + * __objAddMethod() is a Harbour extension. * $SEEALSO$ * __objAddInline(),__objAddData(),__objDelMethod(),__ObjGetMethodList(),__objGetMsgList(),__objHasMethod(),__objModMethod() * $END$ @@ -319,17 +326,17 @@ * $SYNTAX$ * __objAddInline( , , ) --> oObject * $ARGUMENTS$ - * is the object to work on. + * is the object to work on. * - * is the symbol name of the new INLINE to add. + * is the symbol name of the new INLINE to add. * - * is a code block to associate with the INLINE method. + * is a code block to associate with the INLINE method. * $RETURNS$ - * __objAddInline() return a reference to . + * __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 . + * with the name already exist in . * $EXAMPLES$ * // create a new THappy class and add a Smile INLINE method * oHappy := TClass():New( "THappy" ) @@ -338,10 +345,11 @@ * ? oHappy:Smile( 1 ) // :) * ? oHappy:Smile( 2 ) // ;) * ? oHappy:Smile( 3 ) // *SMILE* + * * $STATUS$ * R * $COMPLIANCE$ - * __objAddInline() is a Harbour extension. + * __objAddInline() is a Harbour extension. * $SEEALSO$ * __objAddData(),__objAddMethod(),__objDelInline(),__ObjGetMethodList(),__objGetMsgList(),__objHasMethod() ,__objModInline() * $END$ @@ -357,15 +365,15 @@ * $SYNTAX$ * __objAddData( , ) --> oObject * $ARGUMENTS$ - * is the object to work on. + * is the object to work on. * - * is the symbol name of the new DATA to add. + * is the symbol name of the new DATA to add. * $RETURNS$ - * __objAddData() return a reference to . + * __objAddData() return a reference to . * $DESCRIPTION$ * __objAddData() is a low level class support function that add a new * DATA to an object. is unchanged if a symbol with the name - * already exist in . + * already exist in . * $EXAMPLES$ * // create a new THappy class and add a lHappy DATA * oHappy := TClass():New( "THappy" ) @@ -376,10 +384,11 @@ * ELSE * ? ":(..." * ENDIF + * * $STATUS$ * R * $COMPLIANCE$ - * __objAddData() is a Harbour extension. + * __objAddData() is a Harbour extension. * $SEEALSO$ * __objAddInline(),__objAddMethod(),__objDelData(),__objGetMsgList(),__ObjGetValueList(),__objHasData(),__ObjSetValueList() * $END$ @@ -395,22 +404,22 @@ * $SYNTAX$ * __objModMethod( , , ) --> oObject * $ARGUMENTS$ - * is the object to work on. + * is the object to work on. * - * is the symbol name of the METHOD to modify. + * is the symbol name of the METHOD to modify. * * is a pointer to a new function to associate with the - * method. + * method. * $RETURNS$ - * __objModMethod() return a reference to . + * __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. + * 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. + * created using the @ operator, see example below. * $EXAMPLES$ * // create a new THappy class and add a Smile method * oHappy := TClass():New( "THappy" ) @@ -441,10 +450,11 @@ * cSmile := "*WINK*" * ENDCASE * RETURN cSmile + * * $STATUS$ * R * $COMPLIANCE$ - * __objModMethod() is a Harbour extension. + * __objModMethod() is a Harbour extension. * $SEEALSO$ * __objAddMethod(),__objDelMethod(),__ObjGetMethodList(),__objGetMsgList(),__objHasMethod() * $END$ @@ -460,19 +470,19 @@ * $SYNTAX$ * __objModInline( , , ) --> oObject * $ARGUMENTS$ - * is the object to work on. + * is the object to work on. * - * is the symbol name of the INLINE method to modify. + * is the symbol name of the INLINE method to modify. * - * is a new code block to associate with the INLINE method. + * is a new code block to associate with the INLINE method. * $RETURNS$ - * __objModInline() return a reference to . + * __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. + * mechanism. * $EXAMPLES$ * // create a new THappy class and add a Smile INLINE method * oHappy := TClass():New( "THappy" ) @@ -485,10 +495,11 @@ * __objModInline( oHappy, "Smile", bYourInline ) * ? oHappy:Smile( 1 ) // *SMILE* * ? oHappy:Smile( 2 ) // *WINK* + * * $STATUS$ * R * $COMPLIANCE$ - * __objModInline() is a Harbour extension. + * __objModInline() is a Harbour extension. * $SEEALSO$ * __objAddInline(),__objDelInline(),__ObjGetMethodList(),__objGetMsgList(),__objHasMethod() * $END$ @@ -504,19 +515,19 @@ * $SYNTAX$ * __objDelMethod( , ) --> oObject * $ARGUMENTS$ - * is the object to work on. + * is the object to work on. * * is the symbol name of METHOD or INLINE method to be - * deleted (removed) from the object. + * deleted (removed) from the object. * $RETURNS$ - * __objDelMethod() return a reference to . + * __objDelMethod() return a reference to . * $DESCRIPTION$ * __objDelMethod() 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 - * . + * . * - * __objDelInline() is exactly the same as __objDelMethod(). + * __objDelInline() is exactly the same as __objDelMethod(). * $EXAMPLES$ * // create a new THappy class and add a Smile method * oHappy := TClass():New( "THappy" ) @@ -535,10 +546,11 @@ * cSmile := ";)" * ENDCASE * RETURN cSmile + * * $STATUS$ * R * $COMPLIANCE$ - * __objDelMethod() is a Harbour extension. + * __objDelMethod() is a Harbour extension. * $SEEALSO$ * __objAddInline(),__objAddMethod(),__ObjGetMethodList(),__objGetMsgList(),__objHasMethod(),__objModInline(),__objModMethod() * $END$ @@ -554,17 +566,17 @@ * $SYNTAX$ * __objDelInline( , ) --> oObject * $ARGUMENTS$ - * is the object to work on. + * is the object to work on. * * is the symbol name of METHOD or INLINE method to be - * deleted (removed) from the object. + * deleted (removed) from the object. * $RETURNS$ - * __objDelInMethod() return a reference to . + * __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 := TClass():New( "THappy" ) @@ -583,10 +595,11 @@ * cSmile := ";)" * ENDCASE * RETURN cSmile + * * $STATUS$ * R * $COMPLIANCE$ - * __objDelMethod() is a Harbour extension. + * __objDelMethod() is a Harbour extension. * $SEEALSO$ * __objAddInline(),__objAddMethod(),__ObjGetMethodList(),__objGetMsgList(),__objHasMethod(),__objModInline(),__objModMethod() * $END$ @@ -602,16 +615,16 @@ * $SYNTAX$ * __objDelMethod( , ) --> oObject * $ARGUMENTS$ - * is the object to work on. + * is the object to work on. * * is the symbol name of DATA to be deleted (removed) from - * the object. + * the object. * $RETURNS$ - * __objDelData() return a reference to . + * __objDelData() return a reference to . * $DESCRIPTION$ * __objDelData() is a low level class support function that delete * (remove) a DATA from an object. is unchanged if a symbol - * with the name does not exist in . + * with the name does not exist in . * $EXAMPLES$ * // create a new THappy class and add a lHappy DATA * oHappy := TClass():New( "THappy" ) @@ -620,10 +633,11 @@ * // remove lHappy DATA * __objDelData( oHappy, "lHappy" ) * ? __objHasData( oHappy, "lHappy" ) // .F. + * * $STATUS$ * R * $COMPLIANCE$ - * __objDelData() is a Harbour extension. + * __objDelData() is a Harbour extension. * $SEEALSO$ * __objAddData(),__objGetMsgList(),__ObjGetValueList(),__objHasData(),__ObjSetValueList() * $END$ diff --git a/harbour/doc/en/set.txt b/harbour/doc/en/set.txt index 5d6ec7c025..a6046e1469 100644 --- a/harbour/doc/en/set.txt +++ b/harbour/doc/en/set.txt @@ -38,11 +38,11 @@ * $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) + * 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 + * Either the current or previous century setting as a logical value * $END$ */ @@ -56,19 +56,19 @@ * $SYNTAX$ * Set( [, [, ] ] ) --> xPreviousSetting * $ARGUMENTS$ - * Set Number - * Any expression to assing a value to the seting - * Logical expression + * Set Number + * Any expression to assing a value to the seting + * Logical expression * - * + * * - * _SET_ALTERNATE | + * _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 + * 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 @@ -76,23 +76,23 @@ * 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 | + * 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 | + * 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 + * precedence over SET CANCEL. + * _SET_COLOR * Sets the current color scheme, using color pairs in the * sequence ",,,, * ". Each color pair uses the format @@ -105,19 +105,19 @@ * 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 | + * "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 | + * 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 + * (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 + * 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"), @@ -125,12 +125,12 @@ * ("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 + * 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 + * 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 @@ -138,25 +138,25 @@ * 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 + * 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 | + * 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 | + * 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 + * 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_EPOCH + * all output is sent to the screen. Defaults to "SCREEN". + * _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 @@ -167,13 +167,13 @@ * 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 | + * 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 + * 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 @@ -184,8 +184,8 @@ * 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 | + * 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 @@ -194,22 +194,22 @@ * 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 | + * 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 | + * 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 Clipper! - * _SET_EXTRAFILE + * ReadExit() function. + * _SET_EXTRA | + * QUESTION: What is this for? + * It does not affect _SET_EXTRAFILE in Clipper! + * _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 @@ -217,58 +217,58 @@ * 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 | + * 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 | + * 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 | + * 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_MARGIN + * standard color setting. + * _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 | + * _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 + * 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 + * 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 | + * 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 + * 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 @@ -277,36 +277,36 @@ * 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 | + * 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 | + * 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 + * 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 | + * 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 | + * 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. + * is a hard stop at the first and last positions. * $RETURNS$ - * The current or previous setting + * The current or previous setting * $END$ */ @@ -321,28 +321,28 @@ * __SetFunction( , [] ) --> NIL * $ARGUMENTS$ * is a number in the range 1..40 that represent the - * function key to be assigned. + * 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. + * that any previous __SetFunction() or SETKEY() for that function. * $RETURNS$ - * __SetFunction() always return NIL. + * __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. + * 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 + * 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. + * during compile time. * $EXAMPLES$ * // Set F1 with a string * CLS @@ -351,13 +351,14 @@ * @ 10, 0 SAY "type something or F1 for lazy mode " GET cTest * READ * ? cTest - * $TESTS$ + * * $STATUS$ + * R * $COMPLIANCE$ * Harbour use 11 and 12 to represent F11 and F12, while CA-Clipper use - * 11 and 12 to represent Shift-F1 and Shift-F2. + * 11 and 12 to represent Shift-F1 and Shift-F2. * $PLATFORMS$ - * $FILES$ + * All * $SEEALSO$ * INKEY(),SETKEY(),__Keyboard(),SET KEY * $END$ @@ -374,27 +375,26 @@ * SET FUNCTION TO [] * $ARGUMENTS$ * is a number in the range 1..40 that represent the - * function key to be assigned. + * 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. - * $RETURNS$ + * 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. + * 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 + * 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. + * during compile time. * $EXAMPLES$ * // Set F1 with a string * CLS @@ -403,13 +403,14 @@ * @ 10, 0 SAY "type something or F1 for lazy mode " GET cTest * READ * ? cTest - * $TESTS$ + * * $STATUS$ + * R * $COMPLIANCE$ * Harbour use 11 and 12 to represent F11 and F12, while CA-Clipper use - * 11 and 12 to represent Shift-F1 and Shift-F2. + * 11 and 12 to represent Shift-F1 and Shift-F2. * $PLATFORMS$ - * $FILES$ + * All * $SEEALSO$ * INKEY(),SETKEY(),__Keyboard() * $END$ @@ -425,18 +426,18 @@ * $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 + * 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 + * 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. + * by using an array of key values in place on the first parameter. * $EXAMPLES$ * local bOldF10 := setKey( K_F10, {|| Yahoo() } ) * ... // some other processing @@ -449,15 +450,17 @@ * // 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-Clipper 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() + * returned once set - see SetKeyGet() * $SEEALSO$ * HB_SETKEYSAVE() * $END$ @@ -473,25 +476,27 @@ * $SYNTAX$ * HB_SETKEYGET( [, ] ) * $ARGUMENTS$ - * is an numeric key value - * is an optional return-parameter + * is an numeric key value + * is an optional return-parameter * $RETURNS$ - * Current assigned action-block + * Current assigned action-block * $DESCRIPTION$ * The HB_SetKeyGet() function returns the current code-block assigned to * a key, and optionally assignes the condition-block to the - * return-parameter + * 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$ - * HB_SETKEYGET() is a new function and hence not CA-Clipper compliant. + * HB_SETKEYGET() is a new function and hence not CA-Clipper compliant. * $SEEALSO$ * SETKEY(),HB_SETKEYSAVE(),HB_SETKEYCHECK() * $END$ @@ -508,26 +513,28 @@ * HB_SETKEYSAVE( [ ] ) * $ARGUMENTS$ * is an optional set-key list from a previous call to - * HB_SetKeySave(), or NIL to clear current set-key list + * HB_SetKeySave(), or NIL to clear current set-key list * $RETURNS$ - * Current set-key list + * 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. + * 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$ - * HB_SETKEYSAVE() is new. + * HB_SETKEYSAVE() is new. * $SEEALSO$ * SETKEY() * $END$ @@ -544,21 +551,21 @@ * 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 + * 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 - + * 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 + * 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 + * ACCEPT, INPUT, READ, and WAIT * $EXAMPLES$ * // within ReadModal() * if HB_SetKeyCheck( K_ALT_X, GetActive() ) @@ -569,12 +576,14 @@ * return * case nInKey == K_ESC * ... // some other processing + * * $TESTS$ * None definable + * * $STATUS$ * R * $COMPLIANCE$ - * HB_SETKEYCHECK() is new. + * HB_SETKEYCHECK() is new. * $SEEALSO$ * SETKEY(),HB_SETKEYSAVE() * $END$ @@ -590,11 +599,9 @@ * $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 - * $RETURNS$ - * + * 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 @@ -602,7 +609,7 @@ * 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. + * by using an array of key values in place on the first parameter. * $EXAMPLES$ * local bOldF10 := setKey( K_F10, {|| Yahoo() } ) * ... // some other processing @@ -615,15 +622,17 @@ * // 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-Clipper 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() + * returned once set - see SetKeyGet() * $SEEALSO$ * HB_SETKEYSAVE() * $END$ @@ -639,21 +648,20 @@ * $SYNTAX$ * SETTYPEAHEAD( ) --> * $ARGUMENTS$ - * is a valid typeahead size. + * is a valid typeahead size. * $RETURNS$ - * The previous state of _SET_TYPEAHEAD + * 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. + * Set( _SET_TYPEAHEAD ) where used. * $EXAMPLES$ * // Sets typeahead to 12 * SetTypeahead( 12 ) - * $TESTS$ - * + * * $STATUS$ * R * $COMPLIANCE$ - * SETTYPEAHEAD() is fully CA-Clipper compliant. + * SETTYPEAHEAD() is fully CA-Clipper compliant. * $SEEALSO$ * __ACCEPT(),__INPUT() * $END$ @@ -669,22 +677,18 @@ * $SYNTAX$ * __XHELP() --> * $ARGUMENTS$ - * None + * None * $RETURNS$ - * This function returns aleatory values. + * This function returns aleatory values. * $DESCRIPTION$ * This is an internal undocumented Clipper function, which will * try to call the user defined function HELP() if it's defined * in the current application. This is the default SetKey() handler - * for the F1 key. - * $EXAMPLES$ - * $TESTS$ - * $STATUS$ + * for the F1 key. + * $STATUS$ * R * $COMPLIANCE$ - * __XHELP() is fully CA-Clipper compliant. - * $SEEALSO$ - * + * __XHELP() is fully CA-Clipper compliant. * $END$ */ @@ -698,18 +702,19 @@ * $SYNTAX$ * SET DEFAULT TO [] * $ARGUMENTS$ - * Drive and/or path. + * Drive and/or path. * $DESCRIPTION$ * This command changes the drive and directory used for reading and * writting database,index,memory, and alternate files.Specifying no * parameters with this command will default the operation to the - * current logged drive and directory. + * current logged drive and directory. * $EXAMPLES$ * SET DEFAULT to c:\TEMP + * * $STATUS$ * R * $COMPLIANCE$ - * This command is Ca-Clipper Compliant. + * This command is Ca-Clipper Compliant. * $SEEALSO$ * SET PATH,CURDIR(),SET() * $END$ @@ -726,18 +731,19 @@ * SET WRAP ON/OFF * SET WRAP () * $ARGUMENTS$ - * Logical expression for toggle + * 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. + * the wrapping mode is set OFF;otherwise,it is set ON. * $EXAMPLES$ * See Tests/menutest.prg + * * $STATUS$ * R * $COMPLIANCE$ - * This command is Ca-Clipper Compliant. + * This command is Ca-Clipper Compliant. * $SEEALSO$ * @...PROMPT,MENU TO * $END$ @@ -751,30 +757,33 @@ * $ONELINER$ * Extablishes a message row for @...PROMPT command * $SYNTAX$ - * SET MESSAGE TO [ [CENTER]] + * SET MESSAGE TO [ [CENTER]] * $ARGUMENTS$ - * Row number to display the message + * Row number to display the message * $DESCRIPTION$ * This command is designed to work in conjuntion 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 apear. + * witch any message associated with an @...PROMPT command will apear. + * If the value of is 0,all messages will be supressed. * 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;therefor,the screen area is cleared out * by the centered message will vary based on the length of each - * individual message. + * 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. + * witch suppresses all messages output. + * The British spelling of CENTRE is also supported. * $EXAMPLES$ * See Tests/menutest.prg + * * $STATUS$ * R * $COMPLIANCE$ - * This command is Ca-Clipper Compliant. + * This command is Ca-Clipper Compliant. * $SEEALSO$ * SET(),SET WRAP,@...PROMPT,MENU TO * $END$ @@ -788,22 +797,23 @@ * $ONELINER$ * Specifies a search path for opening files * $SYNTAX$ - * SET WRAP TO [] + * SET WRAP TO [] * $ARGUMENTS$ - * Search path for files + * 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 hiracrchy is: 1 Current drive and directory,2 The SET DEFAULT - * path;3 The SET PATH path. + * search hirarchy 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$ - * This command is Ca-Clipper Compliant. + * This command is Ca-Clipper Compliant. * $SEEALSO$ * SET DEFAULT,CURDIR(),SET() * $END$ diff --git a/harbour/doc/en/string.txt b/harbour/doc/en/string.txt index 3494c4269e..a241dbc253 100644 --- a/harbour/doc/en/string.txt +++ b/harbour/doc/en/string.txt @@ -39,23 +39,23 @@ * $SYNTAX$ * ISALPHA() --> lAlpha * $ARGUMENTS$ - * Any character string + * Any character string * $RETURNS$ - * lAlpha Logical true (.T.) or false (.F.). + * 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.). + * return a logical false (.F.). * $EXAMPLES$ * QOUT( "isalpha( 'hello' ) = ", isalpha( 'hello' ) ) * QOUT( "isalpha( '12345' ) = ", isalpha( '12345' ) ) - * $TESTS$ + * * $STATUS$ * R * $COMPLIANCE$ - * This function is CA-Clipper compliant + * This function is CA-Clipper compliant * $PLATFORMS$ - * $FILES$ + * All * $SEEALSO$ * ISDIGIT(),ISLOWER(),ISUPPER(),LOWER(),UPPER() * $END$ @@ -71,24 +71,24 @@ * $SYNTAX$ * ISDIGIT() --> lDigit * $ARGUMENTS$ - * Any character string + * Any character string * $RETURNS$ - * lDigit Logical true (.T.) or false (.F.). + * lDigit Logical true (.T.) or false (.F.). * $DESCRIPTION$ * This function takes the caracter 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.). + * return a logical false (.F.). * $EXAMPLES$ * QOUT( "isdigit( '12345' ) = ", isdigit( '12345' ) ) * QOUT( "isdigit( 'abcde' ) = ", isdigit( 'abcde' ) ) - * $TESTS$ + * * $STATUS$ * R * $COMPLIANCE$ - * This function is CA-Clipper compliant + * This function is CA-Clipper compliant * $PLATFORMS$ - * $FILES$ + * All * $SEEALSO$ * ISALPHA(),ISLOWER(),ISUPPER(),LOWER(),UPPER() * $END$ @@ -104,24 +104,24 @@ * $SYNTAX$ * ISUPPER() --> lUpper * $ARGUMENTS$ - * Any character string + * Any character string * $RETURNS$ - * lUpper Logical true (.T.) or false (.F.). + * lUpper Logical true (.T.) or false (.F.). * $DESCRIPTION$ * This function takes the caracter string and checks to * see if the leftmost character is a uppercased letter.If so, the * function will return a logical true (.T.);otherwise, it will - * return a logical false (.F.). + * return a logical false (.F.). * $EXAMPLES$ * QOUT( "isupper( 'Abcde' ) = ", isupper( 'Abcde' ) ) * QOUT( "isupper( 'abcde' ) = ", isupper( 'abcde' ) ) - * $TESTS$ + * * $STATUS$ * R * $COMPLIANCE$ - * This function is CA-Clipper compliant + * This function is CA-Clipper compliant * $PLATFORMS$ - * $FILES$ + * All * $SEEALSO$ * ISALPHA(),ISLOWER(),ISDIGIT(),LOWER(),UPPER() * $END$ @@ -137,24 +137,24 @@ * $SYNTAX$ * ISLOWER() --> lLower * $ARGUMENTS$ - * Any character string + * Any character string * $RETURNS$ - * lLower Logical true (.T.) or false (.F.). + * lLower Logical true (.T.) or false (.F.). * $DESCRIPTION$ * This function takes the caracter 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.). + * return a logical false (.F.). * $EXAMPLES$ * QOUT( "islower( 'Abcde' ) = ", islower( 'Abcde' ) ) * QOUT( "islower( 'abcde' ) = ", islower( 'abcde' ) ) - * $TESTS$ + * * $STATUS$ * R * $COMPLIANCE$ - * This function is CA-Clipper compliant + * This function is CA-Clipper compliant * $PLATFORMS$ - * $FILES$ + * All * $SEEALSO$ * ISALPHA(),ISDIGIT(),ISUPPER(),LOWER(),UPPER() * $END$ @@ -170,23 +170,20 @@ * $SYNTAX$ * LTRIM() --> * $ARGUMENTS$ - * Character expression with leading spaces + * Character expression with leading spaces * $RETURNS$ - * The same character expression with leading spaces removed + * The same character expression with leading spaces removed * $DESCRIPTION$ - * This function trims the leading space blanl + * This function trims the leading space blank * $EXAMPLES$ * ? QOUT( LTRIM("HELLO ")) - * $TESTS$ - * + * * $STATUS$ * R * $COMPLIANCE$ - * This functions is CA-CLIPPER compatible + * This functions is CA-CLIPPER compatible * $PLATFORMS$ - * - * $FILES$ - * + * All * $SEEALSO$ * TRIM(),RTRIM(),ALLTRIM() * $END$ @@ -202,25 +199,25 @@ * $SYNTAX$ * AT(,) --> nPos * $ARGUMENTS$ - * Substring to search for - * Main string + * Substring to search for + * Main string * $RETURNS$ * AT() return the starting position of the first occurrence of the - * substring in the main string + * 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 second expression,the function will return 0. * $EXAMPLES$ * QOUT( "at( 'cde', 'abcdefgfedcba' ) = '" +; * at( 'cde', 'abcsefgfedcba' ) + "'" ) - * $TESTS$ + * * $STATUS$ * R * $COMPLIANCE$ - * This function is CA-Clipper compatible. + * This function is CA-Clipper compatible. * $PLATFORMS$ - * $FILES$ + * All * $SEEALSO$ * RAT() * $END$ @@ -234,28 +231,27 @@ * $ONELINER$ * Searches for a substring from the right side of a string. * $SYNTAX$ - * RAT(,) --> nPos + * RAT(,) --> nPos * $ARGUMENTS$ - * Substring to search for - * Main string + * Substring to search for + * Main string * $RETURNS$ - * RAT() return the location of beginnig position. + * RAT() return the location of beginnig position. * $DESCRIPTION$ * This function searches througt 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 - * occurence of in ,the value of the function will be 0. + * occurence of in ,the value of the function will be 0. * $EXAMPLES$ * QOUT( "rat( 'cde', 'abcdefgfedcba' ) = '" +; * rat( 'cde', 'abcsefgfedcba' ) + "'" ) - * $TESTS$ - * + * * $STATUS$ * R * $COMPLIANCE$ - * Will not work with a search string > 64 KB on some platforms + * Will not work with a search string > 64 KB on some platforms * $PLATFORMS$ - * $FILES$ + * All * $SEEALSO$ * AT(),SUBSTR(),RIGHT() * $END$ @@ -271,26 +267,23 @@ * $SYNTAX$ * LEFT(,) --> * $ARGUMENTS$ - * Main character to be parsed - * Number of bytes to return beggining at the leftmost position + * Main character to be parsed + * Number of bytes to return beggining at the leftmost position * $RETURNS$ - * Substring of evaluation + * Substring of evaluation * $DESCRIPTION$ - * This functions returns the leftmost characters of . + * This functions returns the leftmost characters of . * It is equivalent to the following programing expression: - * SUBSTR(,1, + * SUBSTR(,1, * $EXAMPLES$ * ? QOUT(LEFT('HELLO HARBOUR',5)) - * $TESTS$ - * + * * $STATUS$ * R * $COMPLIANCE$ - * This functions is CA CLIPPER compatible + * This functions is CA CLIPPER compatible * $PLATFORMS$ - * - * $FILES$ - * + * All * $SEEALSO$ * SUBSTR(),RIGHT(),AT(),RAT() * $END$ @@ -306,25 +299,21 @@ * $SYNTAX$ * SUBSTR(,) --> * $ARGUMENTS$ - * Character expression to be parsed - * Number of bytes to return beggining at the rightmost position + * Character expression to be parsed + * Number of bytes to return beggining at the rightmost position * $RETURNS$ - * Substring of evaluation + * Substring of evaluation * $DESCRIPTION$ - * This functions returns the rightmost characters of . - * + * This functions returns the rightmost characters of . * $EXAMPLES$ * ? QOUT(RIGHT('HELLO HARBOUR',5)) - * $TESTS$ - * + * * $STATUS$ * R * $COMPLIANCE$ - * This functions is CA CLIPPER compatible + * This functions is CA CLIPPER compatible * $PLATFORMS$ - * - * $FILES$ - * + * All * $SEEALSO$ * SUBSTR(),LEFT(),AT(),RAT() * $END$ @@ -340,19 +329,20 @@ * $SYNTAX$ * SUBSTR(,[,)] --> * $ARGUMENTS$ - * Character expression to be parsed - * Start position - * Number of characters to return + * Character expression to be parsed + * Start position + * Number of characters to return * $RETURNS$ - * Substring of evaluation + * Substring of evaluation * $DESCRIPTION$ * This functions returns a character string formed from , * starting at the position of and continuing on for a * lenght of characters. If is not specified, the value - * will be all remaining characters from the position of . + * 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 . + * for the number of characters specified in . * $EXAMPLES$ * FUNCTION MAIN() * LOCAL X:=REPLICATE('ABCD',70000) @@ -360,18 +350,18 @@ * ? QOUT(SUBSTR(X,65519,200) * * RETURN NIL + * * $TESTS$ * ? QOUT(SUBSTR('HELLO HARBOUR',5) + * * $STATUS$ * R * $COMPLIANCE$ * This functions is CA CLIPPER compatible with the execption that * CA CLIPPER will generate an error if the passed string is >65519 bytes - * and Harbour depends of plataform. + * and Harbour depends of plataform. * $PLATFORMS$ - * - * $FILES$ - * + * All * $SEEALSO$ * LEFT(),AT(),RIGHT() * $END$ @@ -388,57 +378,59 @@ * STR(, [], []) --> cNumber * $ARGUMENTS$ * is the numeric expression to be converted to a character - * string. + * 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. + * 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: + * 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 - * --------------------------------------------------------------- + * 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. + * 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. + * strings using a mask instead of length and decimal specifications. * * The inverse of STR() is VAL(), which converts character numbers to - * numerics. + * numerics. * * * If is less than the number of whole number digits in - * , STR() returns asterisks instead of the number. + * , 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. + * 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. + * 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$ - * CA-Clipper compatible. + * CA-Clipper compatible. * $SEEALSO$ * STRZERO(),VAL() * $END$ @@ -455,57 +447,59 @@ * STRZERO(, [], []) --> cNumber * $ARGUMENTS$ * is the numeric expression to be converted to a character - * string. + * 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. + * 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: + * 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 - * --------------------------------------------------------------- + * 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. + * 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. + * strings using a mask instead of length and decimal specifications. * * The inverse of STRZERO() is VAL(), which converts character numbers to - * numerics. + * numerics. * * * If is less than the number of whole number digits in - * , STR() returns asterisks instead of the number. + * , 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. + * 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. + * decimal places), the return value is rounded to an integer. * $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$ - * CA-Clipper compatible (it was not mentioned in the docs though). + * CA-Clipper compatible (it was not mentioned in the docs though). * $SEEALSO$ * STR(),VAL() * $END$ @@ -519,16 +513,17 @@ * $ONELINER$ * Converts any scalar type to a string. * $SYNTAX$ - * HB_VALTOSTR( ) + * HB_VALTOSTR( ) --> cString * $ARGUMENTS$ - * is any scalar argument. + * is any scalar argument. * $RETURNS$ - * A string representation of using default conversions. + * A string representation of using default conversions. * $DESCRIPTION$ - * HB_VALTOSTR can be used to convert any scalar value to a string. + * 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" @@ -537,10 +532,11 @@ * ? HB_VALTOSTR( NIL ) == "NIL" * ? HB_VALTOSTR( .F. ) == ".F." * ? HB_VALTOSTR( .T. ) == ".T." + * * $STATUS$ * R * $COMPLIANCE$ - * HB_VALTOSTR() is a Harbour enhancement. + * HB_VALTOSTR() is a Harbour enhancement. * $SEEALSO$ * STR(),VAL() * $END$ @@ -556,27 +552,29 @@ * $SYNTAX$ * LEN( | ) --> * $ARGUMENTS$ - * is a character string or the array to check. + * is a character string or the array to check. * $RETURNS$ * The length of the string or the number of elements that contains - * an array. + * an array. * $DESCRIPTION$ * This function returns the string length or the size of an array. If * it is used with a multidimensional array it returns the size of the - * first dimension. + * first dimension. * $EXAMPLES$ * ? Len( "Harbour" ) --> 7 * ? Len( { "One", "Two" } ) --> 2 + * * $TESTS$ * function Test() * LOCAL cName := "" * ACCEPT "Enter your name: " TO cName * ? Len( cName ) * return nil + * * $STATUS$ * R * $COMPLIANCE$ - * LEN() is fully CA-Clipper compliant. + * LEN() is fully CA-Clipper compliant. * $SEEALSO$ * EMPTY(),RTRIM(),LTRIM(),AADD(),ASIZE() * $END$ @@ -592,25 +590,27 @@ * $SYNTAX$ * EMPTY( ) --> * $ARGUMENTS$ - * is any valid expression. + * is any valid expression. * $RETURNS$ * A logical value. It is true (.T.) if the passed argument is empty - * otherwise it is false (.F.). + * 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. + * logical indicating whether it the expression is empty or not. * $EXAMPLES$ * ? Empty( "I'm not empty" ) + * * $TESTS$ * function Test() * ? Empty( 1 ) --> .f. * ? Empty( Date() ) --> .f. * ? Empty( .f. ) --> .t. * return nil + * * $STATUS$ * R * $COMPLIANCE$ - * EMPTY() is fully CA-Clipper compliant. + * EMPTY() is fully CA-Clipper compliant. * $SEEALSO$ * LEN() * $END$ @@ -626,22 +626,24 @@ * $SYNTAX$ * DESCEND( ) --> * $ARGUMENTS$ - * is any valid expression. + * is any valid expression. * $RETURNS$ - * Inverted value of the same type as passed. + * 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. + * 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$ - * DESCEND() is fully CA-Clipper compliant. + * DESCEND() is fully CA-Clipper compliant. * $SEEALSO$ * INDEX,SEEK * $END$ @@ -657,27 +659,24 @@ * $SYNTAX$ * HB_ANSITOOEM() -> cDosString * $ARGUMENTS$ - * Windows ansi string to convert to DOS oem String + * Windows ansi string to convert to DOS oem String * $RETURNS$ - * cDosString Dos based string + * Dos based string * $DESCRIPTION$ * This function converts each character in to the corresponding * character in the MS-DOS (OEM) character set.The character expression * should contain characters from the ANSI character set. * If a character in doesn't have a MS-DOS equivalent, the - * character is converted to a similar MS-DOS character. + * character is converted to a similar MS-DOS character. * $EXAMPLES$ * ? HB_OEMTOANSI("Harbour") - * $TESTS$ - * + * * $STATUS$ * R * $COMPLIANCE$ - * This function is a Harbour extension + * This function is a Harbour extension * $PLATFORMS$ - * This functions work only on Windows Plataform - * $FILES$ - * + * This functions work only on Windows Plataform * $SEEALSO$ * HB_OEMTOANSI() * $END$ @@ -693,26 +692,24 @@ * $SYNTAX$ * HB_OEMTOANSI() -> cDosString * $ARGUMENTS$ - * DOS (OEM) string to convert to WINDOWS (ANSI) String + * DOS (OEM) string to convert to WINDOWS (ANSI) String * $RETURNS$ - * cDosString WINDOWS based string + * WINDOWS based string * $DESCRIPTION$ * This function converts each character in to the corresponding * character in the Windows (ANSI) character set.The character expression * should contain characters from the OEM character set. * If a character in doesn't have a ANSI equivalent, the - * character is remais the same. + * character is remais the same. * $EXAMPLES$ * ? HB_OEMTOANSI("Harbour") - * $TESTS$ + * * $STATUS$ * R * $COMPLIANCE$ - * This function is a Harbour extension + * This function is a Harbour extension * $PLATFORMS$ - * This functions work only on Windows Plataform - * $FILES$ - * + * This functions work only on Windows Plataform * $SEEALSO$ * HB_ANSITOOEM() * $END$ @@ -729,22 +726,23 @@ * $SYNTAX$ * LOWER( ) --> cLowerString * $ARGUMENTS$ - * Any character expression. + * Any character expression. * $RETURNS$ - * Lowercased value of + * Lowercased value of * $DESCRIPTION$ * This function converts any character expression passes as * to its lowercased representation.Any nonalphabetic character withing - * will remain unchanged. + * will remain unchanged. * $EXAMPLES$ * ? Lower("HARBOUR") * ? Lower("Hello All") + * * $STATUS$ * R * $COMPLIANCE$ - * This function is CA-Clipper compatible + * This function is CA-Clipper compatible * $PLATFORMS$ - * ALL + * ALL * $SEEALSO$ * UPPER(),ISLOWER(),ISUPPER() * $END$ @@ -760,21 +758,22 @@ * $SYNTAX$ * UPPER( ) --> cUpperString * $ARGUMENTS$ - * Any character expression. + * Any character expression. * $RETURNS$ - * Uppercased value of + * Uppercased value of * $DESCRIPTION$ * This function converts all alpha characters in to upper - * case values and returns that formatted character expression. + * case values and returns that formatted character expression. * $EXAMPLES$ * ? UPPER("harbour") * ? UPPER("Harbour") + * * $STATUS$ * R * $COMPLIANCE$ - * This function is CA-Clipper compatible + * This function is CA-Clipper compatible * $PLATFORMS$ - * All + * All * $SEEALSO$ * LOWER(),ISUPPER(),ISLOWER() * $END$ diff --git a/harbour/doc/en/tclass.txt b/harbour/doc/en/tclass.txt index 86ecc596fc..0c4ab99fbb 100644 --- a/harbour/doc/en/tclass.txt +++ b/harbour/doc/en/tclass.txt @@ -21,22 +21,22 @@ * $ONELINER$ * TClass() is used in the creation of all classes * $SYNTAX$ - * oClass := TClass():New("TMyClass") - * -or- + * oClass := TClass():New("TMyClass") + * -or- * TClass() is usually accessed by defining a class with the commands - * defined in hbclass.h: - * CLASS TGetList // Calls TClass() to create the TGetList class - * ... - * ENDCLASS + * defined in hbclass.h: + * CLASS TGetList // Calls TClass() to create the TGetList class + * ... + * ENDCLASS * $ARGUMENTS$ - * + * * $RETURNS$ * An instance of the TClass Class. This special object's :New() - * method can then create the classes you define. + * method can then create the classes you define. * $DESCRIPTION$ - * TClass is a class that ... - * The class methods are as follows: - * New() Create a new instance of the class + * TClass is a class that ... + * The class methods are as follows: + * New() Create a new instance of the class * $EXAMPLES$ * FUNCTION TestObject() * local oObject @@ -45,6 +45,7 @@ * oObject:End() * * RETURN Nil + * * $STATUS$ * R * $COMPLIANCE$ @@ -54,9 +55,9 @@ * 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. + * style. * $PLATFORMS$ - * All + * All * $SEEALSO$ * __objHasData(),Object Oriented Programming,CLASS * $END$ diff --git a/harbour/doc/en/terminal.txt b/harbour/doc/en/terminal.txt index f98da0bd8e..0daa288cc3 100644 --- a/harbour/doc/en/terminal.txt +++ b/harbour/doc/en/terminal.txt @@ -288,7 +288,7 @@ * * is a Harbour extension. * $SEEALSO$ - * @...PROMPT,MENU TO, STDOUT(),__NONOALERT() + * @...PROMPT,MENU TO,STDOUT(),__NONOALERT() * $END$ */ @@ -387,6 +387,7 @@ * * $TESTS$ * see the regression test suit for comprehensive tests. + * * $STATUS$ * R * $COMPLIANCE$ diff --git a/harbour/doc/en/var.txt b/harbour/doc/en/var.txt index 38a5c4953b..260cf39d0e 100644 --- a/harbour/doc/en/var.txt +++ b/harbour/doc/en/var.txt @@ -21,33 +21,34 @@ /* $DOC$ * $FUNCNAME$ - * __MVPUBLIC() + * __MVPUBLIC() * $CATEGORY$ - * Variable Management + * Variable Management * $ONELINER$ - * This function creates a PUBLIC variable + * This function creates a PUBLIC variable * $SYNTAX$ - * __MVPUBLIC( ) + * __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. + * = 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 + * 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. + * 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. + * 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. - * + * initialized with .T. value. * $EXAMPLES$ - * $TESTS$ + * None Avaliable + * * $STATUS$ * R * $COMPLIANCE$ + * This function is a Harbour extension * $SEEALSO$ * * $END$ @@ -55,96 +56,90 @@ /* $DOC$ * $FUNCNAME$ - * __MVPRIVATE() + * __MVPRIVATE() * $CATEGORY$ - * Variable Management + * Variable Management * $ONELINER$ - * This function creates a PRIVATE variable + * This function creates a PRIVATE variable * $SYNTAX$ - * __MVPRIVATE( ) + * __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. + * = 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 + * 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. - * + * 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$ - * - * $TESTS$ - * + * None Avaliable + * * $STATUS$ * R * $COMPLIANCE$ - * - * $SEEALSO$ - * + * This function is a Harbour extension * $END$ */ /* $DOC$ * $FUNCNAME$ - * __MVXRELEASE() + * __MVXRELEASE() * $CATEGORY$ - * Variable Management + * Variable Management * $ONELINER$ - * This function releases value stored in PRIVATE or PUBLIC variable + * This function releases value stored in PRIVATE or PUBLIC variable * $SYNTAX$ - * __MVXRELEASE( ) + * __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. + * = 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 + * Nothing * $DESCRIPTION$ - * This function releases values stored in memory variable. It shouldn't - * be called directly, rather it should be placed into RELEASE command. + * 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. + * 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 + * It releases variable even if this variable was created in different + * procedure * $EXAMPLES$ * - * PROCEDURE MAIN() - * PRIVATE mPrivate + * PROCEDURE MAIN() + * PRIVATE mPrivate * - * mPrivate :="PRIVATE from MAIN()" - * ? mPrivate //PRIVATE from MAIN() - * Test() - * ? mPrivate //PRIVATE from MAIN() + * mPrivate :="PRIVATE from MAIN()" + * ? mPrivate //PRIVATE from MAIN() + * Test() + * ? mPrivate //PRIVATE from MAIN() * - * RETURN + * RETURN * - * PROCEDURE Test() - * PRIVATE mPrivate + * PROCEDURE Test() + * PRIVATE mPrivate * - * mPrivate :="PRIVATE from Test()" - * ? mPrivate //PRIVATE from TEST() - * RELEASE mPrivate - * ? mPrivate //NIL - * mPrivate :="Again in Test()" - * - * RETURN - * - * $TESTS$ + * mPrivate :="PRIVATE from Test()" + * ? mPrivate //PRIVATE from TEST() + * RELEASE mPrivate + * ? mPrivate //NIL + * mPrivate :="Again in Test()" * + * RETURN + * * $STATUS$ * R * $COMPLIANCE$ - * + * This function is a Harbour extension * $SEEALSO$ * * $END$ @@ -152,39 +147,38 @@ /* $DOC$ * $FUNCNAME$ - * __MVRELEASE() + * __MVRELEASE() * $CATEGORY$ - * Variable Management + * Variable Management * $ONELINER$ - * This function releases PRIVATE variables + * This function releases PRIVATE variables * $SYNTAX$ - * __MVRELEASE( , ) + * __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.) + * = 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. + * 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. + * 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$ - * - * $TESTS$ - * + * None Avaliable + * * $STATUS$ * R * $COMPLIANCE$ - * + * This function is a Harbour extension * $SEEALSO$ * * $END$ @@ -192,270 +186,266 @@ /* $DOC$ * $FUNCNAME$ - * __MVSCOPE() + * __MVSCOPE() * $CATEGORY$ - * Variable Management + * Variable Management * $ONELINER$ - * If variable exists then returns its scope. + * If variable exists then returns its scope. * $SYNTAX$ - * __MVSCOPE( ) + * __MVSCOPE( ) * $ARGUMENTS$ - * = a string with a variable name to check + * = 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 + * 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 * $DESCRIPTION$ * * $EXAMPLES$ * - * PROCEDURE MAIN() - * PUBLIC mPublic - * PRIVATE mPrivateGlobal + * PROCEDURE MAIN() + * PUBLIC mPublic + * PRIVATE mPrivateGlobal * * CallProc() - * ? __mvScope( "mPrivateLocal" ) //HB_MV_UNKNOWN + * ? __mvScope( "mPrivateLocal" ) //HB_MV_UNKNOWN * - * RETURN + * RETURN * - * PROCEDURE CallProc() - * PRIVATE mPrivateLocal + * 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 + * ? __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 + * IF( __mvScope( "mPublic" ) > HB_MV_ERROR ) + * ? "Variable exists" + * ELSE + * ? "Variable not created yet" + * ENDIF * - * RETURN - * - * $TESTS$ + * RETURN * + * * $STATUS$ * R * $COMPLIANCE$ - * + * This function is a Harbour Extension * $SEEALSO$ - * include/hbmemvar.ch + * include/hbmemvar.ch * $END$ */ /* $DOC$ * $FUNCNAME$ - * __MVCLEAR() + * __MVCLEAR() * $CATEGORY$ - * Variable Management + * Variable Management * $ONELINER$ - * This function releases all PRIVATE and PUBLIC variables + * This function releases all PRIVATE and PUBLIC variables * $SYNTAX$ - * __MVCLEAR() + * __MVCLEAR() * $ARGUMENTS$ - * + * None * $RETURNS$ - * Nothing + * 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. + * 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$ - * - * $SEEALSO$ - * + * This function is a Harbour extension * $END$ */ /* $DOC$ * $FUNCNAME$ - * __MVDBGINFO() + * __MVDBGINFO() * $CATEGORY$ - * Variable Management + * Variable Management * $ONELINER$ - * This function returns the information about the variables for debugger + * This function returns the information about the variables for debugger * $SYNTAX$ - * __MVDBGINFO( [, [, @] ] ) + * __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 + * = 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 + * The return value depends on the number of arguments passed * $DESCRIPTION$ - * This function retrieves the information about memvar variables. + * 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). + * 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. + * 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 "?" + * 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. + * 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. + * 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 + * #include * - * 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 + * 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 + * PROCEDURE MAIN() * - * #include - * PROCEDURE MAIN() + * ? 'PUBLIC=', __mvDBGINFO( HB_MV_PUBLIC ) + * ? 'PRIVATE=', __mvDBGINFO( HB_MV_PRIVATE ) * - * ? 'PUBLIC=', __mvDBGINFO( HB_MV_PUBLIC ) - * ? 'PRIVATE=', __mvDBGINFO( HB_MV_PRIVATE ) + * PUBLIC cPublic:='cPublic in MAIN' * - * PUBLIC cPublic:='cPublic in MAIN' + * ? 'PUBLIC=', __mvDBGINFO( HB_MV_PUBLIC ) + * ? 'PRIVATE=', __mvDBGINFO( HB_MV_PRIVATE ) * - * ? 'PUBLIC=', __mvDBGINFO( HB_MV_PUBLIC ) - * ? 'PRIVATE=', __mvDBGINFO( HB_MV_PRIVATE ) + * PRIVATE cPrivate:='cPrivate in MAIN' * - * PRIVATE cPrivate:='cPrivate in MAIN' + * ? 'PUBLIC=', __mvDBGINFO( HB_MV_PUBLIC ) + * ? 'PRIVATE=', __mvDBGINFO( HB_MV_PRIVATE ) * - * ? 'PUBLIC=', __mvDBGINFO( HB_MV_PUBLIC ) - * ? 'PRIVATE=', __mvDBGINFO( HB_MV_PRIVATE ) + * CountMemvars() * - * CountMemvars() - * - * ? 'Back in Main' - * ? 'PUBLIC=', __mvDBGINFO( HB_MV_PUBLIC ) - * ? 'PRIVATE=', __mvDBGINFO( HB_MV_PRIVATE ) + * ? 'Back in Main' + * ? 'PUBLIC=', __mvDBGINFO( HB_MV_PUBLIC ) + * ? 'PRIVATE=', __mvDBGINFO( HB_MV_PRIVATE ) * * - * RETURN + * RETURN * - * PROCEDURE CountMemvars() - * LOCAL i, nCnt, xVal, cName - * PUBLIC ccPublic:='ccPublic' - * PRIVATE ccPrivate:='ccPrivate' + * 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 ) + * ? 'In CountMemvars' + * ? 'PUBLIC=', __mvDBGINFO( HB_MV_PUBLIC ) + * ? 'PRIVATE=', __mvDBGINFO( HB_MV_PRIVATE ) * - * PRIVATE cPublic:='cPublic' + * PRIVATE cPublic:='cPublic' * - * ? 'PUBLIC=', __mvDBGINFO( HB_MV_PUBLIC ) - * ? 'PRIVATE=', __mvDBGINFO( HB_MV_PRIVATE ) + * ? 'PUBLIC=', __mvDBGINFO( HB_MV_PUBLIC ) + * ? 'PRIVATE=', __mvDBGINFO( HB_MV_PRIVATE ) * - * nCnt =__mvDBGINFO( HB_MV_PRIVATE ) +1 - * FOR i:=1 TO nCnt + * nCnt =__mvDBGINFO( HB_MV_PRIVATE ) +1 + * FOR i:=1 TO nCnt * xVal =__mvDBGINFO( HB_MV_PRIVATE, i, @cName ) * ? i, '=', cName, xVal - * NEXT + * NEXT * - * nCnt =__mvDBGINFO( HB_MV_PUBLIC ) +1 - * FOR i:=1 TO nCnt + * nCnt =__mvDBGINFO( HB_MV_PUBLIC ) +1 + * FOR i:=1 TO nCnt * xVal =__mvDBGINFO( HB_MV_PUBLIC, i, @cName ) * ? i, '=', cName, xVal - * NEXT - * - * RETURN + * NEXT * + * RETURN + * * $STATUS$ * R * $COMPLIANCE$ - * This function should be called from the debugger only. - * $SEEALSO$ - * + * This function should be called from the debugger only. * $END$ */ /* $DOC$ * $FUNCNAME$ - * __MVGET() + * __MVGET() * $CATEGORY$ - * Variable Management + * Variable Management * $ONELINER$ - * This function returns value of memory variable + * This function returns value of memory variable * $SYNTAX$ - * __MVGET( ) + * __MVGET( ) --> * $ARGUMENTS$ - * - string that specifies the name of variable + * - string that specifies the name of variable * $RETURNS$ - * The value of variable + * 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. + * 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 ) ) } + * FUNCTION MEMVARBLOCK( cMemvar ) + * RETURN {|x| IIF( PCOUNT()==0, __MVGET( cMemvar ),; + * __MVPUT( cMemvar, x ) ) } + * * $STATUS$ * R * $COMPLIANCE$ - * + * This function is a Harbour extension * $SEEALSO$ - * __MVPUT() + * __MVPUT() * $END$ */ /* $DOC$ * $FUNCNAME$ - * __MVPUT() + * __MVPUT() * $CATEGORY$ - * Variable Management + * Variable Management * $ONELINER$ - * This function set the value of memory variable + * This function set the value of memory variable * $SYNTAX$ - * __MVGET( [, ] ) + * __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 + * - 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. + * 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 + * 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 ) ) } + * FUNCTION MEMVARBLOCK( cMemvar ) + * RETURN {|x| IIF( PCOUNT()==0, __MVGET( cMemvar ),; + * __MVPUT( cMemvar, x ) ) } + * * $STATUS$ * R * $COMPLIANCE$ - * + * This function is a Harbour extension * $SEEALSO$ * __MVPUT() * $END$ @@ -469,11 +459,11 @@ * $ONELINER$ * Returns a codeblock that sets/gets a value of memvar variable * $SYNTAX$ - * MEMVARBLOCK( ) + * MEMVARBLOCK( ) --> * $ARGUMENTS$ - * - a string that contains the name of variable + * - a string that contains the name of variable * $RETURNS$ - * a codeblock that sets/get the value of variable + * 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 @@ -481,7 +471,7 @@ * 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. + * as a value of the codeblock evaluation. * $EXAMPLES$ * PROCEDURE MAIN() * LOCAL cbSetGet @@ -492,10 +482,11 @@ * ? "Value of xPublic variable", EVAL( cbSetGet ) * * RETURN - * $TESTS$ + * * $STATUS$ * R * $COMPLIANCE$ + * This function is Ca-Clipper compatible * $SEEALSO$ * __MVGET(),__MVPUT() * $END$ @@ -511,23 +502,23 @@ * $SYNTAX$ * FIELDBLOCK( ) --> bFieldBlock * $ARGUMENTS$ - * is a string that contain the field name. + * is a string that contain the field name. * $RETURNS$ * FIELDBLOCK() return a code block that when evaluate could retrieve * field value or assigning a new value to the field. If * is not specified or from type other than character, FIELDBLOCK() - * return NIL. - * $DESCRIPTION$ + * 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. + * 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. + * a specific work area code block use FIELDWBLOCK() instead. * $EXAMPLES$ * // open a file named Test that have a field named "name" * LOCAL bField @@ -536,14 +527,14 @@ * ? 'Original value of field "name" :', EVAL( bField ) * EVAL( bField, "Mr X new name" ) * ? 'New value for the field "name" :', EVAL( bField ) - * $TESTS$ + * * $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. + * in the current work area, the code block return NIL. * - * CA-Clipper would raise BASE/1003 error if the field does not exist. + * CA-Clipper would raise BASE/1003 error if the field does not exist. * $SEEALSO$ * EVAL(),FIELDWBLOCK(),MEMVARBLOCK() * $END$ @@ -559,15 +550,15 @@ * $SYNTAX$ * FIELDWBLOCK( , ) --> bFieldBlock * $ARGUMENTS$ - * is a string that contain the field name. + * is a string that contain the field name. * - * is the work area number in which exist. + * 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. + * 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 @@ -576,7 +567,7 @@ * 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. + * block return NIL. * $EXAMPLES$ * LOCAL bField * // this block work on the field "name" that exist on work area 2 @@ -594,14 +585,14 @@ * ? "Name value for file Two :", EVAL( bField ) * EVAL( bField, "Two has new name" ) * ? "and now: ", One->name, Two->name - * $TESTS$ + * * $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. + * in the given work area, the code block return NIL. * - * CA-Clipper would raise BASE/1003 error if the field does not exist. + * CA-Clipper would raise BASE/1003 error if the field does not exist. * $SEEALSO$ * EVAL(),FIELDBLOCK(),MEMVARBLOCK() * $END$ @@ -617,21 +608,21 @@ * $SYNTAX$ * TYPE( ) --> * $ARGUMENTS$ - * must be a character expression. + * must be a character expression. * $RETURNS$ - * Returns a string indicating the type of the passed expression. + * a string indicating the type of the passed expression. * - * "A" - array - * "B" - block - * "C" - string - * "D" - date - * "L" - logical - * "M" - memo - * "N" - numeric - * "O" - object - * "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 + * "A" - array + * "B" - block + * "C" - string + * "D" - date + * "L" - logical + * "M" - memo + * "N" - numeric + * "O" - object + * "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. @@ -640,33 +631,18 @@ * is returned (in other words there is no call for passed UDF function * during a data type determination - this is Clipper compatible * behavior). Additionally if requested user defined function is not - * linked into executable then "U" is returned. + * 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. + * 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. - * - * Notes: - * - Incompatibility with Clipper: - * In the following code: - * - * PRIVATE lCond := 0 - * ? TYPE( "IIF( lCond, 'true', MyUDF() )" ) - * - * Clipper 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. - * + * expression is returned. * $EXAMPLES$ * ? TYPE( "{ 1, 2 }" ) //prints "A" * ? TYPE( "IIF(.T., SUBSTR('TYPE',2,1), .F.)" ) //prints "C" @@ -688,11 +664,23 @@ * SET FILTER TO &cFilter * ENDIF * - * $TESTS$ + * * $STATUS$ * R * $COMPLIANCE$ * + * - Incompatibility with Clipper: + * In the following code: + * + * PRIVATE lCond := 0 + * ? TYPE( "IIF( lCond, 'true', MyUDF() )" ) + * + * Clipper 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. * $SEEALSO$ * VALTYPE() * $END$ @@ -708,14 +696,15 @@ * $SYNTAX$ * VALTYPE( ) --> * $ARGUMENTS$ - * is any valid expression. + * is any valid expression. * $RETURNS$ - * Returns a character indicating the type of the passed expression. + * a character indicating the type of the passed expression. * $DESCRIPTION$ * This function returns one character which represents the date type - * of the argument. + * of the argument. * $EXAMPLES$ * See Test + * * $TESTS$ * function Test() * ? ValType( Array( 1 ) ) --> "A" @@ -727,10 +716,11 @@ * ? ValType( TBrowse() ) --> "O" * ? ValType( NIL ) --> "U" * return nil + * * $STATUS$ * R * $COMPLIANCE$ - * VALTYPE() is fully CA-Clipper compliant. + * VALTYPE() is fully CA-Clipper compliant. * $SEEALSO$ * TYPE() * $END$ diff --git a/harbour/doc/subcodes.txt b/harbour/doc/subcodes.txt index 60ee8ab075..6a0604601d 100644 --- a/harbour/doc/subcodes.txt +++ b/harbour/doc/subcodes.txt @@ -1,7 +1,7 @@ /* * $Id$ */ - +/* Proposition: * If the error is raised in the same condition as in Clipper then the same @@ -11,7 +11,7 @@ subcode number should be used. start from 3000 * Errors generated in tools functions should start from 4000 - +*/ /* ************************************************************************** */ /* $DOC$ @@ -22,10 +22,10 @@ start from 3000 * $ONELINER$ * Attempt to acces nonexisting or hidden variable * $DESCRIPTION$ - * The specified variable was not found. - * If it is a database field make sure that the required database is open. + * The specified variable was not found. + * If it is a database field make sure that the required database is open. * If it is a private or public variable then you must first create it - * using PRIVATE or PUBLIC statement + * using PRIVATE or PUBLIC statement. * $FUNCTION$ * * $STATUS$ @@ -43,7 +43,7 @@ start from 3000 * $ONELINER$ * Invalid type of argument * $DESCRIPTION$ - * The used data is not of logical type + * The used data is not of logical type * $FUNCTION$ * * $STATUS$ @@ -61,7 +61,7 @@ start from 3000 * $ONELINER$ * Bound error in array access * $DESCRIPTION$ - * The attempt to retrieve data from non-array value + * The attempt to retrieve data from non-array value * $FUNCTION$ * * $STATUS$ @@ -79,7 +79,7 @@ start from 3000 * $ONELINER$ * Bound error in array access * $DESCRIPTION$ - * The attempt to set data to non-array value + * The attempt to set data to non-array value * $FUNCTION$ * * $STATUS$ @@ -97,9 +97,9 @@ start from 3000 * $ONELINER$ * Invalid type of arguments * $DESCRIPTION$ - * The type of compared arguments do not match + * The type of compared arguments do not match * $FUNCTION$ - * == + * == * $STATUS$ * Clipper * $SEEALSO$ @@ -115,9 +115,9 @@ start from 3000 * $ONELINER$ * Invalid type of arguments * $DESCRIPTION$ - * The type of compared arguments do not match + * The type of compared arguments do not match * $FUNCTION$ - * <> + * <> * $STATUS$ * Clipper * $SEEALSO$ @@ -133,9 +133,9 @@ start from 3000 * $ONELINER$ * Invalid type of arguments * $DESCRIPTION$ - * The type of compared arguments do not match + * The type of compared arguments do not match * $FUNCTION$ - * < + * < * $STATUS$ * Clipper * $SEEALSO$ @@ -151,9 +151,9 @@ start from 3000 * $ONELINER$ * Invalid type of arguments * $DESCRIPTION$ - * The type of compared arguments do not match + * The type of compared arguments do not match * $FUNCTION$ - * <= + * <= * $STATUS$ * Clipper * $SEEALSO$ @@ -169,9 +169,9 @@ start from 3000 * $ONELINER$ * Invalid type of arguments * $DESCRIPTION$ - * The type of compared arguments do not match + * The type of compared arguments do not match * $FUNCTION$ - * > + * > * $STATUS$ * Clipper * $SEEALSO$ @@ -187,9 +187,9 @@ start from 3000 * $ONELINER$ * Invalid type of arguments * $DESCRIPTION$ - * The type of compared arguments do not match + * The type of compared arguments do not match * $FUNCTION$ - * >= + * >= * $STATUS$ * Clipper * $SEEALSO$ @@ -206,9 +206,9 @@ start from 3000 * Invalid type of arguments * $DESCRIPTION$ * Operation is not allowed for passed argument. The argument is not - * a logical value. + * a logical value. * $FUNCTION$ - * ! + * ! * $STATUS$ * Clipper * $SEEALSO$ @@ -224,9 +224,9 @@ start from 3000 * $ONELINER$ * Invalid type of arguments * $DESCRIPTION$ - * The type of one or both arguments is not a logical + * The type of one or both arguments is not a logical * $FUNCTION$ - * .AND. + * .AND. * $STATUS$ * Clipper * $SEEALSO$ @@ -242,9 +242,9 @@ start from 3000 * $ONELINER$ * Invalid type of arguments * $DESCRIPTION$ - * The type of one or both arguments is not a logical + * The type of one or both arguments is not a logical * $FUNCTION$ - * .OR. + * .OR. * $STATUS$ * Clipper * $SEEALSO$ @@ -260,9 +260,9 @@ start from 3000 * $ONELINER$ * Invalid type of arguments * $DESCRIPTION$ - * The value of argument cannot be incremented + * The value of argument cannot be incremented * $FUNCTION$ - * ++ + * ++ * $STATUS$ * Clipper * $SEEALSO$ @@ -278,9 +278,9 @@ start from 3000 * $ONELINER$ * Invalid type of arguments * $DESCRIPTION$ - * The plus operation is not allowed for used arguments. + * The plus operation is not allowed for used arguments. * $FUNCTION$ - * + + * + * $STATUS$ * Clipper * $SEEALSO$ @@ -296,9 +296,9 @@ start from 3000 * $ONELINER$ * Invalid type of arguments * $DESCRIPTION$ - * The minus operation is not allowed for used arguments. + * The minus operation is not allowed for used arguments. * $FUNCTION$ - * - + * - * $STATUS$ * Clipper * $SEEALSO$ @@ -314,9 +314,9 @@ start from 3000 * $ONELINER$ * Incorrect type of argument * $DESCRIPTION$ - * The specified argument is not a string. + * The specified argument is not a string. * $FUNCTION$ - * RTRIM, TRIM + * RTRIM, TRIM * $STATUS$ * Clipper * $SEEALSO$ @@ -332,9 +332,9 @@ start from 3000 * $ONELINER$ * Incorrect type of argument * $DESCRIPTION$ - * The specified argument is not a string. + * The specified argument is not a string. * $FUNCTION$ - * LTRIM + * LTRIM * $STATUS$ * Clipper * $SEEALSO$ @@ -350,9 +350,9 @@ start from 3000 * $ONELINER$ * Invalid argument passed to function * $DESCRIPTION$ - * The first argument passed to a function is not a string. + * The first argument passed to a function is not a string. * $FUNCTION$ - * UPPER + * UPPER * $STATUS$ * Clipper * $SEEALSO$ @@ -368,9 +368,9 @@ start from 3000 * $ONELINER$ * Invalid argument passed to function * $DESCRIPTION$ - * The first argument passed to a function is not a string. + * The first argument passed to a function is not a string. * $FUNCTION$ - * LOWER + * LOWER * $STATUS$ * Clipper * $SEEALSO$ @@ -386,9 +386,9 @@ start from 3000 * $ONELINER$ * Incorrect type of argument * $DESCRIPTION$ - * The specified argument is not a numeric value. + * The specified argument is not a numeric value. * $FUNCTION$ - * CHR + * CHR * $STATUS$ * Clipper * $SEEALSO$ @@ -404,9 +404,9 @@ start from 3000 * $ONELINER$ * Invalid argument passed to function * $DESCRIPTION$ - * The arguments passed to a function are of incorrect type. + * The arguments passed to a function are of incorrect type. * $FUNCTION$ - * SPACE + * SPACE * $STATUS$ * Clipper * $SEEALSO$ @@ -422,9 +422,9 @@ start from 3000 * $ONELINER$ * Invalid argument passed to function * $DESCRIPTION$ - * The arguments passed to a function are of incorrect type. + * The arguments passed to a function are of incorrect type. * $FUNCTION$ - * REPLICATE + * REPLICATE * $STATUS$ * Clipper * $SEEALSO$ @@ -440,9 +440,9 @@ start from 3000 * $ONELINER$ * Incorrect type of argument * $DESCRIPTION$ - * The specified argument is not a string. + * The specified argument is not a string. * $FUNCTION$ - * ASC + * ASC * $STATUS$ * Clipper * $SEEALSO$ @@ -458,9 +458,9 @@ start from 3000 * $ONELINER$ * Incorrect type of argument * $DESCRIPTION$ - * The specified argument is not a string. + * The specified argument is not a string. * $FUNCTION$ - * AT + * AT * $STATUS$ * Clipper * $SEEALSO$ @@ -476,9 +476,9 @@ start from 3000 * $ONELINER$ * Invalid type of arguments * $DESCRIPTION$ - * The arguments of '$' operator are not a strings. + * The arguments of '$' operator are not a strings. * $FUNCTION$ - * $ + * $ * $STATUS$ * Clipper * $SEEALSO$ @@ -494,9 +494,9 @@ start from 3000 * $ONELINER$ * Invalid argument passed to function * $DESCRIPTION$ - * The first argument passed to a function is not a string. + * The first argument passed to a function is not a string. * $FUNCTION$ - * SUBSTR + * SUBSTR * $STATUS$ * Clipper * $SEEALSO$ @@ -512,9 +512,9 @@ start from 3000 * $ONELINER$ * Invalid argument passed to function * $DESCRIPTION$ - * The passed argument is neither a string nor an array. + * The passed argument is neither a string nor an array. * $FUNCTION$ - * LEN + * LEN * $STATUS$ * Clipper * $SEEALSO$ @@ -531,9 +531,9 @@ start from 3000 * Invalid argument passed to function * $DESCRIPTION$ * The argument (or arguments) passed to a function are of incorrect - * type + * type * $FUNCTION$ - * YEAR + * YEAR * $STATUS$ * Clipper * $SEEALSO$ @@ -550,9 +550,9 @@ start from 3000 * Invalid argument passed to function * $DESCRIPTION$ * The argument (or arguments) passed to a function are of incorrect - * type + * type * $FUNCTION$ - * MONTH + * MONTH * $STATUS$ * Clipper * $SEEALSO$ @@ -569,9 +569,9 @@ start from 3000 * Invalid argument passed to function * $DESCRIPTION$ * The argument (or arguments) passed to a function are of incorrect - * type + * type * $FUNCTION$ - * DAY + * DAY * $STATUS$ * Clipper * $SEEALSO$ @@ -588,9 +588,9 @@ start from 3000 * Invalid argument passed to function * $DESCRIPTION$ * The argument (or arguments) passed to a function are of incorrect - * type + * type * $FUNCTION$ - * DOW + * DOW * $STATUS$ * Clipper * $SEEALSO$ @@ -607,9 +607,9 @@ start from 3000 * Invalid argument passed to function * $DESCRIPTION$ * The argument (or arguments) passed to a function are of incorrect - * type + * type * $FUNCTION$ - * CMONTH + * CMONTH * $STATUS$ * Clipper * $SEEALSO$ @@ -626,9 +626,9 @@ start from 3000 * Invalid argument passed to function * $DESCRIPTION$ * The argument (or arguments) passed to a function is of incorrect - * type + * type * $FUNCTION$ - * CDOW + * CDOW * $STATUS$ * Clipper * $SEEALSO$ @@ -645,9 +645,9 @@ start from 3000 * Invalid argument passed to function * $DESCRIPTION$ * The argument (or arguments) passed to a function is of incorrect - * type + * type * $FUNCTION$ - * DTOS + * DTOS * $STATUS$ * Clipper * $SEEALSO$ @@ -664,9 +664,9 @@ start from 3000 * Incorrect type of argument * $DESCRIPTION$ * The argument (or arguments) passed to a function is of incorrect - * type + * type * $FUNCTION$ - * TRANSFORM + * TRANSFORM * $STATUS$ * Clipper * $SEEALSO$ @@ -682,9 +682,9 @@ start from 3000 * $ONELINER$ * Incorrect type of argument * $DESCRIPTION$ - * The first argument is not a string. + * The first argument is not a string. * $FUNCTION$ - * LEFT + * LEFT * $STATUS$ * Clipper * $SEEALSO$ @@ -699,9 +699,9 @@ start from 3000 * $ONELINER$ * Invalid argument passed to function * $DESCRIPTION$ - * The first arguments passed to a function is not a string. + * The first arguments passed to a function is not a string. * $FUNCTION$ - * STRTRAN + * STRTRAN * $STATUS$ * Clipper * $SEEALSO$ @@ -718,7 +718,7 @@ start from 3000 * Bound error in array access * $DESCRIPTION$ * The specified index into an array was greater then the number of - * elements in the array. + * elements in the array. * $FUNCTION$ * * $STATUS$ @@ -737,7 +737,7 @@ start from 3000 * Bound error in array assigment * $DESCRIPTION$ * The specified index into an array was greater then the number of - * elements in the array. + * elements in the array. * $FUNCTION$ * * $STATUS$ @@ -756,7 +756,7 @@ start from 3000 * Bound error in array element assigment * $DESCRIPTION$ * The specified index into an array was greater then the number of - * elements in the array. + * elements in the array. * $FUNCTION$ * * $STATUS$ @@ -774,9 +774,9 @@ start from 3000 * Invalid argument passed to function * $DESCRIPTION$ * The argument (or arguments) passed to a function is not an numeric - * value + * value * $FUNCTION$ - * MOD + * MOD * $STATUS$ * Clipper * $SEEALSO$ @@ -793,9 +793,9 @@ start from 3000 * Invalid argument passed to function * $DESCRIPTION$ * The argument (or arguments) passed to a function is not an numeric - * value + * value * $FUNCTION$ - * ABS + * ABS * $STATUS$ * Clipper * $SEEALSO$ @@ -812,9 +812,9 @@ start from 3000 * Invalid argument passed to function * $DESCRIPTION$ * The argument (or arguments) passed to a function is not an numeric - * value + * value * $FUNCTION$ - * INT + * INT * $STATUS$ * Clipper * $SEEALSO$ @@ -831,9 +831,9 @@ start from 3000 * Invalid argument passed to function * $DESCRIPTION$ * The argument (or arguments) passed to a function is not an numeric - * value + * value * $FUNCTION$ - * MIN + * MIN * $STATUS$ * Clipper * $SEEALSO$ @@ -850,9 +850,9 @@ start from 3000 * Invalid argument passed to function * $DESCRIPTION$ * The argument (or arguments) passed to a function is not an numeric - * value + * value * $FUNCTION$ - * MAX + * MAX * $STATUS$ * Clipper * $SEEALSO$ @@ -869,9 +869,9 @@ start from 3000 * Invalid argument passed to function * $DESCRIPTION$ * The argument (or arguments) passed to a function is not an numeric - * value + * value * $FUNCTION$ - * ROUND + * ROUND * $STATUS$ * Clipper * $SEEALSO$ @@ -888,9 +888,9 @@ start from 3000 * Invalid argument passed to function * $DESCRIPTION$ * The argument (or arguments) passed to a function is not an numeric - * value + * value * $FUNCTION$ - * LOG + * LOG * $STATUS$ * Clipper * $SEEALSO$ @@ -907,9 +907,9 @@ start from 3000 * Invalid argument passed to function * $DESCRIPTION$ * The argument (or arguments) passed to a function is not an numeric - * value + * value * $FUNCTION$ - * EXP + * EXP * $STATUS$ * Clipper * $SEEALSO$ @@ -926,9 +926,9 @@ start from 3000 * Invalid argument passed to function * $DESCRIPTION$ * The argument (or arguments) passed to a function is not an numeric - * value + * value * $FUNCTION$ - * SQRT + * SQRT * $STATUS$ * Clipper * $SEEALSO$ @@ -945,9 +945,9 @@ start from 3000 * Invalid argument passed to function * $DESCRIPTION$ * The argument (or arguments) passed to a function is not a string - * value + * value * $FUNCTION$ - * VAL + * VAL * $STATUS$ * Clipper * $SEEALSO$ @@ -964,9 +964,9 @@ start from 3000 * Invalid argument passed to function * $DESCRIPTION$ * The argument (or arguments) passed to a function is not a numeric - * value + * value * $FUNCTION$ - * STR + * STR * $STATUS$ * Clipper * $SEEALSO$ @@ -984,9 +984,9 @@ start from 3000 * $ONELINER$ * Incorrect arguments type * $DESCRIPTION$ - * Passed arguments was not strings with filenames to copy/ + * Passed arguments was not strings with filenames to copy/ * $FUNCTION$ - * __COPYFILE + * __COPYFILE * $COMPLIANCE$ * Harbour specific * $SEEALSO$ @@ -1003,9 +1003,9 @@ start from 3000 * File error * $DESCRIPTION$ * An error has occured during the attempt to open, create or write - * during copy operation + * during copy operation * $FUNCTION$ - * __COPYFILE + * __COPYFILE * $STATUS$ * Clipper * $SEEALSO$ @@ -1022,9 +1022,9 @@ start from 3000 * Invalid argument passed to a function * $DESCRIPTION$ * The first argument is not an array or/and the second argument - * is not a code block + * is not a code block * $FUNCTION$ - * AEVAL + * AEVAL * $STATUS$ * Clipper * $SEEALSO$ @@ -1040,12 +1040,12 @@ start from 3000 * $ONELINER$ * Invalid argument passed to function * $DESCRIPTION$ - * The passed value is negative. Only values > 0 are allowed. + * The passed value is negative. Only values > 0 are allowed. * $FUNCTION$ - * SET DECIMALS - * SET EPOCH - * SET MARGIN - * SET MESSAGE + * SET DECIMALS + * SET EPOCH + * SET MARGIN + * SET MESSAGE * $STATUS$ * Clipper * $SEEALSO$ @@ -1055,17 +1055,6 @@ start from 3000 /* ************************************************************************** */ -/* $DOC$ - * $SUBCODE$ - * BASE/3000 - * $CATEGORY$ - * $ONELINER$ - * $DESCRIPTION$ - * $FUNCTION$ - * $STATUS$ - * $SEEALSO$ - * $END$ - */ /* $DOC$ * $SUBCODE$ @@ -1076,9 +1065,9 @@ start from 3000 * Incorrect argument type * $DESCRIPTION$ * The passed argument is not an object. Only data of type OBJECT - * can be cloned by this function + * can be cloned by this function * $FUNCTION$ - * OCLONE + * OCLONE * $STATUS$ * Harbour specific * $SEEALSO$ @@ -1095,9 +1084,9 @@ start from 3000 * 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 + * doesn't have a super class * $FUNCTION$ - * __INSTSUPER + * __INSTSUPER * $STATUS$ * Harbour specific * $SEEALSO$ @@ -1113,9 +1102,9 @@ start from 3000 * $ONELINER$ * Cannot find super class * $DESCRIPTION$ - * Passed argument is not a name of defined class + * Passed argument is not a name of defined class * $FUNCTION$ - * __INSTSUPER + * __INSTSUPER * $STATUS$ * Harbour specific * $SEEALSO$ @@ -1132,9 +1121,9 @@ start from 3000 * 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 + * Only INLINE and METHOD can be modified * $FUNCTION$ - * CLASSMOD + * CLASSMOD * $STATUS$ * Harbour specific * $SEEALSO$ @@ -1151,9 +1140,9 @@ start from 3000 * Incorrect arguments type * $DESCRIPTION$ * Either the first argument was not an object or the second argument - * wasn't a string. + * wasn't a string. * $FUNCTION$ - * ISMESSAGE, OSEND + * ISMESSAGE, OSEND * $STATUS$ * Harbour specific * $SEEALSO$ @@ -1161,18 +1150,6 @@ start from 3000 * $END$ */ -/* $DOC$ - * $SUBCODE$ - * BASE/3006 - * $CATEGORY$ - * (not used yet) - * $ONELINER$ - * $DESCRIPTION$ - * $FUNCTION$ - * $STATUS$ - * $SEEALSO$ - * $END$ - */ /* $DOC$ * $SUBCODE$ @@ -1183,9 +1160,9 @@ start from 3000 * Invalid type of argument * $DESCRIPTION$ * The passed arguments are causing conflict in hanndling of the request. - * There is no point in waiting forever for no input events! + * There is no point in waiting forever for no input events! * $FUNCTION$ - * INKEY + * INKEY * $STATUS$ * Harbour specific * $SEEALSO$ @@ -1202,9 +1179,9 @@ start from 3000 * 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. + * a variable name or an one-dimensional array of strings. * $FUNCTION$ - * __MVPRIVATE, __MVPUBLIC + * __MVPRIVATE, __MVPUBLIC * $STATUS$ * Harbour specific * $SEEALSO$ @@ -1220,9 +1197,9 @@ start from 3000 * 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. + * of variable. The value of this variable will be returned. * $FUNCTION$ - * __MVGET + * __MVGET * $STATUS$ * Harbour specific * $SEEALSO$ @@ -1239,9 +1216,29 @@ start from 3000 * 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. + * of variable. The value of this variable will be set. * $FUNCTION$ - * __MVPUT + * __MVPUT + * $STATUS$ + * Harbour specific + * $SEEALSO$ + * + * $END$ + */ + +/* $DOC$ + * $SUBCODE$ + * BASE/3011 + * $CATEGORY$ + * arguments + * $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 greated then the number of + * passed arguments. + * $FUNCTION$ + * PVALUE * $STATUS$ * Harbour specific * $SEEALSO$ @@ -1258,9 +1255,9 @@ start from 3000 * Invalid argument passed to a function * $DESCRIPTION$ * The first argument is not a string with function/procedure name - * that should be called. + * that should be called. * $FUNCTION$ - * DO + * DO * $STATUS$ * Harbour specific * $SEEALSO$ @@ -1276,9 +1273,9 @@ start from 3000 * $ONELINER$ * Invalid argument passed to an object/class function * $DESCRIPTION$ - * One passed argument is not of the required type. + * One passed argument is not of the required type. * $FUNCTION$ - * __OBJ*() + * __OBJ*() * $STATUS$ * Harbour specific * $SEEALSO$ @@ -1296,9 +1293,9 @@ start from 3000 * doesn't exist. * $DESCRIPTION$ * A symbol should be modified or deleted from a class, but the symbol - * doesn't exist. + * doesn't exist. * $FUNCTION$ - * __OBJ*() + * __OBJ*() * $STATUS$ * Harbour specific * $SEEALSO$ @@ -1314,9 +1311,9 @@ start from 3000 * $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. + * A symbol should be added to a class, but the symbol already exists. * $FUNCTION$ - * __OBJ*() + * __OBJ*() * $STATUS$ * Harbour specific * $SEEALSO$ @@ -1334,9 +1331,9 @@ start from 3000 * $ONELINER$ * Invalid argument passed to function * $DESCRIPTION$ - * The second arguments passed to a function is not a string. + * The second arguments passed to a function is not a string. * $FUNCTION$ - * ISLEAPYEAR + * ISLEAPYEAR * $STATUS$ * Harbour specific * $SEEALSO$ @@ -1354,9 +1351,9 @@ start from 3000 * $ONELINER$ * Create error * $DESCRIPTION$ - * The specified file cannot be created due some OS error. + * The specified file cannot be created due some OS error. * $FUNCTION$ - * SET, SET ALTERNATE TO + * SET, SET ALTERNATE TO * $STATUS$ * Clipper * $SEEALSO$