PrlVmCfg_IsTemplate Function

Determines if the specified virtual machine object contains a virtual machine or a template configuration information.

Syntax

PRL_RESULT PrlVmCfg_IsTemplate(
    PRL_HANDLE hVmCfg, 
    PRL_BOOL_PTR pbVmIsTemplate
);

File

PrlApiVm.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

pbVmIsTemplate

[out] A pointer to a variable that receives the result. PRL_TRUE indicates that the machine is a template. PBL_FALE indicates otherwise.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

If the object contains a template configuration, it can be used to create new virtual machines from it. See PrlVm_Clone for the information on how to create virtual machines from templates.

Links

PHT_VM_CONFIGURATION