StringCchGetsW 函数 (strsafe.h)

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

注意此函数只能内联使用。

StringCchGets 取代了以下函数：

StringCchGets 不能替换 fget，fgets 不会用终止 null 字符替换换行符。

语法

STRSAFEAPI StringCchGetsW(
  [out] STRSAFE_LPWSTR 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 或 ferror 确定发生了哪一个。
STRSAFE_E_INVALID_PARAMETER	cchDest 中的值大于允许的最大值。
STRSAFE_E_INSUFFICIENT_BUFFER	cchDest 中的值为 1 或更小。

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

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

pszDest 的值不应为 NULL。如果需要处理 null 字符串指针值，请参阅 StringCchGetsEx 。

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

注意

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

引用