summaryrefslogtreecommitdiffstats
path: root/doc/array.n
diff options
context:
space:
mode:
authorfvogel <fvogelnew1@free.fr>2017-10-24 21:24:07 (GMT)
committerfvogel <fvogelnew1@free.fr>2017-10-24 21:24:07 (GMT)
commit40ce2eccbc52b403d4a4b7bc479fbde987a14e18 (patch)
treedef80b95ab5c82a0f402bfcd055a593438cf2374 /doc/array.n
parent9306fa604ca63f8626f859c1f6cb5154a659e504 (diff)
downloadtcl-40ce2eccbc52b403d4a4b7bc479fbde987a14e18.zip
tcl-40ce2eccbc52b403d4a4b7bc479fbde987a14e18.tar.gz
tcl-40ce2eccbc52b403d4a4b7bc479fbde987a14e18.tar.bz2
'array for' implementation (TIP #421) from Brad Lanam
Diffstat (limited to 'doc/array.n')
-rw-r--r--doc/array.n7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/array.n b/doc/array.n
index 25ad0c6..751c688 100644
--- a/doc/array.n
+++ b/doc/array.n
@@ -47,6 +47,13 @@ been the return value from a previous invocation of
Returns 1 if \fIarrayName\fR is an array variable, 0 if there
is no variable by that name or if it is a scalar variable.
.TP
+\fBarray for {\fIkeyVariable ?valueVariable?\fB} \fIarrayName body\fR
+The first argument is a one or two element list of variable names for the
+key and value of each entry in the array. The second argument is the
+array name to iterate over. The third argument is the body to execute
+for each key and value returned.
+The ordering of the returned keys is undefined.
+.TP
\fBarray get \fIarrayName\fR ?\fIpattern\fR?
Returns a list containing pairs of elements. The first
element in each pair is the name of an element in \fIarrayName\fR