nxa.GetBranchIds
- Wolfgang Granzer
Description
This function returns a list of item branch IDs matching the provided criteria.
Signature
array nxa.GetBranchIds(string, string, boolean)
Parameters
Name | Type | Mandatory/Optional | Description |
|---|---|---|---|
rootPath | string | M | The name of the root folder for the search. |
itemIdFilter | string | M | The search filter that is applied to the full item IDs. An asterisk “*” can be used as a wildcard. |
searchRecursive | boolean | O, default true | If true then branches in subfolders will be considered, otherwise only those of the given rootPath. |
Example
nxa.GetBranchIds("NETx\\VAR","*ric", true)returns the list of all item branch IDs of the branch NETx\VAR that end with ric. The result will be NETx\VAR\Numeric.
Return
Type | Description |
|---|---|
string [] | An array of strings containing all item branch IDs matching the provided criteria. If no item branch IDs match, the function returns nil. The start index of the array is, as it is common in LUA, 1. |
Applies to
NETx BMS Platform R2 Build 2070+
NETx Multi Protocol Server R2 Build 2070+