PrlVmCfg_SetSmartGuardNotifyBeforeCreation Function

Enables or disables notification of automatic snapshot creation, a SmartGuard feature.

Syntax

PRL_RESULT PrlVmCfg_SetSmartGuardNotifyBeforeCreation(
    PRL_HANDLE hVmCfg, 
    PRL_BOOL bNotifyBeforeCreation
);

File

PrlApiVm.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

bNotifyBeforeCreation

Action type. Specify PRL_TRUE if you want the user to be notified. Specify PRL_FALSE if you want to create snapshots silently.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

SmartGuard is a facility that allows to make automatic snapshots of a virtual machine at predefined time intervals. By default, the snapshots are creating transparently to the user. If needed, Parallels Service can notify the user that a snapshot is about to be created. The user can then choose to proceed with snapshot creation or cancel it. This function allows to enabled or disable this feature. The notifications are received by the client via the PHT_EVENT handle received by a callback function. See PHT_EVENT and PrlEvent_CreateAnswerEvent for more information and code samples.