Copyright (c) 2001 by Kevin B. Kenny <kennykb@acm.org>. All rights reserved.
See the file "license.terms" for information on usage and redistribution
of this file, and for a DISCLAIMER OF ALL WARRANTIES.
RCS: @(#) $Id: lset.n,v 1.15 2008/03/26 09:59:22 dkf Exp $
.so man.macros
The lset command accepts a parameter, varName, which it interprets as the name of a variable containing a Tcl list. It also accepts zero or more indices into the list. The indices may be presented either consecutively on the command line, or grouped in a Tcl list and presented as a single argument. Finally, it accepts a new value for an element of varName.
If no indices are presented, the command takes the form: .CS lset varName newValue .CE or .CS lset varName {} newValue .CE In this case, newValue replaces the old value of the variable varName.
When presented with a single index, the lset command treats the content of the varName variable as a Tcl list. It addresses the index'th element in it (0 refers to the first element of the list). When interpreting the list, lset observes the same rules concerning braces and quotes and backslashes as the Tcl command interpreter; however, variable substitution and command substitution do not occur. The command constructs a new list in which the designated element is replaced with newValue. This new list is stored in the variable varName, and is also the return value from the lset command.
If index is negative or greater than or equal to the number of elements in $varName, then an error occurs.
.VS 8.5 The interpretation of each simple index value is the same as for the command string index, supporting simple index arithmetic and indices relative to the end of the list. .VE 8.5
If additional index arguments are supplied, then each argument is used in turn to address an element within a sublist designated by the previous indexing operation, allowing the script to alter elements in sublists. The command, .CS lset a 1 2 newValue .CE or .CS lset a {1 2} newValue .CE replaces element 2 of sublist 1 with newValue.
The integer appearing in each index argument must be greater than or equal to zero. The integer appearing in each index argument must be strictly less than the length of the corresponding list. In other words, the lset command cannot change the size of a list. If an index is outside the permitted range, an error is reported.