ImportOwnCertificateOrCertificatePackFromFile Method (IEasyUAClientServerApplication)

Imports the own certificate and its private key from a given file.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Sub ImportOwnCertificateOrCertificatePackFromFile( _
   ByVal importCertificateArguments As UAImportCertificateArguments _
)

'Usage
 
Dim instance As IEasyUAClientServerApplication
Dim importCertificateArguments As UAImportCertificateArguments
 
instance.ImportOwnCertificateOrCertificatePackFromFile(importCertificateArguments)

void ImportOwnCertificateOrCertificatePackFromFile( 
   UAImportCertificateArguments importCertificateArguments
)

void ImportOwnCertificateOrCertificatePackFromFile( 
   UAImportCertificateArguments^ importCertificateArguments
)

Parameters

importCertificateArguments: Contains arguments for importing an application certificate.
The value of this parameter cannot be null (Nothing in Visual Basic).

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.ObjectDisposedException	An operation was performed on a disposed object.
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.

System.ObjectDisposedException An operation was performed on a disposed object.

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

When UACertificateArguments.CertificateTypeId in importCertificateArguments is null (Nothing in Visual Basic), the operation imports the whole certificate pack. Otherwise, it imports the certificate of certificate type specified by the UACertificateArguments.CertificateTypeId in importCertificateArguments. If the specified certificate type Id is Null, the default certificate type Id from DefaultCertificateTypeId is used instead.

When certificate pack is used, this method operates on certificates with certificate type Ids given by PackCertificateTypeIds.

This method allows the application to import its own certificate from a specified file. The certificate is used for securing communications with OPC UA servers and clients. The importCertificateArguments parameter provides the necessary details for locating and accessing the certificate file.

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

IEasyUAClientServerApplication Interface
IEasyUAClientServerApplication Members
PackCertificateTypeIds Property

Documentation Home, Send Documentation Feedback. Technical Support