共用方式為


stringCchGetsA 函式 (strsafe.h)

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

注意 此函式只能內嵌使用。
 
StringCchGets 是下列函式的取代專案:StringCchGets 不是 fgets的取代專案,不會以終止的 Null 字元取代分行符號。

語法

STRSAFEAPI StringCchGetsA(
  [out] STRSAFE_LPSTR pszDest,
  [in]  size_t        cchDest
);

參數

[out] pszDest

類型: LPTSTR

目的地緩衝區,接收復制的字元。

[in] cchDest

類型: size_t

目的地緩衝區的大小,以字元為單位。 此值必須至少為 2,函式才能成功。 允許的最大字元數,包括終止的 Null 字元,會 STRSAFE_MAX_CCH。 如果 cchDest 太小而無法保存整行文字,則會截斷資料。

傳回值

類型: HRESULT

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

傳回碼 描述
S_OK
字元是從 stdin 讀取、複製到 pszDest的緩衝區,而緩衝區是以 Null 結束。
STRSAFE_E_END_OF_FILE
指出錯誤或檔案結尾條件。 使用 feoffeofr 來判斷已發生哪一個。
STRSAFE_E_INVALID_PARAMETER
cchDest中的值大於允許的最大值。
STRSAFE_E_INSUFFICIENT_BUFFER
cchDest中的值為 1 或更少。
 

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

備註

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

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

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

String 資料類型 字串常值 函式
char "字串" StringCchGetsA
TCHAR TEXT (「string」) StringCchGets
WCHAR L「string」 StringCchGetsW
 

注意

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

需求

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

另請參閱

參考

StringCbGets

StringCchGetsEx