4814b3b5df
* doc/en/memvar2.txt
* doc/en/menu.txt
* doc/en/misc.txt
* doc/en/nation.txt
* doc/en/objfunc.txt
* doc/en/rdddb.txt
* doc/en/rddmisc.txt
* doc/en/rddord.txt
* doc/en/sayget.txt
* doc/en/set.txt
* doc/en/string.txt
* doc/en/tbrowse.txt
* doc/en/tclass.txt
* doc/en/terminal.txt
* doc/en/tgetlist.txt
* doc/en/tlabel.txt
* doc/en/treport.txt
* doc/en/var.txt
! further fixes in $EXAMPLES$ sections
70 lines
2.0 KiB
Plaintext
70 lines
2.0 KiB
Plaintext
/*
|
|
* $Id$
|
|
*/
|
|
|
|
/*
|
|
* The following parts are Copyright of the individual authors.
|
|
* www - http://harbour-project.org
|
|
*
|
|
* Copyright 1999 Chen Kedem <niki@actcom.co.il>
|
|
* Documentation for: READVAR()
|
|
*
|
|
* See COPYING for licensing terms.
|
|
*
|
|
*/
|
|
|
|
/* $DOC$
|
|
* $TEMPLATE$
|
|
* Function
|
|
* $NAME$
|
|
* READVAR()
|
|
* $CATEGORY$
|
|
* API
|
|
* $SUBCATEGORY$
|
|
* User interface
|
|
* $ONELINER$
|
|
* Return variable name of current GET or MENU
|
|
* $SYNTAX$
|
|
* READVAR( [<cVarName>] ) --> cOldVarName
|
|
* $ARGUMENTS$
|
|
* <cVarName> is a new variable name to set.
|
|
* $RETURNS$
|
|
* READVAR() return the old variable name. If no variable previously
|
|
* was set, READVAR() return "".
|
|
* $DESCRIPTION$
|
|
* READVAR() is set inside a READ or MENU TO command to hold the
|
|
* uppercase name of the GET / MENU TO variable, and re-set back to old
|
|
* value when those commands finished. You should not normally set a
|
|
* variable name but rather use it to retrieve the name of a GET
|
|
* variable when executing a VALID or WHEN clause, or during SET KEY
|
|
* execution and you are inside a READ or MENU TO.
|
|
* $EXAMPLES$
|
|
* // display a menu, press F1 to view the MENU TO variable name
|
|
* CLS
|
|
* @ 1, 10 PROMPT "blood sucking insect that infect beds "
|
|
* @ 2, 10 PROMPT "germ; virus infection "
|
|
* @ 3, 10 PROMPT "defect; snag; (source of) malfunctioning"
|
|
* @ 4, 10 PROMPT "small hidden microphone "
|
|
* @ 6, 10 SAY "(Press F1 for a hint)"
|
|
* SET KEY 28 TO ShowVar
|
|
* MENU TO What_Is_Bug
|
|
*
|
|
* PROCEDURE ShowVar
|
|
* Alert( ReadVar() ) // WHAT_IS_BUG in red ALERT() box
|
|
* $STATUS$
|
|
* R
|
|
* $COMPLIANCE$
|
|
* READVAR() works exactly like CA-Cl*pper's READKEY().
|
|
*
|
|
* Note however,
|
|
* that the <cVarName> parameter is not documented and used internally
|
|
* by CA-Cl*pper.
|
|
* $PLATFORMS$
|
|
* All
|
|
* $FILES$
|
|
* Library is rtl
|
|
* $SEEALSO$
|
|
* @...GET,@...PROMPT,MENU TO,READ,SET KEY,__AtPrompt(),__MenuTo()
|
|
* $END$
|
|
*/
|