通过

StringCchGetsA 函数 （strsafe.h）

  • 项目

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

注意 此函数只能内联使用。
 
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，并 失败 宏来测试此函数的返回值。

返回代码 描述
S_OK
 字符从 stdin 读取，复制到 pszDest的缓冲区，缓冲区以 null 结尾。
STRSAFE_E_END_OF_FILE
 指示错误或文件结束条件。 使用 或 铁 来确定发生了哪一个。
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 版本。 将中性编码别名与不中性编码的代码混合使用可能会导致编译或运行时错误不匹配。 有关详细信息，请参阅函数原型的 约定。

要求

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

另请参阅

参考

StringCbGets

StringCchGetsEx