AFSecurity.GetAccessControl Method
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Note: This API is now obsolete.
Gets the access control security descriptor for the associated object.
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[BrowsableAttribute(false)] [ObsoleteAttribute("Replace with the GetSecurityString method instead.")] public string GetAccessControl()
<BrowsableAttribute(false)> <ObsoleteAttribute("Replace with the GetSecurityString method instead.")> Public Function GetAccessControl As String Dim instance As AFSecurity Dim returnValue As String returnValue = instance.GetAccessControl()
public: [BrowsableAttribute(false)] [ObsoleteAttribute(L"Replace with the GetSecurityString method instead.")] String^ GetAccessControl()
[<BrowsableAttribute(false)>] [<ObsoleteAttribute("Replace with the GetSecurityString method instead.")>] member GetAccessControl : unit -> string
Return Value
Type: StringReturns the access control security descriptor for the associated object.
Exceptions
| Exception | Condition |
|---|---|
| InvalidOperationException | This exception is thrown if the security for the object has been modified using the ACL format and the changes have not been saved to the server. |
Remarks
See the Security Descriptor String Format section of the Security Formats topic for a description of the format of the returned string.
This method will make a call to the server each time it is called to ensure the latest version of the security descriptor is loaded.
 Notes to Callers |
|---|
| For PI AF Server 2.7 or later you can call the GetSecurityString Overload method to obtain the security string with the new security identities (see AFSecurityIdentity) which are supported by newer servers. You can use the PISystem.Supports method to check if the server supports SecurityIdentity. |
Version Information
AFSDK
Supported in: 2.6, 2.5, 2.4Obsolete (compiler warning) in 3.1.1
Obsolete (compiler warning) in 3.1.0
Obsolete (compiler warning) in 3.0.2
Obsolete (compiler warning) in 3.0.1
Obsolete (compiler warning) in 3.0.0
Obsolete (compiler warning) in 2.10.11
Obsolete (compiler warning) in 2.10.5
Obsolete (compiler warning) in 2.10.0
Obsolete (compiler warning) in 2.10
Obsolete (compiler warning) in 2.9.5
Obsolete (compiler warning) in 2.9
Obsolete (compiler warning) in 2.8.5
Obsolete (compiler warning) in 2.8
Obsolete (compiler warning) in 2.7.5
Obsolete (compiler warning) in 2.7