ServerProgram Property (ServerDescriptor)

Contains ProgID (if given) or {CLSID} of the OPC server.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<IgnoreDataMemberAttribute()>
<NotNullAttribute()>
<XmlIgnoreAttribute()>
Public Shadows Property ServerProgram As String

'Usage
 
Dim instance As ServerDescriptor
Dim value As String
 
instance.ServerProgram = value
 
value = instance.ServerProgram

[IgnoreDataMember()]
[NotNull()]
[XmlIgnore()]
public new string ServerProgram {get; set;}

[IgnoreDataMember()]
[NotNull()]
[XmlIgnore()]
public:
new property String^ ServerProgram {
   String^ get();
   void set (    String^ value);
}

Property Value

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

The default value of this property is "" (String.Empty).

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

Remarks

There are maximum length limitations on the server program.

The ServerClass and ServerProgram return different values if both the CLSID and ProgID are present.

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

ServerDescriptor Class
ServerDescriptor 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.