fscanf_s, _fscanf_s_l, fwscanf_s, _fwscanf_s_l

Статья
06/09/2015

Чтение форматированных данных из потока. В этих версиях fscanf, _fscanf_l, fwscanf, _fwscanf_l усовершенствована безопасность, как описано в разделе Функции безопасности в CRT.

int fscanf_s( 
   FILE *stream,
   const char *format [,
   argument ]... 
);
int _fscanf_s_l( 
   FILE *stream,
   const char *format,
   locale_t locale [,
   argument ]... 
);
int fwscanf_s( 
   FILE *stream,
   const wchar_t *format [,
   argument ]... 
);
int _fwscanf_s_l( 
   FILE *stream,
   const wchar_t *format,
   locale_t locale [,
   argument ]... 
);

Параметры

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

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

Каждая из этих функций возвращает количество полей, которые успешно преобразуются и назначаются; возвращаемое значение не включает поля, которые были считаны, но не присваиваются. Возвращаемое значение 0 указывает, что поля не были присвоены. При возникновении ошибки или если достигнут конец файлового потока перед первым преобразованием, возвращенное значение EOF для fscanf_s и fwscanf_s.

Эти функции проверяют свои параметры. Если параметр stream или format указывает на файл или на NULL, эти функции вызывают обработчик недопустимого параметра, как описано в разделе Проверка параметров. Если продолжение выполнения разрешено, эти функции возвращают EOF и устанавливают для errno значение EINVAL.

Заметки

Функция fscanf_s считывает данные из текущей позиции в stream в расположения, заданные в argument (если он есть). Каждый argument должен быть указателем на переменную, которая имеет тип, который соответствует спецификатору типа в format. format управляет интерпретацией полей ввода и имеет те же форму и функцию, как и аргумент format для scanf_s; см. раздел Поля спецификации формата. Функции scanf и wscanf для описания format. fwscanf_s - версия fscanf_s для расширенных символов; аргумент формата в fwscanf_s строка расширенных символов. Поведение этих функций идентично, если поток открыт в режиме ANSI-совместимости. fscanf_s сейчас не поддерживает входные данные из потока ЮНИКОДА.

Основное различие между более безопасными функциями (которые имеют суффикс _s) и другими версиями состоит в том, что более безопасные функции требуют размер в символах каждого поля типа c, C, s, S и [, который должен передаваться в качестве аргумента сразу же за переменной. Дополнительные сведения см. в разделах scanf_s, _scanf_s_l, wscanf_s, _wscanf_s_l и Спецификация ширины scanf.

Примечание

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

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

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

Подпрограмма TCHAR.H	_UNICODE & _MBCS не определены	_MBCS определено	_UNICODE определено
_ftscanf_s	fscanf_s	fscanf_s	fwscanf_s
_ftscanf_s_l	_fscanf_s_l	_fscanf_s_l	_fwscanf_s_l

Требования

Функция	Обязательный заголовок
fscanf_s, _fscanf_s_l	<stdio.h>
fwscanf_s, _fwscanf_s_l	<stdio.h> или <wchar.h>

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

Пример

// crt_fscanf_s.c
// This program writes formatted
// data to a file. It then uses fscanf to
// read the various data back from the file.
 
#include <stdio.h>
#include <stdlib.h>

FILE *stream;

int main( void )
{
   long l;
   float fp;
   char s[81];
   char c;

   errno_t err = fopen_s( &stream, "fscanf.out", "w+" );
   if( err )
      printf_s( "The file fscanf.out was not opened\n" );
   else
   {
      fprintf_s( stream, "%s %ld %f%c", "a-string", 
               65000, 3.14159, 'x' );
      // Set pointer to beginning of file:
      fseek( stream, 0L, SEEK_SET );

      // Read data back from file:
      fscanf_s( stream, "%s", s, _countof(s) );
      fscanf_s( stream, "%ld", &l );

      fscanf_s( stream, "%f", &fp );
      fscanf_s( stream, "%c", &c, 1 );

      // Output data read:
      printf( "%s\n", s );
      printf( "%ld\n", l );
      printf( "%f\n", fp );
      printf( "%c\n", c );

      fclose( stream );
   }
}