IEntity.BulkEnumerateIdentities Method

  • Article

Enumerates the given identities.

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

Syntax

'Declaration
Function BulkEnumerateIdentities ( _
    identities As IList(Of Identity), _
    lobSystemInstance As ILobSystemInstance _
) As IEntityInstanceEnumerator
'Usage
Dim instance As IEntity
Dim identities As IList(Of Identity)
Dim lobSystemInstance As ILobSystemInstance
Dim returnValue As IEntityInstanceEnumerator

returnValue = instance.BulkEnumerateIdentities(identities, _
    lobSystemInstance)

IEntityInstanceEnumerator BulkEnumerateIdentities(
    IList<Identity> identities,
    ILobSystemInstance lobSystemInstance
)

Parameters

Return Value

Type: Microsoft.BusinessData.Runtime.IEntityInstanceEnumerator
An enumerator.

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 corresponding to given identities, which the calling application can compare with the local version to identify if anything has changed, and if so, 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.

See Also

Reference

IEntity Interface

IEntity Members

Microsoft.BusinessData.MetadataModel Namespace

EnumerateChangedIdentities(DateTime, IFilterCollection, ILobSystemInstance)

EnumerateDeletedIdentities(DateTime, IFilterCollection, ILobSystemInstance)

EnumerateIdentities(IFilterCollection, ILobSystemInstance)