AF SDK Reference

AFCheckOutInfo Class

Save PDF

TABLE OF CONTENTS

AFCheckOutInfo Class

Save PDF

Last UpdatedNov 18, 2025
4 minute read

The AFCheckOutInfo object is used to represent the checked out status information of the current object.

Inheritance Hierarchy

SystemObject
OSIsoft.AFAFCheckOutInfo

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

Syntax

[SerializableAttribute]
public sealed class AFCheckOutInfo

<SerializableAttribute>
Public NotInheritable Class AFCheckOutInfo

Dim instance As AFCheckOutInfo

[SerializableAttribute]
public ref class AFCheckOutInfo sealed

[<SealedAttribute>]
[<SerializableAttribute>]
type AFCheckOutInfo =  class end

The AFCheckOutInfo type exposes the following members.

Properties

	Name	Description
	CheckOutTime	This property is the time that the user checked out the current object.
	EnableAutoCheckOut	This property controls whether the AF SDK automatically checks out objects when they are modified.
	IsCheckedOutThisSession	The property indicates that the object was checked out by this execution session of the application.
	IsCheckedOutThisThread	The property indicates that the object was checked out by the current thread during the execution session of the application.
	IsCheckedOutToMe	The property indicates if the current logged in user has the object checked out.
	MachineName	This property is the name of the machine from where the object was initially checked out.
	UserName	This property is the name of the user that currently has the object checked out.

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a String that represents the current object. (Overrides ObjectToString.)

Remarks

The AFCheckOutInfo object contains properties for the information about the current object's checked out status.

Examples

// This example demonstrates displaying checkout information of an element.

// Get the Database
PISystems myPISystems = new PISystems();
AFDatabase myDB = myPISystems.DefaultPISystem.Databases.DefaultDatabase;

// Create an Element
AFElement myElement = myDB.Elements.Add("MyElement");

// Display CheckOut Information
AFCheckOutInfo myCOInfo = myElement.CheckOutInfo;
Console.WriteLine("CheckOutTime = {0}", myCOInfo.CheckOutTime.LocalTime);
Console.WriteLine("UserName = {0}", myCOInfo.UserName);

' This example demonstrates displaying checkout information of an element.

' Get the Database
Dim myPISystems As New PISystems
Dim myDB As AFDatabase = myPISystems.DefaultPISystem.Databases.DefaultDatabase

' Create an Element
Dim myElement As AFElement = myDB.Elements.Add("MyElement")

' Display CheckOut Information
Dim myCOInfo As AFCheckOutInfo = myElement.CheckOutInfo
Console.WriteLine("CheckOutTime = {0}", myCOInfo.CheckOutTime.LocalTime)
Console.WriteLine("UserName = {0}", myCOInfo.UserName)

No code example is currently available or this language may not be supported.

AF SDK Reference