PrlVmCfg_IsAutoCompressEnabled Function

Determines whether the Automatic HDD compress feature is enabled or not in a virtual machine.

Syntax

PRL_RESULT PrlVmCfg_IsAutoCompressEnabled(
    PRL_HANDLE hVmCfg, 
    PRL_BOOL_PTR pbEnabled
);

File

PrlApi.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

pbEnabled

[out] A pointer to a variable that receives the result. PRL_TRUE indicates that Automatic HDD compress is enabled. PRL_FALSE indicates otherwise.

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer to buffer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

Automatic HDD compress is feature that allows to make automatic compacting of a virtual machine disks at predefined time intervals. The feature recommends Parallels Tools installed in a virtual machine.