AFEventFrame.GetSecurity Method

Save PDF

Feedback

HomeAF SDK Reference...NamespacesOSIsoft.AF.EventFrameAFEventFrame ClassAFEventFrame MethodsAFEventFrame.GetSecurity Method

TABLE OF CONTENTS

AFEventFrame.GetSecurity Method

Save PDF

Feedback

Last UpdatedSep 18, 2024

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

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

Syntax

public AFSecurity GetSecurity(
	AFSecurityItem securityItem
)

Public Function GetSecurity ( 
	securityItem As AFSecurityItem
) As AFSecurity

Dim instance As AFEventFrame
Dim securityItem As AFSecurityItem
Dim returnValue As AFSecurity

returnValue = instance.GetSecurity(securityItem)

public:
virtual AFSecurity^ GetSecurity(
	AFSecurityItem securityItem
) sealed

abstract GetSecurity : 
        securityItem : AFSecurityItem -> AFSecurity 
override GetSecurity : 
        securityItem : AFSecurityItem -> AFSecurity

Parameters

securityItem: Type: OSIsoft.AF.AFSecurityItem
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.

Implements

IAFSecurable.GetSecurity(AFSecurityItem)

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

Filters

Product Family