RtlStringCbCatNW 函式 (ntstrsafe.h)

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

語法

NTSTRSAFEDDI RtlStringCbCatNW(
  [in, out] NTSTRSAFE_PWSTR pszDest,
  [in]      size_t          cbDest,
  [in]      STRSAFE_PCNZWCH pszSrc,
            size_t          cbToAppend
);

參數

[in, out] pszDest

緩衝區的指標,在輸入時會包含要串連 pszSrc 的 Null 終止字串。 輸出時,這是包含整個結果字串的目的地緩衝區。 pszSrc 的字串最多為 cbMaxAppend 位元組,會新增至 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 指標存在。
  • 目的地緩衝區的長度為零,但存在非零長度的來源字串。

備註

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

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

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

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

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

pszSrcpszDest 都不能是 NULL。 如果您需要處理 NULL 字串指標值,請使用 RtlStringCbCatNEx

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

規格需求

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

另請參閱

RtlStringCbCat

RtlStringCbCatNEx

RtlStringCchCatN