Skip to content

Latest commit

 

History

History
103 lines (77 loc) · 3.49 KB

ns-ntdef-_unicode_string.md

File metadata and controls

103 lines (77 loc) · 3.49 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords dev_langs topic_type api_type api_location api_name
NS:ntdef._UNICODE_STRING
_UNICODE_STRING (ntdef.h)
The UNICODE_STRING structure is used to define Unicode strings.
*PUNICODE_STRING
PUNICODE_STRING
PUNICODE_STRING structure pointer [Kernel-Mode Driver Architecture]
UNICODE_STRING
UNICODE_STRING structure [Kernel-Mode Driver Architecture]
_UNICODE_STRING
kernel.unicode_string
kstruct_d_9f862aaa-4cd6-4420-8255-ad577d8a8c59.xml
ntdef/PUNICODE_STRING
ntdef/UNICODE_STRING
kernel\unicode_string.htm
kernel
b02f29a9-1049-4e29-aac3-72bf0c70a21e
04/30/2018
*PUNICODE_STRING, PUNICODE_STRING, PUNICODE_STRING structure pointer [Kernel-Mode Driver Architecture], UNICODE_STRING, UNICODE_STRING structure [Kernel-Mode Driver Architecture], _UNICODE_STRING, kernel.unicode_string, kstruct_d_9f862aaa-4cd6-4420-8255-ad577d8a8c59.xml, ntdef/PUNICODE_STRING, ntdef/UNICODE_STRING
ntdef.h
Wdm.h, Ntddk.h, Ntdef.h
Windows
Windows
UNICODE_STRING
_UNICODE_STRING
ntdef/_UNICODE_STRING
UNICODE_STRING
ntdef/UNICODE_STRING
c++
APIRef
kbSyntax
HeaderDef
ntdef.h
UNICODE_STRING

_UNICODE_STRING structure

-description

The UNICODE_STRING structure is used to define Unicode strings.

-struct-fields

-field Length

The length, in bytes, of the string stored in Buffer.

-field MaximumLength

The length, in bytes, of Buffer.

-field Buffer

Pointer to a buffer used to contain a string of wide characters.

-syntax

typedef struct _UNICODE_STRING {
  USHORT Length;
  USHORT MaximumLength;
  PWSTR  Buffer;
} UNICODE_STRING, *PUNICODE_STRING;

-remarks

The UNICODE_STRING structure is used to pass Unicode strings. Use RtlUnicodeStringInit or RtlUnicodeStringInitEx to initialize a UNICODE_STRING structure.

If the string is null-terminated, Length does not include the trailing null character.

The MaximumLength is used to indicate the length of Buffer so that if the string is passed to a conversion routine such as RtlAnsiStringToUnicodeString the returned string does not exceed the buffer size.

-see-also

ANSI_STRING

OEM_STRING

RtlAnsiStringToUnicodeSize

RtlAnsiStringToUnicodeString

RtlFreeUnicodeString

RtlInitUnicodeString

RtlUnicodeStringToAnsiSize

RtlUnicodeStringToAnsiString