From 6c51f15406af6e064fa673d07026fd8d11c3d22d Mon Sep 17 00:00:00 2001 From: Alexey Myronenko Date: Thu, 20 Sep 2012 14:00:25 +0000 Subject: [PATCH] 2012-09-20 16:55 UTC+0200 Alexey Myronenko (m.oleksa/at/ukr.net) --- harbour/doc/en/memo.txt | 159 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 153 insertions(+), 6 deletions(-) diff --git a/harbour/doc/en/memo.txt b/harbour/doc/en/memo.txt index 3721f30802..b242da9b00 100644 --- a/harbour/doc/en/memo.txt +++ b/harbour/doc/en/memo.txt @@ -14,6 +14,8 @@ * MEMOREAD() documentation * MEMOWRIT() documentation * + * Documentation for HB_MEMOREAD(), HB_MEMOWRIT() + * * See COPYING for licensing terms. * */ @@ -40,7 +42,7 @@ * is the character to replace soft returns with. If not * specified defaults to single space. * $RETURNS$ - * Trasformed string. + * Transformed string. * $DESCRIPTION$ * Returns a string/memo with carriage return chars converted to * specified chars. @@ -77,7 +79,7 @@ * $ARGUMENTS$ * is a string of chars to convert. * $RETURNS$ - * Trasformed string. + * Transformed string. * $DESCRIPTION$ * Returns a string/memo with soft carriage return chars converted to * hard carriage return chars. @@ -143,10 +145,11 @@ * process, the function will returns a null string (""). * $EXAMPLES$ * * This example uses MEMOREAD() to assign the contents of a text - * file to a character variable for later search + * * file to a character variable for later search * * cFile := "account.prg" * cString := MEMOREAD( cFile ) + * cCopyright := "Melina" * * IF At( "Melina", cString ) == 0 // check for copyright * MEMOWRIT( cFile, cCopyright + cString ) // if not, add it! @@ -160,10 +163,80 @@ * $FILES$ * Library is rtl * $SEEALSO$ - * MEMOEDIT(),MEMOWRIT(),REPLACE + * MEMOEDIT(),MEMOWRIT(),REPLACE,HB_MEMOREAD() * $END$ */ +/* $DOC$ + * $TEMPLATE$ + * Function + * $NAME$ + * HB_MEMOREAD() + * $CATEGORY$ + * API + * $SUBCATEGORY$ + * Strings + * $ONELINER$ + * Return the text file's contents as a character string + * $SYNTAX$ + * HB_MEMOREAD( ) --> cString + * $ARGUMENTS$ + * is the filename to read from disk. + * It must include the file extension. If file to be read + * lives in another directory, you must include the path. + * $RETURNS$ + * Returns the contents of a text file as a character string. + * + * If cannot be found or read HB_MEMOREAD returns an empty + * string (""). + * $DESCRIPTION$ + * HB_MEMOREAD() is a function that reads the content of a text file + * (till now) from disk (floppy, HD, CD-ROM, etc.) into a memory string. + * In that way you can manipulate as any character string or assigned + * to a memo field to be saved in a database. + * + * HB_MEMOREAD() function is used together with MEMOEDIT() and HB_MEMOWRIT() + * to get from disk text from several sources that would be edited, + * searched, replaced, displayed, etc. + * + * It is used to import data from other sources to our database. + * + * Note: + * HB_MEMOREAD() does not use the settings SET DEFAULT or SET PATH to + * search for . + * It searches for in the current directory. + * If the file is not found, then HB_MEMOREAD() searches in the DOS path. + * + * Over a network, HB_MEMOREAD() attempts to open in read-only + * mode and shared. If the file is used in mode exclusive by another + * process, the function will returns a null string (""). + * + * HB_MEMOREAD() vs MEMOREAD(): + * HB_MEMOREAD() is identical to MEMOREAD() except it won't truncate the + * last byte (on non-UNIX compatible systems) if it's a EOF char. + * $EXAMPLES$ + * * This example uses HB_MEMOREAD() to assign the contents of a text + * * file to a character variable for later search + * + * cFile := "account.prg" + * cString := HB_MEMOREAD( cFile ) + * cCopyright := "Melina" + * + * IF At( "Melina", cString ) == 0 // check for copyright + * HB_MEMOWRIT( cFile, cCopyright + cString ) // if not, add it! + * ENDIF + * $STATUS$ + * R + * $COMPLIANCE$ + * C + * $PLATFORMS$ + * All(64K) + * $FILES$ + * Library is rtl + * $SEEALSO$ + * MEMOEDIT(),HB_MEMOWRIT(),REPLACE,MEMOREAD() + * $END$ + */ /* $DOC$ * $TEMPLATE$ @@ -200,7 +273,7 @@ * * There is a third parameter (optional), , (not found in * CA-Cl*pper) which let to programmer change the default behavior of - * - allways - to write the EOF character, CHR(26) as in CA-Cl*pper. + * - always - to write the EOF character, CHR(26) as in CA-Cl*pper. * * If there is no third parameter, nothing change, EOF is written as * in CA-Cl*pper, the same occurs when is set to .T. @@ -231,6 +304,80 @@ * $FILES$ * Library is rtl * $SEEALSO$ - * MEMOEDIT(),MEMOREAD() + * MEMOEDIT(),MEMOREAD(),HB_MEMOWRIT() + * $END$ + */ + +/* $DOC$ + * $TEMPLATE$ + * Function + * $NAME$ + * HB_MEMOWRIT() + * $CATEGORY$ + * API + * $SUBCATEGORY$ + * Strings + * $ONELINER$ + * Write a memo field or character string to a text file on disk + * $SYNTAX$ + * HB_MEMOWRIT( , , [] ) --> lSuccess + * $ARGUMENTS$ + * is the filename to read from disk. + * It must include the file extension. If file to be read + * lives in another directory, you must include the path. + * + * Is the memo field or character string, to be write to + * . + * + * Is a logic variable that settle if the "end of file" + * character - CHR(26) - is written to disk. + * This parameter is optional. By default is true (.T.) + * $RETURNS$ + * Function returns true (.T.) if the writing operation was successful; + * otherwise, it returns false (.F.). + * $DESCRIPTION$ + * This a function that writes a memo field or character string to a + * text file on disk (floppy, HD, CD-ROM, etc.) + * If you not specified a path, HB_MEMOWRIT() writes to the + * current directory. If exists, it is overwritten. + * + * There is a third parameter (optional), , (not found in + * CA-Cl*pper) which let to programmer change the default behavior of + * - always - to write the EOF character, CHR(26) as in CA-Cl*pper. + * + * If there is no third parameter, nothing change, EOF is written as + * in CA-Cl*pper, the same occurs when is set to .T. + * But, if is set to .F., EOF char is Not written to the + * end of the file. + * + * HB_MEMOWRIT() function is used together with HB_MEMOREAD() and + * MEMOEDIT() to save to disk text from several sources that was edited, + * searched, replaced, displayed, etc. + * + * Note that HB_MEMOWRIT() do not use the directory settings SET DEFAULT. + * + * HB_MEMOWRIT() vs MEMOWRIT(): + * HB_MEMOWRIT() never writes the obsolete EOF char at the end of the file. + * $EXAMPLES$ + * * This example uses HB_MEMOWRIT() to write the contents of a character + * * variable to a text file. + * + * cFile := "account.prg" + * cString := HB_MEMOREAD( cFile ) + * cCopyright := "Melina" + * + * IF At( "Melina", cString ) == 0 // check for copyright + * HB_MEMOWRIT( cFile, cCopyright + cString ) // if not, add it! + * ENDIF + * $STATUS$ + * R + * $COMPLIANCE$ + * C + * $PLATFORMS$ + * All + * $FILES$ + * Library is rtl + * $SEEALSO$ + * MEMOEDIT(),MEMOREAD(),HB_MEMOWRIT() * $END$ */