RtndSetInterruptModeration

RtndSetInterruptModeration requests the interface to change the value of the interval, in nanoseconds, for interrupt moderation. If the interrupt type is MSI-X, the NL2 will supply the message ID of the MSI-X message to throttle. Otherwise, the NL2 will set the MessageId parameter to zero (0).

Syntax

BOOL RtndSetInterruptModeration(
  [in]    ULONG_PTR RtndInterfaceId,
  [in]    ULONG MessageId,
  [in]    ULONG IntervalNs
);

Parameters

[in] RtndInterfaceId

The number or pointer used to identify the interface. This value is returned by RtndManageInterface.

[in] MessageId

The message ID of the MSI-X message to throttle if the interrupt type is MSI-X. If the interrupt type is not MSI-X, the value is set to zero (0) by the NL2.

[in] IntervalNs

The new value of the interval, in nanoseconds.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. To get extended error information, call GetLastError.

Common error codes:

Note: Custom drivers may return other error codes not listed above.

Remarks

The NL2 always calls this function from the main thread of the NL2 process.

Note: The NL2 will never provide a value of IntervalNs which exceeds the limit reported by the driver in the RTND_FEATURE_INTERRUPT structure.

Characteristics

Requirements

See Also:

• RTND_FEATURE_INTERRUPT
• RtndManageInterface