PrlVm_CreateSnapshotEx Function

Creates a virtual machine snapshot.

Syntax

PRL_HANDLE PrlVm_CreateSnapshotEx(
    PRL_HANDLE hVm, 
    PRL_CONST_STR sName, 
    PRL_CONST_STR sDescription, 
    PRL_UINT32 nFlags
);

File

PrlApiVm.h

Parameters

sName

Snapshot name.

sDescription

Snapshot description.

handle

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

nFlag

Flags from enum PRL_CREATE_SNAPSHOT_FLAGS

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.