Edit

Share via

CM_Connect_MachineA function (cfgmgr32.h)

  • Article

[Beginning in Windows 8 and Windows Server 2012 functionality to access remote machines has been removed. You cannot access remote machines when running on these versions of Windows.]

The CM_Connect_Machine function creates a connection to a remote machine.

Syntax

CMAPI CONFIGRET CM_Connect_MachineA(
  [in, optional] PCSTR     UNCServerName,
  [out]          PHMACHINE phMachine
);

Parameters

[in, optional] UNCServerName

Caller-supplied pointer to a text string representing the UNC name, including the \ prefix, of the system for which a connection will be made. If the pointer is NULL, the local system is used.

[out] phMachine

Address of a location to receive a machine handle.

Note Using this function to access remote machines is not supported beginning with Windows 8 and Windows Server 2012, as this functionality has been removed.
 

Return value

If the operation succeeds, the function returns CR_SUCCESS. Otherwise, it returns one of the CR_-prefixed error codes defined in Cfgmgr32.h.

Remarks

Callers of CM_Connect_Machine must call CM_Disconnect_Machine to deallocate the machine handle, after it is no longer needed.

Use machine handles obtained with this function only with the PnP configuration manager functions.

Functionality to access remote machines has been removed in Windows 8 and Windows Server 2012 and later operating systems thus you cannot access remote machines when running on these versions of Windows.

Requirements

Requirement Value
Minimum supported client Available in Microsoft Windows 2000 and later versions of Windows.
Target Platform Desktop
Header cfgmgr32.h (include Cfgmgr32.h)
Library Cfgmgr32.lib

See also

CM_Disconnect_Machine