Browse the current branch for branches or items.
Syntax
Parameters
- filterType
- IN: branch/leaf filter
OPC_BRANCH - returns only items that have children
OPC_LEAF - returns only items that don't have children
OPC_FLAT - returns everything at and below this level including all children of children - basically 'pretends' that the address space in actually FLAT
This parameter is ignored for FLAT address space. - filterCriteria
- A server specific filter string.
This is entirely free format and may be entered by the user via an EDIT field.
Although the valid criteria are vendor specific, source code for a recommended filter function
is included in an Apppendix at the end of this document. This particular filter function is
commonly used by OPC interfaces and is very similar in functionality to the LIKE function in
Visual Basic. A pointer to a NUL string indicates no filtering.
- sTypeFilter
- Data type filter specified as a .Net data type
Filter the returned list based in the available datatypes (those that would succeed if passed to AddItem). Type void indicates no filtering. - accessRightsFilter
- Filter based on the AccessRights bit mask (OPC_READABLE or OPC_WRITEABLE).
The bits passed in the bitmask are 'ANDed' with the bits that would be returned for this Item by
AddItem, ValidateItem or EnumOPCItemAttributes. If the result is non-zero then the item is returned.
A 0 value in the bitmask indicates that the AccessRights bits should be ignored during the filtering
process.
- nodes
- OUT: string array with the browsed items.
Return Value
HRESULT success/error code
Requirements
Target Platforms: Windows 7/8/10, Windows Server 2008/2012/2016, .NET 4.7.2
See Also