GetOwnCertificatePack Method (_EasyUAClientServerApplication)

Gets the own certificate pack with given certificate sub-id, and optionally allowing for incomplete pack.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<JetBrains.Annotations.NotNullAttribute()>
Function GetOwnCertificatePack( _
   ByVal certificateSubId As String, _
   ByVal allowIncomplete As Boolean _
) As _UANodeIdPkiCertificateReadOnlyDictionary

'Usage
 
Dim instance As _EasyUAClientServerApplication
Dim certificateSubId As String
Dim allowIncomplete As Boolean
Dim value As _UANodeIdPkiCertificateReadOnlyDictionary
 
value = instance.GetOwnCertificatePack(certificateSubId, allowIncomplete)

[JetBrains.Annotations.NotNull()]
_UANodeIdPkiCertificateReadOnlyDictionary GetOwnCertificatePack( 
   string certificateSubId,
   bool allowIncomplete
)

[JetBrains.Annotations.NotNull()]
_UANodeIdPkiCertificateReadOnlyDictionary^ GetOwnCertificatePack( 
   String^ certificateSubId,
   bool allowIncomplete
)

Parameters

certificateSubId: The sub-id of the certificates. Normally an empty string.
The value of this parameter can 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

Exception Description

System.Exception An error has occurred during application execution.

Exception	Description
System.Exception	An error has occurred during application execution.
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

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 member or type is for use from COM. It is not meant to be used from .NET or Python. Refer to the corresponding .NET member or type instead, if you are developing in .NET or Python.

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

Reference

_EasyUAClientServerApplication Interface
_EasyUAClientServerApplication Members
PackCertificateTypeIds Property

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

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.