共用方式為


RtlStringCchCatNExW 函式 (ntstrsafe.h)

RtlStringCchCatNExWRtlStringCchCatNExA 函式串連兩個字元計數位符串,同時限制附加字元串的大小。

語法

NTSTRSAFEDDI RtlStringCchCatNExW(
  [in, out, optional] NTSTRSAFE_PWSTR pszDest,
  [in]                size_t          cchDest,
  [in, optional]      STRSAFE_PCNZWCH pszSrc,
                      size_t          cchToAppend,
  [out, optional]     NTSTRSAFE_PWSTR *ppszDestEnd,
  [out, optional]     size_t          *pcchRemaining,
  [in]                DWORD           dwFlags
);

參數

[in, out, optional] pszDest

緩衝區的指標,在輸入時會包含以 null 結尾的字串,pszSrc 將會串連。 在輸出中,這是包含整個結果字串的目的地緩衝區。 pszSrc的字串,最多 cchMaxAppend 字元,會新增至字元串結尾,pszDest 並以 null 字元結束。 pszDest 指標可以 NULL,但只有在 dwFlags中設定STRSAFE_IGNORE_NULLS時。

[in] cchDest

目的地緩衝區的大小,以字元為單位。 允許的字元數上限為 NTSTRSAFE_MAX_CCH。 如果 pszDest 為 NULLcchDest 必須是零。

[in, optional] pszSrc

Null 終止字串的指標。 此字串會串連至緩衝區中包含在 pszDest 之字串的結尾。 pszSrc 指標可以 NULL,但只有在 dwFlags中設定STRSAFE_IGNORE_NULLS時。

cchToAppend

要附加至緩衝區中 pszDest之字元串的最大字元數。

[out, optional] ppszDestEnd

如果呼叫端提供非NULL 位址指標,則在串連作業完成之後,函式會載入該位址,並具有目的地緩衝區所產生 Null 字串終止符的指標。

[out, optional] pcchRemaining

如果呼叫端提供非NULL 位址指標,則函式會載入位址,其中包含 pszDest所指向之緩衝區中未使用的字元數,包括終止的 null 字元。

[in] dwFlags

一或多個旗標,並選擇性地填滿位元組。 旗標的定義如下:

價值 意義
STRSAFE_FILL_BEHIND_NULL 如果設定此旗標且函式成功,則會使用 dwFlags 的低位元組來填滿結尾 Null 字元後面的目的地緩衝區部分。
STRSAFE_IGNORE_NULLS 如果設定此旗標,pszDestpszSrc或兩者都可以 NULLNULLpszSrc 指標會被視為可以複製的空字串(TEXT(“”)。 nullpszDest 指標無法接收空字串。
STRSAFE_FILL_ON_FAILURE 如果設定此旗標且函式失敗,則會使用 dwFlags 的低位元組來填滿整個目的地緩衝區,而緩衝區會以 null 結束。 此作業會覆寫任何預先存在的緩衝區內容。
STRSAFE_NULL_ON_FAILURE 如果設定此旗標且函式失敗,目的地緩衝區會設定為空字串 (TEXT(“”))。 此作業會覆寫任何預先存在的緩衝區內容。
STRSAFE_NO_TRUNCATION

如果已設定此旗標,且函式會傳回 STATUS_BUFFER_OVERFLOW

  • 如果同時指定 STRSAFE_FILL_ON_FAILURESTRSAFE_NO_TRUNCATION 會據以填滿目的地緩衝區。
  • 否則,目的地緩衝區將會未經修改。

傳回值

此函式會傳回下表所列的其中一個NTSTATUS值。 如需如何測試 NTSTATUS 值的資訊,請參閱使用 NTSTATUS 值

傳回碼 描述
STATUS_SUCCESS 成功 狀態表示源數據存在、輸出字串建立時未截斷,且結果目的地緩衝區會以 Null 結束。
STATUS_BUFFER_OVERFLOW 警告 狀態表示作業因目的地緩衝區空間不足而未完成。 如果已設定 STRSAFE_NO_TRUNCATION,請參閱 dwFlags 參數以取得詳細資訊。
STATUS_INVALID_PARAMETER

這個 錯誤 狀態表示函式收到無效的輸入參數。 如需詳細資訊,請參閱下列段落。

函式會在下列情況下傳回STATUS_INVALID_PARAMETER值:

  • 指定了無效的旗標。
  • cchDest 中的值大於緩衝區大小上限。
  • 目的地緩衝區已滿。
  • NULL 指標沒有 STRSAFE_IGNORE_NULLS 旗標。
  • 目的地緩衝區指標 NULL,但緩衝區大小不是零。
  • 目的地緩衝區指標 NULL,或其長度為零,但存在非零長度的來源字串。

言論

RtlStringCchCatNExWRtlStringCchCatNExA 應使用,而不是下列函式:

  • strncat
  • wcsncat

目的地緩衝區的大小,以字元為單位,會提供給 RtlStringCchCatNExWRtlStringCchCatNExA,以確保函式不會寫入緩衝區結尾。

RtlStringCchCatNExWRtlStringCchCatNExA 藉由傳回目的地字元串結尾的指標,以及該字元串中未使用的字元數,來新增至 RtlStringCchCatN 的功能。 旗標可以傳遞至 函式以取得其他控制件。

使用 RtlStringCchCatNExW 來處理 Unicode 字串,並 RtlStringCchCatNExA 來處理 ANSI 字符串。 您使用的表單取決於您的資料,如下表所示。

字串數據類型 字串常值 功能
WCHAR L“string” RtlStringCchCatNExW
char “string” RtlStringCchCatNExA

如果 pszSrcpszDest 指向重迭字串,則函式的行為是未定義的。

pszSrcpszDest 都不能 NULL,除非設定STRSAFE_IGNORE_NULLS旗標,在此情況下或兩者都可以 NULL。 如果 pszDestNULLpszSrc 必須 NULL 或指向空字串。

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

要求

要求 價值
最低支援的用戶端 Windows XP 中提供 Service Pack 1 (SP1) 和更新版本的 Windows。
目標平臺 桌面
標頭 ntstrsafe.h (包括 Ntstrsafe.h)
連結庫 Ntstrsafe.lib
IRQL 如果所操作的字串一律位於記憶體中,則為任何 ,否則PASSIVE_LEVEL

另請參閱