OPC Studio User's Guide and Reference
GetOwnCertificatePack(IEasyUAClientServerApplication,String,Boolean) Method



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.Application.Extensions Namespace > IEasyUAClientServerApplicationExtension Class > GetOwnCertificatePack Method : GetOwnCertificatePack(IEasyUAClientServerApplication,String,Boolean) Method
The OPC UA client/server application object that will perform the operation.

In client applications, this is typically obtained by calling System.IServiceProvider.GetService(System.Type) on the OpcLabs.EasyOpc.UA.IEasyUAClient (EasyUAClient object) with the type of OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication as an argument.

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

The sub-id of the certificates. Normally an empty string.

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

Determines whether certificates might be missing from the certificate pack.
Gets the own certificate pack with given certificate sub-id, and optionally allowing for incomplete pack.
Syntax
'Declaration
 
<ExtensionAttribute()>
<JetBrains.Annotations.NotNullAttribute()>
Public Overloads Shared Function GetOwnCertificatePack( _
   ByVal application As IEasyUAClientServerApplication, _
   ByVal certificateSubId As String, _
   ByVal allowIncomplete As Boolean _
) As UANodeIdPkiCertificateDictionary
'Usage
 
Dim application As IEasyUAClientServerApplication
Dim certificateSubId As String
Dim allowIncomplete As Boolean
Dim value As UANodeIdPkiCertificateDictionary
 
value = IEasyUAClientServerApplicationExtension.GetOwnCertificatePack(application, certificateSubId, allowIncomplete)
[Extension()]
[JetBrains.Annotations.NotNull()]
public static UANodeIdPkiCertificateDictionary GetOwnCertificatePack( 
   IEasyUAClientServerApplication application,
   string certificateSubId,
   bool allowIncomplete
)
[Extension()]
[JetBrains.Annotations.NotNull()]
public:
static UANodeIdPkiCertificateDictionary^ GetOwnCertificatePack( 
   IEasyUAClientServerApplication^ application,
   String^ certificateSubId,
   bool allowIncomplete
) 

Parameters

application
The OPC UA client/server application object that will perform the operation.

In client applications, this is typically obtained by calling System.IServiceProvider.GetService(System.Type) on the OpcLabs.EasyOpc.UA.IEasyUAClient (EasyUAClient object) with the type of OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication as an argument.

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

certificateSubId
The sub-id of the certificates. Normally an empty string.

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

allowIncomplete
Determines whether certificates might be missing from the certificate pack.

Return Value

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

The individual elements of the returned value can be null (Nothing in Visual Basic).

Exceptions
ExceptionDescription

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.

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 allowIncomplete is true, and the certificate for the particular certificate type is missing from the certificate pack, the dictionary entry with for the certificate type id will still be present, but the certificate value will be null (Nothing in Visual Basic). When allowIncomplete is false and any of the certificates is missing from the certificate pack, the methods throws an exception. In both cases, when the method succeeds, the resulting dictionary contains entries for all certificate types in the certificate pack.

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