Name

Description

VixHandle
VixHost_RegisterVM(VixHandle hostHandle,
                   const char *vmxFilePath,
                   VixEventProc *callbackProc,
                   void *clientData);

This function adds a virtual machine to the host's inventory.

Parameters

hostHandle

The host handle returned by VixHost_Connect().

vmxFilePath

The path name of the .vmx file on the host.

callbackProc

A function to be invoked when VixHost_RegisterVM() completes.

clientData

A user-supplied parameter to be passed to the callback function.

Return Value

Remarks

• This function adds a virtual machine to the local host's inventory. 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. If the path name includes backslash characters, you need to precede each one with an escape character.
• This function does not apply to Workstation, which has no virtual machine inventory.
• This function is asynchronous. Completion is reported by a job handle.

Side Effects

Requirements

Example

VixError err = VIX_OK;
VixHandle hostHandle = VIX_INVALID_HANDLE;
VixHandle jobHandle = VIX_INVALID_HANDLE;

// Connect to the local host:
jobHandle = VixHost_Connect(VIX_API_VERSION,
                            VIX_SERVICEPROVIDER_VMWARE_SERVER,
                            NULL, // hostName
                            0, // hostPort
                            NULL, // userName
                            NULL, // password
                            0, // options
                            VIX_INVALID_HANDLE, // propertyListHandle
                            NULL, // callbackProc
                            NULL); // clientData

err = VixJob_Wait(jobHandle,
                  VIX_PROPERTY_JOB_RESULT_HANDLE,
                  &hostHandle,
                  VIX_PROPERTY_NONE);
if (VIX_OK != err) {
   // Handle the error...
   goto abort;
}
// Release handle when done:
Vix_ReleaseHandle(jobHandle);

// Register the virtual machine:
jobHandle = VixHost_RegisterVM(hostHandle,
                               "c:\\Virtual Machines\\vm1\\win2000.vmx",
                               NULL, // callbackProc
                               NULL); // clientData
err = VixJob_Wait(jobHandle,
                  VIX_PROPERTY_NONE);
if (VIX_OK != err) {
   // Handle the error...
   goto abort;
}
// Release handle when done:
Vix_ReleaseHandle(jobHandle);