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

AF SDK Reference

AFEventFrameSearch.Subscribe Method (IObserver(AFSearchUpdateEvent(AFEventFrame)), Boolean, Int32)

AFEventFrameSearch.Subscribe Method (IObserver(AFSearchUpdateEvent(AFEventFrame)), Boolean, Int32)

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFEventFrameSearch.Subscribe Method (IObserver(AFSearchUpdateEvent(AFEventFrame)), Boolean, Int32)
Subscribes an observer to matches for this event frame search.

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

Syntax

public IDisposable Subscribe(
	IObserver<AFSearchUpdateEvent<AFEventFrame>> observer,
	bool observeExistingMatches,
	int maxCount
)
Public Function Subscribe ( 
	observer As IObserver(Of AFSearchUpdateEvent(Of AFEventFrame)),
	observeExistingMatches As Boolean,
	maxCount As Integer
) As IDisposable

Dim instance As AFEventFrameSearch
Dim observer As IObserver(Of AFSearchUpdateEvent(Of AFEventFrame))
Dim observeExistingMatches As Boolean
Dim maxCount As Integer
Dim returnValue As IDisposable

returnValue = instance.Subscribe(observer, 
	observeExistingMatches, maxCount)
public:
IDisposable^ Subscribe(
	IObserver<AFSearchUpdateEvent<AFEventFrame^>^>^ observer, 
	bool observeExistingMatches, 
	int maxCount
)
member Subscribe : 
        observer : IObserver<AFSearchUpdateEvent<AFEventFrame>> * 
        observeExistingMatches : bool * 
        maxCount : int -> IDisposable 

Parameters

observer
Type: SystemIObserverAFSearchUpdateEventAFEventFrame
The observer to notify on changes.
observeExistingMatches
Type: SystemBoolean
True if the current matches should be sent to the observer.
maxCount
Type: SystemInt32
Maximum number of items to observe at once.

Return Value

Type: IDisposable
An IDisposable instance to call to unsubscribe.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.0, 2.10

See Also

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