Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

PIDatabaseSecurities Class

  • Last UpdatedNov 18, 2025
  • 4 minute read
PIDatabaseSecurities Class
The PIDatabaseSecurities collection represents the available PIDatabaseSecurity objects on a particular PIServer.

Inheritance Hierarchy

SystemObject
  OSIsoft.AF.PIPIDatabaseSecurities

Namespace:  OSIsoft.AF.PI
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public sealed class PIDatabaseSecurities : IList<PIDatabaseSecurity>, 
	ICollection<PIDatabaseSecurity>, IEnumerable<PIDatabaseSecurity>, IEnumerable, 
	IList, ICollection
Public NotInheritable Class PIDatabaseSecurities
	Implements IList(Of PIDatabaseSecurity), ICollection(Of PIDatabaseSecurity), 
	IEnumerable(Of PIDatabaseSecurity), IEnumerable, IList, ICollection

Dim instance As PIDatabaseSecurities
public ref class PIDatabaseSecurities sealed : IList<PIDatabaseSecurity^>, 
	ICollection<PIDatabaseSecurity^>, IEnumerable<PIDatabaseSecurity^>, IEnumerable, 
	IList, ICollection
[<SealedAttribute>]
type PIDatabaseSecurities =  
    class
        interface IList<PIDatabaseSecurity>
        interface ICollection<PIDatabaseSecurity>
        interface IEnumerable<PIDatabaseSecurity>
        interface IEnumerable
        interface IList
        interface ICollection
    end

The PIDatabaseSecurities type exposes the following members.

Properties

  NameDescription
Public property
Count
Gets the number of items actually contained in the collection.
Public property
ItemInt32
Gets or sets the item at the specified index.
Public property
ItemString
Returns the specified object from the collection by name.
Public property
Server
The PIServer for this PIDatabaseSecurities collection.

Methods

  NameDescription
Public method
Contains(String)
This method determines whether the collection contains a specific item referenced by name.
Public method
Contains(PIDatabaseSecurity)
This method determines whether the collection contains a specific item.
Public method
CopyTo
Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array.
Public method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public method
GetEnumerator
Returns an enumerator that iterates through the collection.
Public method
GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
IndexOf
Searches for the specified object and returns the zero-based index of the first occurrence within the entire collection.
Public method
Refresh
Refresh the collection by loading from the PIServer.
Public method
ToString
Returns a string that represents the current object.
(Inherited from Object.)

Extension Methods

  NameDescription
Public Extension MethodCode example
ChunkedByPIDatabaseSecurity
This extension method breaks up search results into chunks to make it easier to page through and process IEnumerableT collections in chunks.
(Defined by AFSDKExtension.)

Remarks

This is the collection of available PIDatabaseSecurity objects on a particular PIServer. The contained PIDatabaseSecurity objects control accesses to most PI Data Archive resources.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6

See Also

TitleResults for “How to create a CRG?”Also Available in