PI Powershell

GetAFEventFrame Class

Save PDF

TABLE OF CONTENTS

GetAFEventFrame Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Get an AF Event Frame(s)

The Get-AFEventFrame cmdlet gets a child AF Event Frame(s) on a specified AF Event Frame, or gets an AF Event Frame by GUID on an AF Server.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellGetAFEventFrame

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

Syntax

[CmdletAttribute("Get", "AFEventFrame", DefaultParameterSetName = "EventFrameName", 
	SupportsShouldProcess = true)]
public class GetAFEventFrame : OSICmdletBase

<CmdletAttribute("Get", "AFEventFrame", DefaultParameterSetName := "EventFrameName", 
	SupportsShouldProcess := true)>
Public Class GetAFEventFrame
	Inherits OSICmdletBase

Dim instance As GetAFEventFrame

[CmdletAttribute(L"Get", L"AFEventFrame", DefaultParameterSetName = L"EventFrameName", 
	SupportsShouldProcess = true)]
public ref class GetAFEventFrame : public OSICmdletBase

[<CmdletAttribute("Get", "AFEventFrame", DefaultParameterSetName = "EventFrameName", 
	SupportsShouldProcess = true)>]
type GetAFEventFrame =  
    class
        inherit OSICmdletBase
    end

The GetAFEventFrame type exposes the following members.

Constructors

	Name	Description
	GetAFEventFrame

Properties

	Name	Description
	AFEventFrame	Parent AF Event Frame for which to retrieve child event frames
	AFServer	AF Server from which to get the AF Event Frame
	ID	GUID of the AF Event Frame to get
	Index	Index of the child AF Event Frame to get
	Name	Name of the child AF Event Frame to get
	QueryDate	Query date for the AF Event Frame to get
	Refresh	Refresh the container before accessing

Examples

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

Where:

$afServer = Get-AFServer -Name "PIAF1"

This example gets the AF Event Frame with the specified GUID from the AF Server "PIAF1".

Examples

Get-AFEventFrame -Name * -Refresh -AFEventFrame $MyEventFrame

Where:

$afDB = Get-AFDatabase "AFDatabase1" -AFServer (Get-AFServer -Name "PIAF1")

$MyEventFrame = Find-AFEventFrame -StartTime (ConvertFrom-AFRelativeTime "T") -EndTime (ConvertFrom-AFRelativeTime "*") -AFSearchMode Inclusive -MaxCount 1 -AFDatabase $afDB

This example gets all child AF Event Frames on the parent AF Event Frame stored in $MyEventFrame on the AF Database "AFDatabase1" on the AF Server "PIAF1".

PI Powershell