NdisRegisterPoll function (poll.h)

Article
02/22/2024

A miniport driver calls the NdisRegisterPoll function to register a Poll object with NDIS.

Syntax

NDIS_EXPORTED_ROUTINE NDIS_STATUS NdisRegisterPoll(
  [_In_]     NDIS_HANDLE                     NdisHandle,
  [_In_opt_] void                            *Context,
  [_In_]     NDIS_POLL_CHARACTERISTICS const *Characteristics,
  [_Out_]    NDIS_POLL_HANDLE                *PollHandle
);

Parameters

[_In_] NdisHandle

An NDIS-supplied miniport handle given to the driver in their MiniportInitialize callback.

[_In_opt_] Context

A pointer to a block of driver-allocated context that stores information about the Poll object. NDIS passes this context information in calls to NdisPoll and NdisSetPollNotification.

[_In_] Characteristics

A pointer to a driver-initialized NDIS_POLL_CHARACTERISTICS structure.

[_Out_] PollHandle

On a successful return this location contains a handle for the new Poll object.

Return value

Returns STATUS_SUCCESS if the operation succeeds. Otherwise, returns an NTSTATUS error code.

Remarks

Drivers typically register one Poll object for each RSS processor in their MiniportInitialize callback.

Drivers should call the NdisDeregisterPoll to deregister the Poll object.

Requirements

Requirement	Value
Minimum supported client	Windows 11
Minimum supported server	Windows Server 2022
Header	poll.h (include ndis.h)
IRQL	PASSIVE_LEVEL