Files
harbour-core/harbour/doc/en/tlabel.txt

86 lines
2.8 KiB
Plaintext

/*
* $Id$
*/
/*
* The following parts are Copyright of the individual authors.
* www - http://www.harbour-project.org
*
* Copyright 1999 Luiz Rafael Culik <culik@sl.conex.net>
* Documentation
*
* See doc/license.txt for licensing terms.
*
*/
/* $DOC$
* $FUNCNAME$
* LABEL FORM
* $CATEGORY$
* Command
* $ONELINER$
* Displays labels to the screen or an alternate device
* $SYNTAX$
* LABEL FORM <cLabelName> [TO PRINTER] [TO FILE <cFile>] [<cScope>]
* [WHILE <bWhile> ] [FOR <bFor> ] [SAMPLE] [NOCONSOLE]
* $ARGUMENTS$
* <cLabelName> Name of label file </par>
*
* <cFile> Name of an alternate file </par>
*
* <cScope> Expression of a scoping condition </par>
*
* <bWhile> WHILE condition </par>
*
* <bFor> FOR condition </par>
* $DESCRIPTION$
* This command allows labels to be printed based on the format
* outlined in LBL file specified as <cLabelName>. By default, output
* will go to the screen however this output may be rerouted with
* either the TO PRINTER or the TO FILE clause. </par>
*
* If the TO FILE clause is specified, the name of the ASCII text file
* containing the generated labels will be <cFile>. </par>
*
* If no file extension is specified a .TXT extension is added.
* <cScope> is the scope condition for this command. Valid scopes
* include NEXT <expN> (number of records to be displayed, where <expN>
* is the number of records), RECORD <expN> (a specific record to be
* printed), REST (all records starting from the current record
* position,and ALL (all records). The default is ALL. </par>
*
* Both logical expression may work ill conjunction with one another
* where <bFor> is the logical expression for the FOR condition (for
* records to be displayed whitin a given value range) and <bWhile> for
* the WHILE condition (for records to be displayed until they fail to
* meet the condition). </par>
*
* If the SAMPLE clause is specified, test labels will be generated. </par>
*
* If the NOCONSOLE clause is specified,the console will be turned off
* while this command is being executed. </par>
*
* This command follows the search criteria outlined in the SET PATH TO
* command. The path may be specified, along, with (the drive letter,
* in <cLabelName> </par>
* $EXAMPLES$
* FUNCTION MAIN()
* USE Test New
* LABEL FORM EE
* USE
* RETURN NIL
*
*
* $STATUS$
* R
* $COMPLIANCE$
* This command is CA-Clipper compliant. </par>
* $PLATFORMS$
* ALL </par>
* $FILES$
* Library is rtl
* $SEEALSO$
* REPORT FORM
* $END$
*/