Share via

StringCchCatNExA 函式 (strsafe.h)

  • 發行項

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

StringCchCatNEx 會傳回目的地字串結尾的指標，以及該字串中保留未使用的字元數，以新增 StringCchCatN 的功能。 旗標也可以傳遞至 函式以取得其他控制項。

StringCchCatNEx 是下列函式的取代專案：

語法

STRSAFEAPI StringCchCatNExA(
  [in, out]       STRSAFE_LPSTR  pszDest,
  [in]            size_t         cchDest,
  [in]            STRSAFE_PCNZCH pszSrc,
  [in]            size_t         cchToAppend,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcchRemaining,
  [in]            DWORD          dwFlags
);

參數

[in, out] pszDest

類型： LPTSTR

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

[in] cchDest

類型： size_t

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

[in] pszSrc

類型： LPCTSTR

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

[in] cchToAppend

類型： size_t

要附加至 pszDest的最大字元數。

[out, optional] ppszDestEnd

類型： LPTSTR*

pszDest結尾的指標位址。 如果 ppszDestEnd 不是Null ，而且任何資料會附加至目的地緩衝區，這會指向字串結尾的終止 Null 字元。

[out, optional] pcchRemaining

類型： size_t*

pszDest中未使用的字元數，包括終止的 Null 字元。 如果 pcchRemaining 為 Null，則不會保留或傳回計數。

[in] dwFlags

類型： DWORD

下列一或多個值。

值 意義
STRSAFE_FILL_BEHIND_Null
0x00000200
 如果函式成功， 則會使用 dwFlags 的低位元組 (0) ，在終止 Null 字元之後填滿 pszDest 的未初始化部分。
STRSAFE_IGNORE_NullS
0x00000100
 將 Null 字串指標視為空字串， (TEXT (「」) ) 。
STRSAFE_FILL_ON_FAILURE
0x00000400
 如果函式失敗， 則會使用 dwFlags (0) 的低位元組來填滿整個 pszDest 緩衝區，且緩衝區為 null 終止。 如果 發生STRSAFE_E_INSUFFICIENT_BUFFER 失敗，則會覆寫目的地緩衝區中任何預先存在的或截斷字串。
STRSAFE_Null_ON_FAILURE
0x00000800
 如果函式失敗， pszDest 會設定為空字串， (TEXT (「」) ) 。 如果 發生STRSAFE_E_INSUFFICIENT_BUFFER 失敗，則會覆寫目的地緩衝區中任何預先存在的或截斷字串。
STRSAFE_NO_TRUNCATION
0x00001000
 如果函式失敗， 則不會變更 pszDest 。 原始內容中不會新增任何專案。

傳回值

類型： HRESULT

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

傳回碼 描述
S_OK
 來源資料存在、字串串連而不截斷，且結果目的地緩衝區為 Null 終止。
STRSAFE_E_INVALID_PARAMETER
 cchDest中的值大於STRSAFE_MAX_CCH、傳遞不正確旗標，或pszDest、cchDest的大小和要附加 pszSrc中的材質數量不一致。
STRSAFE_E_INSUFFICIENT_BUFFER
 複製作業因為緩衝區空間不足而失敗。 根據 dwFlags的值，目的地緩衝區可能包含預定結果的截斷、Null 終止版本。 在可接受截斷的情況下，這不一定會被視為失敗狀況。
 

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

備註

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

如果 pszSrc 和 pszDest 所指向的字串重迭，則行為未定義。

除非指定STRSAFE_IGNORE_NullS旗標，否則pszSrc和pszDest都不應該是Null，在此情況下，這兩者都可能是Null。 不過，即使忽略 Null 值，仍可能會傳回空間不足的錯誤。

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

String 資料類型 字串常值 函式
char "字串" StringCchCatNExA
TCHAR TEXT (「string」) StringCchCatNEx
WCHAR L「string」 StringCchCatNExW
 

注意

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

規格需求

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

另請參閱

參考

StringCbCatNEx

StringCchCatEx

StringCchCatN