共用方式為

StringCchCopyNA 函式 (strsafe.h)

  • 發行項

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

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

語法

STRSAFEAPI StringCchCopyNA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cchDest,
  [in]  STRSAFE_PCNZCH pszSrc,
  [in]  size_t         cchToCopy
);

參數

[out] pszDest

類型： LPTSTR

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

[in] cchDest

類型： size_t

pszDest的大小，以字元為單位。 這個值必須夠大，才能保存所複製的字元， (pszSrc 的長度或 cchSrc的值，不論哪一個值較小，) 加上 1 來考慮終止的 Null 字元。 允許的最大字元數是 STRSAFE_MAX_CCH。

[in] pszSrc

類型： LPCTSTR

來源字串。 此字串必須可讀取最多 cchSrc 字元或 null 結束字元，無論何者優先。

[in] cchToCopy

類型： size_t

要從 pszSrc 複製到 pszDest的最大字元數。

傳回值

類型： HRESULT

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

傳回碼 描述
S_OK
 來源資料存在，字元會從 pszSrc 複製而沒有截斷，而結果目的地緩衝區會以 Null 結束。
STRSAFE_E_INVALID_PARAMETER
 cchDest中的值大於STRSAFE_MAX_CCH，或目的地緩衝區已滿。
STRSAFE_E_INSUFFICIENT_BUFFER
 複製作業因為緩衝區空間不足而失敗。 目的地緩衝區包含預定結果的截斷、Null 終止版本。 在可接受截斷的情況下，這不一定會被視為失敗狀況。
 

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

備註

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

雖然此常式是為了 取代 strncpy，但行為有差異。 如果cchSrc大於pszSrc中的字元數，則 StringCchCopyN與strncpy不同，在複製 cchSrc字元之前，不會繼續以 Null 字元填補pszDest。

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

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

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

String 資料類型 字串常值 函式
char "字串" StringCchCopyNA
TCHAR TEXT (「string」) StringCchCopyN
WCHAR L「string」 StringCchCopyNW
 

注意

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

規格需求

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

另請參閱

參考

StringCbCopyN

StringCchCopy

StringCchCopyNEx