Share via

StringCbCopyNA 函式 (strsafe.h)

  • 發行項

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

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

語法

STRSAFEAPI StringCbCopyNA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cbDest,
  [in]  STRSAFE_PCNZCH pszSrc,
  [in]  size_t         cbToCopy
);

參數

[out] pszDest

類型： LPTSTR

目的地緩衝區，接收複製的字元。

[in] cbDest

類型： size_t

pszDest 的大小，以位元組為單位。 這個值必須夠大，才能保存複製的位元組 (pszSrc 的大小或 cbSrc 的值，不論哪一個是較小的) ，也會考慮終止的 Null 字元。 允許的最大字元數為 STRSAFE_MAX_CCH * sizeof(TCHAR)。

[in] pszSrc

類型： LPCTSTR

來源字串。 此字串必須以 Null 結束。

[in] cbToCopy

類型： size_t

要從 pszSrc 複製到 pszDest 的最大位元元組數目。

傳回值

類型： HRESULT

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

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

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

備註

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

雖然此例程是為了取代 strncpy，但行為有差異。 如果 cbSrc 大於 pszSrc 中的位元元組數目，則 StringCbCopyN 與 strncpy 不同，在複製 cbSrc 位元組之前，不會繼續以 null 字元填補 pszDest。

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

pszSrc 和 pszDest 都不應該是 NULL。 如果您需要處理 Null 字串指標值，請參閱 StringCbCopyNEx 。

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

String 資料類型 字串常值 函式
char "字串" StringCbCopyNA
TCHAR TEXT (“string”) StringCbCopyN
WCHAR L“string” StringCbCopyNW
 

注意

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

規格需求

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

另請參閱

參考

StringCbCopy

StringCbCopyNEx

StringCchCopyN