ConstantValue(UADataVariable,TypeCode,Object) Method

Makes constant data variable with given value type code and value.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function ConstantValue( _
   ByVal dataVariable As UADataVariable, _
   ByVal valueTypeCode As TypeCode, _
   ByVal value As Object _
) As UADataVariable

'Usage
 
Dim dataVariable As UADataVariable
Dim valueTypeCode As TypeCode
Dim value As Object
Dim value As UADataVariable
 
value = UADataVariableExtension.ConstantValue(dataVariable, valueTypeCode, value)

[Extension()]
[NotNull()]
public static UADataVariable ConstantValue( 
   UADataVariable dataVariable,
   TypeCode valueTypeCode,
   object value
)

[Extension()]
[NotNull()]
public:
static UADataVariable^ ConstantValue( 
   UADataVariable^ dataVariable,
   TypeCode valueTypeCode,
   Object^ value
)

Parameters

dataVariable: The data variable that will be modified and returned.
The value of this parameter cannot be null (Nothing in Visual Basic).
valueTypeCode: The type of the data variable, expressed as .NET type code (System.TypeCode).
value: The constant value that will be provided by the data variable.
The value of this parameter can be null (Nothing in Visual Basic).

Return Value

Returns the , internally modified as defined by the method.

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.ArgumentOutOfRangeException	The value of an argument is outside the allowable range of values as defined by the invoked method. 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.ComponentModel.InvalidEnumArgumentException	An invalid enumeration value was used. 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.ArgumentOutOfRangeException

The value of an argument is outside the allowable range of values as defined by the invoked method.

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.ComponentModel.InvalidEnumArgumentException

An invalid enumeration value was used.

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.

Remarks

The data variable is made read-only, and its minimum sampling interval is set to System.Threading.Timeout.Infinite, effectively disabling the sampling.

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

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

UADataVariableExtension Class
UADataVariableExtension Members
Overload List

Documentation Home, Send Documentation Feedback. Technical Support