Share via


Workspace.IsScannerAsynchronous Property

This flag applies only to local workspaces (Location == WorkspaceLocation.Local). If true, then the VersionControlServer which owns this Workspace will raise the PendingChangesChanged and GetCompleted events as soon the disk scanner notices that something has changed on disk.

That is, the generation of those events is truly asynchronous. If false, the disk scanner only runs when it is required for correctness -- as a part of calls to this Workspace object's public methods. The events will still raise, but they will raise after the scanned API call which notices them, instead of as soon as they occur on disk.

The default is false. Setting this flag to true may decrease performance, but it is useful for the construction of a feature such as an always-up-to-date list of pending changes in the workspace.

Namespace:  Microsoft.TeamFoundation.VersionControl.Client
Assembly:  Microsoft.TeamFoundation.VersionControl.Client (in Microsoft.TeamFoundation.VersionControl.Client.dll)

Syntax

'Declaration
Public Property IsScannerAsynchronous As Boolean
public bool IsScannerAsynchronous { get; set; }
public:
property bool IsScannerAsynchronous {
    bool get ();
    void set (bool value);
}
member IsScannerAsynchronous : bool with get, set
function get IsScannerAsynchronous () : boolean 
function set IsScannerAsynchronous (value : boolean)

Property Value

Type: System.Boolean

.NET Framework Security

See Also

Reference

Workspace Class

Microsoft.TeamFoundation.VersionControl.Client Namespace