Reference

OpcClassicApplicationDescription Members

Type

OpcClassicApplicationDescription

Namespace

Opc.UaFx.Classic

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Constructors

OpcClassicApplicationDescription

3 overloads

Overload	Description
OpcClassicApplicationDescription(Guid)	Initializes a new instance of the OpcClassicApplicationDescription class using the specified classId of a server on the local host.
OpcClassicApplicationDescription(Guid, string)	Initializes a new instance of the OpcClassicApplicationDescription class using the specified classId and progId of a server on the local host.
OpcClassicApplicationDescription(Guid, string, string)	Initializes a new instance of the OpcClassicApplicationDescription class using the specified classId, progId and host.

OpcClassicApplicationDescription(Guid)

Initializes a new instance of the OpcClassicApplicationDescription class using the specified classId of a server on the local host.

public OpcClassicApplicationDescription(Guid classId)

Public Sub New(classId As Guid)

Parameters

Name	Type	Description
classId	Guid	The class identifier (CLSID) of the server.

OpcClassicApplicationDescription(Guid, string)

Initializes a new instance of the OpcClassicApplicationDescription class using the specified classId and progId of a server on the local host.

public OpcClassicApplicationDescription(Guid classId, string progId)

Public Sub New(classId As Guid, progId As String)

Parameters

Name	Type	Description
classId	Guid	The class identifier (CLSID) of the server.
progId	String	The program identifier (ProgID) of the server, or a null reference (Nothing in Visual Basic) if it is not known.

OpcClassicApplicationDescription(Guid, string, string)

Initializes a new instance of the OpcClassicApplicationDescription class using the specified classId, progId and host.

public OpcClassicApplicationDescription(
    Guid classId,
    string progId,
    string host)

Public Sub New(classId As Guid, progId As String, host As String)

Parameters

Name	Type	Description
classId	Guid	The class identifier (CLSID) of the server.
progId	String	The program identifier (ProgID) of the server, or a null reference (Nothing in Visual Basic) if it is not known.
host	String	The name of the host of the server, or a null reference (Nothing in Visual Basic) or an empty string for "localhost".

Remarks

The Uri of the description uses the scheme "opc.com", the host and the path "progId/{classId}", or only "{classId}" without a program identifier.

Properties

ClassId

Gets the class identifier of the server.

public Guid ClassId { get; }

Public ReadOnly Property ClassId As Guid

Property value

Guid

The class identifier (CLSID) of the server.

Host

Gets the name of the host of the server.

public string Host { get; }

Public ReadOnly Property Host As String

Property value

String

The name of the host of the server; "localhost" if none has been specified.

HostIdentity

since v2.12

Gets or sets the identity used to authenticate at the host of the server using DCOM.

public OpcClassicIdentity HostIdentity { get; set; }

Public Property HostIdentity As OpcClassicIdentity

Property value

OpcClassicIdentity

The OpcClassicIdentity to use, or a null reference (Nothing in Visual Basic) to use the identity of the process.

Name

Gets or sets the display name of the server.

public string Name { get; set; }

Public Property Name As String

Property value

String

The display name of the server; by default the ProgId with spaces instead of dots, or a null reference (Nothing in Visual Basic) without a program identifier.

ProgId

Gets the program identifier of the server.

public string ProgId { get; }

Public ReadOnly Property ProgId As String

Property value

String

The version independent program identifier of the server, if known; otherwise its program identifier (ProgID), or a null reference (Nothing in Visual Basic) if it is not known.

Uri

Gets the URI which identifies the server.

public Uri Uri { get; }

Public ReadOnly Property Uri As Uri

Property value

Uri

The URI of the scheme "opc.com" which identifies the server on its host.

Methods

Create

static

Creates a description of the server identified by the uri specified.

public static OpcClassicApplicationDescription Create(Uri uri)

Public Shared Function Create(uri As Uri) As OpcClassicApplicationDescription

Parameters

Name	Type	Description
uri	Uri	The URI of the scheme "opc.com" whose path specifies the class identifier, or the program identifier and the class identifier separated by a slash.

Returns

OpcClassicApplicationDescription

A new OpcClassicApplicationDescription of the server.

Exceptions

Exception	Condition
ArgumentException	The uri is not of the scheme "opc.com" or its path does not specify a class identifier.
ArgumentNullException	The uri is a null reference (Nothing in Visual Basic).

TryCreate

static

Tries to create a description of the server identified by the uri specified.

public static bool TryCreate(
    Uri uri,
    out OpcClassicApplicationDescription result)

Public Shared Function TryCreate(
    uri As Uri,
    result As OpcClassicApplicationDescription) As Boolean

Parameters

Name	Type	Description
uri	Uri	The URI of the scheme "opc.com" whose path specifies the class identifier, or the program identifier and the class identifier separated by a slash.
result	out OpcClassicApplicationDescription	The OpcClassicApplicationDescription created, or a null reference (Nothing in Visual Basic) if the uri does not identify a server.

Returns

Boolean

The value true if the description has been created; otherwise the value false, also if the uri is a null reference (Nothing in Visual Basic).