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

See changelog 20000101 21:00

Browse Source
This commit is contained in:
Luiz Rafael Culik
2000-04-02 00:13:17 +00:00
parent 5aeb6c4eda
commit ded727a2fb
12 changed files with 1046 additions and 354 deletions
Download Patch File Download Diff File Expand all files Collapse all files

250
harbour/doc/en/array.txt
View File

@@ -26,28 +26,25 @@
* $SYNTAX$
* ARRAY(<nElements> [, <nElements>...]) --> aArray
* $ARGUMENTS$
* <nElements> is the number of elements in the specified dimension. </par>
* <nElements> is the number of elements in the specified dimension.
* $RETURNS$
* <aArray> an array of specified dimensions. </par>
* <aArray> an array of specified dimensions.
* $DESCRIPTION$
* This function returns an uninitialized array with the length of
* <nElements>. Nested arrays are uninitialized within the same array
* pointer reference if additional parameters are specified. </par>
* 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. </par>
* $EXAMPLES$
<fixed>
* the array or the variable with the same name as the array.
* $EXAMPLES$
* FUNCTION Main()
* LOCAL aArray:=Array(10)
* LOCAL x:=1
* FOR x:=1 to LEN(aArray)
* aArray[x]:=Array(x)
* NEXT
* Return Nil
</fixed>
* Return Nil
* $STATUS$
* R
* $SEEALSO$
@@ -55,7 +52,7 @@
* $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. </par>
* Clipper has a limit of 4096 array elements.
* $END$
*/
@@ -69,26 +66,25 @@
* $SYNTAX$
* AADD(<aArray>[, <xValue>]) --> Value
* $ARGUMENTS$
* <aArray> The name of an array </par>
* <xValue> Element to add to array <aArray> </par>
* <aArray> The name of an array
* <xValue> Element to add to array <aArray>
* $RETURNS$
* <Value> if specified <xValue>,<xValue> will return , otherwise this
* function returns a NIL value. </par>
* function returns a NIL value.
* $DESCRIPTION$
* This function dynamically increases the length of the array named
* <aArray> by one element and stores the value of <xValue> to that
* newly created element. </par>
* newly created element.
* <xValue> may be an array reference pointer, which in turn may be
* stored to an array's subscript position. </par>
* $EXAMPLES$
<fixed>
* stored to an array's subscript position.
* $EXAMPLES$
* LOCAL aArray:={}
* AADD(aArray,10)
* FOR x:=1 to 10
* AADD(aArray,x)
* NEXT
</fixed>
* NEXT
* $STATUS$
* R
* $SEEALSO$
@@ -106,28 +102,28 @@
* $SYNTAX$
* ASIZE(<aArray>, <nLen>) --> aTarget
* $ARGUMENTS$
* <aArray> Name of array to be dynamically altered </par>
* <nLen> Numeric value representing the new size of <aArray> </par>
* <aArray> Name of array to be dynamically altered
* <nLen> Numeric value representing the new size of <aArray>
* $RETURNS$
* <aTarget> an array pointer reference to <aTarget>. </par>
* <aTarget> an array pointer reference to <aTarget>.
* $DESCRIPTION$
* This function will dynamically increase or decrease the size of
* <aArray> by adjusting the length of the array to <nLen> subscript
* positions. </par>
* positions.
* If the length of the array <aArray> 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. </par>
* $EXAMPLES$
<fixed>
* lengthened a NIL value is assigned to the new subscript position.
* $EXAMPLES$
* aArray := { 1 } // Result: aArray is { 1 }
* ASIZE(aArray, 3) // Result: aArray is { 1, NIL, NIL }
* ASIZE(aArray, 1) // Result: aArray is { 1 } </fixed>
* ASIZE(aArray, 1) // Result: aArray is { 1 }
* $STATUS$
* R
* $COMPLIANCE$
* If HB_COMPAT_C53 is defined, the function generates an Error,
* else it will return the array itself. </par>
* else it will return the array itself.
* $SEEALSO$
* AADD(),ADEL(),AFILL(),AINS()
* $INCLUDE$
@@ -145,22 +141,20 @@
* $SYNTAX$
* ATAIL(<aArray>) --> Element
* $ARGUMENTS$
* <aArray> is the array. </par>
* <aArray> is the array.
* $RETURNS$
* <Element> the expression of the last element in the array. </par>
* <Element> the expression of the last element in the array.
* $DESCRIPTION$
* This function return the value of the last element in the array
* named <aArray>. This function does not alter the size of the
* array or any of the subscript values. </par>
* $EXAMPLES$
<fixed>
* array or any of the subscript values.
* $EXAMPLES$
* LOCAL array:= {"Harbour", "is", "Supreme", "Power"}
* ? ATAIL(aArray)
</fixed>
* ? ATAIL(aArray)
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA Clipper compliant </par>
* This function is CA Clipper compliant
* $SEEALSO$
* LEN(),ARRAY(),ASIZE(),AADD()
* $END$
@@ -176,13 +170,14 @@
* $SYNTAX$
* AINS(<aArray>, <nPos>) --> aTarget
* $ARGUMENTS$
* <aArray> Array name. </par>
* <nPos> Subscript position in <aArray> </par>
* <aArray> Array name.
* <nPos> Subscript position in <aArray>
* $RETURNS$
* <aTarget> an array pointer reference. </par>
* <aTarget> an array pointer reference.
* $DESCRIPTION$
* This function inserts a NIL value in the array named <aArray>
* at the <nPos>th position. </par>
* at the <nPos>th position.
* All array elements starting with the <nPos>th position will be
* shifted down one subscript position in the array list and the
@@ -190,16 +185,14 @@
* 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 <aArray>
* will remain unchanged. </par>
* $EXAMPLES$
<fixed>
* will remain unchanged.
* $EXAMPLES$
* LOCAL aArray:={"Harbour","is","Power!","!!!"}
* AINS(aArray,4)
</fixed>
* AINS(aArray,4)
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA Clipper compliant </par>
* This function is CA Clipper compliant
* $SEEALSO$
* AADD(),ACOPY(),ADEL(),AEVAL(),AFILL(),ASIZE()
* $INCLUDE$
@@ -217,10 +210,11 @@
* $SYNTAX$
* ADEL(<aArray>, <nPos>) --> aTarget
* $ARGUMENTS$
* <aArray> Name of array from which an element is to be removed. </par>
* <nPos> Subscript of the element to be removed. </par>
* <aArray> Name of array from which an element is to be removed.
* <nPos> Subscript of the element to be removed.
* $RETURNS$
* <aTarget> an array pointer reference. </par>
* <aTarget> an array pointer reference.
* $DESCRIPTION$
* This function deletes the element found at <nPos> subscript position
* in the array <aArray>. All elements in the array <aArray> below the
@@ -228,18 +222,18 @@
* array. In other words, what was formerly the sixth subscript position
* will become the fifth subscript position. The length of the array
* <aArray> will remain unchanged,as the last element in the array will
* become a NIL data type. </par>
* become a NIL data type.
* $EXAMPLES$
<fixed>
* LOCAL aArray
* aArray := { "Harbour","is","Power" } // Result: aArray is
*
* ADEL(aArray, 2) // Result: aArray is
</fixed>
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA Clipper compliant </par>
* This function is CA Clipper compliant
* $SEEALSO$
* ACOPY(),AINS(),AFILL()
*
@@ -256,12 +250,15 @@
* $SYNTAX$
* AFILL(<aArray>, <xValue>,[<nStart>], [<nCount>]) --> aTarget
* $ARGUMENTS$
* <aArray> Name of array to be filled. </par>
* <xValue> Expression to be globally filled in <aArray> </par>
* <nStart> Subscript starting position </par>
* <nCount> Number of subscript to be filled </par>
* <aArray> Name of array to be filled.
* <xValue> Expression to be globally filled in <aArray>
* <nStart> Subscript starting position
* <nCount> Number of subscript to be filled
* $RETURNS$
* <aTarget> an array pointer. </par>
* <aTarget> an array pointer.
* $DESCRIPTION$
* This function will fill each element of an array named <aArray> with
* the value <xValue>. If specified, <nStart> denotes the beginning
@@ -269,21 +266,19 @@
* filled for <nCount> positions. If Not specified, the value of
* <nStart> will be 1, and the value of <nCount> will be the value
* of LEN(<aArray>); thus, all subscript positions in the array
* <aArray> will be filled with the value of <xValue>. </par>
* <aArray> will be filled with the value of <xValue>.
* This function will work on only a single dimension of <aArray>.
* If there are array pointer references within a subscript <aArray>,
* those values will be lost, since this function will overwrite those
* values with new values. </par>
* values with new values.
* $EXAMPLES$
<fixed>
* LOCAL aTest:={Nil,0,1,2}
* Afill(aTest,5)
</fixed>
* Afill(aTest,5)
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA Clipper compliant </par>
* This function is CA Clipper compliant
* $SEEALSO$
* AADD(),AEVAL(),DBSTRUCT(),DIRECTORY()
* $END$
@@ -299,40 +294,41 @@
* $SYNTAX$
* ASCAN(<aTarget>, <xSearch>,[<nStart>], [<nCount>]) --> nStoppedAt
* $ARGUMENTS$
* <aTarget> Name of array to be scanned. </par>
* <xSearch> Expression to search for in <aTarget> </par>
* <nStart> Beginning subscript position at which to start the search. </par>
* <nCount> Number of elements to scan with <aTarget>. </par>
* <aTarget> Name of array to be scanned.
* <xSearch> Expression to search for in <aTarget>
* <nStart> Beginning subscript position at which to start the search.
* <nCount> Number of elements to scan with <aTarget>.
* $RETURNS$
* <nStoppedAt> A numeric value of subscript position where <xSearch> was found. </par>
* <nStoppedAt> A numeric value of subscript position where <xSearch> was found.
* $DESCRIPTION$
* This function scan the content of array named <aTarget> for the
* value of <xSearch>. The return value is the position in the array
* <aTarget> in which <xSearch> was found. If it was not found, the
* return value will be 0. </par>
* return value will be 0.
* If specified, the beginning subscript position at which to start
* scanning may be set with the value passed as <nStart>. The default
* is 1. </par>
* is 1.
* If specified, the number of array elements to scan may be set with
* the value passed as <nCount>. The default is the number of elements
* in the array <aTarget>. </par>
* in the array <aTarget>.
* If <xSearch> 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. </par>
* $EXAMPLES$
<fixed>
* 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"})
</fixed>
* 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 </par>
* This function is not CA-Clipper compatible. Clipper ASCAN() is affected by the SET EXACT ON/OFF Condition
* $SEEALSO$
* AEVAL()
* $END$
@@ -348,31 +344,34 @@
* $SYNTAX$
* AEVAL(<aArray>, <bBlock>, [<nStart>], [<nCount>]) --> aArray
* $ARGUMENTS$
* <aArray> Is the array to be evaluated. </par>
* <bBlock> Is a code block to evaluate for each element processed. </par>
* <nStart> The beginning array element to evaluate. </par>
* <nCount> The number of elements to process. </par>
* <aArray> Is the array to be evaluated.
* <bBlock> Is a code block to evaluate for each element processed.
* <nStart> The beginning array element to evaluate.
* <nCount> The number of elements to process.
* $RETURNS$
* <aArray> an array pointer reference. </par>
* <aArray> an array pointer reference.
* $DESCRIPTION$
* This function will evaluate and process the subscript elements
* in <aArray>. A code block passed as <bBlock> defines the operation
* to be executed on each element of the array. All elements in <aArray>
* will be evaluated unless specified by a beginning subscript position
* in <nStart> for <nCount> elements. </par>
* in <nStart> for <nCount> elements.
* Two parameters are passed to the code block <bBlock>. The individual
* elements in an array are the first parameter and the subscript position
* is the second. </par>
* 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. </par>
* loop is more appropriate.
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA Clipper compliant </par>
* This function is CA Clipper compliant
* $SEEALSO$
* EVAL(),DBEVAL()
* $END$
@@ -388,48 +387,50 @@
* $SYNTAX$
* ACOPY(<aSource>, <aTarget>, [<nStart>], [<nCount>], [<nTargetPos>]) --> aTarget
* $ARGUMENTS$
* <aSource> is the array to copy elements from. </par>
* <aTarget> is the array to copy elements to. </par>
* <nStart> is the beginning subscript position to copy from <aSource> </par>
* <nCount> the number of subscript elements to copy from <aSource>. </par>
* <nTargetPos> the starting subscript position in <aTarget> to copy elements to. </par>
* <aSource> is the array to copy elements from.
* <aTarget> is the array to copy elements to.
* <nStart> is the beginning subscript position to copy from <aSource>
* <nCount> the number of subscript elements to copy from <aSource>.
* <nTargetPos> the starting subscript position in <aTarget> to copy elements to.
* $RETURNS$
* <aTarget> an array pointer reference </par>
* <aTarget> an array pointer reference
* $DESCRIPTION$
* This function copies array elements from <aSource> to <aTarget>.
* <nStart> is the beginning element to be copied from <aSource>;
* the default is 1. </par>
* the default is 1.
* <nCount> is the number of elements to be copied from <aSource>;
* the default is the entire array. </par>
* the default is the entire array.
* <nTargetPos> is the subscript number in the target array,<aTarget>,
* to which array elements are to be copied; the default is 1 </par>
* to which array elements are to be copied; the default is 1
* This function will copy all data types in <aSource> to <aTarget>. </par>
* This function will copy all data types in <aSource> to <aTarget>.
* If an array element in <aSource> is a pointer reference to another
* array, that array pointer will be copied to <aTarget>; not all
* subdimensions will be copied from one array to the next. This must
* be accomplished via the ACLONE() function. </par>
* be accomplished via the ACLONE() function.
* Note </par>
* Note
* If array <aSource> is larger then <aTarget>, array elements will
* start copying at <nTargetPos> and continue copying until the end
* of array <aTarget> is reached. The ACOPY() function doesn't append
* subscript positions to the target array, the size of the target
* array <aTarget> remains constant. </par>
* $EXAMPLES$
<fixed>
* array <aTarget> remains constant.
* $EXAMPLES$
* LOCAL nCount := 2, nStart := 1, aOne, aTwo
* aOne := {"HABOUR"," is ","POWER"}
* aTwo := {"CLIPPER"," was ","POWER"}
* ACOPY(aOne, aTwo, nStart, nCount)
</fixed>
* ACOPY(aOne, aTwo, nStart, nCount)
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA Clipper compliant </par>
* This function is CA Clipper compliant
* $SEEALSO$
* ACLONE(),ADEL(),AEVAL(),AFILL(),AINS(),ASORT()
* $END$
@@ -445,27 +446,25 @@
* $SYNTAX$
* ACLONE(<aSource>) --> aDuplicate
* $ARGUMENTS$
* <aSource> Name of the array to be cloned. </par>
* <aSource> Name of the array to be cloned.
* $RETURNS$
* <aDuplicate> A new array pointer reference complete with nested
* array values. </par>
* array values.
* $DESCRIPTION$
* This function makes a complete copy of the array expressed as
* <aSource> and return a cloned set of array values.This provides
* a complete set of arrays values for all dimensions within the
* original array <aSource> </par>
* $EXAMPLES$
<fixed>
* original array <aSource>
* $EXAMPLES$
* LOCAL aOne, aTwo
* aOne := {"Harbour"," is ","POWER"}
* aTwo := ACLONE(aOne) // Result: aTwo is {1, 2, 3}
* aOne[1] := "The Harbour Compiler" // Result: aOne is {99, 2, 3}
* // aTwo is still {1, 2, 3}
</fixed>
* // aTwo is still {1, 2, 3}
* $STATUS$
* R
* $COMPLIANCE$
* Clipper will return NIL if the parameter is not an array. </par>
* Clipper will return NIL if the parameter is not an array.
* $SEEALSO$
* ACOPY(),ADEL(),AINS(),ASIZE()
* $END$
@@ -481,23 +480,26 @@
* $SYNTAX$
* ASORT( <aArray>, [<nStart>], [<nCount>], [<bSort>] ) --> aArray
* $ARGUMENTS$
* <aArray> Array to be sorted. </par>
* <nStart> The first element to start the sort from, default is 1. </par>
* <aArray> Array to be sorted.
* <nStart> The first element to start the sort from, default is 1.
* <nCount> Number of elements starting from <nStart> to sort, default
* is all elements. </par>
* is all elements.
* <bSort> 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. </par>
* must return .T. if the sort is in order, .F. if not.
* $RETURNS$
* <aArray> reference to the now sorted <aArray> or NIL if the
* passed <aArray> is not an array. </par>
* passed <aArray> is not an array.
* $DESCRIPTION$
* ASORT() sort all or part of a given array. If <bSort> is omitted,
* the function expect <aArray> 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. </par>
* .T., Numeric are sorted by their value.
* If <bSort> is specified, it is used to handle the sorting order. With
* each time the block is evaluate, two array elements are passed to the
@@ -505,9 +507,8 @@
* 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. </par>
* $EXAMPLES$
* <fixed>
* type.
* $EXAMPLES$
* // sort numeric values in ascending order
* ASORT( { 3, 1, 4, 42, 5, 9 } ) // result: { 1, 3, 4, 5, 9, 42 }
*
@@ -519,8 +520,7 @@
* // sort two-dimensional array according to 2nd element of each pair
* aPair := { {"Sun",8}, {"Mon",1}, {"Tue",57}, {"Wed",-6} }
* ASORT( aPair,,, {| x, y | x[2] < y[2] } )
* // result: { {"Wed",-6}, {"Mon",1}, {"Sun",8}, {"Tue",57} }
* </fixed>
* // result: { {"Wed",-6}, {"Mon",1}, {"Sun",8}, {"Tue",57} }
* $STATUS$
* R
* $COMPLIANCE$
@@ -528,7 +528,7 @@
* 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. </par>
* from Clipper anyway, since they use different sorting algorithm.
* $SEEALSO$
* ASCAN(),EVAL(),SORT
* $END$

492
harbour/doc/en/datetime.txt Normal file
View File

@@ -0,0 +1,492 @@
/*
* $Id$
*/
/*
* The following parts are Copyright of the individual authors.
* www - http://www.harbour-project.org
*
* Copyright 2000 Luiz Rafael Culik <culik@sl.conex.net>
* Documentation for: CDOW(),CMONTH(),DATE(),CTOD(),DAY(),DAYS()
* DOW(),DTOS(),DTOC(),ELAPTIME(),MONTH(),SECONDS(),SECS(),TIME(),YEAR()
* See doc/license.txt for licensing terms.
*
*/
/* $DOC$
* $FUNCNAME$
* CDOW()
* $CATEGORY$
* Date
* $ONELINER$
* Converts a date to the day of week
* $SYNTAX$
* CDOW(<dDate>) --> cDay
* $ARGUMENTS$
* <dDate> Any date expression.
* $RETURNS$
* <cDay> The current day of week.
* $DESCRIPTION$
* This function returns a character string of the day of the week,
* from a date expression <dDate> passed to it.
* If a NULL date is passed to the function, the value of the function
* will be a NULL byte.
* $EXAMPLES$
* ? CDOW(DATE())
* if CDOW(DATE()+10) =="SUNDAY"
* ? "This is a sunny day."
* Endif
* $STATUS$
* R
* $COMPLIANCE$
* This function is Ca-Clipper compliant.
* $PLATFORMS$
* All
* $SEEALSO$
* DAY(),DOW(),DATE(),CMONTH()
* $END$
*/
/* $DOC$
* $FUNCNAME$
* CMONTH()
* $CATEGORY$
* Date
* $ONELINER$
* Return the name of the month.
* $SYNTAX$
* CMONTH(<dDate>) --> cMonth
* $ARGUMENTS$
* <dDate> Any date expression.
* $RETURNS$
* <cMonth> The current month name
* $DESCRIPTION$
* This function returns the name of the month (January,February,etc.)
* from a date expression <dDate> passed to it.
* If a NULL date is passed to the function, the value of the function
* will be a NULL byte.
* $EXAMPLES$
* ? CMONTH(DATE())
* if CMONTH(DATE()+10) =="March"
* ? "Have you done your system BACKUP?"
* Endif
* $STATUS$
* R
* $COMPLIANCE$
* This function is Ca-Clipper compliant
* $PLATFORMS$
* All
* $SEEALSO$
* CDOW(),DATE(),MONTH(),YEAR(),DOW(),DTOC()
* $END$
*/
/* $DOC$
* $FUNCNAME$
* DATE()
* $CATEGORY$
* Date
* $ONELINER$
* Return the Current OS Date
* $SYNTAX$
* DATE() --> dCurDate
* $ARGUMENTS$
* None
* $RETURNS$
* <dCurDate> Current system date.
* $DESCRIPTION$
* This function returns the current system date.
* $EXAMPLES$
* ? Date()
* $TESTS$
* ? "Today is ",Day(date())," of ",cMonth(date())," of ",Year(date())
* $STATUS$
* R
* $COMPLIANCE$
* This function is Ca-Clipper Compliant
* $PLATFORMS$
* All
* $SEEALSO$
* CTOD(),DTOS(),DTOC(),DAY(),MONTH(),CMONTH()
* $END$
*/
/* $DOC$
* $FUNCNAME$
* CTOD()
* $CATEGORY$
* Date
* $ONELINER$
* Converts a character string to a date expression
* $SYNTAX$
* CTOD(<cDateString>) --> dDate
* $ARGUMENTS$
* <cDateString> A character date in format 'mm/dd/yy'
* $RETURNS$
* <dDate> A date expression
* $DESCRIPTION$
* This function converts a date that has been entered as a character
* expression to a date expression.The character expression will be in
* the form "MM/DD/YY" (based on the default value in SET DATE) or in
* the appropriate format specified by the SET DATE TO command. If an
* improper character string is passed to the function,an empty date
* value will be returned.
* $EXAMPLES$
* ? CTOD('12/21/00')
* $STATUS$
* R
* $COMPLIANCE$
* This function is Ca-Clipper compliant
* $PLATFORMS$
* All
* $SEEALSO$
* SET DATE,DATE(),DTOS()
* $END$
*/
/* $DOC$
* $FUNCNAME$
* DAY()
* $CATEGORY$
* Date
* $ONELINER$
* Return the numeric day of th month.
* $SYNTAX$
* DAY(<cDate>) --> nMonth
* $ARGUMENTS$
* <cDate> Any valid date expression.
* $RETURNS$
* <nMonth> Numeric value of the day of month.
* $DESCRIPTION$
* This function returns the numeric value of the day of month from a
* date.
* $EXAMPLES$
* ? Day(DATE())
* ? Day(DATE()+6325)
* $STATUS$
* R
* $COMPLIANCE$
* This function is Ca-Clipper compliant
* $PLATFORMS$
* All
* $SEEALSO$
* CTOD(),DTOS(),DTOC(),DATE(),MONTH(),CMONTH()
* $END$
*/
/* $DOC$
* $FUNCNAME$
* DAYS()
* $CATEGORY$
* Date
* $ONELINER$
* Convert elapsed seconds into days
* $SYNTAX$
* DAYS(<nSecs> ) --> nDay
* $ARGUMENTS$
* <nSecs> The number of seconds
* $RETURNS$
* <nDay> The number of days
* $DESCRIPTION$
* This function converst <nSecs> seconds to the equivalent number
* of days;86399 seconds represent one day,0 seconds being midnight.
* $EXAMPLES$
* ? DAYS(2434234)
* ? "Has been passed ",DAYS(63251),' since midnight'
* $STATUS$
* R
* $COMPLIANCE$
* This function is Ca-Clipper compliant
* $PLATFORMS$
* All
* $SEEALSO$
* SECONDS(),SECS(),ELAPTIME()
* $END$
*/
/* $DOC$
* $FUNCNAME$
* DOW()
* $CATEGORY$
* Date
* $ONELINER$
* Value for the day of week.
* $SYNTAX$
* DOW(<dDate>) --> nDay
* $ARGUMENTS$
* <dDate> Any valid date expression
* $RETURNS$
* <nDay> The current day number
* $DESCRIPTION$
* This function returns the number representing the day of the week
* for the date expressed as <dDate>.
* $EXAMPLES$
* ? DOW(DATE())
* ? DOW(DATE()-6584)
* $STATUS$
* R
* $COMPLIANCE$
* This function is Ca-Clipper compliant
* $PLATFORMS$
* All
* $SEEALSO$
* DTOC(),CDOW(),DATE(),DTOS(),DAY()
* $END$
*/
/* $DOC$
* $FUNCNAME$
* DTOC()
* $CATEGORY$
* Date
* $ONELINER$
* Date to character conversion
* $SYNTAX$
* DTOC(<dDateString>) --> cDate
* $ARGUMENTS$
* <dDateString> Any date
* $RETURNS$
* <dDate> Character represention of date
* $DESCRIPTION$
* This function converts any date expression (a field or variable )
* expressed as <dDateString> to a character expression in the default
* format "MM/DD/YY".The date format is expressed by this function is
* controled in part by the date format specified in the SET DATE
* command
* $EXAMPLES$
* ? DTOC(Date())
* $STATUS$
* R
* $COMPLIANCE$
* This function is Ca-Clipper compliant
* $PLATFORMS$
* All
* $SEEALSO$
* SET DATE,DATE(),DTOS()
* $END$
*/
/* $DOC$
* $FUNCNAME$
* DTOS()
* $CATEGORY$
* Date
* $ONELINER$
* Date to string conversion
* $SYNTAX$
* DTOS(<dDateString>) --> cDate
* $ARGUMENTS$
* <dDateString> Any date
* $RETURNS$
* <dDate> String notation of the date
* $DESCRIPTION$
* This function returns the value of <dDateString> as a character
* string in the format of YYYYMMDD.If the value of <dDateString> is
* an empty date , this function will returbn eight blank spaces.
* $EXAMPLES$
* ? DTOS(Date())
* $STATUS$
* R
* $COMPLIANCE$
* This function is Ca-Clipper compliant
* $PLATFORMS$
* All
* $SEEALSO$
* DTOC(),DATE(),DTOS()
* $END$
*/
/* $DOC$
* $FUNCNAME$
* ELAPTIME()
* $CATEGORY$
* Time
* $ONELINER$
* Calculates elapted time.
* $SYNTAX$
* ELAPTIME(<cStartTime>,<cEndTime>) --> cDiference
* $ARGUMENTS$
* <cStartTime> Start in time as a string format
* <cEndTime> End time as a string format
* $RETURNS$
* <cDiference> Difference between the times
* $DESCRIPTION$
* This function returns a string that shows the difference between
* the starting time represented as <cStartTime> and the ending time
* as <cEndTime>. If the stating time is greater then the ending
* time,the function will assume that the date changed once.
* $EXAMPLES$
* Static cStartTime
* Init Proc Startup
* cStartTime:=Time()
*
* Exit Proc StartExit
* ? "You used this program by",ELAPTIME(cStartTime,Time())
* $STATUS$
* R
* $COMPLIANCE$
* This function is Ca-Clipper compliant
* $PLATFORMS$
* All
* $SEEALSO$
* SECS(),SECONDS(),TIME(),DAY()
* $END$
*/
/* $DOC$
* $FUNCNAME$
* MONTH()
* $CATEGORY$
* Date
* $ONELINER$
* Converts a date expression to a month value
* $SYNTAX$
* MONTH(<dDate>) --> nMonth
* $ARGUMENTS$
* <dDate> Any valid date expression
* $RETURNS$
* <nMonth> Corresponding number of the month in the year, ranging from
* 0 to 12
* $DESCRIPTION$
* This function returns a number that representate the month of given
* date expression <dDate>. If a NULL date (CTOD('')) is passed to the
* function, the value of the function will be 0.
* $EXAMPLES$
* ? Month(DATE())
* $STATUS$
* R
* $COMPLIANCE$
* This function is Ca-Clipper compliant
* $PLATFORMS$
* All
* $SEEALSO$
* CDOW(),DOW(),YEAR(),CMONTH()
* $END$
*/
/* $DOC$
* $FUNCNAME$
* SECONDS()
* $CATEGORY$
* Time
* $ONELINER$
* Returns the number of elapsed seconds past midnight.
* $SYNTAX$
* SECONDS() --> nSeconds
* $ARGUMENTS$
* None
* $RETURNS$
* <nSeconds> Number of seconds since midnight
* $DESCRIPTION$
* This function returns a numeric value representing the number of
* elapsed seconds based on the current system time.
* The system time is considered to start at 0 (midnight);it continues
* up to 86399 seconds.The value of the return expression is displayed
* in both seconds and hundredths of seconds.
* $EXAMPLES$
* ? Seconds()
* $STATUS$
* R
* $COMPLIANCE$
* This function is Ca-Clipper compliant
* $PLATFORMS$
* All
* $SEEALSO$
* TIME()
* $END$
*/
/* $DOC$
* $FUNCNAME$
* SECS()
* $CATEGORY$
* Time
* $ONELINER$
* Return the number of seconds from the system date.
* $SYNTAX$
* SECS( <cTime> ) --> nSeconds
* $ARGUMENTS$
* <cTime> Character expression in a time string format
* $RETURNS$
* <nSeconds> Number of seconds
* $DESCRIPTION$
* This function returns a numeric value that is a number of elapsed
* seconds from midnight base on a time string given as <cTime>.
* $EXAMPLES$
* ? Secs(Time())
* ? Secs(time()-10)
* $STATUS$
* R
* $COMPLIANCE$
* This function is Ca-Clipper compliant
* $PLATFORMS$
* All
* $SEEALSO$
* SECONDS(),ELAPTIME(),TIME()
* $END$
*/
/* $DOC$
* $FUNCNAME$
* TIME()
* $CATEGORY$
* Time
* $ONELINER$
* Returns the system time as a string
* $SYNTAX$
* TIME() --> cTime
* $ARGUMENTS$
* None
* $RETURNS$
* <cTime> Character string representing time
* $DESCRIPTION$
* This function returns the system time represented as a character
* expression in the format of HH:MM:SS
* $EXAMPLES$
* ? Time()
* $STATUS$
* R
* $COMPLIANCE$
* This function is Ca-Clipper compliant
* $PLATFORMS$
* All
* $SEEALSO$
* DATE(),SECONDS()
* $END$
*/
/* $DOC$
* $FUNCNAME$
* YEAR()
* $CATEGORY$
* Date
* $ONELINER$
* Converts the year portion of a date into a numeric value
* $SYNTAX$
* YEAR(<cDate>) --> nYear
* $ARGUMENTS$
* <dDate> Any valid date expression
* $RETURNS$
* <nYear> The year portion of the date.
* $DESCRIPTION$
* This function returns the numeric value for the year in <dDate>.
* This value will always be a four-digit number and is not affected
* by the setting of the SET CENTURY and SET DATE commands. Addition
* ally, an empty date expression passed to this function will yield
* a zero value.
*
* $EXAMPLES$
* ? Year(date())
* ? year(CTOD("01/25/3251"))
* $STATUS$
* R
* $COMPLIANCE$
* This function is Ca-Clipper compliant
* $PLATFORMS$
* All
* $SEEALSO$
* DAY(),MONTH()
* $END$
*/

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

@@ -23,11 +23,11 @@
* $SYNTAX$
* ISBIN(<cN>) -><cNr>
* $ARGUMENTS$
* <cN> STRING TO BE CHECKED
* <cN> STRING TO BE CHECKED </par>
* $RETURNS$
* <cNr> .T. IF THE STRING IS BYNARY,otherwise .F.
* <cNr> .T. IF THE STRING IS BYNARY,otherwise .F. </par>
* $DESCRIPTION$
* check if the passed string is a bynary number or not
* check if the passed string is a bynary number or not </par>
* $SEEALSO$
* ISOCTAL(),ISDEC(),ISHEXA()
* $INCLUDE$
@@ -45,11 +45,11 @@
* $SYNTAX$
* ISOCTAL(<cN>) -><cNr>
* $ARGUMENTS$
* <cN> STRING TO BE CHECKED
* <cN> STRING TO BE CHECKED </par>
* $RETURNS$
* <cNr> .T. IF THE STRING IS OCTAL;otherwise .F.
* <cNr> .T. IF THE STRING IS OCTAL;otherwise .F. </par>
* $DESCRIPTION$
* check if the passed string is a octal number or not
* check if the passed string is a octal number or not </par>
* $SEEALSO$
* ISBIN(),ISDEC(),ISHEXA()
* $INCLUDE$
@@ -67,11 +67,11 @@
* $SYNTAX$
* ISDEC(<cN>) -><cNr>
* $ARGUMENTS$
* <cN> STRING TO BE CHECKED
* <cN> STRING TO BE CHECKED </par>
* $RETURNS$
* <cNr> .T. IF THE STRING IS DECIMAL;otherwise .F.
* <cNr> .T. IF THE STRING IS DECIMAL;otherwise .F. </par>
* $DESCRIPTION$
* check if the passed string is a decimal number or not
* check if the passed string is a decimal number or not </par>
* $SEEALSO$
* ISOCTAL(),ISBIN(),ISHEXA()
* $INCLUDE$
@@ -89,11 +89,11 @@
* $SYNTAX$
* ISHEXA(<cN>) -><cNr>
* $ARGUMENTS$
* <cN> STRING TO BE CHECKED
* <cN> STRING TO BE CHECKED </par>
* $RETURNS$
* <cNr> .T. IF THE STRING IS HEXA;otherwise .F.
* <cNr> .T. IF THE STRING IS HEXA;otherwise .F. </par>
* $DESCRIPTION$
* check if the passed string is a hexa number or not
* check if the passed string is a hexa number or not </par>
* $SEEALSO$
* ISOCTAL(),ISDEC(),ISBIN()
* $INCLUDE$
@@ -111,12 +111,12 @@
* $SYNTAX$
* DECTOBIN(<cN>) -><cNr>
* $ARGUMENTS$
* <cN> NUMBER TO BE CONVERTED
* <cN> NUMBER TO BE CONVERTED </par>
* $RETURNS$
* <cNr> NUMBER CONVERTED
* <cNr> NUMBER CONVERTED </par>
* $DESCRIPTION$
* This function converts a string <cN> from an decimal value
* to an binary value.
* to an binary value. </par>
* $SEEALSO$
* Dectohexa(),dectooctal()
* $INCLUDE$
@@ -134,12 +134,12 @@
* $SYNTAX$
* DECTOOCTAL(<cN>) -><cNr>
* $ARGUMENTS$
* <cN> NUMBER TO BE CONVERTED
* <cN> NUMBER TO BE CONVERTED </par>
* $RETURNS$
* <cNr> NUMBER CONVERTED
* <cNr> NUMBER CONVERTED </par>
* $DESCRIPTION$
* This function converts a string <cN> from an decimal value
* to an octal value.
* to an octal value. </par>
* $SEEALSO$
* Dectohexa(),dectobin()
* $INCLUDE$
@@ -157,12 +157,12 @@
* $SYNTAX$
* DECTOHEXA(<cN>) -><cNr>
* $ARGUMENTS$
* <cN> NUMBER TO BE CONVERTED
* <cN> NUMBER TO BE CONVERTED </par>
* $RETURNS$
* <cNr> NUMBER CONVERTED
* <cNr> NUMBER CONVERTED </par>
* $DESCRIPTION$
* This function converts a string <cN> from an decimal value
* to an hexadecimal value.
* to an hexadecimal value. </par>
* $SEEALSO$
* Dectobin(),dectooctal()
* $INCLUDE$
@@ -180,12 +180,12 @@
* $SYNTAX$
* BIntODEC(<cN>) -><cNr>
* $ARGUMENTS$
* <cN> NUMBER TO BE CONVERTED
* <cN> NUMBER TO BE CONVERTED </par>
* $RETURNS$
* <cNr> NUMBER CONVERTED
* <cNr> NUMBER CONVERTED </par>
* $DESCRIPTION$
* This function converts a string <cN> from an binary value
* to a numeric decimal value.
* to a numeric decimal value. </par>
* $SEEALSO$
* OctaltoDec(),HexatoDec()
* $INCLUDE$
@@ -203,12 +203,12 @@
* $SYNTAX$
* OCTALTODEC(<cN>) -><cNr>
* $ARGUMENTS$
* <cN> NUMBER TO BE CONVERTED
* <cN> NUMBER TO BE CONVERTED </par>
* $RETURNS$
* <cNr> NUMBER CONVERTED
* <cNr> NUMBER CONVERTED </par>
* $DESCRIPTION$
* This function converts a string <cN> from an octal value
* to a numeric decimal value.
* to a numeric decimal value. </par>
* $SEEALSO$
* BintoDec(),HexatoDec()
* $INCLUDE$
@@ -226,12 +226,12 @@
* $SYNTAX$
* HEXATODEC(<cN>) -><cNr>
* $ARGUMENTS$
* <cN> NUMBER TO BE CONVERTED
* <cN> NUMBER TO BE CONVERTED </par>
* $RETURNS$
* <cNr> NUMBER CONVERTED
* <cNr> NUMBER CONVERTED </par>
* $DESCRIPTION$
* This function converts a string <cN> from an hexadecimal value
* to a numeric decimal value.
* to a numeric decimal value. </par>
* $SEEALSO$
* OctaltoDec(),BintoDec()
* $INCLUDE$

37
harbour/doc/en/ht_dbf.txt
View File

@@ -25,16 +25,16 @@
* $SYNTAX$
* FIELDTYPE(<nFieldNum>) --> cFieldType
* $ARGUMENTS$
* <nFieldNum> Data field , which type need to be determined.
* <nFieldNum> Data field , which type need to be determined. </par>
* $RETURNS$
* FIELDTYPE() returns the character that designates the type of a given field:
* 'C' - character string;
* 'N' - numeric;
* 'L' - logical;
* 'D' - date;
* 'M' - memo.
* FIELDTYPE() returns the character that designates the type of a given field: </par>
* 'C' - character string; </par>
* 'N' - numeric; </par>
* 'L' - logical; </par>
* 'D' - date; </par>
* 'M' - memo. </par>
* $DESCRIPTION$
* This function determines the type of a field, designated by its number.
* This function determines the type of a field, designated by its number. </par>
* $EXAMPLES$
* FUNCTION Main()
* LOCAL i
@@ -44,10 +44,11 @@
* NEXT
* USE
* RETURN NIL
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA-CLIPPER TOOLS compatible
* This function is CA-CLIPPER TOOLS compatible </par>
* $SEEALSO$
* FIELDSIZE(),FIELDDECI()
* $END$
@@ -63,11 +64,11 @@
* $SYNTAX$
* FIELDSIZE(<nFieldNum>) --> nFieldSize
* $ARGUMENTS$
* <nFieldNum> Data field , which size need to be determined.
* <nFieldNum> Data field , which size need to be determined. </par>
* $RETURNS$
* FIELDSIZE() returns the number that designates the size of a given field.
* FIELDSIZE() returns the number that designates the size of a given field. </par>
* $DESCRIPTION$
* This function determines the size of a field, designated by its number.
* This function determines the size of a field, designated by its number. </par>
* $EXAMPLES$
* FUNCTION Main()
* LOCAL i
@@ -77,10 +78,11 @@
* NEXT
* USE
* RETURN NIL
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA-CLIPPER TOOLS compatible
* This function is CA-CLIPPER TOOLS compatible </par>
* $SEEALSO$
* FIELDTYPE(),FIELDDECI()
* $END$
@@ -97,12 +99,12 @@
* FIELDDECI(<nFieldNum>) --> nFieldDeci
* $ARGUMENTS$
* <nFieldNum> Numeric data field , for which number of decimal
* places need to be determined.
* places need to be determined. </par>
* $RETURNS$
* FIELDDECI() returns the numeric value that designates the number
* of decimal places of a given field.
* of decimal places of a given field. </par>
* $DESCRIPTION$
* This function determines the number of decimal places of a given numeric field.
* This function determines the number of decimal places of a given numeric field. </par>
* $EXAMPLES$
* FUNCTION Main()
* LOCAL i
@@ -112,10 +114,11 @@
* NEXT
* USE
* RETURN NIL
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA-CLIPPER TOOLS compatible
* This function is CA-CLIPPER TOOLS compatible </par>
* $SEEALSO$
* FIELDTYPE(),FIELDSIZE()
* $END$

151
harbour/doc/en/ht_doc.txt
View File

@@ -21,22 +21,22 @@
* $ONELINER$
* Html Class
* $SYNTAX$
* oHtml:=THtml():New(<cFile>)
* oHtml:=THtml():New(<cFile>) --> oHtm
* $ARGUMENTS$
* <cFile> Name of the Html file to create
* <cFile> Name of the Html file to create </par>
* $RETURNS$
* An instance of the THtml Class
* <oHtm> An instance of the THtml Class </par>
* $DESCRIPTION$
* THtml() is a class that creates an .html file of the same
* name you pass to the constructor.
* The class methods are as follows:
* New(<cFile>) Create a new instance of the THtml class
* Close() Close the created file
* WriteTitle(<cTitle>) Write the file title
* WritePar(<cPar>) Writes a paragraph
* WriteParBold(<cPar>) Same as WritePar(), but the text is bold
* WriteLink(<cLink>,<cName>) Write a link to another topic
* WriteText(<cText>) Write any text
* name you pass to the constructor. </par>
* The class methods are as follows: </par>
* New(<cFile>) Create a new instance of the THtml class </par>
* Close() Close the created file </par>
* WriteTitle(<cTitle>) Write the file title </par>
* WritePar(<cPar>) Writes a paragraph </par>
* WriteParBold(<cPar>) Same as WritePar(), but the text is bold </par>
* WriteLink(<cLink>,<cName>) Write a link to another topic </par>
* WriteText(<cText>) Write any text </par>
* $EXAMPLES$
* FUNCTION MAIN()
*
@@ -51,13 +51,13 @@
* oHtm:WritePar( "See the Links Above" )
* oHtm:Close()
* RETURN Nil
*
* </par>
* $STATUS$
* R
* $COMPLIANCE$
* This is a new Harbour Tools class
* This is a new Harbour Tools class </par>
* $PLATFORMS$
* ALL
* ALL </par>
* $SEEALSO$
* TCLASS()
* $END$
@@ -71,23 +71,23 @@
* $ONELINER$
* OS/2 Documentation Class
* $SYNTAX$
* oNg:=TOs2():New(<cFile>)
* oNg:=TOs2():New(<cFile>) --> oOs2
* $ARGUMENTS$
* <cFile> Name of the IPF Source file to create
* <cFile> Name of the IPF Source file to create </par>
* $RETURNS$
* An instance of the TOs2 Class
* <oOs2> An instance of the TOs2 Class </par>
* $DESCRIPTION$
* TOs2() is a class that creates the OS/2 IPF Source
* of the same name you pass to the constructor.
* The class methods are as follows:
* New(<cFile>) Create a new instance of the TOs2 class
* Close() Close the created file
* WriteTitle(<cTopic>,<cTitle>) Write the file title
* WritePar(<cPar>) Write a paragraph
* WriteParBold(<cPar>) Same as WritePar(), but the text is bold
* WriteLink(<cLink>) Write a link to another topic
* ScanLink(<clink>) Scan the aLinkRef array for a valid topic
* DosToOs2Text(<cText>) Convert a Dos string to a OS/2 String
* of the same name you pass to the constructor. </par>
* The class methods are as follows: </par>
* New(<cFile>) Create a new instance of the TOs2 class </par>
* Close() Close the created file </par>
* WriteTitle(<cTopic>,<cTitle>) Write the file title </par>
* WritePar(<cPar>) Write a paragraph </par>
* WriteParBold(<cPar>) Same as WritePar(), but the text is bold </par>
* WriteLink(<cLink>) Write a link to another topic </par>
* ScanLink(<clink>) Scan the aLinkRef array for a valid topic </par>
* DosToOs2Text(<cText>) Convert a Dos string to a OS/2 String </par>
* $EXAMPLES$
* FUNCTION MAIN()
*
@@ -102,15 +102,13 @@
* oNg:WritePar( "See the Links Above" )
* oNg:Close()
* RETURN Nil
*
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* This is a new Harbour Tools class
* This is a new Harbour Tools class </par>
* $PLATFORMS$
* ALL
* $FILES$
*
* ALL </par>
* $SEEALSO$
* TNortonGuide()
* $END$
@@ -124,21 +122,21 @@
* $ONELINER$
* Norton Guide Class
* $SYNTAX$
* oNg:=TNortonGuide():New(<cFile>)
* oNg:=TNortonGuide():New(<cFile>) --> oNg
* $ARGUMENTS$
* <cFile> Name of the Ng Source file to create
* <cFile> Name of the Ng Source file to create </par>
* $RETURNS$
* An instance of the TNortonGuide Class
* <oNg> An instance of the TNortonGuide Class </par>
* $DESCRIPTION$
* TNortonGuide() is a class that creates the Norton Guide Source
* Code of the same name you pass to the constructor.
* The class methods are as follows:
* New(<cFile>) Create an instance of the TNortonGuide class
* Close() Close the created file
* WriteTitle(<cTopic>,<cTitle>) Write the file title
* WritePar(<cPar>) Write a paragraph
* WriteParBold(<cPar>) Same as WritePar(), but the text is bold
* WriteLink(<cLink>) Write a link to another topic
* Code of the same name you pass to the constructor. </par>
* The class methods are as follows: </par>
* New(<cFile>) Create an instance of the TNortonGuide class </par>
* Close() Close the created file </par>
* WriteTitle(<cTopic>,<cTitle>) Write the file title </par>
* WritePar(<cPar>) Write a paragraph </par>
* WriteParBold(<cPar>) Same as WritePar(), but the text is bold </par>
* WriteLink(<cLink>) Write a link to another topic </par>
* $EXAMPLES$
* FUNCTION MAIN()
*
@@ -153,12 +151,13 @@
* oNg:WritePar( "See the Links Above" )
* oNg:Close()
* RETURN Nil
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* This is a new Harbour Tools class
* This is a new Harbour Tools class </par>
* $PLATFORMS$
* ALL
* ALL </par>
* $SEEALSO$
* TTroff(),TRtf(),THtml(),TOs2()
* $END$
@@ -172,23 +171,23 @@
* $ONELINER$
* Rtf Class
* $SYNTAX$
* oNg:=TRtf():New(<cFile>)
* oNg:=TRtf():New(<cFile>) --> oRtf
* $ARGUMENTS$
* <cFile> Name of the RTF file to create
* <cFile> Name of the RTF file to create </par>
* $RETURNS$
* An instance of the TRtf Class
* <oRtf> An instance of the TRtf Class </par>
* $DESCRIPTION$
* TRtf() is a class that creates the RTF Documentation Source
* Code of the same name you pass to the constructor.
* The class methods are as follows:
* New(<cFile>) Create a new instance of the TRtf class
* Close() Close the create file
* WriteTitle(<cTopic>,<cTitle>) Write the file title
* WritePar(<cPar>) Write a paragraph
* WriteParBold(<cPar>) Same as WritePar(), but the text is bold
* WriteLink(<cLink>) Write a link to another topic
* WriteHeader() Write the RTF header
* EndPar() Write the end paragraph delimiter
* Code of the same name you pass to the constructor. </par>
* The class methods are as follows: </par>
* New(<cFile>) Create a new instance of the TRtf class </par>
* Close() Close the create file </par>
* WriteTitle(<cTopic>,<cTitle>) Write the file title </par>
* WritePar(<cPar>) Write a paragraph </par>
* WriteParBold(<cPar>) Same as WritePar(), but the text is bold </par>
* WriteLink(<cLink>) Write a link to another topic </par>
* WriteHeader() Write the RTF header </par>
* EndPar() Write the end paragraph delimiter </par>
* $EXAMPLES$
* FUNCTION MAIN()
*
@@ -204,13 +203,13 @@
* oRtf:WritePar( "See the Links Above" ):EndPar()
* oRtf:Close()
* RETURN Nil
*
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* This is a new Harbour Tools class
* This is a new Harbour Tools class </par>
* $PLATFORMS$
* ALL
* ALL </par>
* $SEEALSO$
* TNortonGuide()
* $END$
@@ -224,22 +223,22 @@
* $ONELINER$
* Troff Class
* $SYNTAX$
* oTroff:=TTrof():New(<cFile>)
* oTroff:=TTrof():New(<cFile>) --> oTrf
* $ARGUMENTS$
* <cFile> Name of the Troff file to create
* <cFile> Name of the Troff file to create </par>
* $RETURNS$
* An instance of the TTroff Class
* <oTrf> instance of the TTroff Class </par>
* $DESCRIPTION$
* TTroff() is a class that creates the TROFF Documentation Source
* Code of the same name you pass to the constructor.
* The class methods are as follows:
* Code of the same name you pass to the constructor. </par>
* The class methods are as follows: </par>
* New(<cFile>) Create a new instance of the THtml class
* Close() Close the created file
* WriteTitle(<cTopic>,<cTitle>) Write the file title
* WritePar(<cPar>) Write a paragraph
* WriteParBold(<cPar>) Same as WritePar(), but the text is bold
* WriteLink(<cLink>) Write a link to another topic
* WriteText() Writes text without formating
* Close() Close the created file </par>
* WriteTitle(<cTopic>,<cTitle>) Write the file title </par>
* WritePar(<cPar>) Write a paragraph </par>
* WriteParBold(<cPar>) Same as WritePar(), but the text is bold </par>
* WriteLink(<cLink>) Write a link to another topic </par>
* WriteText() Writes text without formating </par>
* $EXAMPLES$
* FUNCTION MAIN()
*
@@ -254,13 +253,13 @@
* oTroff:Close()
*
* RETURN Nil
*
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* This is a new Harbour Tools class
* This is a new Harbour Tools class </par>
* $PLATFORMS$
* ALL
* ALL </par>
* $SEEALSO$
* TNortonGuide()
* $END$

16
harbour/doc/en/ht_str.txt
View File

@@ -23,22 +23,23 @@
* $SYNTAX$
* StrFormat(<cMask>[, <cPar1>[, <cParn>[, ...]]) --> cString
* $ARGUMENTS$
* <cMask> Holds the mask for the resulting string
* <cMask> Holds the mask for the resulting string </par>
* <cParn> Holds the strings to be inserted in the mask
* maximum 9 of them can be specified.
* maximum 9 of them can be specified. </par>
* $RETURNS$
* <cString> Return the mask with all the parameters inserted.
* <cString> Return the mask with all the parameters inserted. </par>
* $DESCRIPTION$
* String replacment, can be useful when writing international
* apps. You can separate the constant strings from the variable ones.
* Each %1 - %9 marks will be replaced with the appropriate parameter
* from the parameter list.
* Marks can be in any order, and can be duplicated.
* You can print "%" character with "%%".
* from the parameter list. </par>
* Marks can be in any order, and can be duplicated. </par>
* You can print "%" character with "%%". </par>
* $EXAMPLES$
* StrFormat("Please insert disk %1 to drive %2", LTrim(Str(2)), "A:")
* StrFormat("This is %1 from %2", "Victor", "Hungary")
* StrFormat("%2 %1 %2", "Param1", "Param2")
* </fixed>
* $TESTS$
* ? StrFormat("Please insert disk %1 to drive %2", LTrim(Str(2)), "A:")
* ? StrFormat("This is %1 from %2", "Victor", "Hungary")
@@ -50,10 +51,11 @@
* ? StrFormat("%2 - %", "one", "two")
* ? StrFormat("%% - %", "one", "two")
* ? StrFormat("%9 - %", "one", "two")
* </fixed>
* $STATUS$
* Done
* $COMPLIANCE$
* All platforms
* All platforms </par>
* $END$
*/

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

@@ -8,7 +8,7 @@
*
* Copyright 2000 Luiz Rafael Culik <culik@sl.conex.net>
* Documentation for: ABS(),EXP(),LOG(),INT(),MAX()
* MIN()
* MIN(),SQRT()
* See doc/license.txt for licensing terms.
*
*/
@@ -251,3 +251,35 @@
* %
* $END$
*/
/* $DOC$
* $FUNCNAME$
* SQRT()
* $CATEGORY$
* Math
* $ONELINER$
* Calculates the square root of a number
* $SYNTAX$
* SQRT( <nNumber> ) --> <nSqrt>
* $ARGUMENTS$
* <nNumber> Any numeric value
* $RETURNS$
* <nSqrt> Square root of <number>
* $DESCRIPTION$
* This function returns the square rot of <nNumber>. The precsion of
* this evaluation is based solly on the settings of the SET DECIMAL TO
* command.Any negative number passed as <nNumber> will always return a 0.
* $EXAMPLES$
* SET Decimal to 5
* ? SQRT(632512.62541)
* ? SQRT(845414111.91440)
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA-Clipper compliant.
* $PLATFORMS$
* All
* $SEEALSO$
* ROUND()
* $END$
*/

150
harbour/doc/en/menu.txt
View File

@@ -21,55 +21,49 @@
* $ONELINER$
* Allows selection of an element from an array
* $SYNTAX$
* ACHOICE(<nTop>, <nLeft>, <nBottom>, <nRight>,
* <acMenuItems>,
* [<alSelableItems> | <lSelableItems>],
* [<cUserFunction> | <bUserBlock>],
* [<nInitialItem>],
* [<nWindowRow>]) --> nPosition
*
* ACHOICE(<nTop>, <nLeft>, <nBottom>, <nRight>, <acMenuItems>, [<alSelableItems> | <lSelableItems>], [<cUserFunction> | <bUserBlock>], [<nInitialItem>], [<nWindowRow>]) --> nPosition
* $ARGUMENTS$
* <nTop> - topmost row used to display array (default 0)
* <nLeft> - leftmost row used to display array (default 0)
* <nBottom> - bottommost row used to display array (default MAXROW())
* <nRight> - rightmost row used to display array (default MAXCOL())
* <acMenuItems> - the character array of items from which to select
* <nTop> - topmost row used to display array (default 0) </par>
* <nLeft> - leftmost row used to display array (default 0) </par>
* <nBottom> - bottommost row used to display array (default MAXROW()) </par>
* <nRight> - rightmost row used to display array (default MAXCOL()) </par>
* <acMenuItems> - the character array of items from which to select </par>
* <alSelableItems> - an array of items, either logical or character,
* which is used to determine if a particular item
* may be selected. If the type of a given item is
* character, it is macro evaluated, and the result
* is expected to be a logical. A value of .T. means
* that the item may be selected, .F. that it may not.
* (See next argument: lSelectableItems)
* (See next argument: lSelectableItems) </par>
* <lSelableItems> - a logical value which is used to apply to all
* items in acMenuItems. If .T., all items may be
* selected; if .F., none may be selected.
* (See previous argument: alSelectableItems)
* Default .T.
* Default .T. </par>
* <cUserFunction> - the name of a function to be called which may
* affect special processing of keystrokes. It is
* specified without parentheses or parameters.
* When it is called, it will be supplied with the
* parameters: nMode, nCurElement, and nRowPos.
* Default NIL.
* Default NIL. </par>
* <bUserBlock> - a codeblock to be called which may
* affect special processing of keystrokes. It
* should be specified in the form
* {|nMode, nCurElemenet, nRowPos| ;
* MyFunc(nMode, nCurElemenet, nRowPos) }.
* Default NIL.
* Default NIL. </par>
* <nInitialItem> - the number of the element to be highlighted as
* the current item when the array is initially
* displayed. 1 origin. Default 1.
* displayed. 1 origin. Default 1. </par>
* <nWindowRow> - the number of the window row on which the initial
* item is to be displayed. 0 origin. Default 0.
* item is to be displayed. 0 origin. Default 0. </par>
* $RETURNS$
* <nPosition> - the number of the item to be selected, or 0 if the
* selection was aborted.
* <nPosition> - the number of the item to be selected, or 0 if the
* selection was aborted. </par>
* $DESCRIPTION$
* Allows selection of an element from an array.
* Allows selection of an element from an array. </par>
* Please see standard Clipper documentation for ACHOICE for
* additional detail.
* additional detail. </par>
* $EXAMPLES$
* aItems := { "One", "Two", "Three" }
* nChoice := ACHOICE( 10, 10, 20, 20, aItems )
@@ -79,9 +73,9 @@
* ? "You chose element " + LTRIM( STR( nChoice ) )
* ?? " which has a value of " + aItems[ nChoice ]
* ENDIF
*
* </fixed>
* $SEEALSO$
*
* MENU TO
* $END$
*/
@@ -96,19 +90,19 @@
* __AtPrompt( <nRow>, <nCol>, <cPrompt>, [<xMsg>] ) --> .F.
* $ARGUMENTS$
* <nRow> is the row number to display the menu <cPrompt>. Value could
* range from zero to MAXROW().
* range from zero to MAXROW(). </par>
*
* <nCol> is the column number to display the menu <cPrompt>. Value
* could range from zero to MAXCOL().
* could range from zero to MAXCOL(). </par>
*
* <cPrompt> is the menu item character string to display.
* <cPrompt> is the menu item character string to display. </par>
*
* <xMsg> define a message to display each time this menu item is
* highlighted. <xMsg> could be a character string or code block that
* is evaluated to a character string. If <xMsg> is not specified or
* got the wrong type, an empty string ("") would be used.
* got the wrong type, an empty string ("") would be used. </par>
* $RETURNS$
* __AtPrompt() always return .F.
* __AtPrompt() always return .F. </par>
* $DESCRIPTION$
* With __AtPrompt() you define and display a menu item, each call to
* __AtPrompt() add another item to the menu, to start the menu itself
@@ -116,10 +110,10 @@
* define any row and column combination and they will be displayed at
* the order of definition. After each call to __AtPrompt(), the cursor
* is placed one column to the right of the last text displayed, and
* ROW() and COL() are updated.
* ROW() and COL() are updated. </par>
*
* @...PROMPT command is preprocessed into __AtPrompt() function during
* compile time.
* compile time. </par>
* $EXAMPLES$
* // display a two line menu with status line at the bottom
* // let the user select favorite day
@@ -135,12 +129,13 @@
* CASE nChoice == 2 // user select 2nd menu item
* ? "Just another day for some"
* ENDCASE
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* CA-Clipper array is limited to 4096 items, and therefor 4096 menu
* items are the maximum that could be defined per one menu, Harbour
* does not have this limit (not that you'll ever need that).
* does not have this limit (not that you'll ever need that). </par>
* $SEEALSO$
* ACHOICE(),MENU TO,SET MESSAGE,SET INTENSITY,SET WRAP,__MENUTO()
* $END$
@@ -157,19 +152,19 @@
* @ <nRow>, <nCol> PROMPT <cPrompt> [MESSAGE <xMsg>]
* $ARGUMENTS$
* <nRow> is the row number to display the menu <cPrompt>. Value could
* range from zero to MAXROW().
* range from zero to MAXROW(). </par>
*
* <nCol> is the column number to display the menu <cPrompt>. Value
* could range from zero to MAXCOL().
* could range from zero to MAXCOL(). </par>
*
* <cPrompt> is the menu item character string to display.
* <cPrompt> is the menu item character string to display. </par>
*
* <xMsg> define a message to display each time this menu item is
* highlighted. <xMsg> could be a character string or code block that
* is evaluated to a character string. If <xMsg> is not specified or
* got the wrong type, an empty string ("") would be used.
* got the wrong type, an empty string ("") would be used. </par>
* $RETURNS$
* @...Prompt always return .F.
* @...Prompt always return .F. </par>
* $DESCRIPTION$
* With @...Prompt you define and display a menu item, each call to
* @...Prompt add another item to the menu, to start the menu itself
@@ -177,10 +172,10 @@
* define any row and column combination and they will be displayed at
* the order of definition. After each call to @...Prompt, the cursor
* is placed one column to the right of the last text displayed, and
* ROW() and COL() are updated.
* ROW() and COL() are updated. </par>
*
* @...PROMPT command is preprocessed into __AtPrompt() function during
* compile time.
* compile time. </par>
* $EXAMPLES$
* // display a two line menu with status line at the bottom
* // let the user select favorite day
@@ -196,12 +191,13 @@
* CASE nChoice == 2 // user select 2nd menu item
* ? "Just another day for some"
* ENDCASE
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* CA-Clipper array is limited to 4096 items, and therefor 4096 menu
* items are the maximum that could be defined per one menu, Harbour
* does not have this limit (not that you'll ever need that).
* does not have this limit (not that you'll ever need that). </par>
* $SEEALSO$
* ACHOICE(),MENU TO,SET MESSAGE,SET INTENSITY,SET WRAP,__MENUTO()
* $END$
@@ -217,54 +213,54 @@
* $SYNTAX$
* __MenuTo( <bBlock>, <cVariable> ) --> nChoice
* $ARGUMENTS$
* <bBlock> is a set/get code block for variable named <cVariable>.
* <bBlock> is a set/get code block for variable named <cVariable>. </par>
*
* <cVariable> is a character string that contain the name of the
* variable to hold the menu choices, if this variable does not exist
* a PRIVATE variable with the name <cVariable> would be created to
* hold the result.
* hold the result. </par>
* $RETURNS$
* __MenuTo() return the number of select menu item, or 0 if there was
* no item to select from or if the user pressed the Esc key.
* no item to select from or if the user pressed the Esc key. </par>
* $DESCRIPTION$
* __MenuTo() invoked the menu define by previous __AtPrompt() call
* and display a highlight bar that the user can move to select an
* option from the menu. If <cVariable> does not exist or not visible,
* a PRIVATE variable named <cVariable> is created and hold the current
* menu selection. If there is a variable named <cVariable>, its value
* is used to select the first highlighted item.
* is used to select the first highlighted item. </par>
*
* Menu prompts and messages are displayed in current Standard color,
* highlighted bar is displayed using current Enhanced color.
* highlighted bar is displayed using current Enhanced color. </par>
*
* Pressing the arrow keys move the highlighted bar. When a menu item
* is highlighted the message associated with it is displayed on the
* line specified with SET MESSAGE. If SET WRAP is ON and the user
* press UP arrow while on the first selection the last menu item is
* highlighted, if the user press Down arrow while on the last item,
* the first item is highlighted.
* the first item is highlighted. </par>
*
* Following are active keys that handled by __MenuTo():
* -----------------------------------------------------
*
* Up - Move to previous item
* Down - Move to next item
* Left - Move to previous item
* Right - Move to next item
* Home - Move to the first item
* End - Move to the last item
* Page-Up - Select menu item, return position
* Page-Down - Select menu item, return position
* Enter - Select menu item, return position
* Esc - Abort selection, return 0
* First letter - Select next menu with the same first letter,
* Following are active keys that handled by __MenuTo(): </par>
* ----------------------------------------------------- </par>
* <table>
* Up Move to previous item
* Down Move to next item
* Left Move to previous item
* Right Move to next item
* Home Move to the first item
* End Move to the last item
* Page-Up Select menu item, return position
* Page-Down Select menu item, return position
* Enter Select menu item, return position
* Esc Abort selection, return 0
* First letter Select next menu with the same first letter,
* | return this item position.
*
* </table>
* upon exit the cursor is placed at MAXROW()-1, 0
* __MenuTo() can be nested without loosing the previous prompts.
* __MenuTo() can be nested without loosing the previous prompts. </par>
*
* MENU TO command is preprocessed into __MenuTo() function during
* compile time.
* compile time. </par>
* $EXAMPLES$
* // display menu item on each screen corner and let user select one
* CLS
@@ -281,10 +277,11 @@
* else
* ?? "Selected option is", nChoice
* endif
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* This command is CA-Clipper compliant
* This command is CA-Clipper compliant </par>
* $SEEALSO$
* @...PROMPT,ACHOICE(),SET MESSAGE,SET INTENSITY,SET WRAP,__ATPROMPT()
* $END$
@@ -303,31 +300,31 @@
* <cVariable> is a character string that contain the name of the
* variable to hold the menu choices, if this variable does not exist
* a PRIVATE variable with the name <cVariable> would be created to
* hold the result.
* hold the result. </par>
* $RETURNS$
* Menu To return the number of select menu item, or 0 if there was
* no item to select from or if the user pressed the Esc key.
* no item to select from or if the user pressed the Esc key. </par>
* $DESCRIPTION$
* Menu To() invoked the menu define by previous __AtPrompt() call
* and display a highlight bar that the user can move to select an
* option from the menu. If <cVariable> does not exist or not visible,
* a PRIVATE variable named <cVariable> is created and hold the current
* menu selection. If there is a variable named <cVariable>, its value
* is used to select the first highlighted item.
* is used to select the first highlighted item. </par>
*
* Menu prompts and messages are displayed in current Standard color,
* highlighted bar is displayed using current Enhanced color.
* highlighted bar is displayed using current Enhanced color. </par>
*
* Pressing the arrow keys move the highlighted bar. When a menu item
* is highlighted the message associated with it is displayed on the
* line specified with SET MESSAGE. If SET WRAP is ON and the user
* press UP arrow while on the first selection the last menu item is
* highlighted, if the user press Down arrow while on the last item,
* the first item is highlighted.
*
* Following are active keys that handled by Menu To:
* -----------------------------------------------------
* the first item is highlighted. </par>
*
* Following are active keys that handled by Menu To: </par>
* ----------------------------------------------------- </par>
* <table>
* Up - Move to previous item
* Down - Move to next item
* Left - Move to previous item
@@ -340,12 +337,12 @@
* Esc - Abort selection, return 0
* First letter - Select next menu with the same first letter,
* | return this item position.
*
* </table>
* upon exit the cursor is placed at MAXROW()-1, 0
* Menu To can be nested without loosing the previous prompts.
* Menu To can be nested without loosing the previous prompts. </par>
*
* MENU TO command is preprocessed into __MenuTo() function during
* compile time.
* compile time. </par>
* $EXAMPLES$
* // display menu item on each screen corner and let user select one
* CLS
@@ -362,10 +359,11 @@
* else
* ?? "Selected option is", nChoice
* endif
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* This command is CA Clipper compliant
* This command is CA Clipper compliant </par>
* $SEEALSO$
* @...PROMPT,ACHOICE(),SET MESSAGE,SET INTENSITY,SET WRAP,__ATPROMPT()
* $END$

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

@@ -26,8 +26,11 @@
* AFields(<aNames>[,<aTypes>][,<aLen>][,<aDecs>]) --> <nFields>
* $ARGUMENTS$
* <aNames> Array of field names
* <aTypes> Array of field names
* <aLens> Array of field names
* <aDecs> Array of field names
* $RETURNS$
* <nFields> Number od fields in a database or work area
@@ -59,8 +62,7 @@
* R
* $COMPLIANCE$
* AFIELDS() is fully CA-Clipper compliant.
* $SEEALSO$
* $END$
* $END$
*/
/* $DOC$
@@ -112,10 +114,15 @@
* [<lRest>] ) --> NIL
* $ARGUMENTS$
* <bBlock> Operation that is to be performed
* <bFor> Code block for the For condition
* <bWhile> Code block for the WHILE condition
* <nNext> Number of NEXT records to process
* <nRecord> Record number to work on exactly
* <lRest> Toggle to rewind record pointer
* $RETURNS$
* DBEVAL() always returns NIL
@@ -219,7 +226,7 @@
* $ONELINER$
* Appends a new record to a database file.
* $SYNTAX$
* DbAppend(<<lLock>]) --> NIL
* DbAppend(<lLock>]) --> NIL
* $ARGUMENTS$
* <lLock> Toggle to release record locks
* $RETURNS$
@@ -233,8 +240,8 @@
* with NULL bytes.The header of the database is not updated until
* the record is flushed from the buffer and the contents are
* written to the disk.
* Under a networking enviroment, DBAPPEND() performs an addi-
* tional operation: It attrmps to lock the newly added record. If
* Under a networking enviroment, DBAPPEND() performs an additional
* operation: It attrmps to lock the newly added record. If
* the database file is currently locked or if a locking assignment
* if made to LASTREC()+1,NETERR() will return a logical true (.T.)
* immediately after the DBAPPEND() function. This function does
@@ -263,7 +270,7 @@
/* $DOC$
* $FUNCNAME$
* DBCLEARFILTER()
* DBCLEARFILTER()
* $CATEGORY$
* DATA BASE
* $ONELINER$
@@ -273,7 +280,7 @@
* $RETURNS$
* DbClearFilTer() always returns NIL
* $DESCRIPTION$
* This function clears any active filter condiction
* This function clears any active filter condiction
* for the current or selected work area.
* $EXAMPLES$
* Function Main()
@@ -300,7 +307,7 @@
/* $DOC$
* $FUNCNAME$
* DBCLOSEALL()
* DBCLOSEALL()
* $CATEGORY$
* DATA BASE
* $ONELINER$
@@ -541,10 +548,14 @@
* [<cAlias>]) --> NIL
* $ARGUMENTS$
* <cDatabase> Name of database to be create
* <aStruct> Name of a multidimensional array that contains the a database
* structure
* <cDriver> Name of the RDD
* <lOpen> Toggle to Open the create File
* <cAlias> Name of database Alias
* $RETURNS$
* DBCREATE() always returns NIL.
@@ -947,7 +958,9 @@
* DBSEEK(<expKey>, [<lSoftSeek>],[<lFindLast>]) --> lFound
* $ARGUMENTS$
* <expKey> Any expression
* <lSoftSeek> Toggle SOFTSEEK condition
* <lFindLast> is an optional logical value that set the current
* record position to the last record if successful
* $RETURNS$
@@ -1123,6 +1136,7 @@
* DBSETFILTER(<bCondition>, [<cCondition>]) --> NIL
* $ARGUMENTS$
* <bCondition> Code block expression for filtered evaluation.
* <cCondition> Optional character expression of code block.
* $RETURNS$
* DBSETFILTER() always returns NIL.
@@ -1270,10 +1284,15 @@
* [<lShared>], [<lReadonly>]) --> NIL
* $ARGUMENTS$
* <lNewArea> A optional logical expression for the new work area
* <cDriver> Database driver name
* <cName> File Name
* <xcAlias> Alias name
* <lShared> Shared/exclusive status flag
* <lReadonly> Read-write status flag.
* $RETURNS$
* DBUSEAREA() always returns NIL.
@@ -1653,7 +1672,7 @@
* $SYNTAX$
* FOUND() --> lSuccess
* $ARGUMENTS$
*
* None.
* $RETURNS$
* <lSuccess> A logical true (.T.) is successful;otherwise, false (.F.)
* $DESCRIPTION$

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

@@ -22,7 +22,9 @@
*
* Copyright 2000 Luiz Rafael Culik <Culik@sl.conex.net>
* Documentation for: SET WRAP,SET DEFAULT,SET MESSAGE
* Documentation for: SET PATH
* Documentation for: SET PATH,SET INTENSITY,SET ALTERNATE
* Documentation for: SET CENTURY,SET DATE,SET CONSOLE
* Documentation for: SET EPOCH
*
* See doc/license.txt for licensing terms.
*
@@ -797,7 +799,7 @@
* $ONELINER$
* Specifies a search path for opening files
* $SYNTAX$
* SET WRAP TO [<cPath>] </par>
* SET PATH TO [<cPath>] </par>
* $ARGUMENTS$
* <cPath> Search path for files </par>
* $DESCRIPTION$
@@ -818,3 +820,153 @@
* SET DEFAULT,CURDIR(),SET()
* $END$
*/
/* $DOC$
* $COMMANDNAME$
* SET INTENSITY
* $CATEGORY$
* Command
* $ONELINER$
* Toggles the enhaced display of PROMPT's and GETs.
* $SYNTAX$
* SET INTENSITY [ON / OFF] [(<lInte>)]
* $ARGUMENTS$
* <lInte> Logical expression for toggle command
* $DESCRIPTION$
* This command set the field input color and @...PROMPT menu color
* to either highlighted (inverse video) or normal color. The default
* condition is ON (highlighted).
* $EXAMPLES$
* SET INTENSITY ON
* $STATUS$
* R
* $COMPLIANCE$
* This command is Ca-Clipper Compliant. </par>
* $SEEALSO$
* @...GET,@...PROMPT,@...SAY,SET()
* $END$
*/
/* $DOC$
* $COMMANDNAME$
* SET ALTERNATE
* $CATEGORY$
* Command
* $ONELINER$
* Toggle and echos output to an alternate file
* $SYNTAX$
* SET ALTERNATE to <cFile> [ADDITIVE]
* SET ALTERNATE [ON / OFF] [(<lAlter>)]
* $ARGUMENTS$
* <cFile> Name of alternate file.
*
* <lAlter> Logical expression for toggle </par>
* $DESCRIPTION$
* This command toggles and output console information to the alternate
* file <cFile>,provided that the command is toggled on or the condition
* <lAlter> is set to a logical true (.T.). If <cFile> does not has a
* file extension, .TXT will be assumed.The file name may optionally
* have a drive letter and/or directory path.If none is speficied, the
* current drive and directory will be used.
* If the ALTERNATE file is created but no ALTERNATE ON command is
* issued,nothing will be echoed to the file.
* If ADDITIVE clause is used,then the information will be appended
* to the existing alternate file.Otherwise,a new file will be created
* with the specified name (or an existing one will be overwritten) and
* the information will be appended to the file.The default is to create
* a new file.
* A SET ALTERNATE TO command will close the alternate file
* $EXAMPLES$
* SET ALTERNATE TO test.txt
* SET ALTERNATE ON
* ? 'Harbour'
* ? "is"
* ? "Power"
* SET ALTERNATE TO
* SET ALTERNATE OFF
* $STATUS$
* R
* $COMPLIANCE$
* This command is Ca-Clipper Compliant. </par>
* $SEEALSO$
* CLOSE,SET PRINTER,SET CONSOLE,SET()
* $END$
*/
/* $DOC$
* $COMMANDNAME$
* SET CENTURY
* $CATEGORY$
* Command
* $ONELINER$
* Toggle the century digits in all ates display
* $SYNTAX$
* SET CENTURY [ON / OFF] [(<lCent>)]
* $ARGUMENTS$
* <lCent> Logical expression for toggle </par>
* $DESCRIPTION$
* This command allows the input and display of dates with the century
* prefix.It will be in the standart MM/DD/YYYY format unless specified
* by the SET DATE command or SET() function.If <lCent> is a logical
* true (.T.),the command will be set on;otherwise, the command will
* be set off
* $EXAMPLES$
* SET CENTURY ON
* ? DATE()
* SET CENTURY OFF
* $STATUS$
* R
* $COMPLIANCE$
* This command is Ca-Clipper compliant
* $SEEALSO$
* SET DATE,SET EPOCH,CTOD(),DATE(),DTOC(),SET()
* $END$
*/
/* $DOC$
* $COMMANDNAME$
* SET DATE
* $CATEGORY$
* Command
* $ONELINER$
* Assings a date format or chooses a predefined date data set.
* $SYNTAX$
* SET DATE FORMAT [TO] <cFormat>
* SET DATE [TO] [ ANSI / BRITISH / FRENCH / GERMAN / ITALIAN / JAPAN /
* USA / AMERICAN]
* $ARGUMENTS$
* <cFormat> Keyword for date format
* $DESCRIPTION$
* This command sets the date format for function display purposes.
* If specified,<cFormat> may be a customized date format in which the
* letters d,m and y may be used to desing a date format.The default
* is an AMERICAN date format;specifying no parameters will set the
* date format to AMERICAN.Below is a table of the varius predefined
* dates formats.
*
* <table>
* Syntax Date Format
* ANSI yy.mm.dd
* BRITISH dd/mm/yy
* FRENCH dd/mm/yy
* GERMAN dd.mm.yy
* ITALIAN dd-mm-yy
* JAPAN yy.mm.dd
* USA mm-dd-yy
* AMERICAN mm/dd/yy
* </table>
* $EXAMPLES$
* SET DATE JAPAN
* ? DATE()
* SET DATE GERMAN
* ? Date()
* $TESTS$
* See tests/dates.prg
* $STATUS$
* R
* $COMPLIANCE$
* This command is Ca-Clipper compliant
* $SEEALSO$
* SET DATE,SET EPOCH,CTOD(),DATE(),DTOC(),SET()
* $END$
*/

11
harbour/doc/en/terminal.txt
View File

@@ -106,7 +106,6 @@
* $PLATFORMS$
* __XSaveScreen() is part of the GT API, and supported only by some
* platforms. </par>
* $FILES$
* $SEEALSO$
* RESTORE SCREEN,__XRESTSCREEN(),__XSAVESCREEN()
* $END$
@@ -193,7 +192,6 @@
* $PLATFORMS$
* Rest Screen is part of the GT API, and supported only by some
* platforms. </par>
* $FILES$
* $SEEALSO$
* __XRESTSCREEN(),SAVE SCREEN,__XSAVESCREEN()
* $END$
@@ -281,12 +279,12 @@
* displayed. </par>
*
* ON: Only the first four valid <aOptions> are taken. </par>
* OFF: <aOptions> could contain as many as needed options. </par>
* OFF: <aOptions> could contain as many as needed options.
*
* <cColorNorm> is a Harbour extension, or at least un-documented
* in Clipper 5.2 NG. </par>
* in Clipper 5.2 NG.
*
* <nDelay> is a Harbour extension. </par>
* <nDelay> is a Harbour extension.
* $SEEALSO$
* @...PROMPT,MENU TO,STDOUT(),__NONOALERT()
* $END$
@@ -317,7 +315,6 @@
* R
* $COMPLIANCE$
* __NONOALERT() is an undocumented CA-Clipper function </par>
* $SEEALSO$
* $END$
*/
@@ -386,7 +383,7 @@
* ? hb_ColorIndex( "W/N, N/W", CLR_ENHANCED ) // "N/W"
* </fixed>
* $TESTS$
* see the regression test suit for comprehensive tests. </par>
* see the regression test suit for comprehensive tests.
* </fixed>
* $STATUS$
* R

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

@@ -161,7 +161,7 @@
* that match passed skeleton should be either included in deletion
* (if .T.) or excluded from deletion (if .F.) </par>
* $RETURNS$
* Nothing
* Nothing </par>
* $DESCRIPTION$
* This function releases values stored in memory variables. It shouldn't
* be called directly, it should be placed into RELEASE ALL command. </par>
@@ -206,8 +206,6 @@
* function/procedure </par>
* HB_MV_PRIVATE_LOCAL =for private variables declared in current
* function/procedure </par>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* PROCEDURE MAIN()
@@ -241,7 +239,7 @@
* $COMPLIANCE$
* This function is a Harbour Extension </par>
* $SEEALSO$
* include/hbmemvar.ch </par>
* include/hbmemvar.ch
* $END$
*/