RtlUnicodeStringToUTF8String 函式 (ntifs.h)
RtlUnicodeStringToUTF8String 會將指定的 Unicode 字串轉換成 UTF-8 字串。
語法
NTSYSAPI NTSTATUS RtlUnicodeStringToUTF8String(
PUTF8_STRING DestinationString,
PCUNICODE_STRING SourceString,
BOOLEAN AllocateDestinationString
);
參數
DestinationString
放置轉換輸出 UTF-8 字串之緩衝區的指標。 只有當 AllocateDestinationString 為 TRUE 時,才會設定 DestinationString->MaximumLength 字段。
SourceString
要轉換成 UTF-8 之 Unicode 字串的指標。
AllocateDestinationString
布爾值。 設定 TRUE 時,RtlUnicodeStringToUTF8String 配置目的地字串的緩衝區空間。 只有此 API 會配置 DestinationString->Buffer 的記憶體。 如果 RtlUnicodeStringToUTF8String 執行緩衝區配置,則呼叫者必須使用 RtlFreeUTF8String來解除分配緩衝區。
傳回值
當轉換成功時,此函式會傳回STATUS_SUCCESS。 可能的錯誤或警告碼包括:
法典 | 描述 |
---|---|
STATUS_INVALID_PARAMETERX | 錯誤:其中一個參數值無效。 |
STATUS_NO_MEMORY | 錯誤:RtlUnicodeStringToUTF8String 無法配置緩衝區空間。 |
STATUS_BUFFER_OVERFLOW | 警告:DestinationString->Buffer 中轉換的字串會因為目的地緩衝區中的空間不足而遭到截斷。 |
STATUS_SOME_NOT_MAPPED | 警告:呼叫成功,但一或多個輸入字元無效,且已由 Unicode 取代字元 U+FFFD 取代,然後再轉換成 UTF-8。 |
言論
只有在 Unicode 輸入字串以 Null 終止時,UTF-8 輸出字串才會以 Null 結束。
RtlUnicodeStringToUTF8String 支援 Unicode 代理字組。 不過,不後面接著尾端字值的 Surrogate 前置字值,或前面未加上前置字值的尾端字值,無法辨識為有效的字元碼,而且會由 Unicode 取代字元 U+FFFD 取代。
RtlUnicodeStringToUTF8String 會繼續將輸入字串轉換成輸出字串,直到它到達來源緩衝區的結尾或目的地緩衝區的結尾為止,無論第一次發生。 例程會將輸入字串中的任何 Null 字元轉換成輸出字串中的 Null 字元。 如果輸入字串包含終止的 Null 字元,但 null 字元不在來源緩衝區的結尾,則例程會繼續超過終止的 Null 字元,直到到達可用緩衝區空間的結尾為止。
RtlUTF8StringToUnicodeString 例程會將 UTF-8 字串轉換成 Unicode 字串。
您可以使用 RtlUnicodeStringToUTF8String 和 RtlUTF8StringToUnicodeString 例程來執行 Unicode 與 UTF-8 格式之間有效文字字串串的不遺失轉換。 不過,具有任意數據值的字串可能會違反編碼代理字組的 Unicode 規則,而且輸入字串中無效值中包含的任何資訊都會遺失,而且無法從產生的輸出字元串復原。
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Windows 10 版本 2004 |
標頭 | ntifs.h |