IEntity.EnumerateDeletedIdentities Method

  • Article

Enumerates the external items that have been modified after the specified time.

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

Syntax

'Declaration
Function EnumerateDeletedIdentities ( _
    timeStamp As DateTime, _
    filterCollection As IFilterCollection, _
    lobSystemInstance As ILobSystemInstance _
) As IEntityInstanceEnumerator
'Usage
Dim instance As IEntity
Dim timeStamp As DateTime
Dim filterCollection As IFilterCollection
Dim lobSystemInstance As ILobSystemInstance
Dim returnValue As IEntityInstanceEnumerator

returnValue = instance.EnumerateDeletedIdentities(timeStamp, _
    filterCollection, lobSystemInstance)

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

Parameters

Return Value

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

Remarks

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 deleted after the given time, and then the calling application can remove the cached data of these external items.

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.

See Also

Reference

IEntity Interface

IEntity Members

Microsoft.BusinessData.MetadataModel Namespace

BulkEnumerateIdentities(IList<Identity>, ILobSystemInstance)

EnumerateChangedIdentities(DateTime, IFilterCollection, ILobSystemInstance)

EnumerateIdentities(IFilterCollection, ILobSystemInstance)