NdisFreeString (NDIS 5.1) function

Article
06/19/2017

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.

NdisFreeString releases storage that was allocated by NdisInitializeString for a buffered string.

Syntax

VOID NdisFreeString(
  _In_ NDIS_STRING String
);

Parameters

String [in]
NDIS_STRING type that describes the string to release. For Windows 2000 and later, NDIS defines the NDIS_STRING type as a UNICODE_STRING type.

Return value

None

Remarks

An NDIS driver typically calls NdisInitializeString during initialization--for example, to set up names passed to the NdisXxxConfiguration functions. For each call that it makes to NdisInitializeString, a driver must make a corresponding call to NdisFreeString. When releasing buffers allocated during initialization, a driver must call NdisFreeString before the driver's initialization function returns control.

NdisFreeString must be used only for freeing buffers that were allocated with NdisInitializeString.

Requirements

Target platform	Desktop
Version	See NdisFreeString.
Header	Ndis.h (include Ndis.h)
IRQL	PASSIVE_LEVEL