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