AFEventFrame.UndoCheckOut Method

Save PDF

Feedback

HomeAF SDK Reference...NamespacesOSIsoft.AF.EventFrameAFEventFrame ClassAFEventFrame MethodsAFEventFrame.UndoCheckOut Method

TABLE OF CONTENTS

AFEventFrame.UndoCheckOut Method

Save PDF

Feedback

Last UpdatedSep 18, 2024

This method discards all the changes to the object and all sub-objects since the last call to CheckOut(). Any changes since the check out will be lost.

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

Syntax

public void UndoCheckOut(
	bool force
)

Public Sub UndoCheckOut ( 
	force As Boolean
)

Dim instance As AFEventFrame
Dim force As Boolean

instance.UndoCheckOut(force)

public:
virtual void UndoCheckOut(
	bool force
) sealed

abstract UndoCheckOut : 
        force : bool -> unit 
override UndoCheckOut : 
        force : bool -> unit

Parameters

force: Type: System.Boolean
If this parameter is true, then the check out is undone even if the object has been checked out by another user. If false, then only the user that checked out the object is allowed to undo the check out.

Implements

IAFTransactable.UndoCheckOut(Boolean)

Events

Event Type	Reason
IAFChangedEvent.Changed	This event will be raised for each object updated by this method call.

Remarks

All changes since the last call to CheckOut() will be discarded including changes previously applied using the ApplyChanges() method. A check out can only be undone by the user who currently has the object checked out unless the force parameter is set to true.

AF SDK Reference

Filters

Product Family