Arbortext Command Language > Functions by Alphabetical Listing > dlgitem_get_list_array
  
dlgitem_get_list_array
dlgitem_get_list_array(window, dlgitem, array)
Returns the entire list of values in the list dialog item or list tag (in outline lists) identified by dlgitem in window. If dlgitem does not refer to a list dialog item or a list tag (in outline lists), $ERROR is set and 0 is returned. Otherwise, 1 is returned.
The window parameter is a window identifier. dlgitem is the value of the control's id attribute. The array parameter specifies the array for the returned values.
To gather only the selected items in a dialog list item, use the dlgitem_get_select_array function.
Example
$ret = dlgitem_get_list_array($win, "Foliage", $Trees)
Gathers all the values in the Foliage dialog list item and places them in the array $Trees.
Related Topics
dlgitem_get_select_array function