StringCbCopyNW 函式 (strsafe.h)
將指定的位元組數目從一個字串複製到另一個字串。 目的地緩衝區的大小會提供給 函式,以確保它不會寫入超過這個緩衝區的結尾。
StringCbCopyN 取代下列函式:
語法
STRSAFEAPI StringCbCopyNW(
[out] STRSAFE_LPWSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_PCNZWCH 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 巨集來測試此函式的傳回值。
傳回碼 | 描述 |
---|---|
|
源數據存在,數據是從 pszSrc 複製 而不截斷,而結果目的地緩衝區會以 null 終止。 |
|
cbDest 中的值大於 STRSAFE_MAX_CCH * sizeof(TCHAR) ,或目的地緩衝區已滿。
|
|
複製作業因為緩衝區空間不足而失敗。 目的地緩衝區包含已截斷且以 Null 終止之預期結果的版本。 在可接受截斷的情況下,這不一定被視為失敗狀況。 |
請注意,此函式會傳回 HRESULT 值,與它所取代的函式不同。
言論
StringCbCopyN 為程式代碼中的適當緩衝區處理提供額外的處理。 不良的緩衝區處理牽涉到涉及緩衝區滿溢的許多安全性問題。 StringCbCopyN 一律會以 null 終止,而且永遠不會溢位有效的目的地緩衝區,即使來源字串的內容在作業期間變更也一樣。
雖然此例程是取代 strncpy,但行為上存在差異。 如果
如果 pszSrc 所指向的字串與 pszDest 重疊,則行為是未定義的。
pszSrc 或 pszDest 都不應 NULL。 如果您需要處理 Null 字串指標值,請參閱 StringCbCopyNEx。
StringCbCopyN 可用於其泛型表單或更特定的表單。 字串的數據類型會決定您應該使用的此函式形式,如下表所示。
字串數據類型 | 字串常值 | 功能 |
---|---|---|
char | “string” | 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 應用程式] |
目標平臺 | 窗戶 |
標頭 | strsafe.h |
另請參閱
參考