AFEventFrame.FindEventFramesByPath Method (IEnumerable(String), AFObject, IDictionary(String, String))
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Retrieves the AFEventFrame objects identified by the path strings as a list.
Namespace: OSIsoft.AF.EventFrame
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public static AFNamedCollectionList<AFEventFrame> FindEventFramesByPath( IEnumerable<string> paths, AFObject relativeFrom, out IDictionary<string, string> errors )
Public Shared Function FindEventFramesByPath ( paths As IEnumerable(Of String), relativeFrom As AFObject, <OutAttribute> ByRef errors As IDictionary(Of String, String) ) As AFNamedCollectionList(Of AFEventFrame) Dim paths As IEnumerable(Of String) Dim relativeFrom As AFObject Dim errors As IDictionary(Of String, String) Dim returnValue As AFNamedCollectionList(Of AFEventFrame) returnValue = AFEventFrame.FindEventFramesByPath(paths, relativeFrom, errors)
public: static AFNamedCollectionList<AFEventFrame^>^ FindEventFramesByPath( IEnumerable<String^>^ paths, AFObject^ relativeFrom, [OutAttribute] IDictionary<String^, String^>^% errors )
static member FindEventFramesByPath : paths : IEnumerable<string> * relativeFrom : AFObject * errors : IDictionary<string, string> byref -> AFNamedCollectionList<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. - errors
- Type: System.Collections.GenericIDictionaryString, String
If there are any errors finding the specified event frames, then this returned dictionary has the path as the key and the corresponding error message as the value.
Return Value
Type: AFNamedCollectionListAFEventFrameReturns the list of AFEventFrame objects resolved from the specified paths.
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.
| The event frames must be checked in to the server using CheckIn before this method can resolve the path to the object. |