AFSecurity.GetSecurityString Method (Boolean)
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Gets a human readable string which represents the Access Rules of the security
for the associated object with the option to force getting the latest version
from the server.
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public string GetSecurityString( bool force )
Public Function GetSecurityString ( force As Boolean ) As String Dim instance As AFSecurity Dim force As Boolean Dim returnValue As String returnValue = instance.GetSecurityString(force)
public: String^ GetSecurityString( bool force )
member GetSecurityString : force : bool -> string
Parameters
- force
- Type: SystemBoolean
If , this method will make a call to the server each time it is called to ensure the latest version of the security descriptor is updated in the cache and returned. If , then the cached version of the security descriptor will be returned.
Return Value
Type: StringReturns 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.
| 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. |