active list

active list


account Index Level adi
Syntax
Category Definitions
Type Definition
Description a list of strings to be used in a subsequent process that handles items one at a time. Generally, but not always, a list contains item-ids for subsequent processing, but a list may actually contain anything. For example, the statement, "select entity" creates a list of item-ids, while the statement, "select entity name" creates a "list" from the contents of each entity item's "name" attribute.

A "list" may be created by any of the list-generating verbs, such as "get-list", "select", "sselect", etc., or by a FlashBASIC program.

The "end" command may be used to "deactivate" an active list. See "end" for more information on the "double whammy" effect.
Options
See Also select sselect iselect save-list delete-list el secondary list run-list p sreformat EXECUTE verify-system data representation SELECT save rmbi x edit-list READNEXT get-list itemlist* verb classes fi TCL indexer readnext nselect copy-list primary list readnext LOOP readnext null fdk u1195 SYSTEM xk end fl compare-list  
Example sselect entity by name
[404] 18281 items selected out of 18281 items.
>

When this process returns to the TCL prompt, a list is "active". The list may be used by any subsequent process that processes items.

sselect entity by name
[404] 18281 items selected out of 18281 items.
>save-list entity.by.name

List 'entity.by.name' in file 'pointer-file' saved.

This example creates an active list, which is immediately "saved". Once a list is saved, it may be used repeatedly, until it is manually deleted.

sselect entity by name
[404] 18281 items selected out of 18281 items.
>save-list entity.by.name
List 'entity.by.name' in file 'pointer-file' saved.
get-list entity.by.name
[404] 18281 items selected out of 1 items.
>select entity with city "newport beach"
[404] 287 items selected out of 2718281 items.

A list may also be generated from an "active" list.
Warnings Once a list is "active", the next command issued at TCL MUST be a valid list-processing command, otherwise the list will vanish.

For example:

:sselect entity by name
[404] 2718281 items selected out of 2718281 items.
>time
06:44:22  19 Jan 1997  Sunday

The active list has been released.
Compatibility D3 7.0 AP R83
account Index Level adi