Files
harbour-core/harbour/doc/en/ht_str.txt
2000-03-07 17:50:36 +00:00

60 lines
1.8 KiB
Plaintext

/*
* $Id$
*/
/*
* The following parts are Copyright of the individual authors.
* www - http://www.harbour-project.org
*
* Copyright 1999 Victor Szakats <info@szelvesz.hu>
* STRFORMAT() documentation
*
* See doc/license.txt for licensing terms.
*
*/
/* $DOC$
* $FUNCNAME$
* StrFormat()
* $CATEGORY$
* String
* $ONELINER$
* ...
* $SYNTAX$
* StrFormat(<cMask>[, <cPar1>[, <cParn>[, ...]]) --> cString
* $ARGUMENTS$
* <cMask> Holds the mask for the resulting string
* <cParn> Holds the strings to be inserted in the mask
* maximum 9 of them can be specified.
* $RETURNS$
* <cString> Return the mask with all the parameters inserted.
* $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 "%%".
* $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")
* $TESTS$
* ? 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")
* ? StrFormat("Hello")
* ? StrFormat("%1 - %2", "one")
* ? StrFormat("%1 - %2", "one", "two")
* ? StrFormat("%2 - %1", "one", "two")
* ? StrFormat("%2 - %", "one", "two")
* ? StrFormat("%% - %", "one", "two")
* ? StrFormat("%9 - %", "one", "two")
* $STATUS$
* Done
* $COMPLIANCE$
* All platforms
* $END$
*/