Share via

stringCbGetsExA 函式 (strsafe.h)

  • 發行項

從 stdin 取得一行文字，最多包含換行符 (『\n』) 。 文字行會複製到目的地緩衝區，並將換行符取代為 Null 字元。 目的地緩衝區的大小會提供給 函式，以確保其不會寫入超過這個緩衝區的結尾。

注意 此函式只能內嵌使用。
 
StringCbGetsEx 會傳回目的地字串結尾的指標，以及該字串中剩餘未使用的位元組數目，以新增至 StringCbGets 的功能。 旗標也可以傳遞至 函式以取得其他控制件。

StringCbGetsEx 是下列函式的取代專案：

StringCbGetsEx 不是 fgets 的取代專案，不會以終止的 Null 字元取代換行符。

語法

STRSAFEAPI StringCbGetsExA(
  [out]           STRSAFE_LPSTR pszDest,
  [in]            size_t        cbDest,
  [out, optional] STRSAFE_LPSTR *ppszDestEnd,
  [out, optional] size_t        *pcbRemaining,
  [in]            DWORD         dwFlags
);

參數

[out] pszDest

類型： LPTSTR

要接收輸入的目的地緩衝區。

[in] cbDest

類型： size_t

目的地緩衝區的大小，以位元組為單位。 此值必須大於 sizeof(TCHAR) ，函式才能成功。 允許的最大位元組數目為 STRSAFE_MAX_CCH * sizeof(TCHAR)。 如果 cbDest 太小而無法保存整行文字，則會截斷數據。

[out, optional] ppszDestEnd

類型： LPTSTR*

pszDest 結尾的指標位址。 如果 ppszDestEnd 為非 NULL ，且任何數據都複製到目的地緩衝區，這會指向字串結尾的終止 Null 字元。

[out, optional] pcbRemaining

類型： size_t*

pszDest 中未使用的位元組數目，包括用於終止 Null 字元的位元組數目。 如果 其 值為 NULL，則不會保留或傳回計數。

[in] dwFlags

類型： DWORD

下列一或多個值。

值 意義
STRSAFE_FILL_BEHIND_NULL
0x00000200
 如果函式成功， 則會使用 dwFlags (0) 的低位元組，在終止 Null 字元之後填滿 pszDest 未初始化的部分。
STRSAFE_IGNORE_NULLS
0x00000100
 將 NULL 字串指標視為空字串， (TEXT (“”) ) 。 此旗標適用於模擬 lstrcpy 等函式。
STRSAFE_FILL_ON_FAILURE
0x00000400
 如果函式失敗， 則會使用 dwFlags (0) 的低位元節來填滿整個 pszDest 緩衝區，而緩衝區會以 Null 結束。 如果 發生STRSAFE_E_INSUFFICIENT_BUFFER 失敗，則會覆寫傳回的任何截斷字串。
STRSAFE_NULL_ON_FAILURE
0x00000800
 如果函式失敗， pszDest 會設定為空字串， (TEXT (“”) ) 。 如果發生 STRSAFE_E_INSUFFICIENT_BUFFER 失敗，則會覆寫任何截斷的字串。
STRSAFE_NO_TRUNCATION
0x00001000
 如同 STRSAFE_NULL_ON_FAILURE的情況，如果函式失敗， pszDest 會設定為空字串， (TEXT (“”) ) 。 如果發生 STRSAFE_E_INSUFFICIENT_BUFFER 失敗，則會覆寫任何截斷的字串。

傳回值

類型： HRESULT

此函式可以傳回下列其中一個值。 強烈建議您使用 SUCCEEDED 和 FAILED 宏來測試此函式的傳回值。

傳回碼 描述
S_OK
 從 stdin 讀取數據、複製到 pszDest 的緩衝區，且緩衝區已終止 Null。
STRSAFE_E_END_OF_FILE
 指出錯誤或檔尾條件。 使用 feof 或 feofr 來判斷已發生哪一個。
STRSAFE_E_INVALID_PARAMETER
 cbDest 中的值大於允許的最大值或傳遞無效的旗標。
STRSAFE_E_INSUFFICIENT_BUFFER
 cbDest 中的值為1或更少。
 

請注意，此函式會傳回 HRESULT 值，與它所取代的函式不同。

備註

StringCbGetsEx 提供額外的處理，以在程式代碼中正確處理緩衝區。 在涉及緩衝區溢出的許多安全性問題中，緩衝區處理不佳。 StringCbGetsEx 一律會以 Null 結束非零長度的目的地緩衝區。

除非指定STRSAFE_IGNORE_NULLS旗標，否則 pszDest 的值不應該為 NULL。 不過，即使忽略 NULL 值，仍可能會傳回因空間不足而造成的錯誤。

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

String 資料類型 字串常值 函式
char "字串" StringCbGetsExA
TCHAR TEXT (“string”) StringCbGetsEx
WCHAR L“string” StringCbGetsExW
 

注意

strsafe.h 標頭會將 StringCbGetsEx 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

規格需求

需求 值
最低支援的用戶端 Windows XP with SP2 [傳統型應用程式 |UWP 應用程式]
最低支援的伺服器 Windows Server 2003 SP1 [傳統型應用程式 |UWP 應用程式]
目標平台 Windows
標頭 strsafe.h

另請參閱

參考

StringCbGets

StringCchGetsEx