uaPLUS Reference
BrowseOPCAreas Method
See Also  Send Feedback
NSPlugin Namespace > EventAreaBrowser Class : BrowseOPCAreas Method

browseFilterType
An AreaBrowseType enumerator value. 'Area' returns only areas. 'Source' returns only sources.
filterCriteria
A server specific filter string. See OPC specification Appendix A for the definition of the syntax which must be supported by all servers. The implementer may extend this syntax to provide additional capabilities. An empty string indicates no filtering.
numNodes
Number of returned result strings
nodes
Browse result in an array of strings. The array has the size 'numAreas'

Glossary Item Box

Return a string array with a list of Areas as determined by the passed parameters. The position from which the browse is done can be set via the ChangeBrowsePosition.{br/> The returned enumerator may be empty if no Areas or Sources satisfied the filter constraints. The strings returned by the enumerator represent the Areas or Sources contained in the current level. They do not include ?? and delimiter or “parent” names. Clients are allowed to create and hold multiple enumerators in order to maintain more than one “browse position” at a time. Changing the browse position in one enumerator will not affect any other enumerator the client has created. The client must release each enumerator when finished with it.

Syntax

Visual Basic (Declaration) 
Public Function BrowseOPCAreas( _
   ByVal browseFilterType As EventBrowseType, _
   ByVal filterCriteria As String, _
   ByRef numNodes As Integer, _
   ByRef nodes As String() _
) As Integer
C# 
public int BrowseOPCAreas( 
   EventBrowseType browseFilterType,
   string filterCriteria,
   out int numNodes,
   out string[] nodes
)

Parameters

browseFilterType
An AreaBrowseType enumerator value. 'Area' returns only areas. 'Source' returns only sources.
filterCriteria
A server specific filter string. See OPC specification Appendix A for the definition of the syntax which must be supported by all servers. The implementer may extend this syntax to provide additional capabilities. An empty string indicates no filtering.
numNodes
Number of returned result strings
nodes
Browse result in an array of strings. The array has the size 'numAreas'

Requirements

Target Platforms: Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows 7, Windows Server 2008 family

See Also

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