CM_Request_Eject_PC_Ex function (cfgmgr32.h)

Article
10/13/2021

[Beginning with Windows 8 and Windows Server 2012, this function has been deprecated. Please use CM_Request_Eject_PC instead.]

The CM_Request_Eject_PC_Ex function requests that a portable PC, which is inserted in a local or a remote docking station, be ejected.

Syntax

CMAPI CONFIGRET CM_Request_Eject_PC_Ex(
  [in, optional] HMACHINE hMachine
);

Parameters

[in, optional] hMachine

Supplies a machine handle that is returned by CM_Connect_Machine.

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, the function returns one of the CR_-prefixed error codes that are defined in Cfgmgr32.h.

Remarks

Use this function to request that a portable PC, which is inserted in a local or a remote docking station, be ejected. You can also use the following related functions with docking stations:

CM_Is_Dock_Station_Present identifies whether a docking station is present in a local machine.
CM_Is_Dock_Station_Present_Ex identifies whether a docking station is present in a local or a remote machine.
CM_Request_Eject_PC requests that a portable PC, which is inserted in a local docking station, be ejected.

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
DLL	Cfgmgr32.dll