OPC Studio User's Guide and Reference
AsStopped Method



OpcLabs.ServerOpcUA Assembly > OpcLabs.EasyOpc.UA Namespace > IEasyUAServerExtension Class : AsStopped Method
The server object that will perform the operation.

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

Stops the OPC UA server if it is started, and returns the same OPC UA server.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Shared Function AsStopped( _
   ByVal server As IEasyUAServer _
) As IEasyUAServer
'Usage
 
Dim server As IEasyUAServer
Dim value As IEasyUAServer
 
value = IEasyUAServerExtension.AsStopped(server)
[Extension()]
[NotNull()]
public static IEasyUAServer AsStopped( 
   IEasyUAServer server
)
[Extension()]
[NotNull()]
public:
static IEasyUAServer^ AsStopped( 
   IEasyUAServer^ server
) 

Parameters

server
The server object that will perform the operation.

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

Return Value

Returns the server that was passed in, in a stopped state, for chaining or further operations.

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

Remarks

If the server is already stopped, this method does nothing and simply returns the server instance. This is a convenience method to ensure that the server is not running without having to check its state explicitly.

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

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

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