通过

_cgets_s、_cgetws_s

  • 项目

从控制台获取一个字符串。 _cgets and _cgetws的这些版本的安全得到了增强，如CRT 中的安全功能 所述。

重要

此 API 不能用于在 Windows 运行时 中执行的应用程序。有关更多信息，请参见不支持 /ZW 的 CRT 函数。

errno_t _cgets_s( 
   char *buffer,
   size_t numberOfElements,
   size_t *pSizeRead
);
errno_t _cgetws_s(
   wchar_t *buffer
   size_t numberOfElements,
   size_t *pSizeRead
);
template <size_t size>
errno_t _cgets_s( 
   char (&buffer)[size],
   size_t *pSizeRead
); // C++ only
template <size_t size>
errno_t _cgetws_s(
   wchar_t (&buffer)[size],
   size_t *pSizeRead
); // C++ only

参数

  • [out] buffer
    数据的存储位置。

  • [in] numberOfElements
    单字节或宽字符的缓冲区的大小，也是要读取的字符的最大数量。

  • [in] pSizeRead
    实际读取的字符数量。

返回值

如果成功，返回值为零；否则，如果失败，返回错误代码。

错误情况

buffer

numberOfElements

pSizeRead

返回

buffer 的内容

NULL

any

any

EINVAL

无

not NULL

零

any

EINVAL

未修改

not NULL

any

NULL

EINVAL

零长度字符串

备注

_cgets_s 和 _cgetws_s 从控制台读取字符串，将字符串 (有null 结束符) 复制到buffer。 _cgetws_s 是函数的宽字符版本；除字符大小外，这两个函数行为相同。 要读取的字符串的最大大小作为 numberOfElements 参数传入。 此大小应包括额外的终止 null 字符。 读取的字符的实际数目在 pSizeRead中。

如果错误发生在操作或在验证参数期间，则调用无效参数的处理程序，如 参数验证 所述。 如果允许继续执行，将 EINVAL 设置为 errno，并返回EINVAL。

在 C++ 中，重载模板简化这些函数的使用；重载可以自动推导出缓冲区长度 ，不再需要指定大小参数，并且它们可以自动用以更新、更安全的对应物替换旧的、不安全的函数。 有关更多信息，请参见安全模板重载。

一般文本例程映射

Tchar.h 例程

未定义 _UNICODE 和 _MBCS

已定义 _MBCS

已定义 _UNICODE

_cgetts_s

_cgets_s

_cgets_s

_cgetws_s

要求

例程

必需的标头

_cgets_s

<conio.h>

_cgetws_s

<conio.h> 或 <wchar.h>

有关更多兼容性信息，请参见兼容性。

.NET Framework 等效项

不适用。若要调用标准 C 函数，请使用 PInvoke。有关详细信息，请参阅平台调用示例。

请参见

参考

控制台和端口 I/O

_getch、_getwch