GetValueRank Method (UAClientReadOnlyModelProvider)

Interrogates the information model for the OPC-UA value rank of the given node.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Function GetValueRank( _
   ByVal modelNodeDescriptor As UAModelNodeDescriptor _
) As ValueResult(Of Integer)

'Usage
 
Dim instance As UAClientReadOnlyModelProvider
Dim modelNodeDescriptor As UAModelNodeDescriptor
Dim value As ValueResult(Of Integer)
 
value = instance.GetValueRank(modelNodeDescriptor)

public ValueResult<int> GetValueRank( 
   UAModelNodeDescriptor modelNodeDescriptor
)

public:
ValueResult<int>^ GetValueRank( 
   UAModelNodeDescriptor^ modelNodeDescriptor
)

Parameters

modelNodeDescriptor: Model node descriptor. Identifies the node in OPC UA information model.
The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

Returns a OpcLabs.BaseLib.OperationModel.Generic.ValueResult<T> with the value rank.

This method never returns null (Nothing in Visual Basic).

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.
System.InvalidOperationException	A method call was invalid for the object's current state. 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.

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.

System.InvalidOperationException

A method call was invalid for the object's current state.

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.

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

UAClientReadOnlyModelProvider Class
UAClientReadOnlyModelProvider Members

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

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.