VtListGetItem(VTCL)


VtListGetItem -- return item(s) from List

Synopsis

VtListGetItem list_widgetName [options]

Description

Gets one or more items from a List. (The returned value depends on the options to the command.)

Options


-all (NA)
Returns the entire List.

-position integer (NA)
Returns the List item at offset integer. (The base position is 1. To indicate the last item on the List, use 0.)

-positionList integer list (NA)
Specifies a list of item positions to return.

Return values

If VtListGetItem 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.

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