dni::sort_collection (::quartus::dcmd_dni)
The following table displays information for the dni::sort_collection Tcl command:
| Tcl Package and Version |
Belongs to ::quartus::dcmd_dni 1.0 |
|||
| Syntax | dni::sort_collection [-h | -help] [-long_help] [-descending] [-dictionary] [-limit <limit> ] <collection> <criteria> | |||
| Arguments | -h | -help | Short help | ||
| -long_help | Long help with examples and possible return values | |||
| -descending | Indicates that the collection is to be sorted in reverse order. By default, the sort proceeds in ascending order | |||
| -dictionary | Sort strings dictionary order. For example "a30" would come after "a4" | |||
| -limit <limit> | Only return the first unique values from the primary sort key | |||
| <collection> | The base collection | |||
| <criteria> | Specifies a list of one or more application or user-defined attributes to use as sort keys | |||
| Description |
Sorts a collection based on one or more attributes, resulting in a new, sorted collection. The sort is ascending by default. |
|||
| Example Usage |
set size [::dni::sort_collection $collection {is_hierarchy}]
|
|||
| Return Value | Code Name | Code | String Return | |
| TCL_OK | 0 | INFO: Operation successful | ||