XDASrv Reference Manual
BrowseItemIDs Method
See Also  Send Feedback
NSPlugin Namespace > GenericServer Class : BrowseItemIDs Method




BrowseType
branch/leaf filter OPCBROWSETYPE
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
name pattern match expression
DataTypeFilter
Filter the returned list based in the available datatypes (those that would succeed if passed to AddItem). System.Void indicates no filtering.
AccessRightsFilter
Filter based on the AccessRights bit mask OPCAccess
(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.
currBranch
current branch for the calling client
NrItems
OUT: number of items returned
ItemIDs
OUT: Items meeting the browse criteria.

Virtual mode browse handling.

Called only from the Professional edition generic server when BrowseMode VIRTUAL is configured.

This method browses the items in the current branch of the virtual address space. It has to be implemented according the OPC DA V2 specification.

Syntax

Visual Basic (Declaration) 
Public Function BrowseItemIDs( _
   ByVal BrowseType As Integer, _
   ByVal FilterCriteria As String, _
   ByVal DataTypeFilter As Type, _
   ByVal AccessRightsFilter As Integer, _
   ByVal currBranch As String, _
   ByRef NrItems As Integer, _
   ByRef ItemIDs As String() _
) As Integer
Visual Basic (Usage)Copy Code
Dim instance As GenericServer
Dim BrowseType As Integer
Dim FilterCriteria As String
Dim DataTypeFilter As Type
Dim AccessRightsFilter As Integer
Dim currBranch As String
Dim NrItems As Integer
Dim ItemIDs As String()
Dim value As Integer
 
value = instance.BrowseItemIDs(BrowseType, FilterCriteria, DataTypeFilter, AccessRightsFilter, currBranch, NrItems, ItemIDs)
C# 
public int BrowseItemIDs( 
   int BrowseType,
   string FilterCriteria,
   Type DataTypeFilter,
   int AccessRightsFilter,
   string currBranch,
   out int NrItems,
   out string[] ItemIDs
)
Managed Extensions for C++ 
public: int BrowseItemIDs( 
   int BrowseType,
   string* FilterCriteria,
   Type* DataTypeFilter,
   int AccessRightsFilter,
   string* currBranch,
   [PARAMFLAG::Out] int NrItems,
   [PARAMFLAG::Out] string*[] ItemIDs
) 
C++/CLI 
public:
int BrowseItemIDs( 
   int BrowseType,
   String^ FilterCriteria,
   Type^ DataTypeFilter,
   int AccessRightsFilter,
   String^ currBranch,
   [Out] int NrItems,
   [Out] array<String^> ItemIDs
) 

Parameters

BrowseType
branch/leaf filter OPCBROWSETYPE
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
name pattern match expression
DataTypeFilter
Filter the returned list based in the available datatypes (those that would succeed if passed to AddItem). System.Void indicates no filtering.
AccessRightsFilter
Filter based on the AccessRights bit mask OPCAccess
(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.
currBranch
current branch for the calling client
NrItems
OUT: number of items returned
ItemIDs
OUT: Items meeting the browse criteria.

Return Value

HRESULT error/success code

E_FAIL
E_OUTOFMEMORY
E_INVALIDARG
OPC_E_INVALIDFILTER
S_OK
S_FALSE

The operation failed.
Not enough memory
An argument to the function was invalid.
The filter string was not valid
The operation succeeded.
No items meet the filter criteria.

HRESULT success/error code

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

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