VtListDeleteItem(1vtcl)


VtListDeleteItem -- delete item(s) from List

Synopsis

VtListDeleteItem list_widgetName [options]

Description

Deletes an item or items from a List.

Options


-all (NA)
Deletes the entire List.

-item string (C)
Specifies an item to delete.

-itemList list (C)
Specifies a list of items to delete.

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

-positionList integer list (NA)
Specifies a list of positions to delete. (The base position is 1. To indicate the last item on the List, use 0.)

Return values

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

INVALID_POSITION
the position value is outside the list range

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.

25 April 2004
© 2004 The SCO Group, Inc. All rights reserved.
UnixWare 7 Release 7.1.4 - 25 April 2004