PrlVm_UpdateSnapshotData Function

Modifies the specified virtual machine snapshot name and description.

Syntax

PRL_HANDLE PrlVm_UpdateSnapshotData(
    PRL_HANDLE hVm, 
    PRL_CONST_STR sSnapshotUuid, 
    PRL_CONST_STR sNewName, 
    PRL_CONST_STR sNewDescription
);

File

PrlApi.h

Parameters

sSnapshotUuid

The ID of the snapshot to modify. To obtain a list of the available snapshots and their ID's, use the PrlVm_GetSnapshotsTreeEx function.

sNewName

New snapshot name.

sNewDescription

New snapshot description.

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.