GetPropertyValueInt16(IEasyDAClient,ServerDescriptor,DANodeDescriptor,DAPropertyDescriptor) Method

Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to System.Int16.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Function GetPropertyValueInt16( _
   ByVal client As IEasyDAClient, _
   ByVal serverDescriptor As ServerDescriptor, _
   ByVal nodeDescriptor As DANodeDescriptor, _
   ByVal propertyDescriptor As DAPropertyDescriptor _
) As Short

'Usage
 
Dim client As IEasyDAClient
Dim serverDescriptor As ServerDescriptor
Dim nodeDescriptor As DANodeDescriptor
Dim propertyDescriptor As DAPropertyDescriptor
Dim value As Short
 
value = IEasyDAClientExtension2.GetPropertyValueInt16(client, serverDescriptor, nodeDescriptor, propertyDescriptor)

[Extension()]
public static short GetPropertyValueInt16( 
   IEasyDAClient client,
   ServerDescriptor serverDescriptor,
   DANodeDescriptor nodeDescriptor,
   DAPropertyDescriptor propertyDescriptor
)

[Extension()]
public:
static short GetPropertyValueInt16( 
   IEasyDAClient^ client,
   ServerDescriptor^ serverDescriptor,
   DANodeDescriptor^ nodeDescriptor,
   DAPropertyDescriptor^ propertyDescriptor
)

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.
propertyDescriptor: The property descriptor 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.

Remarks

Using implicit conversions, you can pass an item ID in place of node descriptor.

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.