PI Powershell

GetAFCheckedOutItem Class

Save PDF

TABLE OF CONTENTS

GetAFCheckedOutItem Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Get a checked out AF objects

The Get-AFCheckedOutItem cmdlet gets items checked out from an AF Server or AF Database. AF Server only includes: AFContact, AFNotificationContactTemplate, and UOMDatabase objects. All other objects must be retrieved via the AF Database.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellGetAFCheckedOutItem

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

Syntax

[CmdletAttribute("Get", "AFCheckedOutItem", SupportsShouldProcess = true)]
public class GetAFCheckedOutItem : OSICmdletBase

<CmdletAttribute("Get", "AFCheckedOutItem", SupportsShouldProcess := true)>
Public Class GetAFCheckedOutItem
	Inherits OSICmdletBase

Dim instance As GetAFCheckedOutItem

[CmdletAttribute(L"Get", L"AFCheckedOutItem", SupportsShouldProcess = true)]
public ref class GetAFCheckedOutItem : public OSICmdletBase

[<CmdletAttribute("Get", "AFCheckedOutItem", SupportsShouldProcess = true)>]
type GetAFCheckedOutItem =  
    class
        inherit OSICmdletBase
    end

The GetAFCheckedOutItem type exposes the following members.

Constructors

	Name	Description
	GetAFCheckedOutItem

Properties

	Name	Description
	AFCheckedOutMode	Filter by mode that the AF Objects were checked out in. Valid values are: AllObjects : ObjectsCheckOutToMe : ObjectsCheckOutThisSession : ObjectsCheckOutThisThread
	AFDatabase	AF Database from which to get AF checked out objects
	AFServer	AF Server from which to get AF checked out objects. AF Server only includes AFContact, AFNotificationTemplate, and UOMDatabase objects.
	CheckedOutToMe	Gets the AF Objects checked out to the current user (current security context)
	Refresh	Refresh container before accessing

Examples

Get-AFCheckedOutItem -AFCheckedOutMode AllObjects -AFDatabase $afDB

Where:

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

Gets all checked out items from the AF Database "AFDatabase1" on the AF Server "PIAF1".

Examples

Get-AFCheckedOutItem -CheckedOutToMe -AFDatabase $afDB

Where:

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

Gets the checked out AF objects by the connected user on the AF Database "AFDatabase1" on the AF Server "PIAF1".

Examples

Get-AFCheckedOutItem -AllObjects -AFServer $afServer

Where:

$afServer = Get-AFServer -Name "PIAF1"

Gets all checked out AF objects on the AF Server "PIAF1". Note that the only objects checked out on the server level are AFContact, AFNotificationContactTemplate, and UOMDatabase check outs.

PI Powershell