home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / tcl2-73c.zip / tcl7.3 / doc / foreach.n < prev    next >
Text File  |  1993-05-03  |  2KB  |  48 lines
  1. '\"
  2. '\" Copyright (c) 1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/foreach.n,v 1.1 93/05/03 17:09:42 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .so man.macros
  24. .HS foreach tcl
  25. .BS
  26. '\" Note:  do not modify the .SH NAME line immediately below!
  27. .SH NAME
  28. foreach \- Iterate over all elements in a list
  29. .SH SYNOPSIS
  30. \fBforeach \fIvarname list body\fR
  31. .BE
  32.  
  33. .SH DESCRIPTION
  34. .PP
  35. In this command \fIvarname\fR is the name of a variable, \fIlist\fR
  36. is a list of values to assign to \fIvarname\fR, and \fIbody\fR is a
  37. Tcl script.
  38. For each element of \fIlist\fR (in order
  39. from left to right), \fBforeach\fR assigns the contents of the
  40. field to \fIvarname\fR as if the \fBlindex\fR command had been used
  41. to extract the field, then calls the Tcl interpreter to execute
  42. \fIbody\fR.  The \fBbreak\fR and \fBcontinue\fR statements may be
  43. invoked inside \fIbody\fR, with the same effect as in the \fBfor\fR
  44. command.  \fBForeach\fR returns an empty string.
  45.  
  46. .SH KEYWORDS
  47. foreach, iteration, list, looping
  48.