VtDrawnListDeleteItem(VTCL)


VtDrawnListDeleteItem -- delete an item from a DrawnList

Synopsis

VtDrawnListDeleteItem drawnlist_widgetName [options]

Description

Deletes an item from a DrawnList. It is an error if the position or the field options do not match something in the list. Only one of the options listed may be used at one time.

Options


-all (NA)
Specify the entire list.

-field column matchStr (NA)
Delete the item whose field column matches the string matchStr. For example, if your list contains:
{0 1 "String one"}
{0 1 "String two"} 
{0 1 "String three"}
specifying -field 2 "String one" would match item 1.

-position integer (NA)
Specify a list item by position. (The base position is 1. To indicate the last item on the list, use 0.)

-positionList integer_list (NA)
Specify a list of items to delete by position.

Return values

If VtDrawnListDeleteItem 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

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