CM_Add_IDA function (cfgmgr32.h)

Article
02/22/2024

The CM_Add_ID function appends a specified device ID (if not already present) to a device instance's hardware ID list or compatible ID list.

Syntax

CMAPI CONFIGRET CM_Add_IDA(
  DEVINST dnDevInst,
  PSTR    pszID,
  ULONG   ulFlags
);

Parameters

dnDevInst

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

pszID

Caller-supplied pointer to a NULL-terminated device ID string.

ulFlags

Caller-supplied flag constant that specifies the list onto which the supplied device ID should be appended. The following flag constants are valid.

Flag Constant	Definition
CM_ADD_ID_COMPATIBLE	The specified device ID should be appended to the specific device instance's compatible ID list.
CM_ADD_ID_HARDWARE	The specified device ID should be appended to the specific device instance's hardware ID list.

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

The CM_Add_ID function can only be used when dnDevInst represents a root-enumerated device. For other devices, the bus driver reports hardware and compatible IDs when enumerating a child device after receiving IRP_MN_QUERY_ID.

Each appended device ID is considered less compatible than IDs already existing in the specified list. For information about device IDs, hardware IDs, and compatible IDs, see Device Identification Strings.

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

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