PrlVmCfg_SetTemplateSign Function

Allows to modify a regular virtual machine to become a template, and vise versa.

Syntax

PRL_RESULT PrlVmCfg_SetTemplateSign(
    PRL_HANDLE hVmCfg, 
    PRL_BOOL bVmIsTemplate
);

File

PrlApiVm.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

bVmIsTemplate

The value to set. Specify PRL_TRUE to make the virtual machine a template. Specify PRL_FALSE to switch a template to a regular virtual machine.

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

A template is very similar to a regular virtual machine with the major exception being it cannot be started. Templates are used to create new virtual machines as exact copies of them. To create a virtual machine from a template, use the PrlVm_Clone function specifying the template as the source.

Links

PHT_VM_CONFIGURATION