共用方式為


StringCchCopyNW 函式 (strsafe.h)

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

StringCchCopyN 取代下列函式:

語法

STRSAFEAPI StringCchCopyNW(
  [out] STRSAFE_LPWSTR  pszDest,
  [in]  size_t          cchDest,
  [in]  STRSAFE_PCNZWCH 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

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

傳回碼 描述
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不同,則不會繼續以 null 字元填補 pszDest直到複製 cchSrc 字元為止。

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

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

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

字串數據類型 字串常值 功能
char “string” 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 應用程式]
目標平臺 窗戶
標頭 strsafe.h

另請參閱

參考

StringCbCopyN

StringCchCopy

StringCchCopyNEx