StringCbCatNA 函式 (strsafe.h)

將指定的位元組數目從一個字串串連到另一個字串。 目的地緩衝區的大小,以位元組為單位,會提供給函式,以確保它不會寫入超過這個緩衝區的結尾。

StringCbCatN 取代下列函式:

語法

STRSAFEAPI StringCbCatNA(
  [in, out] STRSAFE_LPSTR  pszDest,
  [in]      size_t         cbDest,
  [in]      STRSAFE_PCNZCH pszSrc,
  [in]      size_t         cbToAppend
);

參數

[in, out] pszDest

類型:LPTSTR

目的地緩衝區,其中包含要串連至 pszSrc的字串,並將接收結果字串。 pszSrc的字串,最多 cbMaxAppend 個字節,會新增至 pszDest的字元串結尾。

[in] cbDest

類型:size_t

目的地緩衝區的大小,以位元組為單位。 這個值必須考慮 pszSrc 長度 加上 pszDest 或 cbMaxAppend (以較小者為準) 加上終止 Null 字元的長度。 允許的位元元數目上限為 STRSAFE_MAX_CCH * sizeof(TCHAR)。

[in] pszSrc

類型:LPCTSTR

要串連至 pszDest 結尾 pszDest的來源字串。 此來源字串必須以 Null 結束。

[in] cbToAppend

類型:size_t

要附加至 pszDest的最大位元元組數。

傳回值

類型:HRESULT

此函式可以傳回下列其中一個值。 強烈建議您使用 SUCCEEDED 和 FAILED 巨集來測試此函式的傳回值。

傳回碼 描述
S_OK
源數據存在,字串會串連而不截斷,結果目的地緩衝區會以 Null 結束。
STRSAFE_E_INVALID_PARAMETER
cbDest 中的值大於允許的最大值,或目的地緩衝區已滿。
STRSAFE_E_INSUFFICIENT_BUFFER
串連作業因為緩衝區空間不足而失敗。 目的地緩衝區包含已截斷且以 Null 終止之預期結果的版本。 在可接受截斷的情況下,這不一定被視為失敗狀況。
 

請注意,此函式會傳回 HRESULT 值,與它所取代的函式不同。

言論

與其取代的函式相比,StringCbCatN 會提供額外的處理,以在程式碼中處理適當的緩衝區。 不良的緩衝區處理牽涉到涉及緩衝區滿溢的許多安全性問題。 StringCbCatN 一律會以 null 終止,而且永遠不會溢位有效的目的地緩衝區,即使來源字串的內容在作業期間變更也一樣。

如果 pszSrc 所指向的字串與 pszDest 重疊,則行為是未定義的。

pszSrc 或 pszDest 都不應 NULL。 如果您需要處理 Null 字串指標值,請參閱 StringCbCatNEx。

StringCbCatN 可用於其泛型表單或更特定的表單。 字串的數據類型會決定您應該使用的這個函式形式。

字串數據類型 字串常值 功能
char “string” StringCbCatNA
TCHAR TEXT(“string”) StringCbCatN
WCHAR L“string” StringCbCatNW
 

注意

strsafe.h 標頭會將 StringCbCatN 定義為別名,根據 UNICODE 預處理器常數的定義,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱函式原型的 慣例。

要求

要求 價值
最低支援的用戶端 Windows XP with SP2 [傳統型應用程式 |UWP 應用程式]
支援的最低伺服器 Windows Server 2003 SP1 [傳統型應用程式 |UWP 應用程式]
目標平臺 窗戶
標頭 strsafe.h

另請參閱

參考

StringCbCat

StringCbCatNEx

StringCchCatN