The Win32_ShadowCopy class is a storage extent that represents a duplicate copy of the original volume at a previous time.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties. Properties and methods are in alphabetic order, not MOF order.
|
class Win32_ShadowCopy : CIM_LogicalElement
{
string ID;
string SetID;
string ProviderID;
uint32 Count;
string DeviceObject;
string VolumeName;
string OriginatingMachine;
string ServiceMachine;
string ExposedName;
uint32 State;
boolean Persistent;
boolean ClientAccessible;
boolean NoAutoRelease;
boolean NoWriters;
boolean Transportable;
boolean NotSurfaced;
boolean HardwareAssisted;
boolean Differential;
boolean Plex;
boolean Imported;
boolean ExposedRemotely;
boolean ExposedLocally;
}; |
Methods
The Win32_ShadowCopy class defines the following method.
| Method | Description |
Create | Creates a shadow copy by using the specified context. |
Properties
The Win32_ShadowCopy class defines the following properties.
- ClientAccessible
- Data type: boolean
Access type: Read-onlyIf true, the shadow copy is created by the Windows Previous Versions component.
- Count
- Data type: uint32
Access type: Read-onlyNumber of shadow copies in a shadow copy set to which a shadow copy belongs.
- DeviceObject
- Data type: string
Access type: Read-onlyWindows object manager name for an underlying storage device that supports the original volume.
- Differential
- Data type: boolean
Access type: Read-onlyIf true, the shadow copy is created by a differential shadow copy provider. The provider can be implemented in hardware or software.
- ExposedLocally
- Data type: boolean
Access type: Read-onlyIf true, the shadow copy is exposed on the local computer with a drive letter or mount point. If ExposedLocally and ExposedRemotely are not set, the shadow copy is hidden.
- ExposedName
- Data type: string
Access type: Read-onlyFile system name of a shadow copy when it is exposed. The ExposedName property might contain a drive letter or mount point. The ExposedName property is NULL when a shadow copy is hidden or otherwise not exposed.
- ExposedRemotely
- Data type: boolean
Access type: Read-onlyIf true, the shadow copy is exposed on a remote computer with a network share. If ExposedRemotely and ExposedLocally are not set, the shadow copy is hidden.
- HardwareAssisted
- Data type: boolean
Access type: Read-onlyIf true, the shadow copy is created by a hardware shadow copy provider.
- ID
- Data type: string
Access type: Read-onlyUnique identifier for a shadow copy on the system.
- Imported
- Data type: boolean
Access type: Read-onlyIf true, the shadow copy is imported to a computer by using the Import method and is not created by using the Create method.
- NoAutoRelease
- Data type: boolean
Access type: Read-onlyIf true, the shadow copy is retained after the requestor process ends. If false, the shadow copy is automatically deleted when the requestor process ends.
- NotSurfaced
- Data type: boolean
Access type: Read-onlyIf true, the shadow copy is not currently in the device namespace of a local computer.
- NoWriters
- Data type: boolean
Access type: Read-onlyIf true, the shadow copy is created with the involvement of the shadow copy writer components.
- OriginatingMachine
- Data type: string
Access type: Read-onlyName of the computer that hosts the original volume.
- Persistent
- Data type: boolean
Access type: Read-onlyIf true, the shadow copy is persistent across reboots.
- Plex
- Data type: boolean
Access type: Read-onlyIf true, the shadow copy is created by a split mirror shadow copy provider. The provider can be implemented in hardware or software.
- ProviderID
- Data type: string
Access type: Read-onlyUnique identifier for a shadow provider that creates a shadow.
- ServiceMachine
- Data type: string
Access type: Read-onlyName of the computer that services the shadow copy.
- SetID
- Data type: string
Access type: Read-onlyUnique identifier for a shadow copy set to which the shadow belongs.
- State
- Data type: uint32
Access type: Read-onlyCurrent state of a shadow copy.
| Value | Meaning |
| 0 | Unknown |
| 1 | Preparing |
| 2 | ProcessingPrepare |
| 3 | Prepared |
| 4 | ProcessingPrecommit |
| 5 | Precommitted |
| 6 | ProcessingCommit |
| 7 | Committed |
| 8 | ProcessingPostcommit |
| 9 | Created |
| 10 | Aborted |
| 11 | Deleted |
| 12 | Count |
- Transportable
- Data type: boolean
Access type: Read-onlyIf true, the shadow copy can be surfaced on another computer. If false, and the volumes are surfaced locally, it may not be possible to surface them later on a different computer.
- VolumeName
- Data type: string
Access type: Read-onlyName of the original volume for which a shadow copy is made.
Examples
For script code examples, see WMI Tasks for Scripts and Applications and the TechNet ScriptCenter Script Repository.
For C++ code examples, see WMI C++ Application Examples.
Requirements
| Server | Requires Windows Server 2008 or Windows Server 2003. |
| MOF | Declared in Vss.mof. |
| DLL | Requires Vsswmi.dll. |
| Namespace | Defined in \root\cimv2. |
See Also
Win32_ShadowProvider
Win32_ShadowContext
Win32_ShadowStorage
Win32_ShadowBy
Win32_ShadowFor
Win32_ShadowOn
Win32_ShadowVolumeSupport
Win32_ShadowDiffVolumeSupport
Send comments about this topic to Microsoft
Build date: 8/20/2008