共用方式為

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

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

傳回碼 描述
S_OK
 字元是從 stdin 讀取，會複製到 pszDest的緩衝區，而緩衝區則以 null 結束。
STRSAFE_E_END_OF_FILE
 指出錯誤或檔尾條件。 使用 feof 或 鐵 來判斷發生哪一個。
STRSAFE_E_INVALID_PARAMETER
 cchDest 中的值大於允許的值上限。
STRSAFE_E_INSUFFICIENT_BUFFER
 cchDest 中的值為 1 或更少。
 

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

言論

StringCchGets 為您的程式代碼中適當的緩衝區處理提供額外的處理。 不良的緩衝區處理牽涉到涉及緩衝區滿溢的許多安全性問題。 StringCchGets 一律以 null 終止非零長度的目的地緩衝區。

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

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

字串數據類型 字串常值 功能
char “string” 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 應用程式]
目標平臺 窗戶
標頭 strsafe.h

另請參閱

參考

StringCbGets

StringCchGetsEx