Files
harbour-core/doc/en/nation.txt
Viktor Szakats ec87fbc449 2013-03-24 20:22 UTC+0100 Viktor Szakats (harbour syenar.net)
* contrib/hbct/doc/en/*.txt
  * contrib/hbgt/doc/en/hbgt.txt
  * contrib/hbmisc/doc/en/*.txt
  * contrib/hbziparc/doc/en/hbziparc.txt
  * contrib/rddads/doc/en/adsfuncs.txt
  * doc/en/*.txt
    ! space after comma
    ! unicode fix
    ! minor corrections

  * extras/template/tests/hbmk.hbm
    * cleaned recently added comment
2013-03-24 20:22:55 +01:00

125 lines
3.0 KiB
Plaintext

/*
* The following parts are Copyright of the individual authors.
* www - http://harbour-project.org
*
* 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$
Language and Nation MSG()
$CATEGORY$
API
$SUBCATEGORY$
Language and Nation
$ONELINER$
Returns international strings messages.
$SYNTAX$
Language and Nation MSG( <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 returns "Invalid Argument", and if <nMsg> is any
other type it returns an empty string. </par>
$DESCRIPTION$
Language and Nation MSG() 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$
*/