UcmInitializeDevice function (ucmmanager.h)

Article
02/22/2024

Initializes the USB connector manager framework extension (UcmCx).

Syntax

NTSTATUS UcmInitializeDevice(
  [in] WDFDEVICE           WdfDevice,
  [in] PUCM_MANAGER_CONFIG Config
);

Parameters

[in] WdfDevice

A handle to a framework device object that the client driver received in the previous call to WdfDeviceCreate.

[in] Config

A pointer to a caller-supplied UCM_MANAGER_CONFIG structure that is initialized by calling UCM_MANAGER_CONFIG_INIT.

Return value

UcmInitializeDevice returns STATUS_SUCCESS if the operation succeeds. Otherwise, this method can return an appropriate NTSTATUS value.

Remarks

This method initializes UcmCx and allocates resources required, registers for PnP events, and sets up I/O targets. The client driver must call this method in the driver's EVT_WDF_DRIVER_DEVICE_ADD implementation.

Requirements

Requirement	Value
Minimum supported client	Windows 10
Minimum supported server	Windows Server 2016
Target Platform	Windows
Minimum KMDF version	1.15
Minimum UMDF version	2.15
Header	ucmmanager.h (include Ucmcx.h)
Library	UcmCxstub.lib
IRQL	PASSIVE_LEVEL