Name

VixDiskLib_Connect

Description

VixError
VixDiskLib_Connect(const VixDiskLibConnectParams *connectParams,
                   VixDiskLibConnection *connection);

This function opens a connection to VixDiskLib. You can use this connection to later on request various services from VixDiskLib.

See also VixDiskLib_ConnectEx(), which has additional parameters and can open more efficient connections to managed disk.

Parameters

connectParams
A struct containing the parameters to establish a connection.
connection
A handle for the connection. This is an output parameter.

Return Value

VIX_OK if the function succeeded, otherwise an appropriate VIX error code.

Remarks

Example

   VixDiskLibConnectParams cnxParams = {0};
   if (appGlobals.isRemote) {
      cnxParams.vmName = NULL;
      cnxParams.serverName = hostName;
      cnxParams.credType = VIXDISKLIB_CRED_UID;
      cnxParams.creds.uid.userName = userName;
      cnxParams.creds.uid.password = password;
      cnxParams.port = port;
   }
   VixError vixError = VixDiskLib_Connect(&cnxParams,
                                          &connection);

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