GetPropertyValueArrayOfChar(IEasyDAClient,String,String,String,DAPropertyId) Method

Gets a value of OPC property, using individual parameters specifying the OPC server, and OPC Item ID, and converts it to an array of System.Char.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function GetPropertyValueArrayOfChar( _
   ByVal client As IEasyDAClient, _
   ByVal machineName As String, _
   ByVal serverClass As String, _
   ByVal itemId As String, _
   ByVal propertyId As DAPropertyId _
) As Char()

'Usage
 
Dim client As IEasyDAClient
Dim machineName As String
Dim serverClass As String
Dim itemId As String
Dim propertyId As DAPropertyId
Dim value() As Char
 
value = IEasyDAClientExtension2.GetPropertyValueArrayOfChar(client, machineName, serverClass, itemId, propertyId)

[Extension()]
[NotNull()]
public static char[] GetPropertyValueArrayOfChar( 
   IEasyDAClient client,
   string machineName,
   string serverClass,
   string itemId,
   DAPropertyId propertyId
)

[Extension()]
[NotNull()]
public:
static array<char>^ GetPropertyValueArrayOfChar( 
   IEasyDAClient^ client,
   String^ machineName,
   String^ serverClass,
   String^ itemId,
   DAPropertyId^ propertyId
)

Parameters

client: The client object that will perform the operation.
machineName: Name of the machine. Determines the computer on which the OPC server is located. May be an empty string, in which case the OPC server is assumed to exist on the local computer or at the computer specified for it by DCOM configuration.
serverClass: Contains ProgID of the OPC server to read from.
itemId: The Item ID of the OPC item involved in the operation.
propertyId: The Property ID of the OPC property being obtained

Return Value

If successful, the function returns the actual value of the OPC property requested, 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.

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.