uaPLUS Reference
CreateBrowser Method
See Also  Send Feedback
HDAPluginDBA Namespace > Browser Class : CreateBrowser Method

attrID
The filter attribute IDs.
bOperator
The filter operators.
filter
The filter values.
errors
The validity of the filtering inputs.

Glossary Item Box

Create a new browser object with the specified filters, operators and attributes. 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 CreateBrowser( _
   ByVal attrID() As Integer, _
   ByVal bOperator() As OperatorCodes, _
   ByVal filter() As Object, _
   ByRef errors As Integer() _
) As Integer
C# 
public int CreateBrowser( 
   int[] attrID,
   OperatorCodes[] bOperator,
   object[] filter,
   out int[] errors
)

Parameters

attrID
The filter attribute IDs.
bOperator
The filter operators.
filter
The filter values.
errors
The validity of the filtering inputs.

Return Value

Success failure HRESULT

Remarks

A filter is defined by the three parameters pdwAttrID, pOperator and vFilter. The filter expression is true if the relationship of the value of the attribute to the filter value matches the filter operator. If multiple filter expressions are given, they must all be true for the item to be included.

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.