IEntity.FindFiltered Method (IFilterCollection, String, ILobSystemInstance)

  • Article

Returns external items filtered by the given criteria using the specified Finder.

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

Syntax

'Declaration
Function FindFiltered ( _
    filterCollection As IFilterCollection, _
    finderName As String, _
    lobSystemInstance As ILobSystemInstance _
) As IEntityInstanceEnumerator
'Usage
Dim instance As IEntity
Dim filterCollection As IFilterCollection
Dim finderName As String
Dim lobSystemInstance As ILobSystemInstance
Dim returnValue As IEntityInstanceEnumerator

returnValue = instance.FindFiltered(filterCollection, _
    finderName, lobSystemInstance)

IEntityInstanceEnumerator FindFiltered(
    IFilterCollection filterCollection,
    string finderName,
    ILobSystemInstance lobSystemInstance
)

Parameters

Return Value

Type: Microsoft.BusinessData.Runtime.IEntityInstanceEnumerator
An enumerator to the external items.

Remarks

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.

The mode of operation can be specified for this method. For more information about how to use operation modes, see OperationMode.

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

FindFiltered Overload

Microsoft.BusinessData.MetadataModel Namespace