OPCHDA.NET-UA
CreateBrowse Method
See Also  Send Feedback
OpcHDaNetUaOption.Net4 Assembly > hdaUAwrapper Namespace > HDAServer Class : CreateBrowse Method

filter
The filter definitions.
browser
OUT: Created browser object
errors
OUT: Reports the validity of the filtering inputs.

Glossary Item Box

This synchronous function creates a new OPCHDA_BROWSER object. The filters will be applied to all method calls to this instance of the browser. The server is expected to validate the filter arrays. The server must support a single client having simultaneous access to multiple browse interfaces. Filtering is optional behavior for a server. If a server does not support filtering, or only supports filtering on some of the requested attributes, the server shall return an interface to a browser which is only filtered on the accepted attributes. A server which does not support filtering shall return a pointer to an unfiltered browser interface. Filter operations are additive. To successfully pass filter criteria, the item must successfully satisfy all of the filter criteria. Implementation of filtering and browsing is server specific, however it is anticipated that servers with hierarchical name spaces may only apply filters to leaves, causing them to return branches which have no leaves which satisfy the criteria. It is anticipated that a client may create one browser to locate a particular area of the hierarchy, obtain a fully qualified branch name using GetBranchPosition, then pass that branch name to another browser which is using a different filter set. Servers may optionally support wild cards for string filters. To represent a single character the “?” shall be used. To represent multiple characters the “*” shall be used.

Syntax

Visual Basic (Declaration) 
Public Function CreateBrowse( _
   ByVal filter() As BrowseFilter, _
   ByRef browser As HDABrowser, _
   ByRef errors As Integer() _
) As Integer
C# 
public int CreateBrowse( 
   BrowseFilter[] filter,
   out HDABrowser browser,
   out int[] errors
)

Parameters

filter
The filter definitions.
browser
OUT: Created browser object
errors
OUT: Reports the validity of the filtering inputs.

Return Value

S_OK, OPC_W_NOFILTER, OPC_E_UNKNOWNATTRID, OPC_E_INVALIDDATATYPE, E_INVALIDARG, E_FAIL

Requirements

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

See Also

Copyright © 2018 Advosol Inc. All Rights Reserved.