SearchAndSubscribe Method (RealtimeTable)

In This Topic

Searches the table for existing rows using the query criteria and then subscribes to receive row events. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public RealtimeCursor SearchAndSubscribe( 
   QueryFilter queryFilter,
   bool useRecyclingCursor
)

Public Function SearchAndSubscribe( _
   ByVal queryFilter As QueryFilter, _
   ByVal useRecyclingCursor As Boolean _
) As RealtimeCursor

Parameters

queryFilter: A null query filter will search all rows and all rows that become available will be retrieved.
useRecyclingCursor: If set to true, all the entries in RealtimeCursor will reference the most current row returned by RealtimeCursor.Current. To ensure all the entries in RealtimeCursor remain unique, set useRecyclingCursor to false. The default is true.

Return Value

A RealtimeCursor that encapsulates the retrieved rows, as well as provides facilities to wait for new row events.

Exceptions

Exception	Description
ArcGIS.Core.Data.Exceptions.GeodatabaseException	A geodatabase-related exception has occurred.

Remarks

This method is thread-safe and it can be called on any thread. If the cursor is disposed or in the process of being disposed when this method is called it will result in undefined behavior. This operation is atomic. It is guaranteed that the returned RealtimeCursor will correctly reflect any insert or delete operations that occured at any time during the exection of this method. If no query filter is set, all pre-existing rows will be searched and all rows that become available after subscribing will be retrieved.

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

RealtimeTable Class
RealtimeTable Members

Send feedback