RtlUnicodeStringInit 函式 (ntstrsafe.h)

  • 發行項

RtlUnicodeStringInit 函式會初始化UNICODE_STRING結構。

語法

NTSTRSAFEDDI RtlUnicodeStringInit(
  [out]          PUNICODE_STRING  DestinationString,
  [in, optional] NTSTRSAFE_PCWSTR pszSrc
);

參數

[out] DestinationString

要初始化 之UNICODE_STRING 結構的指標。 pszSrc 指標會複製到 DestinationString 參數的 UNICODE_STRING 結構中。 pszSrc 指向的字串字元數上限為 NTSTRSAFE_UNICODE_STRING_MAX_CCH。

[in, optional] pszSrc

選擇性。 Null 終止字串常數的指標。 這個字串指標將會複製到 DestinationString 參數所指向之UNICODE_STRING結構的 Buffer 成員。 此字串指標可以是 NULL。

傳回值

RtlUnicodeStringInit 會傳回下列其中一個 NTSTATUS 值。

傳回碼 Description
STATUS_SUCCESS
 此 成功 狀態表示源數據存在、字串複製而未截斷，且結果目的地緩衝區為 Null 終止。
STATUS_INVALID_PARAMETER
 這個 錯誤 狀態表示函式收到無效的輸入參數。 如需詳細資訊，請參閱下列清單。
 

當發生下列其中一項時，RtlUnicodeStringInit 會傳回STATUS_INVALID_PARAMETER值：

  • pszSrc 參數指向的字串長度大於NTSTRSAFE_UNICODE_STRING_MAX_CCH個字元。
  • DestinationString 指標為 NULL，但 pszSrc 指標不是 NULL。
如需如何測試 NTSTATUS 值的詳細資訊，請參閱 使用NTSTATUS值。

備註

RtlUnicodeStringInit 函式會執行下列動作：

  • 將 pszSrc 參數指向之UNICODE_STRING結構的 Length 成員設定為 pszSrc 參數指向的字串長度，以位元組為單位。
  • 將UNICODE_STRING結構的 MaximumLength 成員設定為 pszSrc 參數指向的字串長度，以位元組為單位加上 2 個字節。
  • 將 UNICODE_STRING 結構的 Buffer 成員設定為 pszSrc 參數所指定的位址。
DestinationString 指標不應為 NULL。 如果您需要指定 NULLDestinationString 指標值，請使用 RtlUnicodeStringInitEx 函式。

如需安全字串函式的詳細資訊，請參閱 使用安全字串函式。

規格需求

需求 值
最低支援的用戶端 從 Windows XP 搭配 Service Pack 1 (SP1) 開始提供。
目標平台 桌面
標頭 ntstrsafe.h (包含 Ntstrsafe.h)
程式庫 Ntstrsafe.lib
IRQL 如果正在操作的字串一律位於記憶體中，則為任何 ，否則PASSIVE_LEVEL

另請參閱

RtlUnicodeStringInitEx

UNICODE_STRING