Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
CM_Request_Device_Eject
Collapse the table of content
Expand the table of content

CM_Request_Device_Eject function

The CM_Request_Device_Eject function prepares a local device instance for safe removal, if the device is removable. If the device can be physically ejected, it will be.

Syntax


CMAPI
CONFIGRET
WINAPI CM_Request_Device_Eject(
  _In_      DEVINST        dnDevInst,
  _Out_opt_ PPNP_VETO_TYPE pVetoType,
  _Out_opt_ LPTSTR         pszVetoName,
  _In_      ULONG          ulNameLength,
  _In_      ULONG          ulFlags
);

Parameters

dnDevInst [in]

Caller-supplied device instance handle that is bound to the local machine.

pVetoType [out, optional]

(Optional.) If not NULL, this points to a location that, if the removal request fails, receives a PNP_VETO_TYPE-typed value indicating the reason for the failure.

pszVetoName [out, optional]

(Optional.) If not NULL, this is a caller-supplied pointer to a string buffer that receives a text string. The type of information this string provides is dependent on the value received by pVetoType. For information about these strings, see PNP_VETO_TYPE.

ulNameLength [in]

(Optional.) Caller-supplied value representing the length of the string buffer supplied by pszVetoName. This should be set to MAX_PATH.

ulFlags [in]

Not used.

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

If pszVetoName is NULL, the PnP manager displays a message to the user indicating the device was removed or, if the request failed, identifying the reason for the failure. If pszVetoName is not NULL, the PnP manager does not display a message. (Note, however, that for Microsoft Windows 2000 only, the PnP manager displays a message even if pszVetoName is not NULL, if the device's CM_DEVCAP_DOCKDEVICE capability is set.)

Callers of CM_Request_Device_Eject sometimes require SeUndockPrivilege or SeLoadDriverPrivilege, as follows:

  • If the device's CM_DEVCAP_DOCKDEVICE capability is set (the device is a "dock" device), callers must have SeUndockPrivilege. (SeLoadDriverPrivilege is not required.)

  • If the device's CM_DEVCAP_DOCKDEVICE capability is not set (the device is not a "dock" device), and if the calling process is either not interactive or is running in a multi-user environment in a session not attached to the physical console (such as a remote Terminal Services session), callers of this function must have SeLoadDriverPrivilege.

Privileges are described in the Microsoft Windows SDK documentation.

For information about using device instance handles that are bound to the local machine, see CM_Get_Child.

Requirements

Target platform

Desktop

Version

Available in Microsoft Windows 2000 and later versions of Windows.

Header

Cfgmgr32.h (include Cfgmgr32.h)

Library

Cfgmgr32.lib

Unicode and ANSI names

CM_Request_Device_EjectW (Unicode)

See also

CM_Get_Child
CM_Request_Device_Eject_Ex
CM_Query_And_Remove_SubTree
CM_Query_And_Remove_SubTree_Ex

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft