Visavi Visual OPC .NET  

OpcConnection.Browse Method

Browses the root node of the OPC Server for all branches and leaves.

[Visual Basic]
 Overloads Public Function Browse( _
   String itemId, _
) As IOpcBrowseElement()

[C#]
public IOpcBrowseElement[] Browse(
   string itemId,
);

[C++]
public: IOpcBrowseElement __gc[] Browse( 
   String* itemId,
);

[JScript]
public function Browse(
   itemId : String,
) : IOpcBrowseElement[]

Parameters

itemId 
The Item ID representing the OPC item to be browsed.

Return Value

An array of IOpcBrowseElement objects that represent the branches and leaves for the OPC item specified by the itemId parameter.

Exceptions

Exception Type Condition
BrowseItemException An error occured while browsing the address space for this item. Examine the Message and InnerException properties to get a better understanding of the error's nature.

Remarks

The Browse method uses the browsing interfaces of the OPC Server to browse it's address space. For a better understanding of the heirarchical layout of OPC servers refer to the IOPCBrowse interface of the OPC DA Server Specification.

Requirements

Platforms: Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows .NET Server family

See Also

OpcConnection Interface OpcConnection Members | Visavi.Opc.Client Namespace