PrlVmCfg_GetAutoCompressInterval Function

Determines the interval at which compacting virtual disks are doing by Automatic HDD compress.

Syntax

PRL_RESULT PrlVmCfg_GetAutoCompressInterval(
    PRL_HANDLE hVmCfg, 
    PRL_UINT32_PTR pnInterval
);

File

PrlApi.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

pnInterval

[out] A pointer to a variable the receives the automatic compress interval, in seconds.

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 a facility that allows to make automatic compress of a virtual machine disks at predefined time intervals. The currently set time interval can be obtained using this function.