RtlStringCbCatNA 函式 (ntstrsafe.h)

  • 發行項

RtlStringCbCatNW 和 RtlStringCbCatNA 函式會串連兩個字節計數的字串，同時限制附加字串的大小。

語法

NTSTRSAFEDDI RtlStringCbCatNA(
  [in, out] NTSTRSAFE_PSTR pszDest,
  [in]      size_t         cbDest,
  [in]      STRSAFE_PCNZCH pszSrc,
            size_t         cbToAppend
);

參數

[in, out] pszDest

緩衝區的指標，在輸入時包含要串連 pszSrc 的 Null 終止字串。 在輸出中，這是包含整個結果字串的目的地緩衝區。 pszSrc 的字串最多為 cbToAppend 位元組，會新增至 pszDest 處的字串結尾，並以 Null 字元終止。

[in] cbDest

目的地緩衝區的大小，以位元組為單位。 緩衝區必須夠大，才能同時包含字串和終止的 Null 字元。

若為 Unicode 字串，最大位元節數目為 NTSTRSAFE_MAX_CCH * sizeof (WCHAR) 。

對於 ANSI 字串，最大位元組數目是NTSTRSAFE_MAX_CCH * sizeof (char) 。

[in] pszSrc

Null 終止字串的指標。 此字串會串連至 pszDest 緩衝區中包含的字串結尾。

cbToAppend

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

傳回值

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

傳回碼 Description
STATUS_SUCCESS
 此 成功 狀態表示源數據已存在、字串已串連而不截斷，且產生的目的地緩衝區會以 Null 終止。
STATUS_BUFFER_OVERFLOW
 這個 警告 狀態表示串連作業因緩衝區空間不足而未完成。 目的地緩衝區包含已截斷且以 Null 終止之預期結果的版本。
STATUS_INVALID_PARAMETER
 此錯誤狀態表示函式收到無效的輸入參數。 如需詳細資訊，請參閱下列段落。

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

  • cbDest 中的值大於緩衝區大小上限。
  • 目的地緩衝區已滿。
  • NULL 指標存在。
  • 目的地緩衝區的長度為零，但存在非零長度來源字串。

備註

應該使用 RtlStringCbCatNW 和 RtlStringCbCatNA ，而不是下列函式：

  • strncat
  • wcsncat
目的地緩衝區的大小，以位元組為單位，會提供給 RtlStringCbCatNW 和 RtlStringCbCatNA ，以確保它們不會寫入緩衝區結尾。

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

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

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

pszSrc 和 pszDest 都不能是 NULL。 如果您需要處理 NULL 字串指標值，請使用 RtlStringCbCatNEx。

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

規格需求

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

另請參閱

RtlStringCbCat

RtlStringCbCatNEx

RtlStringCchCatN