NdisMInitializeWrapper macro (ndis.h)

Note   NDIS 5. x has been deprecated and is superseded by NDIS 6. x. For new NDIS driver development, see Network Drivers Starting with Windows Vista. For information about porting NDIS 5. x drivers to NDIS 6. x, see Porting NDIS 5.x Drivers to NDIS 6.0.

NdisMInitializeWrapper notifies NDIS that a new miniport driver is initializing.

Syntax

VOID NdisInitializeWrapper(
  _Out_ PNDIS_HANDLE  NdisWrapperHandle,
  _In_ PVOID SystemSpecific1,
  _In_ PVOID SystemSpecific2,
  _In_ PVOID SystemSpecific3
);

Parameters

[out] _a

Pointer to a caller-supplied variable in which NDIS returns a handle that represents itself. If the call to NdisMInitializeWrapper fails, NDIS sets the variable at NdisWrapperHandle to NULL.

[in] _b

Specifies a pointer of a system-specific type.

For Windows 2000 and later drivers, this is a pointer to an opaque driver object input to the miniport driver's DriverEntry function.

[in] _c

Specifies a pointer of a system-specific type.

For Windows 2000 and later drivers, this is a pointer to an opaque registry path input to the miniport driver's DriverEntry function.

[in] _d

Specifies a pointer of a system-specific type.

For Windows 2000 and later drivers, this pointer should be set to NULL when the miniport driver calls NdisMInitializeWrapper.

Return value

None

Remarks

A NIC driver or intermediate driver must call NdisMInitializeWrapper before it calls any other NdisXxx function. Usually, this call is the initial action of any NIC driver's DriverEntry function, which calls NdisMRegisterMiniport or NdisIMRegisterLayeredMiniport with the returned NdisWrapperHandle next. NDIS intermediate drivers also must call NdisMInitializeWrapper from the DriverEntry function and, then, call NdisMRegisterMiniport or NdisIMRegisterLayeredMiniport with the returned NdisWrapperHandle.

Such a driver's subsequent calls to NdisXxx initialization and configuration functions must pass the NdisWrapperHandle as a parameter. Consequently, it is an input parameter to the MiniportInitialize function.

If the call to NdisMInitializeWrapper fails, NDIS sets the variable at NdisWrapperHandle to NULL. The driver should always check the value of this variable after NdisMInitializeWrapper returns. If the value is NULL, the driver should fail the call to the DriverEntry function.

Requirements

See also

Initializing a Miniport Driver

NdisMRegisterMiniport

MiniportInitialize

NdisIMRegisterLayeredMiniport

NdisTerminateWrapper