RtndShutdownInterface

RtndShutdownInterface shuts down an interface. After the function returns, the NIC will no longer generate a hardware interrupt.

Syntax

Copy
BOOL RtndShutdownInterface(
  [in]            ULONG_PTR RtndInterfaceId,
  [in, ignored]   ULONG Flags
);

Parameters

[in] RtndInterfaceId

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

[in, ignored] Flags

Reserved for future use. The value is set to zero by the NL2. Drivers must ignore this parameter.

Return Value

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

Remarks

RtndShutdownInterface differs from RtndStopInterface in that RtndShutdownInterface is shutdown-safe. It will perform the minimum to disable interrupts, and then return. It will not free memory or close handles like RtndStopInterface.

This function should be empty for virtual devices.

Characteristics

Real-time requirements

Deterministic behavior

Recommended

Local memory allocation/deallocation restrictions

Process

External MSpace

Internal MSpace

System

Not allowed

Not allowed

Process

Not allowed

Not allowed

Contiguous memory allocation/deallocation restrictions

Contiguous memory

Not allowed

Requirements

Minimum supported version Header

eRTOS 1.0 SDK

Rtnd.h

See Also: