StringCchCatA 函式 (strsafe.h)

將一個字串串連到另一個字串。 目的地緩衝區的大小會提供給 函式,以確保 StringCchCat 不會寫入超過此緩衝區結尾。

StringCchCat 取代下列函式:

語法

STRSAFEAPI StringCchCatA(
  [in, out] STRSAFE_LPSTR  pszDest,
  [in]      size_t         cchDest,
  [in]      STRSAFE_LPCSTR pszSrc
);

參數

[in, out] pszDest

類型:LPTSTR

目的地緩衝區,其中包含要串連 pszSrc 的字串,而且將接收整個結果字串。 pszSrc 的字串會新增至 pszDest的字串結尾。

[in] cchDest

類型:size_t

目的地緩衝區的大小,以字元為單位。 此值必須大於或等於 pszSrc 加上 pszDest 加上 1 長度,以同時考慮字串和終止 Null 字元。 允許的最大字元數是 STRSAFE_MAX_CCH。

[in] pszSrc

類型:LPCTSTR

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

傳回值

類型:HRESULT

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

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

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

言論

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

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

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

StringCchCat 可用於其泛型表單或更特定的表單。 字串的數據類型會決定您應該使用的此函式形式,如下表所示。

字串數據類型 字串常值 功能
char “string” StringCchCatA
TCHAR TEXT(“string”) StringCchCat
WCHAR L“string” StringCchCatW
 

注意

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

要求

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

另請參閱

參考

StringCbCat

StringCchCatEx

StringCchCatN