Win32_OfflineFilesCache class

Represents the Offline Files cache. Each computer contains only one Offline Files cache. Thus, each computer creates only one instance of this singleton class.

The following syntax is simplified from MOF code and includes all inherited properties.

Syntax

class Win32_OfflineFilesCache
{
  boolean Enabled;
  boolean Active;
  string  Location;
};

Members

The Win32_OfflineFilesCache class has these types of members:

Methods

The Win32_OfflineFilesCache class has these methods.

MethodDescription
DeleteItems

Deletes one or more items from the Offline Files cache.

Enable

Enables or disables the Offline Files feature.

Encrypt

Encrypts or unencrypts files in the Offline Files cache.

Pin

Assures that an item will be available offline.

RenameItem

Renames an item in the Offline Files cache.

RenameItemEx

Renames an item in the Offline Files cache. This method is identical to the RenameItem method, except that it will attempt to do the rename operation right away.

Windows 7, Windows Server 2008 R2, Windows Vista, and Windows Server 2008:  This method is not supported until Windows 8 and Windows Server 2012.

SuspendRoot

Suspends or un-suspends a directory tree in the Offline Files cache.

Synchronize

Synchronizes one or more items.

TransitionOffline

Transitions an item offline if possible.

TransitionOnline

Transitions an item online if possible.

Unpin

Removes the assurance that an item will be available offline.

 

Properties

The Win32_OfflineFilesCache class has these properties.

Active
Data type: boolean
Access type: Read-only

Specifies the running state of the Offline Files feature. If this property is TRUE, the Offline Files feature is running, caching is active, and cached files will be available offline. If this property is FALSE, the Offline Files feature is not running, Offline Files will not cache files, and any cached files will not be available offline. Note that a system restart may be necessary before the configured state takes effect. To determine the configuration state of the feature, query the Enabled property.

Enabled
Data type: boolean
Access type: Read-only

Specifies the configuration state of the Offline Files feature. If this property is TRUE, the Offline Files feature has been enabled and is configured to run. If this property is FALSE, the Offline Files feature has been disabled and is not configured to run. Note that a system restart may be necessary before the configured state takes effect. To determine the actual state of the feature, query the Active property.

Location
Data type: string
Access type: Read-only

The path of the directory on the local computer where the Offline Files cache is located.

Remarks

The role of this object is to control the configuration of the Offline Files feature as well as manipulate the individual items that are stored within the cache. Items in the cache represent servers, shares, directories, and files that are associated with the UNC paths of remote files that are cached.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Namespace

\root\cimv2

MOF

OfflineFilesWmiProvider.mof

DLL

Cscobj.dll

See also

Offline Files WMI Provider Reference

 

 

Show:
© 2014 Microsoft