StringCbGetsW 函式 (strsafe.h)
從 stdin 取得一行文字,最多包含換行符 (『\n』) 。 文字行會複製到目的地緩衝區,並將換行符取代為 Null 字元。 目的地緩衝區的大小會提供給 函式,以確保它不會寫入超過這個緩衝區的結尾。
語法
STRSAFEAPI StringCbGetsW(
[out] STRSAFE_LPWSTR pszDest,
[in] size_t cbDest
);
參數
[out] pszDest
類型: LPTSTR
接收輸入的目的地緩衝區。
[in] cbDest
類型: size_t
目的地緩衝區的大小,以位元組為單位。 此值必須大於 sizeof(TCHAR)
,函式才能成功。 允許的最大位元元數目是 STRSAFE_MAX_CCH * sizeof(TCHAR)
。 如果 cbDest 太小而無法保存整行文字,則會截斷數據。
傳回值
類型: HRESULT
此函式可以傳回下列其中一個值。 強烈建議您使用 SUCCEEDED 和 FAILED 宏來測試此函式的傳回值。
傳回碼 | 描述 |
---|---|
|
從 stdin 讀取數據、複製到 pszDest 的緩衝區,且緩衝區已以 Null 終止。 |
|
指出錯誤或檔尾條件。 使用 feof 或 來 判斷發生哪一個。 |
|
cbDest 中的值大於允許的最大值。 |
|
cbDest 中的值是sizeof(TCHAR) 或更少。
|
請注意,此函式會傳回 HRESULT 值,不同於它所取代的函式。
備註
StringCbGets 為程式代碼中的適當緩衝區處理提供額外的處理。 在涉及緩衝區溢出的許多安全性問題中,都牽涉到緩衝區處理不佳的情況。 StringCbGets 一律會以 null 終止非零長度的目的地緩衝區。
pszDest 的值不應該是 NULL。 如果您需要處理 Null 字串指標值,請參閱 StringCbGetsEx 。
StringCbGets 可用於其泛型形式或更特定的表單中。 字串的數據類型會決定您應該使用的此函式形式,如下表所示。
String 資料類型 | 字串常值 | 函式 |
---|---|---|
char | "字串" | StringCbGetsA |
TCHAR | TEXT (“string”) | StringCbGets |
WCHAR | L“string” | StringCbGetsW |
注意
strsafe.h 標頭會將 StringCbGets 定義為別名,根據 UNICODE 預處理器常數的定義,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱 函式原型的慣例。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows XP with SP2 [傳統型應用程式 |UWP 應用程式] |
最低支援的伺服器 | Windows Server 2003 SP1 [傳統型應用程式 |UWP 應用程式] |
目標平台 | Windows |
標頭 | strsafe.h |
另請參閱
參考