AF SDK Reference

AFEventFrame.FindEventFramesByPath Method (IEnumerable(String), AFObject)

Save PDF

TABLE OF CONTENTS

AFEventFrame.FindEventFramesByPath Method (IEnumerable(String), AFObject)

Save PDF

Last UpdatedNov 18, 2025
3 minute read

Retrieves the AFEventFrame objects identified by the path strings as keyed results.

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

Syntax

public static AFKeyedResults<string, AFEventFrame> FindEventFramesByPath(
	IEnumerable<string> paths,
	AFObject relativeFrom
)

Public Shared Function FindEventFramesByPath ( 
	paths As IEnumerable(Of String),
	relativeFrom As AFObject
) As AFKeyedResults(Of String, AFEventFrame)

Dim paths As IEnumerable(Of String)
Dim relativeFrom As AFObject
Dim returnValue As AFKeyedResults(Of String, AFEventFrame)

returnValue = AFEventFrame.FindEventFramesByPath(paths, 
	relativeFrom)

public:
static AFKeyedResults<String^, AFEventFrame^>^ FindEventFramesByPath(
	IEnumerable<String^>^ paths, 
	AFObject^ relativeFrom
)

static member FindEventFramesByPath : 
        paths : IEnumerable<string> * 
        relativeFrom : AFObject -> AFKeyedResults<string, AFEventFrame>

Parameters

paths: Type: System.Collections.GenericIEnumerableString
The collection of paths used to locate the AFEventFrame. Each of the path names may be relative to the specified object or a fully qualified path. The paths may reference elements from a different PISystem or AFDatabase. See Path Syntax for more information.
relativeFrom: Type: OSIsoft.AFAFObject
Specifies the object that the paths may be relative to. If , then all paths must be fully qualified.

Return Value

Type: AFKeyedResultsString, AFEventFrame
Returns a dictionary of results where the key is the specified path and its value is the AFEventFrame resolved from the path.

Remarks

This method can be used to find a list of AFEventFrame objects from a list of object paths. An object path can be obtained by calling one of the GetPath Overload methods. See Path Syntax for a complete description of the path syntax.

Important
The event frames must be checked in to the server using CheckIn before this method can resolve the path to the object.

AF SDK Reference