scanf_s, _scanf_s_l, wscanf_s, _wscanf_s_l

Статья
06/09/2015

Чтение форматированных данных из стандартного входного потока. В этих версиях scanf, _scanf_l, wscanf, _wscanf_l усовершенствована безопасность, как описано в разделе Функции безопасности в CRT.

int scanf_s(
   const char *format [,
   argument]... 
);
int _scanf_s_l(
   const char *format,
   locale_t locale [,
   argument]... 
);
int wscanf_s(
   const wchar_t *format [,
   argument]... 
);
int _wscanf_s_l(
   const wchar_t *format,
   locale_t locale [,
   argument]... 
);

Параметры

format
Строка управления форматом.
argument
Необязательные аргументы.
locale
Используемый языковой стандарт.

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

Возвращает число успешно преобразованных и назначенных полей; возвращаемое значение не включает поля, которые были считаны, но не назначены. Возвращаемое значение 0 указывает, что поля не были присвоены. Возвращаемое значение равно EOF в случае ошибки или если при первой попытке считать символ встречается символ конца файла или конца строки. Если параметр format указывает на NULL, вызывается обработчик недопустимого параметра, как описано в разделе Проверка параметров. Если продолжение выполнения разрешено, scanf_s и wscanf_s возвращают EOF и устанавливают для errno значение EINVAL.

Сведения об этих и других кодах ошибок см. в разделе errno, _doserrno, _sys_errlist, and _sys_nerr.

Заметки

Функция scanf_s считывает данные из стандартного входного потока stdin и записывает данные в расположение, указанное argument. Каждый argument должен быть указателем на переменную, которая имеет тип, который соответствует спецификатору типа в format. Если копирование производится между перекрывающимися строками, поведение не определено.

wscanf_s — двухбайтовая версия scanf_s; аргумент format для wscanf_s - строка двухбайтовых знаков. Поведение wscanf_s и scanf_s идентично, если поток открыт в режиме ANSI-совместимости. scanf_s сейчас не поддерживает входные данные из потока ЮНИКОДА.

Версии этих функций, имеющие суффикс _l, идентичны за исключением того, что они используют переданный параметр языкового стандарта вместо языкового стандарта текущего потока.

В отличие от scanf и wscanf, scanf_s и wscanf_s требуют, чтобы размер буфера был задан для всех входных параметров типа c, C, s, S или наборов строковых элементов управления, заключенных в []. Размер буфера в символах передается в качестве дополнительного параметра сразу после указателя в буфер или переменную. Например, при чтении строки, размер буфера для этой строки передается следующим образом:

char s[10];

scanf_s("%9s", s, _countof(s)); // buffer size is 10, width specification is 9

Размер буфера включает конечное значение NULL. Можно использовать поле спецификации ширины, чтобы гарантировать, что считываемый токен поместится в буфер. Если не используется поле спецификации ширины, и токен считанный слишком велик чтобы влезть в буфер, ничего не записывается в этот буфер.

Примечание

Параметр размера — типа unsigned, а не size_t.

В следующем примере показано, что параметр размера буфера описывает максимальное число символов, а не байт. В вызове wscanf_s ширина символов, показанная типом буфера, не соответствует ширине символов, указанной описателем формата.

wchar_t ws[10];
wscanf_s("%9S", ws, _countof(ws));

Описатель формата S показывает использование ширины символов, которая является "противоположной" ширине по умолчанию, которую поддерживает функция. Ширина символов является однобайтовой, но функция поддерживает двухбайтовые символы. В данном примере демонстрируется чтение в строку до 9 однобайтовых символов и помещение их в двухбайтовый буфер символов. Символы обрабатываются как однобайтовые значения; первые два символа хранятся в ws[0], вторые два хранятся в ws[1] и т. д.

В случае символов, отдельный символ может быть прочитан следующим образом:

char c;

scanf_s("%c", &c, 1);

При чтении нескольких символов для строк, незавершенных null, целые числа используются как спецификация ширины и размер буфера.

char c[4];

scanf_s("%4c", &c, _countof(c)); // not null terminated

Для получения дополнительной информации см. Спецификация ширины scanf.

Универсальное текстовое сопоставление функций

Подпрограмма TCHAR.H	_UNICODE & _MBCS не определены	_MBCS определено	_UNICODE определено
_tscanf_s	scanf_s	scanf_s	wscanf_s
_tscanf_s_l	_scanf_s_l	_scanf_s_l	_wscanf_s_l

Для получения дополнительной информации см. Поля спецификации формата. Функции scanf и wscanf.

Требования

Подпрограмма	Обязательный заголовок
scanf_s, _scanf_s_l	<stdio.h>
wscanf_s, _wscanf_s_l	<stdio.h> или <wchar.h>

Консоль не поддерживается в приложениях Магазин Windows. Стандартные дескрипторы потока, связанные с консолью — stdin, stdout и stderr — необходимо перенаправить, чтобы функции C времени выполнения могли использовать их в приложениях Магазин Windows. Дополнительные сведения о совместимости см. в разделе Совместимость.

Пример

// crt_scanf_s.c
// This program uses the scanf_s and wscanf_s functions
// to read formatted input.
  
#include <stdio.h>
#include <stdlib.h>

int main( void )
{
   int      i,
            result;
   float    fp;
   char     c,
            s[80];
   wchar_t  wc,
            ws[80];

   result = scanf_s( "%d %f %c %C %s %S", &i, &fp, &c, 1,
                     &wc, 1, s, _countof(s), ws, _countof(ws) );
   printf( "The number of fields input is %d\n", result );
   printf( "The contents are: %d %f %c %C %s %S\n", i, fp, c,
           wc, s, ws);
   result = wscanf_s( L"%d %f %hc %lc %S %ls", &i, &fp, &c, 2,
                      &wc, 1, s, _countof(s), ws, _countof(ws) );
   wprintf( L"The number of fields input is %d\n", result );
   wprintf( L"The contents are: %d %f %C %c %hs %s\n", i, fp,
            c, wc, s, ws);
}

Эта программа создает следующие выходные данные для этого ввода:

71 98.6 h z Byte characters

36 92.3 y n Wide characters