CHAPTER 4 Operations on Virtual Machines
55
RC1
VixVM_Open
Function Signature
VixHandle
VixVM_Open(VixHandle hostHandle,
const char *vmxFilePathName,
VixEventProc *callbackProc,
void *clientData);
Parameters
Results
A job handle that describes the state of this asynchronous call.
Notes
• This function opens a virtual machine on the host identified by the
hostHandle parameter. The virtual machine is identified by the
vmxFilePathName, which is a path name to the configuration file (.VMX file)
for that virtual machine.
• The format of the path name depends on the host operating system. For
example, a path name for a Windows host requires backslash as a directory
separator, whereas a Linux host requires a forward slash. If the path name
includes backslash characters, you need to precede each one with an escape
character.
• This function is asynchronous, and uses a job object to report when the
operaton is complete. The function returns a handle to the job object
immediately. When the job is signaled, the virtual machine handle is stored as
the VIX_PROPERTY_JOB_RESULT_HANDLE property of the job object.
hostHandle The handle of a host object, typically returned from
VixHost_Connect().
vmxFilePathName The path name of the virtual machine configuration file on the local
host.
callbackProc A callback function that will be invoked when VixVM_Open()
completes.
clientData A parameter that will be passed to the callbackProc procedure.
