NdisInitUnicodeString macro (ndis.h)

Article
02/22/2024

The NdisInitUnicodeString function initializes a counted Unicode string.

Syntax

void NdisInitUnicodeString(
   _us,
   s
);

Parameters

_us

A pointer to a caller-allocated NDIS_STRING type in which NdisInitUnicodeString should store the counted Unicode string. For Windows 2000 and later, NDIS defines the NDIS_STRING type as a UNICODE_STRING type.

s

A pointer to a null-terminated string with which to initialize the counted string.

Return value

None

Remarks

The DestinationString is initialized to point to the SourceString . The Length and MaximumLength members of NDIS_STRING for the DestinationString are initialized to the length of the string at SourceString. If SourceString is NULL, the length is zero.

Callers of NdisInitUnicodeString must be running at IRQL <= DISPATCH_LEVEL if the DestinationString buffer is allocated from nonpaged memory. Usually, callers are running at IRQL = PASSIVE_LEVEL during driver initialization.

Requirements

Requirement	Value
Minimum supported client	Supported for NDIS 6.0 and NDIS 5.1 drivers (see NdisInitUnicodeString (NDIS 5.1)) in Windows Vista. Supported for NDIS 5.1 drivers (see NdisInitUnicodeString (NDIS 5.1)) in Windows XP.
Target Platform	Universal
Header	ndis.h (include Ndis.h)
Library	Ndis.lib
IRQL	See Remarks section
DDI compliance rules	Irql_Miscellaneous_Function(ndis)