ExportRegisteredApplicationToFile Method (IEasyUAClientServerApplicationExtension)

Exports the registration data of the OPC UA application into an XML file.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
Public Shared Sub ExportRegisteredApplicationToFile( _
   ByVal application As IEasyUAClientServerApplication, _
   ByVal filePath As String _
)

'Usage
 
Dim application As IEasyUAClientServerApplication
Dim filePath As String
 
IEasyUAClientServerApplicationExtension.ExportRegisteredApplicationToFile(application, filePath)

[Extension()]
public static void ExportRegisteredApplicationToFile( 
   IEasyUAClientServerApplication application,
   string filePath
)

[Extension()]
public:
static void ExportRegisteredApplicationToFile( 
   IEasyUAClientServerApplication^ application,
   String^ filePath
)

Parameters

application: The OPC UA client/server application object that will perform the operation.
filePath: The name of the file into which the data will be exported.

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.
OpcLabs.EasyOpc.UA.OperationModel.UAException	The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

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.

OpcLabs.EasyOpc.UA.OperationModel.UAException

The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

If the specified file does not exist, it is created; if it does exist and it is not read-only, the contents are overwritten.

This method exports the security settings in the format used by the GDS client from OPC Foundation (Windows desktop sample). It uses the RegisteredApplication schema (which is not part of the OPC UA standard).

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

IEasyUAClientServerApplicationExtension Class
IEasyUAClientServerApplicationExtension Members

Send Documentation Feedback. Resources: Knowledge Base. Technical support: Online Forums, FAQ.