PrlVm_SwitchToSnapshot Function

Reverts the specified virtual machine to the specified snapshot.

Syntax

PRL_HANDLE PrlVm_SwitchToSnapshot(
    PRL_HANDLE hVm, 
    PRL_CONST_STR sSnapshotUuid
);

File

PrlApi.h

Parameters

sSnapshotUuid

The ID of a snapshot to revert to. To obtain a list of the available snapshots and their IDs, use the PrlVm_GetSnapshotsTreeEx function.

handle

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

Returns

A handle of type PHT_JOB containing the results of this asynchronous operation or PRL_INVALID_HANDLE if there's not enough memory to instantiate the job object.

Remarks

To get the return code from the PHT_JOB object, use the PrlJob_GetRetCode function. Possible value are:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.