Name

VixVM_GetNamedSnapshot

Description

VixError
VixVM_GetNamedSnapshot(VixHandle vmHandle,
                       const char *name,
                       VixHandle *snapshotHandle);

This function returns the handle of the snapshot matching the given name in the virtual machine referenced by vmHandle.

Parameters

vmHandle: Identifies a virtual machine. Call VixVM_Open() to create a virtual machine handle.
name: Idenitfies a snapshot name.
snapshotHandle: An output parameter that receives a handle to a snapshot.

Return Value

VixError.

Remarks

This function returns a handle to the snapshot with the matching name. Since snapshot names are not unique, the first match is returned.
The snapshotHandle returned by this function is reference counted. The calling application is responsible for releasing the handle.

Side Effects

None.

Requirements

vix.h, since VMware Workstation 6.0

Example

VixHandle snapshotHande;
VixError err;

err = VixVM_GetNamedSnapshotHandle(vmHandle, "snapshot 3",
                                   &snapshotHandle);

// remove/revert, otherwise use the snapshot