IEntity.EnumerateChangedIdentities method

Enumerates the identities of changed external items.

Namespace:  Microsoft.BusinessData.MetadataModel
Assembly:  Microsoft.BusinessData (in Microsoft.BusinessData.dll)

IEntityInstanceEnumerator EnumerateChangedIdentities(
	DateTime timeStamp,
	IFilterCollection filterCollection,
	ILobSystemInstance lobSystemInstance
)

Parameters

timeStamp
Type: System.DateTime

A timestamp.

filterCollection
Type: Microsoft.BusinessData.Runtime.IFilterCollection

The filters to apply.

lobSystemInstance
Type: Microsoft.BusinessData.MetadataModel.ILobSystemInstance

The external system instance.

Return value

Type: Microsoft.BusinessData.Runtime.IEntityInstanceEnumerator
The enumerator to external items with minimal data.

This method can be used to optimize synchronization of cached data. This method ideally returns only the Identities and version information of the external items which have been modified after the given time, and then the calling application can request the changed external items to update the cached data.

This method can potentially return a lot of external items. IFilterCollection can be specified to filter the results and optimize the behavior. For more information about how to use filters, see IFilterCollection.

This method returns an IEntityInstanceEnumerator, which requires special clean up and may expose additional functionality to control the behavior when the external system returns data in batches. For more information about how to use external item enumerators, see IEntityInstanceEnumerator.

Instances of objects in the Business Data Connectivity object model are tied to the Metadata Store they are obtained from. Using instances tied to one Metadata Store with the instances from another Metadata Store will cause data corruption and other unexpected behavior. For more information, see DatabaseBackedMetadataCatalog, FileBackedMetadataCatalog, and RemoteSharedFileBackedMetadataCatalog.

Show: