_cgets, _cgetws

Возвращает строку символов из консоли. Доступны более безопасные версии этих функций; see _cgets_s, _cgetws_s.

Важно!

Эти функции устарели. Начиная с Visual Studio 2015 они недоступны в CRT. Безопасные версии этих функций, _cgets_s и _cgetws_s, по-прежнему доступны. Дополнительные сведения об этих альтернативных функциях см. в разделе _cgets_s. _cgetws_s

Важно!

Этот API нельзя использовать в приложениях, выполняемых в среде выполнения Windows. Дополнительные сведения: Функции CRT, которые не поддерживаются в приложениях универсальной платформы Windows.

Синтаксис

char *_cgets(
   char *buffer
);
wchar_t *_cgetws(
   wchar_t *buffer
);
template <size_t size>
char *_cgets(
   char (&buffer)[size]
); // C++ only
template <size_t size>
wchar_t *_cgetws(
   wchar_t (&buffer)[size]
); // C++ only

Параметры

buffer
Место хранения данных.

Возвращаемое значение

_cgets и _cgetws возвращают указатель на начало строки, buffer[2]. Если buffer это NULLтак, эти функции вызывают обработчик недопустимых параметров, как описано в разделе "Проверка параметров". Если выполнение может быть продолжено, они возвращают NULL и устанавливают для errno значение EINVAL.

Замечания

Эти функции считывают строку символов из консоли и хранят строку и ее длину в расположении, указанном buffer. Параметр buffer должен указывать на массив символов. Первый элемент массива, buffer[0], должен содержать максимальную длину (в символах) строки для считывания. Массив должен содержать достаточно элементов для хранения строки, завершающего значение NULL ('\0') и 2 дополнительных байта. Функция читает символы до считывания сочетания возврата каретки и перевода строки (CR-LF) или до считывания указанного числа символов. Строка сохраняется начиная с buffer[2]. Когда функция считывает CR-LF, они сохраняет нуль-символ ("\0"). Затем функция сохраняет фактическую длину строки во втором элементе массива, buffer[1].

Так как все клавиши редактирования активны при вызове _cgets или _cgetws в окне консоли, нажатие клавиши F3 повторяет последнюю введенную запись.

В C++ эти функции имеют шаблонные перегрузки, которые вызывают более новые и безопасные аналоги этих функций. Дополнительные сведения см. в разделе "Безопасные перегрузки шаблонов".

По умолчанию глобальное состояние этой функции ограничивается приложением. Чтобы изменить это поведение, см . статью "Глобальное состояние" в CRT.

Сопоставления подпрограмм универсального текста

Подпрограмма Tchar.h	_UNICODE и _MBCS не определен	_MBCS Определенные	_UNICODE Определенные
_cgetts	_cgets	_cgets	_cgetws

Требования

Маршрут	Обязательный заголовок
_cgets	<conio.h>
_cgetws	<conio.h> или <wchar.h>

Дополнительные сведения о совместимости см. в разделе Совместимость.

Пример

// crt_cgets.c
// compile with: /c /W3
// This program creates a buffer and initializes
// the first byte to the size of the buffer. Next, the
// program accepts an input string using _cgets and displays
// the size and text of that string.

#include <conio.h>
#include <stdio.h>
#include <errno.h>

int main( void )
{
   char buffer[83] = { 80 };  // Maximum characters in 1st byte
   char *result;

   printf( "Input line of text, followed by carriage return:\n");

   // Input a line of text:
   result = _cgets( buffer ); // C4996
   // Note: _cgets is deprecated; consider using _cgets_s
   if (!result)
   {
      printf( "An error occurred reading from the console:"
              " error code %d\n", errno);
   }
   else
   {
      printf( "\nLine length = %d\nText = %s\n",
              buffer[1], result );
   }
}

      A line of input.Input line of text, followed by carriage return:
Line Length = 16
Text = A line of input.

См. также

Консоль и порт ввода-вывода
_getch, _getwch