IBatchableEntityInstanceEnumerator.IsBatchingEnabled Property

Gets or sets a value that indicates whether batching is enabled.

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

Syntax

'Declaration
Property IsBatchingEnabled As Boolean
    Get
    Set
'Usage
Dim instance As IBatchableEntityInstanceEnumerator
Dim value As Boolean

value = instance.IsBatchingEnabled

instance.IsBatchingEnabled = value
bool IsBatchingEnabled { get; set; }

Property Value

Type: System.Boolean
true if enabled; otherwise, false.

Remarks

If IsBatchingEnabled is set to false, the OnBatchCompletion event will not be raised. If it set to true, the OnBatchCompletion event will be raised and if BatchCompletionEventArgs indicate that the next batch should be retrieved, then the next method instance call is made. Otherwise, batching is paused.

See Also

Reference

IBatchableEntityInstanceEnumerator Interface

IBatchableEntityInstanceEnumerator Members

Microsoft.BusinessData.Runtime Namespace