PI Powershell

LockAFEventFrame Class

Save PDF

TABLE OF CONTENTS

LockAFEventFrame Class

Save PDF

Last UpdatedDec 15, 2025
2 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Lock an AF Event Frame

The Lock-AFEventFrame cmdlet will lock an existing AF Event Frame. Locking an AF Event Frame marks it as read-only and changes can no longer be made to it.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellLockAFEventFrame

Namespace: OSIsoft.PowerShell
Assembly: OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 3.1.1.0 (3.1.1.466)

Syntax

[CmdletAttribute("Lock", "AFEventFrame", SupportsShouldProcess = true)]
public class LockAFEventFrame : OSICmdletBase

<CmdletAttribute("Lock", "AFEventFrame", SupportsShouldProcess := true)>
Public Class LockAFEventFrame
	Inherits OSICmdletBase

Dim instance As LockAFEventFrame

[CmdletAttribute(L"Lock", L"AFEventFrame", SupportsShouldProcess = true)]
public ref class LockAFEventFrame : public OSICmdletBase

[<CmdletAttribute("Lock", "AFEventFrame", SupportsShouldProcess = true)>]
type LockAFEventFrame =  
    class
        inherit OSICmdletBase
    end

The LockAFEventFrame type exposes the following members.

Constructors

	Name	Description
	LockAFEventFrame

Properties

	Name	Description
	AFEventFrame	AF Event Frame to lock
	CheckIn	Check in changes immediately

Examples

Lock-AFEventFrameParent -AFEventFrame $MyEventFrame -CheckIn

Where:

$afServer = Get-AFServer -Name PIAF1

$MyEventFrame = Get-AFEventFrame -ID 7570ec51-31c6-4611-0000-000000015f31 -AFServer $afServer

This example locks the AF Event Frame stored in $MyEventFrame. The change is checked in immediately.

PI Powershell