OPCDA.NET Reference Manual
Browse Method
See Also  Send Feedback
OpcDaNetUA.Net4 Assembly > OPCDA.NET Namespace > BGServer Class : Browse Method

branch
The fully qualified name of the branch to be browsed. Nothing (null) or an empty string identifies the root branch.
mode
Branches or Items or both can be included in the browse result.
elementFilter
Filter string for the branch/item names. Nothing (null), an empty string or "*" includes all names. '*' matches any sequence of characters and '?' matches any single character.
vendorFilter
A vendor specific filter string that may be used by some OPC DA3 servers. This is not supported by OPC DA2 servers.
returnProperties
If TRUE, all item properties are returned as part of the browse result.
returnValues
If TRUE, the item property information includes the current property values.
propertyIDs
This optional array of property ID values identifies the properties to be returned. Nothing (null) indicates that no property information should be included in the browse result. This argument is ignored if returnProperties is TRUE.
tag
This object is passed to the competion handler and allows the user to pass any information that may be needed in the completion handler. null (nothing) can be specified if the application does not require to pass any information.
onCompleted
Competion notification handler. void xxx( BGException ex, string branch, BrowseElement[] nodes, object tag ){}

Glossary Item Box

Available in the OPCDA.NET Professional Edition only.
The specified branch is browsed with the specified filters. The browse result is returned to the user as an argument of the completion handler. OPC DA V3 server are browsed using the OPC DA3 Browse() method. For OPC DA V2 servers the browse call is emulated by calling the available OPC DA2 browse handling methods.

Syntax

Visual Basic (Declaration) 
Public Sub Browse( _
   ByVal branch As String, _
   ByVal mode As browseFilter, _
   ByVal elementFilter As String, _
   ByVal vendorFilter As String, _
   ByVal returnProperties As Boolean, _
   ByVal returnValues As Boolean, _
   ByVal propertyIDs() As Integer, _
   ByVal tag As Object, _
   ByVal onCompleted As OnBGSrvBrowse _
) 

Parameters

branch
The fully qualified name of the branch to be browsed. Nothing (null) or an empty string identifies the root branch.
mode
Branches or Items or both can be included in the browse result.
elementFilter
Filter string for the branch/item names. Nothing (null), an empty string or "*" includes all names. '*' matches any sequence of characters and '?' matches any single character.
vendorFilter
A vendor specific filter string that may be used by some OPC DA3 servers. This is not supported by OPC DA2 servers.
returnProperties
If TRUE, all item properties are returned as part of the browse result.
returnValues
If TRUE, the item property information includes the current property values.
propertyIDs
This optional array of property ID values identifies the properties to be returned. Nothing (null) indicates that no property information should be included in the browse result. This argument is ignored if returnProperties is TRUE.
tag
This object is passed to the competion handler and allows the user to pass any information that may be needed in the completion handler. null (nothing) can be specified if the application does not require to pass any information.
onCompleted
Competion notification handler. void xxx( BGException ex, string branch, BrowseElement[] nodes, object tag ){}

Requirements

Target Platforms: Windows 7/8/10, Windows Server 2003/2008/2012/2016, .NET 4.x

See Also

Copyright © 2002-2018 Advosol Inc. All Rights Reserved.