Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFEventFrame.FindEventFrame Method (PISystem, Guid, Object)

AFEventFrame.FindEventFrame Method (PISystem, Guid, Object)

  • Last UpdatedNov 18, 2025
  • 3 minute read
AFEventFrame.FindEventFrame Method (PISystem, Guid, Object)
Retrieves the AFEventFrame object with the specified unique identifier at the specified query date.

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

Syntax

public static AFEventFrame FindEventFrame(
	PISystem system,
	Guid id,
	Object queryDate
)
Public Shared Function FindEventFrame ( 
	system As PISystem,
	id As Guid,
	queryDate As Object
) As AFEventFrame

Dim system As PISystem
Dim id As Guid
Dim queryDate As Object
Dim returnValue As AFEventFrame

returnValue = AFEventFrame.FindEventFrame(system, 
	id, queryDate)
public:
static AFEventFrame^ FindEventFrame(
	PISystem^ system, 
	Guid id, 
	Object^ queryDate
)
static member FindEventFrame : 
        system : PISystem * 
        id : Guid * 
        queryDate : Object -> AFEventFrame 

Parameters

system
Type: OSIsoft.AFPISystem
The PISystem to search for the desired object.
id
Type: SystemGuid
The unique identifier of the object to find.
queryDate
Type: SystemObject
The query date used to find the object. Specify or AFTime.MaxValue for most recent versions of the objects. The value may be an AFTime, DateTime, PITime, String, or numeric. A DateTime (or a DATE will be treated as UTC time if its Kind property is set to Unspecified. Because DATE values from COM or VB6 clients are marshalled as Unspecified, these client applications must convert to UTC prior to marshalling. An integer numeric represents the number of ticks (100-nanosecond intervals) since January 1, 0001. A floating point numeric represents the number of seconds since January 1, 1970 UTC. A String is interpreted as local time, unless it contains a time zone indicator such as a trailing "Z" or "GMT". Strings will be interpreted with the AFTime.Parse Overload methods so that relative formats with intervals ("*", "T+3h", etc.) are also supported. Relative time intervals are based on AFTime.Now.

Return Value

Type: AFEventFrame
The AFEventFrame in the PISystem which matches the unique identifier at the specified queryDate. If the object does not exist, then will be returned.

Remarks

An event frame must be saved to the server using ApplyChanges or CheckIn before it will be returned by this find method. The AFEventFrame object with the specified id at the specified queryDate is returned.

This will only return objects of type AFEventFrame. Types of event frames that inherit from AFEventFrame will not be returned. Use the specific find methods to return types of event frames that inherit from AFEventFrame.

Version Information

AFSDK


See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in