Edit

IOfflineFilesSuspend::SuspendRoot method (cscobj.h)

  • Article

Suspend or release a share root or directory tree. A suspended item is always in the offline state and is excluded from automatic synchronization by Offline Files.

Syntax

HRESULT SuspendRoot(
  [in] BOOL bSuspend
);

Parameters

[in] bSuspend

Specify TRUE to suspend, or FALSE to release.

Return value

Returns S_OK if successful, or an error value otherwise.

Remarks

When a share root or directory tree is suspended, all directories and files contained in the share or directory or in any subfolders are suspended as well. This means that both directories and files may be suspended. Note that a directory can be suspended directly (if it is the root of the share or directory tree) or indirectly (if it is one of the items contained in the share or directory tree).

Requirements

Requirement Value
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Target Platform Windows
Header cscobj.h
DLL CscSvc.dll; CscObj.dll

See also

IOfflineFilesSuspend