NdisMRegisterMiniport

This function registers an NIC or intermediate driver’s Miniport_* entry points and name with the NDIS library when the driver initializes.

At a Glance

Header file:	Ndis.h
Windows CE versions:	2.0 and later

Syntax

NDIS_STATUS NdisMRegisterMiniport(
IN NDIS_HANDLE NdisWrapperHandle,
IN PNDIS_MINIPORT_CHARACTERISTICS MiniportCharacteristics,
IN UINT CharacteristicsLength );

Parameters

NdisWrapperHandle: Handle returned by the NdisMInitializeWrapper function.
MiniportCharacteristics: Pointer to an NDIS_MINIPORT_CHARACTERISTICS structure set up by the caller.
The driver should initialize this structure with 0s before setting up any its members.
CharacteristicsLength: Specifies the length, in bytes, of the caller-supplied characteristics buffer. Depending on the value of the MajorNdisVersion member of NDIS_MINIPORT_CHARACTERISTICS, this parameter must be either sizeof( NDIS40_MINIPORT_CHARACTERISTICS ) or sizeof( NDIS30_MINIPORT_CHARACTERISTICS ).
If the driver includes the build instruction NDIS40_MINIPORT or NDIS30_MINIPORT, as appropriate, in its sources; if the driver writer uses the -DNDIS40_MINIPORT or ..30.. compiler switch, this parameter is set when the driver is built.

Return Values

NDIS_STATUS_SUCCESS indicates success. One of the following status values indicates failure:

NDIS_STATUS_BAD_CHARACTERISTICS: The CharacteristicsLength is too small for the MajorNdisVersion specified in the buffer at MiniportCharacteristics.
NDIS_STATUS_BAD_VERSION: The MajorNdisVersion or MinorNdisVersion specified in the characteristics structure is invalid.
NDIS_STATUS_RESOURCES: A shortage of resources, possibly memory, prevented the NDIS library from registering the caller.
NDIS_STATUS_FAILURE: This is a default error status, returned when none of the preceding errors caused the registration to fail. For example, if the NDIS library cannot load the driver’s image and lock it into system memory, it returns this error.

Remarks

An NIC driver calls this function from its DriverEntry function after DriverEntry calls the NdisMInitializeWrapper function.

Every NIC driver that exports only MiniportXXX functions must set up a characteristics structure and call this function. This structure is copied in the request to the NDIS library’s internal storage. Thus, once it has registered, a miniport driver cannot change its handler functions.

The NDIS library currently does not call MiniportReconfigure functions, so such a function in an existing miniport driver is dead code unless the miniport makes internal calls to its MiniportReconfigure function from MiniportInitialize.

After the driver has called this function, it should be prepared to be called back at the MiniportInitialize entry point specified in the characteristics structure.

NDIS intermediate drivers, which export both MiniportXXX and ProtocolXXX functions, usually call the NdisIMRegisterLayeredMiniport function, instead of this function. Intermediate drivers that export only a set of MiniportXXX functions usually call this funciton.

A driver that calls this function runs at IRQL PASSIVE_LEVEL.