IOfflineFilesSuspend interface

Suspends or releases a share root or directory tree in the Offline Files cache. A suspended tree is always offline and is never synchronized automatically by the Offline Files service. It may, however, be synchronized by the user through Windows Explorer, through Sync Center, or by code calling the Offline Files API.

When to implement

This interface is implemented by Windows.

When to use

Use this interface with caution, because it will transition a scope offline and the user will have no way to transition it online. This feature is primarily used by Windows features that use the offline and sync capabilities of Offline Files and that want to disable the automatic sync capabilities that are normally available to cached items.

Only share and directory items support this interface. Server items do not support suspension and only directory trees may be suspended. Individual files may not be suspended.

Members

The IOfflineFilesSuspend interface inherits from the IUnknown interface. IOfflineFilesSuspend also has these types of members:

Methods

The IOfflineFilesSuspend interface has these methods.

MethodDescription
SuspendRoot

Suspend or release a share root or directory tree.

 

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Header

CscObj.h

DLL

CscSvc.dll;
CscObj.dll

See also

Offline Files API Interfaces

 

 

Show:
© 2015 Microsoft