StringCbCatNExA 函式 (strsafe.h)
將指定的位元組數目從一個字串串連到另一個字串。 目的地緩衝區的大小會提供給 函式,以確保它不會寫入超過這個緩衝區的結尾。
StringCbCatNEx 是下列函式的取代專案:
StringCbCatNEx 會傳回目的地字串結尾的指標,以及該字串中保留未使用的位元組數目,以新增 至 StringCbCatN 的功能。 旗標也可以傳遞至 函式以取得其他控制件。語法
STRSAFEAPI StringCbCatNExA(
[in, out] STRSAFE_LPSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_PCNZCH pszSrc,
[in] size_t cbToAppend,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags
);
參數
[in, out] pszDest
類型: LPTSTR
目的地緩衝區,其中包含要與 pszSrc 串連的字串,並接收整個結果字串。 pszSrc 的字串會新增至 pszDest 字串串的結尾。
[in] cbDest
類型: size_t
目的地緩衝區的大小,以位元組為單位。 此值必須考慮 pszSrc 的長度加上 pszDest 的長度,加上用於終止 Null 字元的位元。 允許的最大位元元數目是 STRSAFE_MAX_CCH * sizeof(TCHAR)
。
[in] pszSrc
類型: LPCTSTR
要串連至 pszDest 結尾的來源字串。 此字串必須以 Null 結尾。
[in] cbToAppend
類型: size_t
要附加至 pszDest 的最大位元元數目。
[out, optional] ppszDestEnd
類型: LPTSTR*
pszDest 結尾的指標位址。 如果 ppszDestEnd 不是 NULL ,而且任何數據會附加至目的地緩衝區,這會指向字串結尾的終止 Null 字元。
[out, optional] pcbRemaining
類型: size_t*
pszDest 中未使用的位元組數目,包括用於終止 Null 字元的位元組數目。 如果 其為NULL,則不會保留或傳回計數。
[in] dwFlags
類型: DWORD
下列一或多個值。
傳回值
類型: HRESULT
此函式可以傳回下列其中一個值。 強烈建議您使用 SUCCEEDED 和 FAILED 宏來測試此函式的傳回值。
傳回碼 | 描述 |
---|---|
|
源數據存在、字串串連而不截斷,且結果目的地緩衝區為 Null 終止。 |
|
cbDest 中的值大於 STRSAFE_MAX_CCH * sizeof(TCHAR) 、傳遞無效的旗標,或 pszDest、cbDest 和要附加在 pszSrc 中的材質數量之間不一致。
|
|
複製作業因為緩衝區空間不足而失敗。 根據 dwFlags 的值,目的地緩衝區可能包含預定結果的截斷、Null 終止版本。 在可接受截斷的情況下,這不一定會被視為失敗狀況。 |
請注意,此函式會傳回 HRESULT 值,不同於它所取代的函式。
備註
相較於取代的函式, StringCbCatNEx 會提供額外的處理,以在程式代碼中處理適當的緩衝區。 在涉及緩衝區溢出的許多安全性問題中,都牽涉到緩衝區處理不佳的情況。 StringCbCatNEx 一律會以 Null 終止,而且永遠不會溢位有效的目的地緩衝區,即使來源字串的內容在作業期間變更也一樣。
如果 pszSrc 和 pszDest 所指向的字串重疊,則行為未定義。
除非指定STRSAFE_IGNORE_NULLS旗標,否則 pszSrc 和 pszDest 都不應該是 NULL,在此情況下,這兩者都可能是 NULL。 不過,即使忽略 NULL 值,仍可能會傳回空間不足的錯誤。
StringCbCatNEx 可用於其泛型形式,或更特定的表單中。 字串的數據類型會決定您應該使用的這個函式形式。
String 資料類型 | 字串常值 | 函式 |
---|---|---|
char | "字串" | StringCbCatNExA |
TCHAR | TEXT (“string”) | StringCbCatNEx |
WCHAR | L“string” | StringCbCatNExW |
注意
strsafe.h 標頭會將 StringCbCatNEx 定義為別名,根據 UNICODE 預處理器常數的定義,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱 函式原型的慣例。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows XP with SP2 [傳統型應用程式 |UWP 應用程式] |
最低支援的伺服器 | Windows Server 2003 SP1 [傳統型應用程式 |UWP 應用程式] |
目標平台 | Windows |
標頭 | strsafe.h |
另請參閱
參考