Name

Suspend

Description

HRESULT
Suspend([in] LONG suspendOptions,
        [in] ICallback* jobDoneCallback,
        [out,retval] IJob** suspendJob);

This function suspends a virtual machine.

Parameters

powerOffOptions
Must be 0.
jobDoneCallback
An ICallback instance that will be called when the operation is complete.
suspendJob
Returns an IJob object that describes the state of this asynchronous operation.

Return Value

HRESULT

Remarks

This function suspends a virtual machine. It is an asynchronous operation, and the job will be signaled when the operation completes. If the virtual machine is not powered on when you call this function, the function returns the error VIX_E_VM_NOT_RUNNING.

Side Effects

None.

Requirements

VixCOM.h, since VMware Workstation 6.0

Example





Copyright (C) 2007-2010 VMware, Inc. All rights reserved.