大网数据广告活动
Windows 系统接口

RtlUnicodeToUTF8N function (Wdm.h)

· 52CE 我爱测

Translates the specified Unicode string into a new character string, using the 8-bit Unicode Transformation Format (UTF-8) code page.

Translates the specified Unicode string into a new character string, using the 8-bit Unicode Transformation Format (UTF-8) code page.

Syntax

NTSTATUS WINAPI RtlUnicodeToUTF8N(
  _Out_     PCHAR  UTF8StringDestination,
  _In_      ULONG  UTF8StringMaxByteCount,
  _Out_opt_ PULONG UTF8StringActualByteCount,
  _In_      PCWSTR UnicodeStringSource,
  _In_      ULONG  UnicodeStringByteCount
);

Parameters

UTF8StringDestination [out]

A pointer to a caller-allocated buffer to receive the translated string.

UTF8StringMaxByteCount [in]

Maximum number of bytes to be written to UTF8StringDestination. If this value causes the translated string to be truncated, RtlUnicodeToUTF8N returns an error status.

UTF8StringActualByteCount [out, optional]

A pointer to a caller-allocated variable that receives the length, in bytes, of the translated string. This parameter is optional and can be NULL. If the string is truncated then the returned number counts the actual truncated string count.

UnicodeStringSource [in]

A pointer to the Unicode source string to be translated.

*UnicodeStringByteCount * [in]

Specifies the number of bytes in the Unicode source string that the UnicodeStringSource parameter points to.

Return value

RtlUnicodeToUTF8N returns one of the following NTSTATUS values:

Return code Description
STATUS_SUCCESS The Unicode string was converted to UTF-8.
STATUS_SOME_NOT_MAPPED An invalid input character was encountered and replaced. This status is considered a success status.
STATUS_INVALID_PARAMETER Both pointers to UTF8StringDestination and UTF8StringActualByteCount were NULL.
STATUS_INVALID_PARAMETER_4 The UnicodeStringSource was NULL.
STATUS_BUFFER_TOO_SMALL UTF8StringDestination was truncated.

Remarks

Although UTF8StringActualByteCount is optional and can be NULL, callers should provide storage for it, because the received length can be used to determine whether the conversion was successful. This routine does not modify the source string. It returns a null-terminated UTF-8 string if the given UnicodeStringSource included a NULL terminator and if the given UTF8StringMaxByteCount did not cause truncation.

If the output is truncated and an invalid input character is encountered then the function returns STATUS_BUFFER_TOO_SMALL error.

If the UTF8StringDestination is set to NULL the function will return the required number of bytes to host the translated string without any truncation in UTF8StringActualByteCount.

Callers of RtlUnicodeToUTF8N must be running at IRQL < DISPATCH_LEVEL.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Header Wdm.h
DLL Ntdll.dll

See also

RtlUTF8ToUnicodeN

Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.

资料来源与适用范围

资料来源
Microsoft Learn / Windows Win32 documentation
适用范围
Windows Win32 API · Source date 05/31/2018
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY 4.0 (documentation), MIT (code samples)

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。