TmListRetrieve Function
Gets the items currently set in the specified list.
Usage
items = TmListRetrieve(tool_name, list_name)
Input Parameters
tool_name—A string specifying the unique name of a VDA Tool.
list_name—A string specifying the unique name of a list.
Returned Value
items—A list array containing the currently set items or an empty list if no items have been set.
Keywords
Count—Returns the number of items retrieved. (integer)
Discussion
Only those items that have been set are returned. Items that have been allocated but not used are not returned.
This procedure defines the behavior of the TM_LIST_RETRIEVE method.
Example
This example retrieves all the items in a list and uses the Count keyword to get the number of items in the list.
; Retrieve all the items in the list.
list_name = TmList(tool_name)
TmListAppend, tool_name, list_name, 'First Item'
TmListAppend, tool_name, list_name, 2L
TmListInsert, tool_name, list_name, 'New Item', 0
items = TmListRetrieve(tool_name, list_name)
INFO, items, /Full
; Use the Count keyword to return the number of items in the list.
items = TmListRetrieve(tool_name, list_name, Count=count)
INFO, items
PRINT, count
See Also
Version 2017.0
Copyright © 2017, Rogue Wave Software, Inc. All Rights Reserved.