RtlStringCchCatNExA 函式 (ntstrsafe.h)

RtlStringCchCatNExW 和 RtlStringCchCatNExA 函式會串連兩個字元計數位符串，同時限制附加字串的大小。

語法

NTSTRSAFEDDI RtlStringCchCatNExA(
  [in, out, optional] NTSTRSAFE_PSTR pszDest,
  [in]                size_t         cchDest,
  [in, optional]      STRSAFE_PCNZCH pszSrc,
                      size_t         cchToAppend,
  [out, optional]     NTSTRSAFE_PSTR *ppszDestEnd,
  [out, optional]     size_t         *pcchRemaining,
  [in]                DWORD          dwFlags
);

參數

[in, out, optional] pszDest

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

[in] cchDest

目的地緩衝區的大小，以字元為單位。 允許的最大字元數是NTSTRSAFE_MAX_CCH。 如果 pszDest 為 NULL，cchDest 必須是零。

[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	如果已設定此旗標，則 pszDest 或 pszSrc 或兩者都可以是 NULL。 NULLpszSrc 指標會被視為空字串 (TEXT (“”) ) ，可以複製。 NULLpszDest 指標無法接收無空字串。
STRSAFE_FILL_ON_FAILURE	如果設定此旗標且函式失敗， 則會使用 dwFlags 的低位元組來填滿整個目的地緩衝區，而緩衝區會以 Null 結束。 此作業會覆寫任何預先存在的緩衝區內容。
STRSAFE_NULL_ON_FAILURE	如果設定此旗標且函式失敗，目的地緩衝區會設定為空字串， (TEXT (“”“) ) 。 此作業會覆寫任何預先存在的緩衝區內容。
STRSAFE_NO_TRUNCATION	如果已設定此旗標，且函式會傳回 STATUS_BUFFER_OVERFLOW： 如果同時指定STRSAFE_FILL_ON_FAILURE，STRSAFE_NO_TRUNCATION據以填入目的地緩衝區。 否則，目的地緩衝區將會未經修改。

傳回值

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

傳回碼	Description
STATUS_SUCCESS	此 成功 狀態表示源數據已存在、已建立輸出字串而不截斷，且結果目的地緩衝區為 Null 終止。
STATUS_BUFFER_OVERFLOW	此 警告 狀態表示作業因目的地緩衝區空間不足而未完成。 如果 已設定STRSAFE_NO_TRUNCATION ，請參閱 dwFlags 參數以取得詳細資訊。
STATUS_INVALID_PARAMETER	這個 錯誤 狀態表示函式收到無效的輸入參數。 如需詳細資訊，請參閱下列段落。 當下列情況時，函式會傳回STATUS_INVALID_PARAMETER值： 指定了無效的旗標。 cchDest 中的值大於緩衝區大小上限。 目的地緩衝區已滿。 NULL 指標沒有STRSAFE_IGNORE_NULLS旗標。 目的地緩衝區指標為 NULL，但緩衝區大小不是零。 目的地緩衝區指標為 NULL，或其長度為零，但存在非零長度的來源字串。

備註

應該使用 RtlStringCchCatNExW 和 RtlStringCchCatNExA，而不是下列函式：

• strncat
• wcsncat

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

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

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

字串資料類型	字串常值	函式
WCHAR	L“string”	RtlStringCchCatNExW
char	"字串"	RtlStringCchCatNExA

如果 pszSrc 和 pszDest 指向重疊字串，則函式的行為未定義。

除非已設定STRSAFE_IGNORE_NULLS旗標，否則 pszSrc 和 pszDest 都不能是 NULL ，在此情況下，或兩者都可以是 NULL。 如果 pszDest 為 NULL，pszSrc 必須是 NULL 或指向空字串。

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

規格需求

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

另請參閱

• RtlStringCbCatNEx
• RtlStringCchCatEx
• RtlStringCchCatN