SuspendRoot method of the Win32_OfflineFilesCache class

Suspends or releases 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

uint32 SuspendRoot(
  [in] string  Path,
  [in] boolean Suspend
);

Parameters

Path [in]

The UNC path of the directory to be suspended. The path must exist in the Offline Files cache.

Suspend [in]

Specify TRUE to suspend, or FALSE to release.

Return value

This method returns either a WMI return code or a system error code.

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).

Suspended items are always offline and are excluded from automatic synchronization by the Offline Files service. Nevertheless, suspended items can still be synchronized by using the Synchronize method, or one of the user interface Sync points in either the Sync Center or Windows Explorer.

Requirements

See also

Win32_OfflineFilesCache