StringCbGetsA 函式 (strsafe.h)

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

注意此函式只能內嵌使用。

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

StringCbGets 不是 fgets的取代專案，不會以終止的 Null 字元取代分行符號。

語法

STRSAFEAPI StringCbGetsA(
  [out] STRSAFE_LPSTR pszDest,
  [in]  size_t        cbDest
);

[out] pszDest

類型： LPTSTR

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

[in] cbDest

類型： size_t

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

類型： 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中的值是 `sizeof(TCHAR)` 或更少。

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

StringCbGets 提供額外的處理，以在程式碼中正確處理緩衝區。在涉及緩衝區溢位的許多安全性問題中，緩衝區處理不佳。 StringCbGets 一律會以 null 終止非零長度的目的地緩衝區。

pszDest的值不應為Null。如果您需要處理 Null 字串指標值，請參閱 StringCbGetsEx 。

StringCbGets 可用於其泛型形式或更特定的形式。字串的資料類型會決定您應該使用的此函式形式，如下表所示。

注意

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


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

參考