NdisFreeString macro (ndis.h)

Article
02/22/2024

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

Syntax

void NdisFreeString(
  [in]  String
);

Parameters

[in] String

An NDIS_STRING type value that describes the string to free. 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 the NdisInitializeString function during initialization--for example, to set up names passed to the NdisXxxConfiguration functions. For each call that the driver makes to NdisInitializeString, the driver must make a corresponding call to NdisFreeString. When releasing string buffers that were 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

Requirement	Value
Minimum supported client	Supported for existing drivers in NDIS 6.0 and later, but new drivers should use RtlFreeAnsiString or RtlFreeUnicodeString instead.
Target Platform	Desktop
Header	ndis.h (include Ndis.h)
IRQL	PASSIVE_LEVEL
DDI compliance rules	Irql_Miscellaneous_Function(ndis)