共用方式為


stringCbCopyW 函式 (strsafe.h)

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

StringCbCopy 是下列函式的取代專案:

語法

STRSAFEAPI StringCbCopyW(
  [out] STRSAFE_LPWSTR  pszDest,
  [in]  size_t          cbDest,
  [in]  STRSAFE_LPCWSTR pszSrc
);

參數

[out] pszDest

類型: LPTSTR

接收復制字串的目的地緩衝區。

[in] cbDest

類型: size_t

目的地緩衝區的大小,以位元組為單位。 此值必須考慮 pszSrc 的長度加上終止的 Null 字元。 允許的最大位元組數目為 STRSAFE_MAX_CCH * sizeof(TCHAR)

[in] pszSrc

類型: LPCTSTR

包含來源字串之緩衝區的指標。 此來源字串必須以 Null 結尾。

傳回值

類型: HRESULT

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

傳回碼 描述
S_OK
來源資料存在、完全複製而不截斷,且結果目的地緩衝區會以 Null 終止。
STRSAFE_E_INVALID_PARAMETER
cbDest中的值小於 sizeof(TCHAR) 或大於允許的最大值。
STRSAFE_E_INSUFFICIENT_BUFFER
複製作業因為緩衝區空間不足而失敗。 目的地緩衝區包含已截斷且以 Null 終止之預期結果的版本。 在可接受截斷的情況下,這可能不一定被視為失敗狀況。
 

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

備註

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

如果 pszSrcpszDest 所指向的字串重迭,則行為是未定義的。

pszSrcpszDest都不應該是Null。 如果您需要處理 Null 字串指標值,請參閱 StringCbCopyEx

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

String 資料類型 字串常值 函式
char "字串" StringCbCopyA
TCHAR TEXT (「string」) StringCbCopy
WCHAR L「string」 StringCbCopyW
 

注意

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

規格需求

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

另請參閱

參考

StringCbCopyEx

StringCchCopy