BrowseAccessPaths Method (IEasyDAClientExtension)

Browses the possible access paths of a specified OPC item.

Browse for access paths. Specify machine name, server class, and item ID.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<ElementsNotNullAttribute()>
<NotNullAttribute()>
Public Shared Function BrowseAccessPaths( _
   ByVal client As IEasyDAClient, _
   ByVal machineName As String, _
   ByVal serverClass As String, _
   ByVal itemId As String _
) As String()

'Usage
 
Dim client As IEasyDAClient
Dim machineName As String
Dim serverClass As String
Dim itemId As String
Dim value() As String
 
value = IEasyDAClientExtension.BrowseAccessPaths(client, machineName, serverClass, itemId)

[Extension()]
[ElementsNotNull()]
[NotNull()]
public static string[] BrowseAccessPaths( 
   IEasyDAClient client,
   string machineName,
   string serverClass,
   string itemId
)

[Extension()]
[ElementsNotNull()]
[NotNull()]
public:
static array<String^>^ BrowseAccessPaths( 
   IEasyDAClient^ client,
   String^ machineName,
   String^ serverClass,
   String^ itemId
)

Parameters

client: The client object that will perform the operation.
machineName: Name of the machine (empty string for local computer).
serverClass: Contains ProgID of the OPC server to browse.
itemId: ID of the item for which the access paths will be browsed.

Return Value

The method returns an array of possible access paths to the item. You can use the returned access path e.g. as the AccessPath property of DAItemDescriptor object.

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
OpcLabs.EasyOpc.OperationModel.OpcException	The OPC "Classic" (or OPC XML-DA) operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

OpcLabs.EasyOpc.OperationModel.OpcException

The OPC "Classic" (or OPC XML-DA) operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

Most OPC servers do not use access paths.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

IEasyDAClientExtension Class
IEasyDAClientExtension Members

Send Documentation Feedback. Resources: Knowledge Base. Technical support: Online Forums, FAQ.