Edit

NmrWaitForProviderDeregisterComplete function (netioddk.h)

  • Article

The NmrWaitForProviderDeregisterComplete function waits for the deregistration of a provider module to complete.

Syntax

NTSTATUS NmrWaitForProviderDeregisterComplete(
  [in] HANDLE NmrProviderHandle
);

Parameters

[in] NmrProviderHandle

A handle used by the NMR to represent the registration of the provider module. The NMR returns this handle to the provider module when the provider module calls the NmrRegisterProvider function.

Return value

The NmrWaitForProviderDeregisterComplete function returns one of the following NTSTATUS codes:

Return code Description
STATUS_SUCCESS
 The NMR completed deregistering the provider module.
STATUS_INVALID_PARAMETER
 The provider module called the NmrWaitForProviderDeregisterComplete function before calling the NmrDeregisterProvider function, or the handle specified in the NmrClientHandle parameter is not a valid provider handle.
Other status codes
 An error occurred.

Remarks

A provider module calls the NmrWaitForProviderDeregisterComplete function to wait for the deregistration of the provider module to complete. A provider module calls the NmrWaitForProviderDeregisterComplete function only after calling the NmrDeregisterProvider function.

A provider module typically calls the NmrWaitForProviderDeregisterComplete function from its Unload function to wait until it is completely deregistered from the NMR before the provider module is unloaded from the system. A provider module must not return from a call to its Unload function until after deregistration is complete.

Note  If a provider module uses the Windows Driver Framework, it will typically call the NmrWaitForProviderDeregisterComplete function from its EvtDriverUnload event callback function. In this situation, the provider module must not return from a call to its EvtDriverUnload function until after deregistration is complete.
 

Requirements

Requirement Value
Minimum supported client Available in Windows Vista and later versions of the Windows operating systems.
Target Platform Desktop
Header netioddk.h (include Wsk.h)
Library Netio.lib
IRQL < DISPATCH_LEVEL

See also

NmrDeregisterProvider