Visible to Intel only — GUID: reference_TCL_tcl_pkg_sta_ver_1_0_cmd_remove_from_collection
Ixiasoft
Visible to Intel only — GUID: reference_TCL_tcl_pkg_sta_ver_1_0_cmd_remove_from_collection
Ixiasoft
3.1.29.41. remove_from_collection (::quartus::sta)
The following table displays information for the remove_from_collection Tcl command:
Tcl Package and Version | Belongs to ::quartus::sta |
||
Syntax | remove_from_collection [-h | -help] [-long_help] <base_collection> <items_to_remove> | ||
Arguments | -h | -help | Short help | |
-long_help | Long help with examples and possible return values | ||
<base_collection> | Collection to remove items from | ||
<items_to_remove> | Items to be removed from base_collection | ||
Description | This command takes two collections and returns a new collection that is the difference of the two, effectively the second collection subtracted from the first collection. The second collection can be a string, but the first has to be previously-created collection: either by passing any of the "get_" functions directly, or by passing a variable that contains a collection (see code examples for this command). If a collection is used for the second argument, the types in the second collection must be the same as or a subset of the types in the first collection. If the first collection consists of keepers, the second collection can only consist of keepers, registers or ports. If the first collection consists of partitions, the second collection can only consist of partitions or cells. If the first collection consists of nodes, the second collection can only consist of nodes, keepers, registers, ports, pins, nets or combinational nodes. |
||
Example Usage | |
||
Return Value | Code Name | Code | String Return |
TCL_OK | 0 | INFO: Operation successful | |
TCL_ERROR | 1 | ERROR: Cannot find specified collection. Specify an existing collection. |