StringCbCopyNExW 函式 (strsafe.h)
將指定的位元組數目從一個字串複製到另一個字串。 目的地緩衝區的大小會提供給 函式,以確保其不會寫入超過這個緩衝區的結尾。
StringCbCopyNEx 會傳回目的地字串結尾的指標,以及該字串中剩餘未使用的位元組數目,以新增至 StringCbCopyN 的功能。 旗標也可以傳遞至 函式以取得其他控制件。
StringCbCopyNEx 是下列函式的取代專案:
語法
STRSAFEAPI StringCbCopyNExW(
[out] STRSAFE_LPWSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_PCNZWCH pszSrc,
[in] size_t cbToCopy,
[out, optional] STRSAFE_LPWSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags
);
參數
[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 的最大位元元組數目。
[out, optional] ppszDestEnd
類型: LPTSTR*
pszDest 結尾的指標位址。 如果 ppszDestEnd 為非 NULL ,且任何數據都複製到目的地緩衝區,這會指向字串結尾的終止 Null 字元。
[out, optional] pcbRemaining
類型: size_t*
pszDest 中未使用的位元組數目,包括用於終止 Null 字元的位元組數目。 如果 其 值為 NULL,則不會保留或傳回計數。
[in] dwFlags
類型: DWORD
下列一或多個值。
傳回值
類型: HRESULT
此函式可以傳回下列其中一個值。 強烈建議您使用 SUCCEEDED 和 FAILED 宏來測試此函式的傳回值。
傳回碼 | 描述 |
---|---|
|
源數據存在、完全複製而不截斷,且結果目的地緩衝區會以 Null 終止。 |
|
pszDest 或 pszSrc 大於 STRSAFE_MAX_CCH * sizeof(TCHAR) ,pszDest 是在有源數據要複製時為 NULL,或傳遞無效的旗標。
|
|
複製作業因為緩衝區空間不足而失敗。 根據 dwFlags 的值,目的地緩衝區可能包含已截斷且以 Null 終止之預期結果的版本。 在可接受截斷的情況下,這可能不一定被視為失敗狀況。 |
請注意,此函式會傳回 HRESULT 值,與它所取代的函式不同。
備註
StringCbCopyNEx 提供額外的處理,以在程式代碼中正確處理緩衝區。 在涉及緩衝區溢出的許多安全性問題中,緩衝區處理不佳。 StringCbCopyNEx 一律會以 null 終止,而且永遠不會溢位有效的目的地緩衝區,即使來源字串的內容在作業期間變更也一樣。
雖然此例程是為了取代 strncpy,但行為有差異。 如果 cbSrc 大於 pszSrc 中的位元元組數目,則 StringCbCopyNEx 與 strncpy 不同,在複製 cbSrc 位元組之前,不會繼續以 null 字元填補 pszDest。
如果 pszSrc 和 pszDest 所指向的字串重疊,則行為是未定義的。
除非指定了 STRSAFE_IGNORE_NULLS 旗標,否則 pszSrc 或 pszDest 都不應該是 NULL,在此情況下兩者可以是 NULL。 不過,即使忽略 NULL 值,仍可能會傳回因空間不足而造成的錯誤。
StringCbCopyNEx 可用於其泛型形式或更特定的形式。 字串的數據類型會決定您應該使用的此函式形式,如下表所示。
String 資料類型 | 字串常值 | 函式 |
---|---|---|
char | "字串" | StringCbCopyNExA |
TCHAR | TEXT (“string”) | StringCbCopyNEx |
WCHAR | L“string” | StringCbCopyNExW |
注意
strsafe.h 標頭會將 StringCbCopyNEx 定義為別名,根據 UNICODE 預處理器常數的定義,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱 函式原型的慣例。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows XP with SP2 [傳統型應用程式 |UWP 應用程式] |
最低支援的伺服器 | Windows Server 2003 SP1 [傳統型應用程式 |UWP 應用程式] |
目標平台 | Windows |
標頭 | strsafe.h |
另請參閱
參考