ContentIterator.Cancel Property

Gets or sets whether the current iteration should be canceled.

Namespace:  Microsoft.Office.Server.Utilities
Assembly:  Microsoft.Office.Server (in Microsoft.Office.Server.dll)

Syntax

'Declaration
Public Property Cancel As Boolean
    Get
    Set
'Usage
Dim instance As ContentIterator
Dim value As Boolean

value = instance.Cancel

instance.Cancel = value
public bool Cancel { get; set; }

Property Value

Type: System.Boolean
Returns Boolean.

Remarks

This flag only applies to the current iterator scope and all child scopes. For example, if you have nested iteration scopes that iterate over site collections, sites, lists and list items, setting the Cancel property on the site scoped iterator will immediately cancel the iteration of list items and lists.

See Also

Reference

ContentIterator Class

ContentIterator Members

Microsoft.Office.Server.Utilities Namespace