Name
GetNamedSnapshot
Description
HRESULT
GetNamedSnapshot([in] BSTR name,
[out] ISnapshot** snapshot,
[out,retval] ULONGLONG* error);
This
method
returns the handle of the snapshot matching the
given name in the virtual machine referenced by vmHandle.
Parameters
- name
-
Identifies a snapshot name.
- snapshot
-
An output parameter that receives an ISnapshot object for the named snapshot.
Return Value
HRESULT
Remarks
- This function returns a handle to the snapshot with matching name.
When the snapshot name is a duplicate, returns error 13017 VIX_E_SNAPSHOT_NONUNIQUE_NAME.
You can specify the snapshot name as a path, including snapshots in the tree above
the named snapshot, using '/' or '\\' as path separators, for example 'a/b/c' or 'x/x'.
Side Effects
None.
Requirements
VixCOM.h, since VMware Workstation 6.0
Example
VBScript:
Dim snapshot
Dim err
err = vm.GetNamedSnapshot("snapshot 3", snapshot)
If lib.ErrorIndicatesFailure(err) Then
' Handle the error...
End If