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

AF SDK Reference

AFSecurity.GetSecurityString Method

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFSecurity.GetSecurityString Method
Gets a cached human readable string which represents the Access Rules of the security for the associated object.

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

Syntax

public string GetSecurityString()
Public Function GetSecurityString As String

Dim instance As AFSecurity
Dim returnValue As String

returnValue = instance.GetSecurityString()
public:
String^ GetSecurityString()
member GetSecurityString : unit -> string 

Return Value

Type: String
Returns the access control rules as a human readable string for the associated object.

Remarks

This method will return the security for the associated object in a human readable string format. See the Security String Format section of the Security Formats topic for a description of the format of the returned string.

Important note Important
For a PI AF Server 2.7 or later, the account name will be returned as the name of the AFSecurityIdentity of the current user. For an older PI AF Server, the account name will be returned as the Windows user name of the current user. You can use the PISystem.Supports method to check if the server supports SecurityIdentity.

Version Information

AFSDK


See Also

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