Name

Connect

Description

HRESULT
Connect([in] LONG apiVersion,
        [in] LONG hostType,
        [in] BSTR hostName,
        [in] LONG hostPort,
        [in] BSTR userName,
        [in] BSTR password,
        [in] LONG options,
        [in] IVixHandle* propertyList,
        [in] ICallback* jobDoneCallback,
        [out,retval] IJob** connectJob);

Creates a host handle.

Parameters

apiVersion: Must be VixCOM.Constants.VIX_API_VERSION.
hostType: VixCOM.Constants.VIX_SERVICEPROVIDER_VMWARE_SERVER or VixCOM.Constants.VIX_SERVICEPROVIDER_VMWARE_WORKSTATION.
hostName: DNS name or IP address of remote host. Use NULL (C++), null (C#), or empty (VB) to connect to local host.
hostPort: TCP/IP port of remote host, typically 902. Use zero for local host.
userName: Username to authenticate with on remote machine. Use NULL (C++), null (C#), or empty (VB) to authenticate as current user on local host.
password: Password to authenticate with on remote machine. Use NULL (C++), null (C#), or Empty (VB) to authenticate as current user on local host.
options: Optionally VixCOM.Constants.VIX_HOSTOPTION_USE_EVENT_PUMP (See Remarks section), otherwise zero.
propertyList: Must be NULL (C++), null (C#), or Nothing (VB).
jobDoneCallback: An ICallback instance that will be called when the operation is complete.
connectJob: Returns an IJob object that describes the state of this asynchronous operation.

Return Value

HRESULT

Remarks

To specify the local host (where the API client runs), pass null values for the hostName, hostPort, userName, and password parameters. This is shown in the example below.
If you are already connected to the host, a subsequent call to Connect() succeeds if you connect as the same user and use the same host name. Subsequent calls return the same handle value.

Side Effects

None.

Requirements

VixCOM.h, since VMware Workstation 6.0.

Example

VBScript:

Dim lib
Dim job
Dim err
Dim host
Dim results

Set lib = CreateObject("VixCOM.VixLib")

Set results = Nothing

Set job = lib.Connect(VixCOM.Constants.VIX_API_VERSION, VixCOM.Constants.VIX_SERVICEPROVIDER_VMWARE_SERVER, Empty, 0, Empty, Empty, 0, Nothing, Nothing)
err = job.Wait(Array(VixCOM.Constants.VIX_PROPERTY_JOB_RESULT_HANDLE), results)
If lib.ErrorIndicatesFailure(err) Then
   ' Handle the error...
End If

Set host = results(0)

' ...Do everything in your program...

host.Disconnect()