RtlUTF8ToUnicodeN 函数 (wdm.h)
RtlUTF8ToUnicodeN 例程将 UTF-8 字符串转换为 Unicode 字符串。
语法
NTSYSAPI NTSTATUS RtlUTF8ToUnicodeN(
[out, optional] PWSTR UnicodeStringDestination,
[in] ULONG UnicodeStringMaxByteCount,
[out] PULONG UnicodeStringActualByteCount,
[in] PCCH UTF8StringSource,
[in] ULONG UTF8StringByteCount
);
参数
[out, optional] UnicodeStringDestination
指向调用方分配的目标缓冲区的指针,例程在其中写入 Unicode 输出字符串。 如果此参数为 NULL,则例程会将输出缓冲区的所需大小写入 *UnicodeStringActualByteCount。
[in] UnicodeStringMaxByteCount
指定例程可以写入 UnicodeStringDestination 指向的缓冲区的最大字节数。 如果 UnicodeStringDestination = NULL,则设置 UnicodeStringMaxByteCount = 0。
[out] UnicodeStringActualByteCount
指向例程写入到 UnicodeStringDestination 指向的缓冲区的实际字节数的位置的指针。 如果 UnicodeStringDestination 为非 NULL,则此计数永远不会超过 UnicodeStringMaxByteCount 的值。 如果 UnicodeStringDestination 为 NULL,则此计数是包含整个输出字符串所需的字节数。
[in] UTF8StringSource
指向 UTF-8 源字符串的指针。
[in] UTF8StringByteCount
指定 UTF8StringSource 参数指向的 UTF-8 源字符串中的字节数。
返回值
如果调用成功,并且输入字符串中的所有 UTF-8 字符代码都转换为输出字符串中相应的 Unicode 字符代码,则 RtlUTF8ToUnicodeN 将返回STATUS_SUCCESS。 如果调用成功,但一个或多个输入字符无效并已转换为 Unicode 替换字符 U+FFFD,则返回STATUS_SOME_NOT_MAPPED。 可能的错误返回值包括以下错误代码:
返回代码 | 说明 |
---|---|
|
UnicodeStringMaxByteCount 参数指定缓冲区大小太小,无法包含整个输出字符串。 |
|
UnicodeStringDestination 和 UnicodeStringActualByteCount 参数均为 NULL。 |
|
UTF8StringSource 参数为 NULL。 |
注解
仅当 UTF-8 输入字符串以 null 结尾时,Unicode 输出字符串才以 null 结尾。
如果 UnicodeStringMaxByteCount 参数指定的缓冲区大小太小,无法包含整个输出字符串,则例程将返回STATUS_BUFFER_TOO_SMALL。 在这种情况下,例程将写入缓冲区中容纳的 Unicode 字符数,并且 *UnicodeStringActualByteCount 值指定例程已写入缓冲区的有效字节数。 输出缓冲区中包含的分部字符串可能不包含终止 null 字符。
可以对 RtlUTF8ToUnicodeN 进行初始调用以获取所需的输出缓冲区大小,然后再次调用 RtlUTF8ToUnicodeN 以获取 Unicode 输出字符串。 在初始调用中,设置 UnicodeStringDestination = NULL 和 UnicodeStringMaxByteCount = 0,例程会将所需的缓冲区大小写入 *UnicodeStringActualByteCount。 接下来,分配所需大小的缓冲区,并再次调用 RtlUTF8ToUnicodeN 以获取 Unicode 输出字符串。
RtlUTF8ToUnicodeN 支持 Unicode 代理项对。 但是,不后跟尾随字值的代理前导词值或前面没有前导字值的尾随字值,不会被识别为有效字符,并由 Unicode 替换字符 U+FFFD 替换。
RtlUTF8ToUnicodeN 继续将输入字符串转换为输出字符串,直到到达源缓冲区的末尾或目标缓冲区的末尾(以先出现者为准)。 例程将输入字符串中的任何 null 字符转换为输出字符串中的 null 字符。 如果输入字符串包含终止 null 字符,但 null 字符不位于源缓冲区的末尾,则例程将继续超过终止 null 字符,直到到达可用缓冲区空间的末尾。
RtlUnicodeToUTF8N 例程将 Unicode 字符串转换为 UTF-8 字符串。
可以使用 RtlUTF8ToUnicode 和 RtlUnicodeToUTF8N 例程在 UTF-8 和 Unicode 格式之间执行有效文本字符串的无损转换。 但是,具有任意数据值的字符串可能会违反编码代理项对的 Unicode 规则,并且输入字符串中无效值中包含的任何信息都将丢失,并且无法从生成的输出字符串中恢复。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | 在 Windows 7 和更高版本的 Windows 中可用。 |
目标平台 | 通用 |
标头 | wdm.h (包括 Ntifs.h、Wdm.h、Ntifs.h) |
Library | NtosKrnl.lib |
DLL | NtosKrnl.exe |
IRQL | PASSIVE_LEVEL |