NdisInitializeString function (ndis.h)

Article
02/22/2024

The NdisInitializeString function allocates storage for and initializes a counted string in the system-default character set.

Syntax

void NdisInitializeString(
  PNDIS_STRING Destination,
  PUCHAR       Source
);

Parameters

Destination

A pointer to an NDIS_STRING with a NULL buffer. On return from this function, the NDIS_STRING contains an initialized, counted string. For Windows 2000 and later, NDIS defines the NDIS_STRING type as a UNICODE_STRING type.

Source

A pointer to a null-terminated string with which to initialize the counted string. SourceString must not be NULL.

Return value

None

Remarks

NdisInitializeString sets the Length and MaximumLength members of NDIS_STRING for the destination string and terminates the destination string with zero. For Windows 2000 and later drivers,NdisInitializeString converts the supplied source string to Unicode characters.

SourceString must not be NULL.

The buffer allocated by NdisInitializeString should be released with the NdisFreeString function.

Requirements

Requirement	Value
Minimum supported client	Supported for existing drivers in NDIS 6.0 and later, but new drivers should use RtlInitUnicodeString or RTL_CONSTANT_STRING or DECLARE_CONST_UNICODE_STRING (see ntdef.h) instead.
Target Platform	Universal
Header	ndis.h (include Ndis.h)
Library	Ndis.lib
IRQL	PASSIVE_LEVEL
DDI compliance rules	Irql_Miscellaneous_Function(ndis)