PrlDisk_GetSnapshotsTree Function

Obtains the entire snapshot tree for the specified virtual disk.

Syntax

PRL_RESULT PrlDisk_GetSnapshotsTree(
    const PRL_HANDLE Handle, 
    PRL_SNAPSHOT_ELEMENT_PTR pSnapshotTree, 
    PRL_UINT32_PTR BufferSize
);

File

PrlDisk.h

Parameters

Handle

A handle of type PHT_VIRTUAL_DISK identifying the virtual disk.

pSnapshotTree

[out] A pointer to a buffer that receives the result.

BufferSize

[in] The size of the output buffer (in bytes). Set the buffer pointer to null and this parameter's value to zero to receive the required size. [out] The required output buffer size.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid argument values.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

A virtual disk snapshot is created when a snapshot of a virtual machine is created or manually using the PrlDisk_CreateState function. Each snapshot is identified using a universally unique ID (UUID). Snapshots of a given virtual disk are organized into a tree. You can use the PrlDisk_GetSnapshotsTree function to obtain the entire tree and then traverse it to obtain the UUID of a snapshot of interest. When you know the snapshot UUID, you can revert to it or delete it if needed.