Files
harbour-core/harbour/doc/en/nation.txt
2000-06-20 02:21:06 +00:00

120 lines
3.1 KiB
Plaintext

/*
* $Id$
*/
/*
* The following parts are Copyright of the individual authors.
* www - http://www.harbour-project.org
*
* Copyright 1999 Jose Lalin <dezac@corevia.com>
* ISAFFIRM() documentation
* ISNEGATIVE() documentation
* NATIONMSG() documentation
*
* See doc/license.txt for licensing terms.
*
*/
/* $DOC$
* $FUNCNAME$
* ISAFFIRM()
* $CATEGORY$
* 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
* END DO
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* ISAFFIRM() is fully CA-Clipper compliant. </par>
* $FILES$
* Library is rtl
* $SEEALSO$
* ISNEGATIVE(),NATIONMSG()
* $END$
*/
/* $DOC$
* $FUNCNAME$
* ISNEGATIVE()
* $CATEGORY$
* 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
* END DO
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* ISNEGATIVE() is fully CA-Clipper compliant. </par>
* $FILES$
* Library is rtl
* $SEEALSO$
* ISAFFIRM(),NATIONMSG()
* $END$
*/
/* $DOC$
* $FUNCNAME$
* NATIONMSG()
* $CATEGORY$
* 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 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
* END DO
* </fixed>
* $STATUS$
* C
* $COMPLIANCE$
* NATIONMSG() is fully CA-Clipper compliant. </par>
* $FILES$
* Library is rtl
* $SEEALSO$
* ISAFFIRM(),ISNEGATIVE()
* $END$
*/