PrlVm_DeleteSnapshot Function

Deleted the specified virtual machine snapshot.

Syntax

PRL_HANDLE PrlVm_DeleteSnapshot(
    PRL_HANDLE hVm, 
    PRL_CONST_STR sSnapshotUuid, 
    PRL_BOOL bChild
);

File

PrlApi.h

Parameters

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

sSnapshotUuid

Snapshot ID. To obtain a snapshot ID use the PrlVm_GetSnapshotsTreeEx function.

bChild

Specifies whether snapshots derived from the specified snapshot should be deleted or not. True - delete child snapshots. False - don't delete child snapshots.

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 values are:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.