PrlVmDev_CreateImage Function

Physically creates a virtual device image on the host.

Syntax

PRL_HANDLE PrlVmDev_CreateImage(
    PRL_HANDLE hVmDev, 
    PRL_BOOL bRecreateIsAllowed, 
    PRL_BOOL bNonInteractiveMode
);

File

PrlApi.h

Parameters

hVmDev

A handle identifying the virtual device.

bRecreateIsAllowed

Specifies wether the existing image should be replaced. If set to PRL_TRUE , the existing image will be replaced. If set to PRL_FALSE , the operation will be aborted if image already exists.

bNonInteractiveMode

Specifies wether the operation should be carried out in interactive mode (where the Parallels Service may ask questions and the client will have to send answers). If set to PRL_TRUE , non-interactive mode will be used (the Parallels Service will make decisions on its own). If set to PRL_FALSE , interactive mode will be used.

Returns

A handle of type PHT_JOB containing the results of this asynchronous operation or PRL_INVALID_HANDLE if there's not enough memory to instantiate the job object.

Remarks

To get the return code from the PHT_JOB object, use the PrlJob_GetRetCode function. Possible values are:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Links

PrlApi.h , Virtual Device Functions