VtDrawnListGetItem(1vtcl)

VtDrawnListGetItem -- get record(s) from a DrawnList

Synopsis

VtDrawnListGetItem drawnlist_widgetName [options]

Description

Gets the records from the list. Returns a list of lists; a two dimension list of the items in the DrawnList.

{
   { 0 {string} {data}}
   { 0 {string} {data}}
}

Options

-all (NA)

Gets the entire list.

-field column matchStr (NA)

Gets fields on the basis of a match on columns of data. For example, if your list contains:

{0 1 "String one"}
{0 1 "String two"} 
{0 1 "String three"}

specifying -field 2 "String two" matches item 2.

-position integer (NA)

Specifies an item to get by position. (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 get. If this option is selected, VtDrawnListGetSelectedItem returns a list of positions instead of the normal return value.

Return values

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

INVALID_POSITION: the position value is outside the list range
NO_FIELD: couldn't find the referenced field
NO_OPTION: no options were specified
NOT_DRAWNLIST: referenced widget is not a DrawnList
OPTION_COUNT: too many or too few options specified
RECORD_COUNT: number of records specifed exceeds number of available records