PrlDisk_Compact Function

This method is deprecated now.

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 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.

Remarks

Compacts a virtual disk. A virtual disk may become fragmented similar to a physical disk. As a result, the size that the disk files occupy on the physical 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 designated size of the virtual disk itself remains unchanged.

Please note that not all disks can be compacted. To determine if a disk can or cannot be compacted use the PrlDisk_IsCompactable function.