OPC Studio User's Guide and Reference
FromString Method (ServerDescriptor)



OpcLabs.EasyOpcClassicCore Assembly > OpcLabs.EasyOpc Namespace > ServerDescriptor Class : FromString Method
Contains the descriptor string for the server.

The value represents a server descriptor string. Any string can be passed to this parameter (i.e. will not cause System.ArgumentException), but not all values make sense and will work when an operation using them is attempted. The server descriptor string is typically the ProgID (or {CLSID}) of the object, a string in the form "\\machineName\serverClass", or a URI of the object.

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

Converts a string containing server's descriptor string to a server descriptor.
Syntax
'Declaration
 
<CanBeNullAttribute()>
Public Shared Shadows Function FromString( _
   ByVal descriptorString As String _
) As ServerDescriptor
'Usage
 
Dim descriptorString As String
Dim value As ServerDescriptor
 
value = ServerDescriptor.FromString(descriptorString)
[CanBeNull()]
public new static ServerDescriptor FromString( 
   string descriptorString
)
[CanBeNull()]
public:
new static ServerDescriptor^ FromString( 
   String^ descriptorString
) 

Parameters

descriptorString
Contains the descriptor string for the server.

The value represents a server descriptor string. Any string can be passed to this parameter (i.e. will not cause System.ArgumentException), but not all values make sense and will work when an operation using them is attempted. The server descriptor string is typically the ProgID (or {CLSID}) of the object, a string in the form "\\machineName\serverClass", or a URI of the object.

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

Return Value

Returns the server descriptor created from the string.

This method can return null (Nothing in Visual Basic).

Remarks

The descriptorString may contain one of the following:

In languages that support implicit conversions (such as C# or VB.NET), in many cases you do not have call this method explicitly. When indicated, a call to an available equivalent implicit conversion operator will be created by the compiler automatically.

This method or property does not throw any exceptions, aside from execution exceptions such as System.Threading.ThreadAbortException or System.OutOfMemoryException.

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