Collapse All
Parallels C API Reference Guide
PrlVm_Suspend Function
PrlApi.h PHT_VIRTUAL_MACHINE Send Feedback

Suspends the specified virtual machine.

Syntax
PRL_HANDLE PrlVm_Suspend(
    PRL_HANDLE hVm
);
File
Parameters

handle
A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.
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

When a running virtual machine is suspended using this call, the states of the virtual machine processes are saved into a file on the hard disk, and then the machine is stopped. To resume the machine, use the PrlVm_Resume function call. If after suspending a machine you don't want to resume it but would like to return to the previous state, you may call the PrlVm_DropSuspendedState function.

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
Copyright (c) 1999-2008 Parallels Software International Inc.
What do you think about this topic? Send feedback!