Description
This function returns a list of item IDs matching the provided criteria.
Signature
array nxa.GetItemIds (string, string, boolean, string)
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 data points in subfolders will be considered, otherwise only those of the given rootPath. |
valueFilter | variant | O, default nil | If provided, only IDs of matching server items having the given value will be returned. |
Example
nxa.GetItemIds2("NETx\\XIO\\KNX\\Gateway1","*\\00/1/*", true, true)
returns the list of all item IDs of the group addresses of KNX Gateway1, main group 00, middle group 1, where the current value is true.
Return
Type | Description |
|---|---|
string [] | An array of strings containing all item IDs matching the provided criteria. If no item IDs match, the function returns nil. |
Applies to
NETx BMS Platform R2 Build 2065+
NETx Multi Protocol Server R2 Build 2065+