PrlDisk_Compact Function

Compacts a virtual disk.

Syntax

PRL_RESULT PrlDisk_Compact(
    const PRL_HANDLE Handle, 
    const PRL_DISK_CALLBACK pDiskCallback, 
    PRL_VOID_PTR pParameter
);

File

PrlDisk.h

Parameters

Handle

A handle of type PHT_VIRTUAL_DISK identifying the virtual disk.

pDiskCallback

A pointer to a callback function or NULL pointer. If the parameter contains a pointer to a callback, the function will be called asynchronously. If it contains 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.

Remarks

A virtual disk may become fragmented just like a physical disk. As a result, the size that the disk files occupy on the host's hard drive may be larger than the size of the actual data they contain. The PrlDisk_Compact function defragments the specified virtual disk and decreases the size that the virtual disk files occupy on the physical hard disk. The size of the virtual disk itself (if it is an expanding disk) remains unchanged.

Links

PrlDisk.h , PHT_VIRTUAL_DISK