Click or drag to resize
OSIsoft, LLC

AFSecurityRightsToken Structure

A security rights token is used to check security for an object.

Namespace:  OSIsoft.AF
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 2.10.8.440
Syntax
[SerializableAttribute]
public struct AFSecurityRightsToken : IEquatable<AFSecurityRightsToken>

The AFSecurityRightsToken type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyAddAdjustments
The security rights adjustment to be added to the base security rights for the instance of the object represented by this token.
Public propertyDatabaseId
The ID for the AFDatabase where the object is saved. This will be Empty for a system-level object.
Public propertyObjectId
The ID of the object represented by this token. This value is used as the key in the dictionary returned from the CheckSecurity(PISystem, WindowsIdentity, IListAFSecurityRightsToken) method and does not have to be the ID of the actual object.
Public propertyObjectIdentity
The Identity of the object represented by this token.
Public propertyRemoveAdjustments
The security rights adjustment to be removed to the base security rights for the instance of the object represented by this token.
Public propertySecurityId
The SecurityId of the object represented by this token.
Public propertySecurityItem
The security item represented by this token. If Default, then it represents the security for the object. Otherwise, it represents the security for a collection of the object.
Public propertySecurityOwnerId
The security owner identifier representing the owner of the object represented by this token. The GetUserId(PISystem, String) method can be used to set the value for this property. If this property is not set, then the security for the owner security identity will not be evaluated.
Top
Methods
  NameDescription
Public methodEquals(Object)
Determines whether the specified Object is equal to the current object.
(Overrides ValueTypeEquals(Object).)
Public methodEquals(AFSecurityRightsToken)
Indicates whether the current object is equal to another object of the same type.
Public methodGetHashCode
Gets the hash code for this instance of the object which is suitable for use in hashing algorithms and data structures like a hash table.
(Overrides ValueTypeGetHashCode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a String that represents the current object.
(Overrides ValueTypeToString.)
Top
Operators
  NameDescription
Public operatorStatic memberEquality
The equality operator (==) compares its operands to determine if they are equal.
Public operatorStatic memberInequality
The inequality operator (!=) compares its operands to determine if they are not equal.
Top
Remarks
Version Information

AFSDK

Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7
See Also
Enabling Operational Intelligence