WdfWmiInstanceRegister function (wdfwmi.h)
[Applies to KMDF only]
The WdfWmiInstanceRegister method registers a specified instance of a WMI data provider with the system's WMI service.
Syntax
NTSTATUS WdfWmiInstanceRegister(
[in] WDFWMIINSTANCE WmiInstance
);
Parameters
[in] WmiInstance
A handle to a WMI instance object that the driver obtained from a previous call to WdfWmiInstanceCreate.
Return value
WdfWmiInstanceRegister returns STATUS_SUCCESS if the operation succeeds. Otherwise, this method might return one of the following values:
| Return code | Description |
|---|---|
|
The specified WMI instance has already been registered. |
This method also might return other NTSTATUS values.
A bug check occurs if the driver supplies an invalid object handle.
Remarks
Provider instances are not available to WMI clients until they have been registered. Your driver must either call WdfWmiInstanceRegister or set the Register member of the instance's WDF_WMI_INSTANCE_CONFIG structure to TRUE.
For more information about the WdfWmiInstanceRegister method, see Registering Provider Instances. For more information about WMI, see Supporting WMI in Framework-Based Drivers.
WdfWmiInstanceRegister registers the provider instance synchronously (that is, before returning) if it is called at IRQL = PASSIVE_LEVEL and asynchronously if it is called at IRQL > PASSIVE_LEVEL.
Examples
The following code example registers a specified instance of a WMI data provider with the system's WMI service.
NTSTATUS status;
status = WdfWmiInstanceRegister(wmiInstance);
Requirements
| Requirement | Value |
|---|---|
| Target Platform | Universal |
| Minimum KMDF version | 1.0 |
| Header | wdfwmi.h (include Wdf.h) |
| Library | Wdf01000.sys (see Framework Library Versioning.) |
| IRQL | <=DISPATCH_LEVEL |
| DDI compliance rules | DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf) |