SPChangeToken.Scope Property

Gets the scope of the changes, which can be a list, Web site, site collection, or content database.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online

Syntax

'Declaration
Public ReadOnly Property Scope As SPChangeCollection.CollectionScope
    Get
'Usage
Dim instance As SPChangeToken
Dim value As SPChangeCollection.CollectionScope

value = instance.Scope
public SPChangeCollection.CollectionScope Scope { get; }

Property Value

Type: Microsoft.SharePoint.SPChangeCollection.CollectionScope
A SPChangeCollection.CollectionScope value that indicates the scope.

Remarks

The value of this property helps determine which changes are returned when the change token is used in a query against the change log. To get changes to objects that are contained in a list, pass a change token with the scope SPChangeCollection.CollectionScope.List in your call to the SPList.GetChanges(SPChangeToken) method.

Note that the value of the Scope property must correspond to the type of object that is identified in the ScopeId property. For example, if the value of the ScopeId property is the GUID for a site collection, then the value of the Scope property must be SPChangeCollection.CollectionScope.Site. If it is not, the SPSite.GetChanges(SPChangeToken) method throws an SPException exception.

See Also

Reference

SPChangeToken Class

SPChangeToken Members

Microsoft.SharePoint Namespace