ReadItemValueArrayOfString(IEasyDAClient,ServerDescriptor,DANodeDescriptor,DAReadParameters) Method

Reads a value of named OPC item, and converts it to an array of System.String. The value is requested from the OPC server using a corresponding data type.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<ElementsCanBeNullAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function ReadItemValueArrayOfString( _
   ByVal client As IEasyDAClient, _
   ByVal serverDescriptor As ServerDescriptor, _
   ByVal nodeDescriptor As DANodeDescriptor, _
   ByVal readParameters As DAReadParameters _
) As String()

'Usage
 
Dim client As IEasyDAClient
Dim serverDescriptor As ServerDescriptor
Dim nodeDescriptor As DANodeDescriptor
Dim readParameters As DAReadParameters
Dim value() As String
 
value = IEasyDAClientExtension2.ReadItemValueArrayOfString(client, serverDescriptor, nodeDescriptor, readParameters)

[Extension()]
[ElementsCanBeNull()]
[NotNull()]
public static string[] ReadItemValueArrayOfString( 
   IEasyDAClient client,
   ServerDescriptor serverDescriptor,
   DANodeDescriptor nodeDescriptor,
   DAReadParameters readParameters
)

[Extension()]
[ElementsCanBeNull()]
[NotNull()]
public:
static array<String^>^ ReadItemValueArrayOfString( 
   IEasyDAClient^ client,
   ServerDescriptor^ serverDescriptor,
   DANodeDescriptor^ nodeDescriptor,
   DAReadParameters^ readParameters
)

Parameters

client: The client object that will perform the operation.
serverDescriptor: The OPC server involved in the operation.
nodeDescriptor: The descriptor of the OPC node involved in the operation.
readParameters: The read parameters (such as data source or value age).

Return Value

Returns a value of the OPC item, converted to a type indicated by the method name.

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

Using implicit conversions, you can pass an item ID in place of node descriptor. You can also pass a value age in place of read parameters

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

IEasyDAClientExtension2 Class
IEasyDAClientExtension2 Members
Overload List

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