共用方式為

StringCchGetsExA 函式 （strsafe.h）

  • 發行項

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

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

StringCchGetsEx 取代下列函式：

StringCchGetsEx 不是取代 fgets，它不會以終止的 null 字元取代換行符。

語法

STRSAFEAPI StringCchGetsExA(
  [out]           STRSAFE_LPSTR pszDest,
  [in]            size_t        cchDest,
  [out, optional] STRSAFE_LPSTR *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 字元。 如果 pcchRemainingNULL，則不會保留或傳回計數。

[in] dwFlags

類型：DWORD

下列一或多個值。

價值 意義
STRSAFE_FILL_BEHIND_NULL
0x00000200
 如果函式成功，則會使用 dwFlags （0） 的低位元組來填入 pszDest 的未初始化部分，並遵循終止的 null 字元。
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 或 鐵 來判斷發生哪一個。
STRSAFE_E_INVALID_PARAMETER
 cchDest 中的值大於允許值上限或傳遞無效旗標。
STRSAFE_E_INSUFFICIENT_BUFFER
 cchDest 中的值為 1 或更少。
 

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

言論

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

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

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

字串數據類型 字串常值 功能
char “string” StringCchGetsExA
TCHAR TEXT（“string”） StringCchGetsEx
WCHAR L“string” StringCchGetsExW
 

注意

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

要求

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

另請參閱

參考

StringCbGetsEx

StringCchGets