_cgets_s, _cgetws_s
从控件获取个字符字符串。 _cgets 和_cgetws 的这些版本具有安全增强功能,如 CRT中的安全功能所述。
重要
此 API 不能在 Windows 运行时执行的应用程序。有关更多信息,请参见 CRT 函数不支持与 /ZW。
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 |
Return |
buffer内容 |
---|---|---|---|---|
NULL |
any |
any |
EINVAL |
无 |
不是 NULL |
零 |
any |
EINVAL |
不修改 |
不是 NULL |
any |
NULL |
EINVAL |
零长度字符串 |
备注
_cgets_s 和 _cgetws_s 读取个控件的一个字符串并复制该字符串 (具有 null 结束符)。buffer。 _cgetws_s 是函数的宽字符版本;除了字符大小外,这两种功能的行为相同。 要读取的该字符串的最大大小作为 numberOfElements 参数。 此大小应包括终止 null 的多余字符。 读取的字符的实际数目。pSizeRead放置。
如果发生在操作中或在验证参数,参数无效调用处理程序,如 参数验证 所述。 如果执行允许继续,errno 设置为 EINVAL,并 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。有关更多信息,请参见平台调用示例。