PrlVmDev_CopyImage Function

Copies a virtual device image to another custom location.

Syntax

PRL_HANDLE PrlVmDev_CopyImage(
    PRL_HANDLE hVmDev, 
    PRL_CONST_STR sNewImageName, 
    PRL_CONST_STR sTargetPath, 
    PRL_UINT32 nFlags
);

File

PrlApiVm.h

Parameters

hVmDev

A handle identifying the virtual device.

sNewImageName

New image short name.

sTargetPath

New custom location.

nFlags

Reserved

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

Virtual Device Functions