GetName(DAPropertyIds,Guid) Method

Determines the property name for an OPC property given by its numerical property Id.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Public Overloads Shared Function GetName( _
   ByVal propertyId As DAPropertyIds, _
   ByVal serverClsid As Guid _
) As String

'Usage
 
Dim propertyId As DAPropertyIds
Dim serverClsid As Guid
Dim value As String
 
value = DAPropertyId.GetName(propertyId, serverClsid)

[NotNull()]
public static string GetName( 
   DAPropertyIds propertyId,
   Guid serverClsid
)

[NotNull()]
public:
static String^ GetName( 
   DAPropertyIds propertyId,
   Guid serverClsid
)

Parameters

propertyId: A numerical Id of the property whose name should be determined.
serverClsid: A CLSID of the OPC server for which the property name should be obtained. This is used for properties that are server-specific. For standard properties, the method does not use this parameter, and it can be passed in as Guid.Empty.

Return Value

Returns a string identifier of the property, for pre-defined properties. An empty string is returned if the property is not known.

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

Exceptions

Exception	Description
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.

Exception

Description

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.

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

DAPropertyId Class
DAPropertyId Members
Overload List

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.