OPC Studio User's Guide and Reference
AliasMetadata Constructor(String,String,String)



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Aliasing Namespace > AliasMetadata Class > AliasMetadata Constructor : AliasMetadata Constructor(String,String,String)
Specifies the display name for an alias.

The value of this parameter cannot be null (Nothing in Visual Basic).

The name of the category in which the alias is grouped.

The value of this parameter cannot be null (Nothing in Visual Basic).

Specifies a description for the alias.

The value of this parameter cannot be null (Nothing in Visual Basic).

Initializes a new instance of the class with the specified display name, category, and description.
Syntax
'Declaration
 
Public Function New( _
   ByVal displayName As String, _
   ByVal category As String, _
   ByVal description As String _
)
'Usage
 
Dim displayName As String
Dim category As String
Dim description As String
 
Dim instance As New AliasMetadata(displayName, category, description)
public AliasMetadata( 
   string displayName,
   string category,
   string description
)
public:
AliasMetadata( 
   String^ displayName,
   String^ category,
   String^ description
)

Parameters

displayName
Specifies the display name for an alias.

The value of this parameter cannot be null (Nothing in Visual Basic).

category
The name of the category in which the alias is grouped.

The value of this parameter cannot be null (Nothing in Visual Basic).

description
Specifies a description for the alias.

The value of this parameter cannot be null (Nothing in Visual Basic).

Exceptions
ExceptionDescription

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.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also