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

20000429-02:29 GMT-8 Brian Hays <bhays@abacuslaw.com>

Browse Source
This commit is contained in:
Brian Hays
2000-04-29 09:31:12 +00:00
parent bfbc261063
commit fc6511db7b
7 changed files with 377 additions and 363 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
harbour/ChangeLog
View File

@@ -1,3 +1,12 @@
20000429-02:29 GMT-8 Brian Hays <bhays@abacuslaw.com>
* nation.txt
* misc.txt
* memo.txt
* input.txt
* file.txt
* math.txt
20000429-09:50 GMT+1 Victor Szakats <info@szelvesz.hu>
* bin/bld.*

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

@@ -27,16 +27,16 @@
* $SYNTAX$
* FOPEN( <cFile>, [<nMode>] ) --> nHandle
* $ARGUMENTS$
* <cFile> Name of file to open
* <cFile> Name of file to open.
* <nMode> Dos file open mode
* <nMode> Dos file open mode.
* $RETURNS$
* <nHandle> a DOS file handle
* <nHandle> A file handle.
* $DESCRIPTION$
* This function opens a file expressed as <cFile> and returns a DOS
* file handle to be used with other low-level file functions.The
* This function opens a file expressed as <cFile> and returns a
* file handle to be used with other low-level file functions. The
* value of <nMode> 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 file open modes are as follows:
* <table>
* nMode fileio.ch Meaning
@@ -50,23 +50,23 @@
* 64 FO_DENYNONE Share read only
* </table>
* 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
* 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.
* on this function. Directory names and paths must be specified along
* 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'
* IF (nH:=FOPEN('X.TXT',66) < 0
* ? 'File can't be opened'
* ENDIF
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA-Clipper compliant
* This function is CA-Clipper compliant
* $FILES$
* Library is rtl
* Header is fileio.ch
@@ -81,47 +81,47 @@
* $CATEGORY$
* Low level
* $ONELINER$
* Creates a file
* Creates a file.
* $SYNTAX$
* FCREATE( <cFile>, [<nAttribute>] ) --> nHandle
* $ARGUMENTS$
* <cFile> is the name of the file to create.
* <cFile> is the name of the file to create.
*
* <nAttribute> Numeric code for the DOS file attribute
* <nAttribute> Numeric code for the file attributes.
* $RETURNS$
* <nHandle> Numeric expression
* <nHandle> Numeric file handle to be used in other operations.
* $DESCRIPTION$
* This function creates a new file with a filename of <cFile>. The
* default value of <nAttribute> is 0 and is used to set the DOS
* default value of <nAttribute> is 0 and is used to set the
* attribute byte for the file being created by this function.
* The return value will be DOS file handle that is associated
* The return value will be a file handle that is associated
* with the new file. This number will be between zero to 65,535,
* inclusive. If an error occurs, the return value of this function
* will be -1.
* will be -1.
*
* If the file <cFile> already exists, the existing file will be
* truncated to a file lenght of 0 bytes.
* truncated to a file length of 0 bytes.
* If specified, the folowing table shows the value for <nAttribute>
* If specified, the following table shows the value for <nAttribute>
* and their related meaning to the file <cFile> being created by
* this Function.
* this function.
* <table>
* <nAttribute> fileio.ch Attribute
*
* 0 FC_NORMAL Normal/Default,Read/Write
* 1 FC_READONLY Read-only file attribute is set
* 2 FC_HIDDEN Hidden,Excluded from normal DIR search
* 2 FC_HIDDEN Hidden,Excluded from normal DIR search
* 4 FC_SYSTEM Create,Excluded from normal DIR search
* </table>
* $EXAMPLES$
* IF (nh:=FCREATE("TEST.TXT") <0
* ? "Can not create file"
* ? "Cannot create file"
* ENDIF
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA-Clipper compliant
* This function is CA-Clipper compliant.
* $FILES$
* Library is rtl
* Header is fileio.ch
@@ -140,36 +140,36 @@
* $SYNTAX$
* FREAD( <nHandle>, @<cBuffer>, <nBytes> ) --> nBytes
* $ARGUMENTS$
* <nHandle> Dos file handle
* <nHandle> Dos file handle
* <cBufferVar> Character expression passed by reference
* <cBufferVar> Character expression passed by reference.
* <nBytes> Number of bytes to read.
* <nBytes> Number of bytes to read.
* $RETURNS$
* <nBytes> the number of bytes successfyly read from the file
* <nHandle>
* <nBytes> the number of bytes successfully read from the file.
* <nHandle>
* $DESCRIPTION$
* This function reads the characters from a DOS file whose file handle
* is <nHandle> into it character memory variable expressed as <cBuffer>.
* This function reads the characters from a file whose file handle
* is <nHandle> into a character memory variable expressed as <cBuffer>.
* The function returns the number of bytes successfully read into
* <cBuffer>.
* <cBuffer>.
* The value of <nHandle> is obtained from either it call to the FOPEN()
* or the FCREATE() function.
* The value of <nHandle> is obtained from either a call to the FOPEN()
* or the FCREATE() function.
* The <cBuffer> expression is passed by reference and must be defined
* before this function is called. It also must be at least the same
* length as <nBytes>.
* length as <nBytes>.
* <nBytes> is the number of bytes to read, starting at the current DOS
* <nBytes> is the number of bytes to read, starting at the current
* file pointer position. If this function is successful in reading
* the characters from the file, the length of <cBuffer> or the number
* of bytes specified in <nBytes> will be the value returned. The current
* DOS file pointer advances the number of bytes read with each succe-
* ssive read.The return value is the number of byte successfully read
* from the file <nHandle>. If a 0 is returned, or if the number of
* file pointer advances the number of bytes read with each successive
* read. The return value is the number of bytes successfully read
* from the file. If a 0 is returned, or if the number of
* bytes read matches neither the length of <cBuffer> nor the specified
* value in <nBytes> an end-of-file condition has been reached.
* value in <nBytes> an end-of-file condition has been reached.
* $EXAMPLES$
* cBuffer:=SPACE(500)
* IF (nH:=FOPEN('X.TXT))>0
@@ -181,8 +181,8 @@
* $STATUS$
* R
* $COMPLIANCE$
* This function is not CA-Clipper compliant since may can read
* strings greather the 65K depending of platform.
* This function is CA-Clipper compliant, but also extends the possible
* buffer size to strings greater than 65K (depending on platform).
* $FILES$
* Library is Rtl
* $SEEALSO$
@@ -196,35 +196,35 @@
* $CATEGORY$
* Low level
* $ONELINER$
* Writes characters to a file
* Writes characters to a file.
* $SYNTAX$
* FWRITE( <nHandle>, <cBuffer>, [<nBytes>] ) --> nBytesWritten
* $ARGUMENTS$
* <nHandle> DOS file handle number.
* <nHandle> DOS file handle number.
* <cBuffer> Character expression to be written.
* <cBuffer> Character expression to be written.
* <nBytes> The number of bytes to write.
* <nBytes> The number of bytes to write.
* $RETURNS$
* <nBytesWritten> the number of bytes successfully written.
* <nBytesWritten> the number of bytes successfully written.
* $DESCRIPTION$
* This function writes the contents of <cBuffer> to the file designated
* by its file handle <nHandle>. If used, <nBytes> is the number of
* bytes in <cBuffer> to write.
* bytes in <cBuffer> to write.
* The returned value is the number of bytes successfully written to the
* 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( <cBuffer>) or <nBytes>.
* by FWRITE() is equal to either LEN( <cBuffer>) or <nBytes>.
* The value of <cBuffer> is the string or variable to be written to the
* open DOS file <nHandle>.
* open DOS file <nHandle>.
* The value of <nBytes> is the number of bytes to write out to the file.
* The disk write begins with the current file position in <nHandle>. If
* this variable is not used, the entire contents of <cBuffer> 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
@@ -236,7 +236,7 @@
* R
* $COMPLIANCE$
* This function is not CA-Clipper compatile since
* it can writes strings greather the 64K
* it can writes strings greather the 64K
* $FILES$
* Library is Rtl
* $SEEALSO$
@@ -255,9 +255,9 @@
* FERROR() --> <nErrorCode>
* $RETURNS$
* <nErrorCode> Value of the DOS error last encountered by a
* low-level file function.
* low-level file function.
*
* FERROR() Return Values
* FERROR() Return Values
*
* <table>
* Error Meaning
@@ -283,7 +283,7 @@
* 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"
* //
@@ -295,7 +295,7 @@
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA-Clipper compatible
* This function is CA-Clipper compatible
* $FILES$
* Library is Rtl
* $SEEALSO$
@@ -313,14 +313,14 @@
* $SYNTAX$
* FCLOSE( <nHandle> ) --> <lSuccess>
* $ARGUMENTS$
* <nHandle> DOS file handle
* <nHandle> DOS file handle
* $RETURNS$
* <lSuccess> Logical TRUE (.T.) or FALSE (.F.)
* <lSuccess> Logical TRUE (.T.) or FALSE (.F.)
* $DESCRIPTION$
* This function closes an open file with a dos file handle
* of <nHandle> and writes the associated DOS buffer to the
* disk. The <nHandle> value is derived from the FCREATE()
* or FOPEN() function.
* or FOPEN() function.
* $EXAMPLES$
* nHandle:=FOPEN('x.txt')
* ? FSEEK(nHandle0,2)
@@ -329,7 +329,7 @@
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA-Clipper compliant
* This function is CA-Clipper compliant
* $FILES$
* Library is Rtl
* $SEEALSO$
@@ -347,23 +347,23 @@
* $SYNTAX$
* FERASE( <cFile> ) --> nSuccess
* $ARGUMENTS$
* <cFile> Name of file to erase.
* <cFile> Name of file to erase.
* $RETURNS$
* <nSuccess> 0 if successful, -1 if not
* <nSuccess> 0 if successful, -1 if not
* $DESCRIPTION$
* This function deletes the file specified in <cFile> from the disk.
* No extensions are assumed. The drive and path my be included in
* <cFile>; 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.
* obtained by calling the FERROR() function.
*
* Note: Any file to be removed by FERASE() must still be closed.
* Note: Any file to be removed by FERASE() must still be closed.
*
* $EXAMPLES$
* IF (FERASE("TEST.TXT")==0)
@@ -375,7 +375,7 @@
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA-Clipper Compatible
* This function is CA-Clipper Compatible
* $FILES$
* Library is Rtl
* $SEEALSO$
@@ -393,33 +393,33 @@
* $SYNTAX$
* FRENAME( <cOldFile>, <cNewFile> ) --> nSuccess
* $ARGUMENTS$
* <cOldFile> Old filenarne to he changed
* <cOldFile> Old filenarne to he changed
* <cNewFile> New filename
* <cNewFile> New filename
* $RETURNS$
* <nSuccess> 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 <cOldFile> to <cNewFile>.
* A filename and/or directory name may be specified for either para-
* meter. However, if a path is supplied as part of <cNewFile> and
* this path is different from either the path specified in <cOldFile>
* 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 <cOldFile>. 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 <cNewFile> 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
@@ -429,7 +429,7 @@
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA-Clipper compliant
* This function is CA-Clipper compliant
* $FILES$
* Library is Rtl
* $SEEALSO$
@@ -447,26 +447,26 @@
* $SYNTAX$
* FSEEK( <nHandle>, <nOffset>, [<nOrigin>] ) --> nPosition
* $ARGUMENTS$
* <nHandle> DOS file handle.
* <nHandle> DOS file handle.
* <nOffset> The number of bytes to move.
* <nOffset> The number of bytes to move.
* <nOrigin> The relative position in the file.
* <nOrigin> The relative position in the file.
* $RETURNS$
* <nPosition> the current position relative to begin-of-file
* <nPosition> the current position relative to begin-of-file
* $DESCRIPTION$
* This function sets the file pointer in the file whose DOS file
* handle is <nHandle> and moves the file pointer by <expN2> bytes
* from the file position designated by <nOrigin>. 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.
* <nHandle> is the file handle number. It is obtained from the FOPEN()
* or FCREATE() function.
* or FCREATE() function.
* The value of <nOffSet> is the number of bytes to move the file pointer
* from the position determined by <nOrigin>.The value of <nOffset> may
* be a negative number, suggesting backward movement.
* be a negative number, suggesting backward movement.
* The value of <nOrigin> designates the starting point from which the
* file pointer should he moved, as shown in the following table:
@@ -479,7 +479,7 @@
* 2 FS_END End of file
* </table>
* If a value is not provided for <nOrigin>, 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
*
@@ -505,7 +505,7 @@
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA-Clipper compliant.
* This function is CA-Clipper compliant.
* $FILES$
* Library is rtl
* Header is fileio.ch
@@ -524,20 +524,20 @@
* $SYNTAX$
* FILE( <cFileSpec> ) --> lExists
* $ARGUMENTS$
* <cFileSpec> Dos Skeleton or file name to find.
* <cFileSpec> Dos Skeleton or file name to find.
* $RETURNS$
* <lExists> 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
* <cFileSpec> exist.
* <cFileSpec> exist.
* Dos skeletons symbols may be used in the filename in <cFileSpec>,
* 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")
@@ -545,7 +545,7 @@
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA-Clipper compatible.
* This function is CA-Clipper compatible.
* $FILES$
* Library is Rtl
* $SEEALSO$
@@ -563,29 +563,29 @@
* $SYNTAX$
* FREADSTR(<nHandle>, <nBytes>) --> cString
* $ARGUMENTS$
* <nHandle> DOS file handle number.
* <nHandle> DOS file handle number.
*
* <nBytes> Number of bytes to read.
* <nBytes> Number of bytes to read.
* $RETURNS$
* <cString> an characted expression
* <cString> an characted expression
* $DESCRIPTION$
* This function returns a character string of <nBytes> bytes from a
* file whose DOS file handle is <nHandle>.
* file whose DOS file handle is <nHandle>.
* The value of the file handle <nHandle> is obtained from either the
* FOPEN() or FCREATE() functions.
* FOPEN() or FCREATE() functions.
* The value of <nBytes> is the number of bytes to read from the file.
* The returned string will be the number of characters specified in
* <nBytes> 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)
@@ -597,7 +597,7 @@
* 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.
* $FILES$
* Library is Rtl
* $SEEALSO$
@@ -615,27 +615,27 @@
* $ONELINER$
* Changes the name of a specified file
* $SYNTAX$
* RENAME <cOldFile> TO <cNewFile>
* RENAME <cOldFile> TO <cNewFile>
* $ARGUMENTS$
* <cOldFile> Old filename
* <cOldFile> Old filename
* <cNewFile> New Filename
* <cNewFile> New Filename
* $DESCRIPTION$
* This command changes the name of <cOldFile> to <cNewFile>.Both
* <cOldFile> and <cNewFile> 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 <cNewFile> 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
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* This command is CA-Clipper compatible
* This command is CA-Clipper compatible
* $FILES$
* Library is Rtl
* $SEEALSO$
@@ -653,15 +653,15 @@
* $SYNTAX$
* ERASE <xcFile>
* $ARGUMENTS$
* <xcFile> Name of file to remove
* <xcFile> 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
@@ -669,7 +669,7 @@
* $STATUS$
* R
* $COMPLIANCE$
* This command is CA-Clipper compatible
* This command is CA-Clipper compatible
* $SEEALSO$
* CURDIR(),FILE(),FERASE(),DELETE FILE
* $END$
@@ -685,15 +685,15 @@
* $SYNTAX$
* DELETE FILE <xcFile>
* $ARGUMENTS$
* <xcFile> Name of file to remove
* <xcFile> 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

185
harbour/doc/en/input.txt
View File

@@ -19,7 +19,7 @@
* $CATEGORY$
* Console input
* $ONELINER$
* Extracts the next key code from the Harbour keyboard buffer
* Extracts the next key code from the Harbour keyboard buffer.
* $SYNTAX$
* INKEY( [<nTimeout>] [,<nEvents>] ) --> nKey
* $ARGUMENTS$
@@ -30,28 +30,28 @@
* 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.
*
* <nEvents> 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
* <nEvents> is an optional mask of input events that are to be enabled.
* If omitted, defaults to hb_set.HB_SET_EVENTMASK. Valid input masks are
* in inkey.ch and are explained below. It is recommended that the mask
* names be used rather than their numeric values, in case the numeric
* values change in future releases of Harbour. To allow more than one
* type of input event, simply add the various mask names together.
* type of input event, simply add the various mask names together.
*
* <table>
* inkey.ch Meaning
*
* INKEY_MOVE Mouse motion events are allowed
* INKEY_LDOWN The mouse left click down event is allowed
* INKEY_LUP The mouse left click up event is allowed
* INKEY_RDOWN The mouse right click down event is allowed
* INKEY_RUP The mouse right click up event is allowed
* INKEY_KEYBOARD All keyboard events are allowed
* INKEY_ALL All mouse and keyboard events are allowed
* 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
* </table>
* 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
@@ -60,7 +60,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).
@@ -77,11 +77,11 @@
* S
* $COMPLIANCE$
* INKEY() is compliant with the Clipper 5.3 INKEY() function with one
* exceptions: The Harbour INKEY() function will raise an argument error
* exception: The Harbour INKEY() function will raise an argument error
* if the first parameter is less than or equal to 0 and the second
* parameter (or the default mask) is not valid, because otherwise INKEY
* would never return, because it was, in effect, asked to wait forever
* for no events (Note: In Clipper, this also blocks SET KEY events).
* for no events (Note: In Clipper, this also blocks SET KEY events).
* $FILES$
* Library is rtl
* $SEEALSO$
@@ -103,12 +103,12 @@
* $ARGUMENTS$
* <cString> 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)
@@ -123,7 +123,7 @@
* $STATUS$
* R
* $COMPLIANCE$
* __KEYBOARD() is compliant with CA-Clipper 5.3
* __KEYBOARD() is compliant with CA-Clipper 5.3
* $FILES$
* Library is rtl
* $SEEALSO$
@@ -137,20 +137,20 @@
* $CATEGORY$
* Console input
* $ONELINER$
* Put an inkey code to the keyboard buffer
* Put an inkey code to the keyboard buffer.
* $SYNTAX$
* HB_KEYPUT( <nInkeyCode> )
* $ARGUMENTS$
* <nInkeyCode> 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 )
@@ -162,7 +162,7 @@
* $STATUS$
* R
* $COMPLIANCE$
* Was not part of Clipper
* HB_KEYPUT() is a Harbour extension.
* $FILES$
* Library is rtl
* $SEEALSO$
@@ -176,18 +176,18 @@
* $CATEGORY$
* Console input
* $ONELINER$
* Returns the value of the next key in the Harbour keyboard buffer
* Get the next key code in the buffer without extracting it.
* $SYNTAX$
* NEXTKEY() --> nKey
* $ARGUMENTS$
* None
* None
* $RETURNS$
* <nKey> There is no return value
* <nKey> The value of the next key in the Harbour keyboard buffer.
* $DESCRIPTION$
* Returns the value of the next key in the Harbour keyboard buffer
* without extracting it.
* without extracting it.
* $EXAMPLES$
* // Use NEXTKEY() with INKEY() to change display character or by
* // Use NEXTKEY() with INKEY() to change display characters, or by
* // itself to exit the loop, so that the caller can detect the Esc.
* LOCAL nKey, cChar := "+"
* WHILE TRUE
@@ -208,7 +208,7 @@
* $STATUS$
* R
* $COMPLIANCE$
* NEXTKEY() is compliant with CA-Clipper 5.3
* NEXTKEY() is compliant with CA-Clipper 5.3
* $FILES$
* Library is rtl
* $SEEALSO$
@@ -222,23 +222,23 @@
* $CATEGORY$
* Console input
* $ONELINER$
* Returns the last key exttracted from the Harbour keyboard buffer
* Get the last key extracted from the keyboard buffer.
* $SYNTAX$
* LASTKEY() --> nKey
* $ARGUMENTS$
* None
* None
* $RETURNS$
* <nKey> There is no return value
* <nKey> The last key extracted from the keyboard buffer.
* $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
* MainFunc()
* IF LASTKEY() == K_ESC
* EXIT
* END IF
* ENDIF
* END WHILE
* </fixed>
* $TESTS$
@@ -247,7 +247,7 @@
* $STATUS$
* R
* $COMPLIANCE$
* LASTKEY() is compliant with CA-Clipper 5.3
* LASTKEY() is compliant with CA-Clipper 5.3
* $FILES$
* Library is rtl
* $SEEALSO$
@@ -262,20 +262,20 @@
* $CATEGORY$
* Command
* $ONELINER$
* Stuffs the keyboard with a string
* Stuffs the keyboard with a string.
* $SYNTAX$
* KEYBOARD <cString>
* KEYBOARD <cString>
* $ARGUMENTS$
* <cString> 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 <cString>. The
* number of character that can be stuffed into the keyboard
* buffer is controled by SET TYPEAHEAD command and may range
* This command stuffs the input buffer with <cString>. The
* number of characters that can be stuffed into the keyboard
* buffer is controlled by the SET TYPEAHEAD command and may range
* from 0 to 32,622, with each character 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.
* into the keyboard buffer.
* Issuing a KEYBOARD " " will clear the keyboard buffer.
* $EXAMPLES$
* // Stuff an Enter key into the keyboard buffer
* KEYBOARD CHR(13)
@@ -289,7 +289,7 @@
* $STATUS$
* R
* $COMPLIANCE$
* __KEYBOARD() is compliant with CA-Clipper 5.3
* __KEYBOARD() is compliant with CA-Clipper 5.3
* $SEEALSO$
* CLEAR TYPEAHEAD,__KEYBOARD()
* $END$
@@ -301,43 +301,43 @@
* $CATEGORY$
* Data input and output
* $ONELINER$
* Find out which key terminate a READ
* Find out which key terminated a READ.
* $SYNTAX$
* READKEY() --> nKeyCode
* $ARGUMENTS$
* none.
* None.
* $RETURNS$
* READKEY() return a numeric code representing the key that cause READ
* to terminate.
* READKEY() returns a numeric code representing the key that caused READ
* to terminate.
* $DESCRIPTION$
* READKEY() is used after a READ was terminated to determine the exit
* key pressed. If the get buffer was updated during READ, 256 is added
* to the return code.
* key pressed. If the GET buffer was updated during READ, 256 is added
* to the return code.
*
* <table>
* Exit Return code Return code
* Key (not updated) (updated)
* Exit Return code Return code
* Key (not updated) (updated)
* Up 4 260
* Down 5 261
* Page-Up 6 262
* Page-Down 7 263
* Ctrl Page-Up 34 290
* Ctrl Page-Down 35 291
* Esc 12 268
* Ctrl End 14 270
* Enter 15 271
* Key >= 32 15 271
* otherwise 0 0
* 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
* </table>
* 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.
* READKEY() is a compatibility function so try not to use it.
* READKEY() is superseded by LASTKEY() which returns the INKEY()
* code for that key. UPDATED() could be used to find if the
* GET buffer was changed during the READ.
* $STATUS$
* R
* $COMPLIANCE$
* READKEY() works exactly like CA-Clipper's READKEY().
* READKEY() is compliant with CA-Clipper 5.3
* $FILES$
* Library is rtl
* $SEEALSO$
@@ -351,27 +351,29 @@
* $CATEGORY$
* Console input
* $ONELINER$
* Returns the mouse cursor row position
* Returns the mouse cursor row position.
* $SYNTAX$
* MRow() --> nMouseRow
* $ARGUMENTS$
* None
* None
* $RETURNS$
* <nMouseRow> The mouse cursor row position
* <nMouseRow> The mouse cursor row position.
* $DESCRIPTION$
* This function returns the current mouse row cursor position
* This function returns the current mouse row cursor position.
* On graphical systems the value represents pixel rows.
* On character-based systems the value represents character
* rows as in Clipper.
* $EXAMPLES$
* local nKey
* nKey = InKey( 0 )
* do case
* case nKey ==
* IF MRow() < 1
* ? "Mouse is on top row!"
* ENDIF
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* This function is a Harbour Specific
* MROW() is compliant with CA-Clipper 5.3, but has been extended
* to work on graphical systems as well as character-based systems.
* $PLATFORMS$
* This function is Windows Specific
* $FILES$
* Library is rtl
* $SEEALSO$
@@ -385,27 +387,30 @@
* $CATEGORY$
* Console input
* $ONELINER$
* Returns the mouse cursor column position
* Returns the mouse cursor column position.
* $SYNTAX$
* MCol() --> nMouseColumn
* $ARGUMENTS$
* None
* None
* $RETURNS$
* <nMouseColumn> The mouse cursor column position
* <nMouseColumn> The mouse cursor column position.
* $DESCRIPTION$
* This function returns the current mouse col cursor position
* This function returns the column position of the mouse cursor.
* On graphical systems the value represents pixels.
* On character-based systems the value represents character
* columns as in Clipper.
* $EXAMPLES$
* local nKey
* nKey = InKey( 0 )
* do case
* case nKey ==
* IF MCol() < 1
* ? "Mouse is on left edge!"
* ENDIF
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* This function is a Harbour Specific
* MROW() is compliant with CA-Clipper 5.3, but has been extended
* to work on graphical systems as well as character-based systems.
* $PLATFORMS$
* This function is Windows Specific
* All
* $FILES$
* Library is rtl
* $SEEALSO$

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

@@ -23,12 +23,12 @@
* $SYNTAX$
* ABS(<nNumber>) --> <nAbsNumber>
* $ARGUMENTS$
* <nNumber> Any number
* <nNumber> Any number.
* $RETURNS$
* <nAbsNumber> The absolute numeric value
* <nAbsNumber> The absolute numeric value.
* $DESCRIPTION$
* This function yeilds the absolute value of the numeric value or
* expression <nNumber>
* This function yields the absolute value of the numeric value or
* expression <nNumber>.
* $EXAMPLES$
* Proc Main()
*
@@ -45,7 +45,7 @@
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA-Clipper compliant
* This function is CA-Clipper compliant.
* $PLATFORMS$
* All
* $FILES$
@@ -61,25 +61,25 @@
* $CATEGORY$
* Math
* $ONELINER$
* Calculates the exponential of a real number
* Calculates the value of e raised to the passed power.
* $SYNTAX$
* EXP( <nNumber> ) --> <nExpoent>
* EXP( <nNumber> ) --> <nValue>
* $ARGUMENTS$
* <nNumber> Any real number
* <nNumber> Any real number.
* $RETURNS$
* <nExpoent> The expoent number of <nNumber>
* <nValue> The anti-logarithm of <nNumber>
* $DESCRIPTION$
* This function returns the exponential of any given real number
* <nNumber>
* This function returns the value of e raised to the power of
* <nNumber>. It is the inverse of LOG().
* $EXAMPLES$
* ? EXP(632512)
* ? EXP(45)
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA-Clipper compliant.
* This function is CA-Clipper compliant.
* $PLATFORMS$
* All
* All
* $FILES$
* Library is rtl
* $SEEALSO$
@@ -93,28 +93,28 @@
* $CATEGORY$
* Math
* $ONELINER$
* Return the integer port of a numeric value
* Return the integer port of a numeric value.
* $SYNTAX$
* INT( <nNumber> ) --> <nIntNumber>
* $ARGUMENTS$
* <nNumber> Any numeric value
* <nNumber> Any numeric value.
* $RETURNS$
* <nIntNumber> The integer portion of the numeric value
* <nIntNumber> 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.
* This function converts a numeric expression to an integer. All
* decimal digits are truncated. This function does not round a value
* upward or downward; it merely truncates a number at the decimal point.
* $EXAMPLES$
* SET Decimal to 5
* SET Decimal to 5
* ? INT(632512.62541)
* ? INT(845414111.91440)
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA-Clipper compliant.
* This function is CA-Clipper compliant.
* $PLATFORMS$
* All
* All
* $FILES$
* Library is rtl
* $SEEALSO$
@@ -128,27 +128,27 @@
* $CATEGORY$
* Math
* $ONELINER$
* Returns the natural logarithm of a number
* Returns the natural logarithm of a number.
* $SYNTAX$
* LOG( <nNumber> ) --> <nLog>
* $ARGUMENTS$
* <nNumber> Any numeric expression
* <nNumber> Any numeric expression.
* $RETURNS$
* <nExpoent> The natural logaritmh of <nNumber>
* <nExponent> The natural logarithm of <nNumber>.
* $DESCRIPTION$
* This function will return the natural logarithm of the number <nNumber>.
* If <nNumber> 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.
* This function returns the natural logarithm of the number <nNumber>.
* If <nNumber> is 0 or less than 0, a numeric overflow occurs,
* which is depicted on the display device as a series of asterisks.
* This function is the inverse of EXP().
* $EXAMPLES$
* ? LOG(632512)
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA-Clipper compliant.
* This function is CA-Clipper compliant.
* $PLATFORMS$
* All
* All
* $FILES$
* Library is rtl
* $SEEALSO$
@@ -163,32 +163,32 @@
* $CATEGORY$
* MATH
* $ONELINER$
* Returns the maximum of either two number or two dates.
* Returns the maximum of two numbers or dates.
* $SYNTAX$
* MAX(<xValue>,<xValue1>) --> <xMax>
* $ARGUMENTS$
* <xValue> Any date or numeric value.
* <xValue> Any date or numeric value.
*
* <xValue1> Any date or numeric value.
* <xValue1> Any date or numeric value (same type as <xValue>).
* $RETURNS$
* <xMax> Eighter a numeric or date value
* <xMax> The larger numeric (or later date) value.
* $DESCRIPTION$
* This function returns the larger of the two passed espressions. If
* <xValue> and <xValue1> are numeric data types,the value returned by
* <xValue> and <xValue1> 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 <xValue> and <xValue1> 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.
* larger of the two numbers passed to it. If <xValue> and <xValue1> are
* date data types, the return value will be a date data
* type as well. It will be the later of the two dates passed to it.
* $EXAMPLES$
* ? MAX(214514214,6251242142)
* ? MAX(CTOD('11/11/2000'),CTOD('21/06/2014')
* ? MAX(CTOD('11/11/2000'),CTOD('21/06/2014')
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* This function is Ca-Clipper compliant
* This function is Ca-Clipper compliant.
* $PLATFORMS$
* All
* All
* $FILES$
* Library is rtl
* $SEEALSO$
@@ -202,30 +202,29 @@
* $CATEGORY$
* MATH
* $ONELINER$
* Determines a minumum value or dates.
* Determines the minumum of two numbers or dates.
* $SYNTAX$
* MIN(<xValue>,<xValue1>) --> <xMin>
* $ARGUMENTS$
* <xValue> Any date or numeric value.
* <xValue> Any date or numeric value.
*
* <xValue1> Any date or numeric value.
* <xValue1> Any date or numeric value.
* $RETURNS$
* <xMin> Eighter a numeric or date value
* <xMin> The smaller numeric (or earlier 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 <xValue>
* is a numeric data type,<xValue1> must so be a numeric data type.The
* same may be said if <xValue> is a date data type.
* This function returns the smaller of the two passed espressions.
* <xValue> and <xValue1> must be the same data type. If numeric, the
* smaller number is returned. If dates, the earlier date is returned.
* $EXAMPLES$
* ? MIN(214514214,6251242142)
* ? MIN(CTOD('11/11/2000'),CTOD('21/06/2014')
* ? MIN(CTOD('11/11/2000'),CTOD('21/06/2014')
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* This function is Ca-Clipper compliant
* This function is Ca-Clipper compliant.
* $PLATFORMS$
* All
* All
* $FILES$
* Library is rtl
* $SEEALSO$
@@ -239,18 +238,17 @@
* $CATEGORY$
* Math
* $ONELINER$
* Return the modulus of two numbers
* Return the modulus of two numbers.
* $SYNTAX$
* MOD( <nNumber>,<nNumber1>) --> <nReturn>
* MOD( <nNumber>,<nNumber1>) --> <nRemainder>
* $ARGUMENTS$
* <nNumber> Numerator in a divisional expression
* <nNumber> Numerator in a divisional expression.
*
* <nNumber1> Denominator in a divisional expression
* <nNumber1> Denominator in a divisional expression.
* $RETURNS$
* <nReturn> Remind from the division
* <nRemainder> The remainder after the division operation.
* $DESCRIPTION$
* This functuion will return a value that is correspondent to the
* reminder of one number divided by another
* This functuion returns the remainder of one number divided by another.
* $EXAMPLES$
* ? MOD(12,8.521)
* ? Mod(12,0)
@@ -259,9 +257,9 @@
* $STATUS$
* R
* $COMPLIANCE$
* This Function is Ca-Clipper compliant
* This Function is Ca-Clipper compliant.
* $PLATFORMS$
* All
* All
* $FILES$
* Library is rtl
* $SEEALSO$
@@ -275,27 +273,27 @@
* $CATEGORY$
* Math
* $ONELINER$
* Calculates the square root of a number
* Calculates the square root of a number.
* $SYNTAX$
* SQRT( <nNumber> ) --> <nSqrt>
* $ARGUMENTS$
* <nNumber> Any numeric value
* <nNumber> Any numeric value.
* $RETURNS$
* <nSqrt> Square root of <number>
* <nSqrt> The 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.
* This function returns the square root of <nNumber>. The precision of
* this evaluation is based solely 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
* SET Decimal to 5
* ? SQRT(632512.62541)
* ? SQRT(845414111.91440)
* ? SQRT(845414111.91440)
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA-Clipper compliant.
* This function is CA-Clipper compliant.
* $PLATFORMS$
* All
* All
* $FILES$
* Library is rtl
* $SEEALSO$
@@ -309,30 +307,30 @@
* $CATEGORY$
* Math
* $ONELINER$
* Rounds off a numeric expression
* Rounds off a numeric expression.
* $SYNTAX$
* ROUND( <nNumber>,<nPlace> ) --> <nResult>
* $ARGUMENTS$
* <nNumber> Any numeric value
* <nNumber> Any numeric value.
*
* <nPlace> The number of places to round to
* <nPlace> The number of places to round to.
* $RETURNS$
* <nResult> Rounded number
* <nResult> The rounded number.
* $DESCRIPTION$
* This function rounds off the value of <nNumber> to the number of
* decimal places specified by <nPlace>.If the value of <nPlace> is a
* negative number,the function will atempt to round <nNumber> in whole
* numbers;numbers from 5 through 9 will be rounded up, all others will
* decimal places specified by <nPlace>. If the value of <nPlace> is a
* negative number, the function will attempt to round <nNumber> in whole
* numbers. Numbers from 5 through 9 will be rounded up, all others will
* be rounded down.
* $EXAMPLES$
* ? ROUND(632512.62541,5)
* ? ROUND(845414111.91440,3)
* ? ROUND(845414111.91440,3)
* $STATUS$
* R
* $COMPLIANCE$
* This function is CA-Clipper compliant.
* This function is CA-Clipper compliant.
* $PLATFORMS$
* All
* All
* $FILES$
* Library is rtl
* $SEEALSO$

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

@@ -20,22 +20,22 @@
* $CATEGORY$
* Strings
* $ONELINER$
* Converts hard and soft carriages within strings.
* Converts hard and soft carriage returns within strings.
* $SYNTAX$
* MEMOTRAN( <cString>, <cHard>, <cSoft> ) --> <cConvertedString>
* $ARGUMENTS$
* <cString> is a string of chars to convert.
* <cString> is a string of chars to convert.
* <cHard> is the character to replace hard carriages with. If not
* specified defaults to semicolon.
* <cHard> is the character to replace hard returns with. If not
* specified defaults to semicolon.
* <cSoft> is the character to replace soft carriages with. If not
* specified defaults to single space.
* <cSoft> is the character to replace soft returns with. If not
* specified defaults to single space.
* $RETURNS$
* <cConvertedString> Trasformed string.
* <cConvertedString> Trasformed string.
* $DESCRIPTION$
* Returns a string/memo with carriage chars converted to specified
* chars.
* Returns a string/memo with carriage return chars converted to
* specified chars.
* $EXAMPLES$
* ? MEMOTRAN( DATA->CNOTES )
* </fixed>
@@ -47,7 +47,7 @@
* $STATUS$
* R
* $COMPLIANCE$
* MEMOTRAN() is fully CA-Clipper compliant.
* MEMOTRAN() is fully CA-Clipper compliant.
* $FILES$
* Library is rtl
* $SEEALSO$
@@ -59,18 +59,18 @@
* $FUNCNAME$
* HARDCR()
* $CATEGORY$
* STRINGS
* Strings
* $ONELINER$
* Replace all soft cariages returns with hard cariages returs
* Replace all soft carriage returns with hard carriages returns.
* $SYNTAX$
* HARDCR( <cString> ) --> <cConvertedString>
* $ARGUMENTS$
* <cString> is a string of chars to convert.
* <cString> is a string of chars to convert.
* $RETURNS$
* <cConvertedString> Trasformed string.
* <cConvertedString> Trasformed string.
* $DESCRIPTION$
* Returns a string/memo with soft carriages chars converted to
* hard carraige char.
* Returns a string/memo with soft carriage return chars converted to
* hard carriage return chars.
* $EXAMPLES$
* ? HARDCR( Data->CNOTES )
* </fixed>
@@ -82,7 +82,7 @@
* $STATUS$
* R
* $COMPLIANCE$
* HARDCR() is fully CA-Clipper compliant.
* HARDCR() is fully CA-Clipper compliant.
* $FILES$
* Library is rtl
* $SEEALSO$

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

@@ -17,26 +17,26 @@
* $FUNCNAME$
* OS()
* $ONELINER$
* Return the current operating system
* Return the current operating system.
* $SYNTAX$
* OS() -> <cOperatinSystem>
* OS() --> <cOperatingSystem>
* $CATEGORY$
* DOS
* $RETURNS$
* <cOperatinSystem> -> The Current operating system
* <cOperatinSystem> -> The Current operating system.
* $DESCRIPTION$
* This function will return the current operating system
* This function will return the current operating system.
* $EXAMPLES$
* ? OS()
* $TESTS$
* $STATUS$
* R
* $COMPLIANCE$
* This functions is Ca-Clipper compatible
* This function is Ca-Clipper compatible.
* $PLATFORMS$
* All
* $FILES$
* source/rtl/version.c
* source/rtl/version.c
* $END$
*/
@@ -46,27 +46,28 @@
* $CATEGORY$
* Environment
* $ONELINER$
* Returns the HARBOUR Version or the Harbour/Compiler Version
* Returns the HARBOUR Version or the Harbour/Compiler Version.
* $SYNTAX$
* VERSION() --> <cReturn>
* $ARGUMENTS$
* None
* $RETURNS$
* <cReturn> String contining the Harbour Version or the Harbour
* and C compiler Version when the <nMode> parameter is used.
* <cReturn> String containing the Harbour Version/
* $DESCRIPTION$
* This function returns the current HARBOUR Version
* This function returns the current Harbour Version.
* $EXAMPLES$
* ? QOUT(VERSION()) // Displays Harbour version only
* ? QOUT(VERSION())
* "Harbour Terminal: Standard stream console"
*
* $TESTS$
* $STATUS$
* S
* $COMPLIANCE$
* This functions is Ca-Clipper compatible
* This function is Ca-Clipper compatible.
* $PLATFORMS$
* All
* $FILES$
* source/rtl/version.c
* source/rtl/version.c
* Library is rtl
* $SEEALSO$
* OS()
@@ -79,35 +80,36 @@
* $CATEGORY$
* Environment
* $ONELINER$
* Obtains DOS system environmental settings
* Obtains system environmental settings.
* $SYNTAX$
* GETENV(<cEnviroment>, <cDefaultValue> ) --> <cReturn>
* $ARGUMENTS$
* <cEnviroment> Enviromental variable to obtain
* <cEnviroment> Enviromental variable to obtain.
*
* <cDefaultValue> Optional value to return if <cEnvironment> is not found
* <cDefaultValue> Optional value to return if <cEnvironment> is not found.
* $RETURNS$
* <cReturn> Value of the Variable
* <cReturn> Value of the Environment Variable.
* $DESCRIPTION$
* This function yields a string that is the value of the
* environmental variable <cEnviroment>, witch is stored at the
* level with the Set command. If no environmental variable
* can be found, the value of the function will be a empty string.
* environment variable <cEnviroment>, which is stored at the
* system level with the Set command. If no environment variable
* can be found, the value of the function will be <cDefaultValue>
* if it is passed, else an empty string.
* $EXAMPLES$
* ? QOUT(GETENV('PATH'))
* ? QOUT(GETENV('CONFIG'))
* ? QOUT(GETENV('HARBOURCMD', '-n -l -es2'))
* </fixed>
* $TESTS$
* This command is Ca-Clipper compliant
* $STATUS$
* R
* $COMPLIANCE$
* The <cDefaultValue> parameter is a harbour extension
* This command is Ca-Clipper compliant.
* The <cDefaultValue> parameter is a Harbour extension.
* $PLATFORMS$
* All
* $FILES$
* source/rtl/gete.c
* source/rtl/gete.c
* Library is rtl
* $END$
*/
@@ -118,20 +120,20 @@
* $CATEGORY$
* DOS
* $ONELINER$
* Run a external program
* Run an external program.
* $SYNTAX$
* __RUN( <cCommand> )
* $ARGUMENTS$
* <cCommand> Command to execute
* <cCommand> Command to execute.
* $DESCRIPTION$
* This command runs an external program. Please make sure that you have
* enough free memory to be able to run the external program.
* Do not use it to run Terminate and Stay Resident programs
* (in case of DOS) since it cause several problems
* This command runs an external program. Please make sure that
* you have enough free memory to be able to run the external
* program. Do not use it to run Terminate and Stay Resident programs
* (in case of DOS) since that causes several problems.
*
* 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)
@@ -140,11 +142,11 @@
* $STATUS$
* R
* $COMPLIANCE$
* This function is Ca-Clipper compliant
* This function is Ca-Clipper compliant.
* $PLATFORMS$
* All
* $FILES$
* source/rtl/run.c
* source/rtl/run.c
* Library is rtl
* $SEEALSO$
* RUN
@@ -155,23 +157,23 @@
* $FUNCNAME$
* TONE()
* $CATEGORY$
* Misc
* Miscellaneous
* $ONELINER$
* Sound a tone with a specifies frequency and duration
* Sound a tone with a specified frequency and duration.
* $SYNTAX$
* TONE( <nFrequency>, <nDuration> ) --> NIL
* $ARGUMENTS$
* <nFrequency> is a non-negative numeric value that specifies the
* frequency of the tone in hertz.
* <nFrequency> A non-negative numeric value that specifies the
* frequency of the tone in hertz.
*
* <nDuration> is a positive numeric value which specifies the duration
* of the tone in 1/18 of a second units.
* <nDuration> A positive numeric value which specifies the duration
* of the tone in 1/18 of a second units.
* $RETURNS$
* TONE() always return NIL.
* TONE() always returns NIL.
* $DESCRIPTION$
* TONE() is a sound function that could be used to irritate the end
* user, his or her dog, and the surrounding neighborhood. The frequency
* is 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 )
@@ -197,7 +199,7 @@
* $STATUS$
* S
* $COMPLIANCE$
* TONE() works exactly like CA-Clipper's TONE().
* TONE() works exactly like CA-Clipper's TONE().
* $PLATFORMS$
* All
* $FILES$
@@ -213,16 +215,16 @@
* $CATEGORY$
* Command
* $ONELINER$
* Run a external program
* Run an external program.
* $SYNTAX$
* RUN <cCommand>
* RUN <cCommand>
* $ARGUMENTS$
* <cCommand> Command to execute
* <cCommand> Command to execute.
* $DESCRIPTION$
* This command runs an external program. Please make sure that you have
* enough free memory to be able to run the external program.
* 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 that causes several problems.
* $EXAMPLES$
* Run "edit " + cMyTextFile // Runs an external editor
* Run "command" // Gives a DOS shell (DOS only)
@@ -230,11 +232,11 @@
* $STATUS$
* R
* $COMPLIANCE$
* This command is Ca-Clipper compliant
* This command is Ca-Clipper compliant.
* $PLATFORMS$
* All
* $FILES$
* source/rtl/run.c
* source/rtl/run.c
* Library is rtl
* $SEEALSO$
* RUN

24
harbour/doc/en/nation.txt
View File

@@ -30,8 +30,8 @@
* <lTrueOrFalse> True if passed char is an affirmation char,otherwise
* false </par>
* $DESCRIPTION$
* This function it is used to check if a user input is true or not
* regarding of the msgxxx module used. </par>
* This function is used to check if a user's input is true or not
* according to the msgxxx module used. </par>
* $EXAMPLES$
* // Wait until user enters Y
* DO WHILE !ISAFFIRM( cYesNo )
@@ -55,17 +55,17 @@
* $CATEGORY$
* NATION
* $ONELINER$
* Checks if passed char is a negation char
* Checks if passed char is a negation char.
* $SYNTAX$
* ISNEGATIVE( <cChar> ) --> <lTrueOrFalse>
* $ARGUMENTS$
* <cChar> is a char or string of chars </par>
* $RETURNS$
* <lTrueOrFalse> True if passed char is a negation char,otherwise
* false </par>
* <lTrueOrFalse> True if passed char is a negation char, otherwise
* false. </par>
* $DESCRIPTION$
* This function it is used to check if a user input is true or not
* regarding of the msgxxx module used. </par>
* This function is used to check if a user's input is true or not
* according to the msgxxx module used. </par>
* $EXAMPLES$
* // Wait until user enters N
* DO WHILE !ISNEGATIVE( cYesNo )
@@ -93,13 +93,13 @@
* $SYNTAX$
* NATIONMSG( <nMsg> ) --> <cMessage>
* $ARGUMENTS$
* <nMsg> is the message number you want to get </par>
* <nMsg> is the message number you want to get. </par>
* $RETURNS$
* <cMessage> If <nMsg> is a valid message selector return the message,
* if <nMsg> is nil returns "Invalid Argument" and if <nMsg> is any
* other type it returns an empty string. </par> </par>
* <cMessage> If <nMsg> is a valid message selector, returns the message.
* If <nMsg> is nil returns "Invalid Argument", and if <nMsg> is any
* other type it returns an empty string. </par>
* $DESCRIPTION$
* This functions returns international message descriptions. </par>
* NATIONMSG() returns international message descriptions. </par>
* $EXAMPLES$
* // Displays "Sure Y/N: " and waits until user enters Y
* // Y/N is the string for NATIONMSG( 12 ) with default natmsg module.