Creates a snapshot of a virtual system collection.
Syntax
uint32 CreateSnapshot(
[in] CIM_CollectionOfMSEs REF Collection,
[in] string SnapshotSettings,
[in] uint16 SnapshotType,
[in, out] CIM_Collection REF ResultingSnapshotCollection,
[out] CIM_ConcreteJob REF Job
);
Parameters
Collection [in]
Reference to a CIM_CollectionOfMSEs that describes the affected virtual system collection.
SnapshotSettings [in]
Contains the parameter settings.
SnapshotType [in]
Requested snapshot type:
Unknown (0)
Standard Snapshot (1)
Standard snapshot of the virtual system.
Recovery Snapshot (2)
Snapshot for recovery scenarios including failover replication and backup.
DMTF Reserved (..)
Vendor Specific (32768..65535)
ResultingSnapshotCollection [in, out]
On success, returns a CIM_Collection reference containing the virtual system snapshot.
Job [out]
An optional reference that is returned if the operation is executed asynchronously. If present, the returned reference to an instance of CIM_ConcreteJob can be used to monitor progress and to obtain the result of the method.
Return value
On success, returns either 0 (Complete) or 4096 (Job Started); otherwise, returns an error.
Completed with No Error (0)
Not Supported (1)
Failed (2)
Timeout (3)
Invalid Parameter (4)
Invalid State (5)
Invalid Type (6)
DMTF Reserved (..)
Method Parameters Checked - Job Started (4096)
Method Reserved (4097..32767)
Vendor Specific (32768..65535)
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 10 [desktop apps only] |
| Minimum supported server | Windows Server 2016 |
| Namespace | Root\virtualization\v2 |
| MOF | WindowsVirtualization.V2.mof |
| DLL | Vmms.exe |
See also
Msvm_CollectionSnapshotService
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
