CM_Is_Dock_Station_Present function (cfgmgr32.h)

Article
10/13/2021

The CM_Is_Dock_Station_Present function identifies whether a docking station is present in a local machine.

Syntax

CMAPI CONFIGRET CM_Is_Dock_Station_Present(
  [out] PBOOL pbPresent
);

Parameters

[out] pbPresent

Pointer to a Boolean value that indicates whether a docking station is present in a local machine. The function sets *pbPresent to TRUE if a docking station is present. Otherwise, the function sets *pbPresent to FALSE.

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 determine whether a docking station is present in a local machine. You can also use the following related functions with docking stations:

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.
CM_Request_Eject_PC_Ex requests that a portable PC, which is inserted in a local or a remote docking station, be ejected.

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