AF SDK Reference

IAFSecurable.GetSecurity Method

Save PDF

TABLE OF CONTENTS

IAFSecurable.GetSecurity Method

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Gets the AFSecurity information of the specified security item associated with the object.

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

Syntax

AFSecurity GetSecurity(
	AFSecurityItem securityItem
)

Function GetSecurity ( 
	securityItem As AFSecurityItem
) As AFSecurity

Dim instance As IAFSecurable
Dim securityItem As AFSecurityItem
Dim returnValue As AFSecurity

returnValue = instance.GetSecurity(securityItem)

AFSecurity^ GetSecurity(
	AFSecurityItem securityItem
)

abstract GetSecurity : 
        securityItem : AFSecurityItem -> AFSecurity

Parameters

securityItem: Type: OSIsoft.AFAFSecurityItem
Specifies the security item of the desired AFSecurity information to be returned.

Return Value

Type: AFSecurity
Returns the AFSecurity information of the specified security item associated with the object.

Remarks

Returns the security information of the current user for the specified item type. This method is primarily used to access the collection wide security settings available on the PISystem and AFDatabase objects. The security settings for the collections controls who has rights to create new objects of that type, as well as defines the default security for new items of that type. The Security property accesses the object's primary (or default) security setting.

AF SDK Reference