IEntityInstanceEnumerator Interface

Represents an enumerator interface that enables reading External Items from collections or streams.

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

Syntax

'Declaration
Public Interface IEntityInstanceEnumerator _
    Inherits IEnumerator(Of IEntityInstance), IDisposable, IEnumerator,  _
    ICloseable
'Usage
Dim instance As IEntityInstanceEnumerator
public interface IEntityInstanceEnumerator : IEnumerator<IEntityInstance>, 
    IDisposable, IEnumerator, ICloseable

Remarks

Some operations on external content types will return multiple External Items. These operations will return an enumerator of these External Items using this interface. All instances of IEntityInstanceEnumerator are forward only.

Warning

All implementations of IEntityInstanceEnumerator must be closed using the Close() method after all the required External Items are read. Otherwise, resources used for external system connections will not be reclaimed.

If the external system supports sending results in batches, and the metadata contains enough information about this behavior, the returned enumeration of External Items will also implement IBatchableEntityInstanceEnumerator.

Examples

Code Snippet: Execute a Finder Method Instance of an External Content Type

Code Snippet: Execute the AssociationNavigator Method Instance of an External Content Type for an Association Without a Foreign Key

Code Snippet: Execute the BulkAssociationNavigator Method Instance of an External Content Type

See Also

Reference

IEntityInstanceEnumerator Members

Microsoft.BusinessData.Runtime Namespace

IEntityInstance

IBatchableEntityInstanceEnumerator