通过

StringCchGetsExA 函数 (strsafe.h)

  • 项目

从 stdin 获取一行文本，包括换行符 ('\n') 。 文本行将复制到目标缓冲区，换行符将替换为 null 字符。 目标缓冲区的大小提供给函数，以确保它不会写入此缓冲区的末尾。

注意 此函数只能内联使用。
 
StringCchGetsEx 通过返回指向目标字符串末尾的指针以及该字符串中剩余的未使用的字符数，将添加到 StringCchGets 的功能中。 标志也可以传递给 函数，以便进行其他控制。

StringCchGetsEx 取代了以下函数：

StringCchGetsEx 不是 fget 的替代项，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 字符。 如果 pcchRemaining 为 NULL，则不保留或返回计数。

[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 或 ferror 确定发生了哪一个。
STRSAFE_E_INVALID_PARAMETER
 cchDest 中的值大于允许的最大值，或者传递了无效标志。
STRSAFE_E_INSUFFICIENT_BUFFER
 cchDest 中的值为 1 或更小。
 

请注意，此函数返回 HRESULT 值，这与它所替换的函数不同。

注解

StringCchGetsEx 提供额外的处理，以便在代码中正确处理缓冲区。 不良的缓冲区处理与许多涉及缓冲区溢出的安全问题有关。 StringCchGetsEx 始终为 null 终止非零长度的目标缓冲区。

除非指定了 STRSAFE_IGNORE_NULLS 标志，否则 pszDest 的值不应为 NULL。 但是，即使忽略 NULL 值，仍可能会返回由于空间不足而导致的错误。

StringCchGetsEx 可以在其泛型形式或更具体的窗体中使用。 字符串的数据类型决定了应使用的此函数的形式，如下表所示。

String 数据类型 字符串 函数
char “字符串” StringCchGetsExA
TCHAR TEXT (“string”) StringCchGetsEx
WCHAR L“string” StringCchGetsExW
 

注意

strsafe.h 标头将 StringCchGetsEx 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。 有关详细信息，请参阅 函数原型的约定。

要求

要求 值
最低受支持的客户端 具有 SP2 的 Windows XP [桌面应用 |UWP 应用]
最低受支持的服务器 Windows Server 2003 SP1 [桌面应用 |UWP 应用]
目标平台 Windows
标头 strsafe.h

另请参阅

引用

StringCbGetsEx

StringCchGets