Files
harbour-core/doc/en/natmsg.txt
Viktor Szakats b68e5beb2f 2016-11-07 14:50 UTC+0100 Viktor Szakats (vszakats users.noreply.github.com)
- doc/en/hb_set.txt
  * doc/en/set.txt
  * contrib/hbgd/doc/en/hbgd.txt -> contrib/hbgd/doc/en/gdwrp.txt
  * contrib/hbmisc/doc/en/dates2.txt -> contrib/hbmisc/doc/en/dates.txt
  * contrib/hbmisc/doc/en/ht_class.txt -> contrib/hbmisc/doc/en/fileread.txt
  * contrib/hbmisc/doc/en/ht_conv.txt -> contrib/hbmisc/doc/en/nconvert.txt
  * contrib/hbmisc/doc/en/ht_str.txt -> contrib/hbmisc/doc/en/strfmt.txt
  * contrib/hbxpp/doc/en/browse.txt -> contrib/hbxpp/doc/en/dbcmdx.txt
  * contrib/hbziparc/doc/en/hbziparc.txt -> contrib/hbziparc/doc/en/ziparc.txt
  * contrib/rddads/doc/en/adsfuncs.txt -> contrib/rddads/doc/en/adsfunc.txt
  * doc/en/array.txt -> doc/en/arrayshb.txt
  * doc/en/eval.txt -> doc/en/evalhb.txt
  * doc/en/input.txt -> doc/en/inputall.txt
  * doc/en/lang.txt -> doc/en/langall.txt
  * doc/en/nation.txt -> doc/en/natmsg.txt
  * doc/en/setmode.txt -> doc/en/gx.txt
  * doc/en/tgetlist.txt -> doc/en/readvar.txt
    * renames to sync doc filenames with source filename

  ; Above patches come from 3.4 fork commits below:

    2016-11-03 14:01 UTC+0100 Viktor Szakats (vszakats users.noreply.github.com)
    2016-11-03 13:48 UTC+0100 Viktor Szakats (vszakats users.noreply.github.com)
2016-11-07 14:52:06 +01:00

122 lines
2.8 KiB
Plaintext

/*
* Copyright 1999 Jose Lalin <dezac@corevia.com>
* IsAffirm() documentation
* IsNegative() documentation
* NationMsg() documentation
*
* See COPYING.txt for licensing terms.
*
*/
/* $DOC$
$TEMPLATE$
Function
$NAME$
IsAffirm()
$CATEGORY$
API
$SUBCATEGORY$
Language and Nation
$ONELINER$
Checks if passed char is an affirmation char
$SYNTAX$
IsAffirm( <cChar> ) --> <lTrueOrFalse>
$ARGUMENTS$
<cChar> is a char or string of chars </par>
$RETURNS$
<lTrueOrFalse> True if passed char is an affirmation char, otherwise
false </par>
$DESCRIPTION$
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 )
ACCEPT "Sure: " TO cYesNo
ENDDO
$STATUS$
R
$COMPLIANCE$
C
$FILES$
Library is core
$SEEALSO$
IsNegative(), NationMsg()
$END$
*/
/* $DOC$
$TEMPLATE$
Function
$NAME$
IsNegative()
$CATEGORY$
API
$SUBCATEGORY$
Language and Nation
$ONELINER$
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>
$DESCRIPTION$
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 )
ACCEPT "Sure: " TO cYesNo
ENDDO
$STATUS$
R
$COMPLIANCE$
C
$FILES$
Library is core
$SEEALSO$
IsAffirm(), NationMsg()
$END$
*/
/* $DOC$
$TEMPLATE$
Function
$NAME$
NationMsg()
$CATEGORY$
API
$SUBCATEGORY$
Language and Nation
$ONELINER$
Returns international strings messages.
$SYNTAX$
NationMsg( <nMsg> ) --> <cMessage>
$ARGUMENTS$
<nMsg> is the message number you want to get. </par>
$RETURNS$
<cMessage> if <nMsg> is a valid message selector, returns the message.
If <nMsg> is NIL, it returns "Invalid Argument", and if <nMsg> is any
other type it returns an empty string. </par>
$DESCRIPTION$
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.
DO WHILE ! IsAffirm( cYesNo )
ACCEPT "Sure " + NationMsg( 12 ) + ": " TO cYesNo
ENDDO
$STATUS$
C
$COMPLIANCE$
C
$FILES$
Library is core
$SEEALSO$
IsAffirm(), IsNegative()
$END$
*/