harbour-core/harbour/doc/en/nation.txt

/*
 * $Id$
 */

/*
 * 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 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
 *      END DO
 *  $STATUS$
 *      R
 *  $COMPLIANCE$
 *      C
 *  $FILES$
 *      Library is rtl
 *  $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
 *      END DO
 *  $STATUS$
 *      R
 *  $COMPLIANCE$
 *      C
 *  $FILES$
 *      Library is rtl
 *  $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
 *      END DO
 *  </fixed>
 *  $STATUS$
 *      C
 *  $COMPLIANCE$
 *      C
 *  $FILES$
 *      Library is rtl
 *  $SEEALSO$
 *      ISAFFIRM(),ISNEGATIVE()
 *  $END$
 */