QuickOPC User's Guide and Reference
GetPrimaryAlarmAreaPropertyValue(IEasyDAClient,ServerDescriptor,DANodeDescriptor) Method



OpcLabs.EasyOpcClassic Assembly > OpcLabs.EasyOpc.DataAccess.Extensions Namespace > IEasyDAClientExtension2 Class > GetPrimaryAlarmAreaPropertyValue Method : GetPrimaryAlarmAreaPropertyValue(IEasyDAClient,ServerDescriptor,DANodeDescriptor) Method
The client object that will perform the operation.
The OPC server involved in the operation.
The descriptor of the OPC node involved in the operation.
Obtains value of Primary Alarm Area OPC property for a given OPC item.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function GetPrimaryAlarmAreaPropertyValue( _
   ByVal client As IEasyDAClient, _
   ByVal serverDescriptor As ServerDescriptor, _
   ByVal nodeDescriptor As DANodeDescriptor _
) As String
'Usage
 
Dim client As IEasyDAClient
Dim serverDescriptor As ServerDescriptor
Dim nodeDescriptor As DANodeDescriptor
Dim value As String
 
value = IEasyDAClientExtension2.GetPrimaryAlarmAreaPropertyValue(client, serverDescriptor, nodeDescriptor)
[Extension()]
[NotNull()]
public static string GetPrimaryAlarmAreaPropertyValue( 
   IEasyDAClient client,
   ServerDescriptor serverDescriptor,
   DANodeDescriptor nodeDescriptor
)
[Extension()]
[NotNull()]
public:
static String^ GetPrimaryAlarmAreaPropertyValue( 
   IEasyDAClient^ client,
   ServerDescriptor^ serverDescriptor,
   DANodeDescriptor^ nodeDescriptor
) 

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.

Return Value

Returns a value of this OPC property for a specified OPC item, converted to a proper type.
Exceptions
ExceptionDescription
The OPC "Classic" (or OPC XML-DA) operation has failed.
A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.
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 2012, Windows Server 2016; .NET Core, .NET 5, .NET 6: Linux, macOS, Microsoft Windows

See Also

Reference

IEasyDAClientExtension2 Class
IEasyDAClientExtension2 Members
Overload List