PI Powershell

UnlockAFEventFrame Class

Save PDF

TABLE OF CONTENTS

UnlockAFEventFrame Class

Save PDF

Last UpdatedDec 15, 2025
2 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Unlock an AF Event Frame

The Unlock-AFEventFrame cmdlet will unlock an existing and already locked AF Event Frame. Unlocking an AF Event Frame restores the ability to make changes to it.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellUnlockAFEventFrame

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

Syntax

[CmdletAttribute("Unlock", "AFEventFrame", SupportsShouldProcess = true)]
public class UnlockAFEventFrame : OSICmdletBase

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

Dim instance As UnlockAFEventFrame

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

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

The UnlockAFEventFrame type exposes the following members.

Constructors

	Name	Description
	UnlockAFEventFrame

Properties

	Name	Description
	AFEventFrame	AF Event Frame to unlock

Examples

Unlock-AFEventFrameParent -AFEventFrame $MyEventFrame

Where:

$afServer = Get-AFServer -Name "PIAF1"

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

This example unlocks the AF Event Frame stored in $MyEventFrame, assuming the event frame was already locked.

PI Powershell