GetSecurityKeys Method (IUAReadOnlyPubSubSecurityKeyServiceExtension)

Retrieves the security keys for a security group.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Shared Function GetSecurityKeys( _
   ByVal readOnlyPubSubSecurityKeyService As IUAReadOnlyPubSubSecurityKeyService, _
   ByVal securityGroupId As String, _
   ByVal startingTokenId As Long, _
   ByVal requestedKeyCount As Long _
) As SecurityKeysInfo

'Usage
 
Dim readOnlyPubSubSecurityKeyService As IUAReadOnlyPubSubSecurityKeyService
Dim securityGroupId As String
Dim startingTokenId As Long
Dim requestedKeyCount As Long
Dim value As SecurityKeysInfo
 
value = IUAReadOnlyPubSubSecurityKeyServiceExtension.GetSecurityKeys(readOnlyPubSubSecurityKeyService, securityGroupId, startingTokenId, requestedKeyCount)

[Extension()]
[NotNull()]
public static SecurityKeysInfo GetSecurityKeys( 
   IUAReadOnlyPubSubSecurityKeyService readOnlyPubSubSecurityKeyService,
   string securityGroupId,
   long startingTokenId,
   long requestedKeyCount
)

[Extension()]
[NotNull()]
public:
static SecurityKeysInfo^ GetSecurityKeys( 
   IUAReadOnlyPubSubSecurityKeyService^ readOnlyPubSubSecurityKeyService,
   String^ securityGroupId,
   int64 startingTokenId,
   int64 requestedKeyCount
)

Parameters

readOnlyPubSubSecurityKeyService: OPC UA PubSub security key service (read-only).
The value of this parameter cannot be null (Nothing in Visual Basic).
securityGroupId: The identifier for the security group.
The value of this parameter cannot be null (Nothing in Visual Basic).
startingTokenId: Starting token Id. The current token is requested by passing 0.
Valid values of this parameter are in the range from 0 to 4294967295.
requestedKeyCount: The number of requested keys which should be returned in the response.
Valid values of this parameter are in the range from 0 to 4294967295.

Return Value

Returns the security keys info with the requested keys.

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

Exceptions

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.ArgumentOutOfRangeException	The value of an argument is outside the allowable range of values as defined by the invoked method. 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.
OpcLabs.EasyOpc.UA.OperationModel.UALogicalException	There is a logical error in the OPC UA operation. 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

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

IUAReadOnlyPubSubSecurityKeyServiceExtension Class
IUAReadOnlyPubSubSecurityKeyServiceExtension Members

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.