Name

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

Remarks

• This function returns a handle to the snapshot with matching name. When the snapshot name is a duplicate, it returns error 13017 VIX_E_SNAPSHOT_NONUNIQUE_NAME.
• When there are multiple snapshots with the same name, or the same path to that name, you cannot specify a unique name, but you can to use the UI to rename duplicates.
• You can specify the snapshot name as a path using '/' or '\\' as path separators, including snapshots in the tree above the named snapshot, for example 'a/b/c' or 'x/x'. Do not mix '/' and '\\' in the same path expression.
• This function is not supported when using the VixCOM.Constants.VIX_SERVICEPROVIDER_VMWARE_PLAYER host type.

Side Effects

Requirements

Example

Dim snapshot
Dim err

err = vm.GetNamedSnapshot("snapshot 3", snapshot)
If lib.ErrorIndicatesFailure(err) Then
   ' Handle the error...
End If

' remove/revert, otherwise use the snapshot

Set snapshot = Nothing