PrlDisk_DeleteState Function

Deletes the specified virtual disk snapshot.

Syntax

PRL_RESULT PrlDisk_DeleteState(
    const PRL_HANDLE Handle, 
    PRL_CONST_STR pDirectoryName, 
    PRL_CONST_GUID_PTR pUid, 
    const PRL_BOOL bMerge, 
    const PRL_STATES_CALLBACK pCallback, 
    PRL_VOID_PTR pParameter
);

File

PrlDisk.h

Parameters

Handle

A handle of type PHT_VIRTUAL_DISK identifying the virtual disk.

pDirectoryName

Directory name. The parameter is not currently used.

pUid

Universally unique ID (UUID) of the snapshot to delete.

bMerge

A flag indicating whether the data contained in the snapshot being deleted should be merged with the descending snapshots. PRL_TRUE merges the snapshot data, PRL_FALSE simply deletes the snapshot. If you don't merge the data, all descending snapshots will be lost.

pCallback

A pointer to a callback function or NULL pointer. If the parameter contains a valid pointer to the callback, the function will be called asynchronously. If it contains a NULL pointer, the function will be called synchronously.

pParameter

A pointer to a buffer containing user-defined data to pass to the callback function.

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid argument values.

PRL_ERR_SUCCESS - function completed successfully.