VtListSetItem(VTCL)


VtListSetItem -- set a List item to a specified value

Synopsis

VtListSetItem list_widgetName [options]

Description

Sets a List item (indicated by -item or -position) to the value specified by -newItem. To set all items in the List use -itemList.

Options


-item string (C)
Sets the item to change.

-itemList list (C)
Sets a list of items to change.

-newItem string (NA)
Sets the new value to assign to the List item being changed.

-position integer (NA)
Specifies the position of an item to change. (The base position is 1. To indicate the last item on the List, use 0.)

Return values

If VtListSetItem fails, it returns one of the following error messages:

INVALID_POSITION
the position value is outside the List range

ITEM_OR_LIST
need to set either -item or -itemList

ITEM_OR_POSITION
need to set either -item or -position

NEED_NEW_ITEM
need to specify a new item (replacement)

NEED_OPTION
no option was specified

NO_FIELD
couldn't find the referenced field

NOT_LIST
referenced widget is not a List

OPTION_COUNT
too many or too few options specified

RECORD_COUNT
number of records specifed exceeds number of available records

Standard errors
See ``Tcl widget creation errors'' in Developing Visual Tcl applications.

02 June 2005
© 2005 The SCO Group, Inc. All rights reserved.
SCO OpenServer Release 6.0.0 - 02 June 2005