Name

VMGetNamedSnapshot

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

$err. The error code returned by the operation. For returned values, see Topics > Error Codes.

$snapshotHandle. The handle to the snapshot.

Remarks

Side Effects

None.

Requirements

use VMware::Vix::Simple;
use VMware::Vix::API::Constants;
since VMware Workstation 6.0

Example

my $err;
my $snapshotHandle;

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

# remove/revert, otherwise use the snapshot

Copyright (C) 2007-2010 VMware, Inc. All rights reserved.