Skip to content

Reference

OpcSecurityPolicyCollection Members

Represents a collection of the security policies of endpoints (see EndpointPolicies).

Reference

OpcSecurityPolicyCollection Members ​

Type
OpcSecurityPolicyCollection
Namespace
Opc.UaFx
Assembly
Opc.UaFx.Advanced.dll
Package
Opc.UaFx.Advanced v2.59.0

Constructors ​

OpcSecurityPolicyCollection ​

since v2.6

Initializes a new instance of the OpcSecurityPolicyCollection class, which is empty.

csharp
public OpcSecurityPolicyCollection()
vbnet
Public Sub New()

Properties ​

Count ​

Gets the number of security policies in the collection.

csharp
public int Count { get; }
vbnet
Public ReadOnly Property Count As Integer

Property value

Int32

The number of security policies in the collection.

Implements

Count

IsReadOnly ​

Gets a value indicating whether the collection is read-only.

csharp
public bool IsReadOnly { get; }
vbnet
Public ReadOnly Property IsReadOnly As Boolean

Property value

Boolean

Always the value false.

Implements

IsReadOnly

Methods ​

Add ​

Adds the security policy specified to the end of the collection.

csharp
public void Add(OpcSecurityPolicy item)
vbnet
Public Sub Add(item As OpcSecurityPolicy)

Parameters

NameTypeDescription
itemOpcSecurityPolicyThe security policy to add.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe item is a null reference (Nothing in Visual Basic).

Implements

Add(OpcSecurityPolicy)

Clear ​

Removes all security policies from the collection.

csharp
public void Clear()
vbnet
Public Sub Clear()

Implements

Clear()

Contains ​

Determines whether the collection contains the security policy specified.

csharp
public bool Contains(OpcSecurityPolicy item)
vbnet
Public Function Contains(item As OpcSecurityPolicy) As Boolean

Parameters

NameTypeDescription
itemOpcSecurityPolicyThe security policy to locate.

Returns

Boolean

The value true if the collection contains the item; otherwise the value false.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe item is a null reference (Nothing in Visual Basic).

Implements

Contains(OpcSecurityPolicy)

CopyTo ​

Copies the security policies of the collection to the array specified, starting at the arrayIndex specified.

csharp
public void CopyTo(OpcSecurityPolicy[] array, int arrayIndex)
vbnet
Public Sub CopyTo(array As OpcSecurityPolicy(), arrayIndex As Integer)

Parameters

NameTypeDescription
arrayOpcSecurityPolicy[]The array to copy the security policies to.
arrayIndexInt32The zero-based index in the array at which copying begins.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe array is a null reference (Nothing in Visual Basic).
ArgumentOutOfRangeExceptionThe arrayIndex is less than zero.
ArgumentExceptionThe number of security policies in the collection is greater than the space from arrayIndex to the end of the array.

Implements

CopyTo(OpcSecurityPolicy[], int)

GetEnumerator ​

Returns an enumerator that iterates through the security policies of the collection.

csharp
public IEnumerator<OpcSecurityPolicy> GetEnumerator()
vbnet
Public Function GetEnumerator() As IEnumerator(Of OpcSecurityPolicy)

Returns

IEnumerator<OpcSecurityPolicy>

An enumerator for the security policies of the collection.

Implements

GetEnumerator()

IndexOf ​

Determines the index of the security policy specified in the collection.

csharp
public int IndexOf(OpcSecurityPolicy item)
vbnet
Public Function IndexOf(item As OpcSecurityPolicy) As Integer

Parameters

NameTypeDescription
itemOpcSecurityPolicyThe security policy to locate.

Returns

Int32

The zero-based index of the item, or -1 if the collection does not contain it.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe item is a null reference (Nothing in Visual Basic).

Implements

IndexOf(OpcSecurityPolicy)

Insert ​

Inserts the security policy specified at the index specified.

csharp
public void Insert(int index, OpcSecurityPolicy item)
vbnet
Public Sub Insert(index As Integer, item As OpcSecurityPolicy)

Parameters

NameTypeDescription
indexInt32The zero-based index at which the item is to be inserted.
itemOpcSecurityPolicyThe security policy to insert.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe item is a null reference (Nothing in Visual Basic).
ArgumentOutOfRangeExceptionThe index is less than zero or greater than Count.

Implements

Insert(int, OpcSecurityPolicy)

Remove ​

Removes the security policy specified from the collection.

csharp
public bool Remove(OpcSecurityPolicy item)
vbnet
Public Function Remove(item As OpcSecurityPolicy) As Boolean

Parameters

NameTypeDescription
itemOpcSecurityPolicyThe security policy to remove.

Returns

Boolean

The value true if the item has been removed; otherwise the value false.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe item is a null reference (Nothing in Visual Basic).

Implements

Remove(OpcSecurityPolicy)

RemoveAt ​

Removes the security policy at the index specified.

csharp
public void RemoveAt(int index)
vbnet
Public Sub RemoveAt(index As Integer)

Parameters

NameTypeDescription
indexInt32The zero-based index of the security policy to remove.

Exceptions

ExceptionCondition
ArgumentOutOfRangeExceptionThe index is less than zero or not less than Count.

Implements

RemoveAt(int)

Indexers ​

Item ​

Gets or sets the security policy at the index specified.

csharp
public OpcSecurityPolicy this[int index] { get; set; }
vbnet
Public Default Property this[](index As Integer) As OpcSecurityPolicy

Parameters

NameTypeDescription
indexInt32The zero-based index of the security policy.

Property value

OpcSecurityPolicy

The security policy at the index.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe value to set is a null reference (Nothing in Visual Basic).
ArgumentOutOfRangeExceptionThe index is less than zero or not less than Count.

Implements

this[int]