Name

Description

($err, $snapshotHandle) = VMGetNamedSnapshot($vmHandle,
                                             $name);

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 VMOpen() to create a virtual machine handle.

name

Identifies a snapshot name.

Return Value

$snapshotHandle. The handle to the snapshot.

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.
• The snapshotHandle returned by this function is reference counted. The calling application is responsible for releasing the handle.
• This function is not supported when using the VIX_SERVICEPROVIDER_VMWARE_PLAYER host type.

Side Effects

Requirements

use VMware::Vix::Simple;
use VMware::Vix::API::Constants;

Example

my $err;
my $snapshotHandle;

($err, $snapshotHandle) = VMGetNamedSnapshot($vmHandle, "snapshot 3");

# remove/revert, otherwise use the snapshot