SelectByLinks()
Summary
Selects nodes based on a set of links from its associated line layer.
Changes
Added to version 2022.
Syntax
n_selected = SelectByLinks(string set_name, string operation, string link_set, opt array options)
| Argument | Contents |
|---|---|
| set_name | The name of the selection set |
| operation | The operation to perform, as indicated below |
| link_set | The set of links to use |
| Operation | Meaning |
|---|---|
| several | Replaces the contents of the selection set |
| less | Removes features from the selection set |
| more | Adds features to the selection set |
| subset | Selects a subset of the selection set |
| Option | Type | Contents |
|---|---|---|
| Inclusion | String | Enclosed or Intersecting, overriding the current setting; for more information, see SetSelectInclusion() |
| Max | Integer | Maximum number of records to select |
| Display | Boolean | "True" or "False" overriding the current setting; for more information, see SetSelectDisplay() |
| Auto Redraw | Boolean | "True" or "False" overriding the current setting; for more information, see SetSelectAutoRedraw() |
| Source And | String | A selection set on the current layer that records must be in to be selected |
| Source Not | String | A selection set on the current layer that records must not be in to be selected |
Returns
An integer indicating the number of records in the selection set.
Notes
The options array is an optional argument.
The current layer must be a node layer.
If the set does not already exist, SelectByLinks() creates it.
Example
n = SelectByLinks("Selection", "Several", linkset)Error Codes
| Error Type | Meaning |
|---|---|
| Error | The set name, the operation type or the link set is invalid |
| NotFound | No features exist |
See Also
| Function | Summary |
|---|---|
| SelectByNodes() | Selects links based on a set of nodes from its associated node layer |