Namespaces
Variants

std:: vscanf, std:: vfscanf, std:: vsscanf

From cppreference.net
< cpp ‎ | io ‎ | c
C++
Input/output library
C-style I/O
Определено в заголовочном файле <cstdio>
int vscanf ( const char * format, std :: va_list vlist ) ;
(1) (начиная с C++11)
int vfscanf ( std:: FILE * stream, const char * format, std :: va_list vlist ) ;
(2) (начиная с C++11)
int vsscanf ( const char * buffer, const char * format, std :: va_list vlist ) ;
(3) (начиная с C++11)

Считывает данные из различных источников, интерпретирует их в соответствии с format и сохраняет результаты в места, определённые vlist .

1) Считывает данные из stdin .
2) Считывает данные из файлового потока stream .
3) Считывает данные из строки символов с нулевым завершением buffer .

Содержание

Параметры

stream - входной файловый поток для чтения
buffer - указатель на строку символов с нулевым завершителем для чтения
format - указатель на строку символов с нулевым завершителем, определяющую способ чтения ввода
vlist - список переменных аргументов, содержащий принимающие аргументы.


Строка format состоит из

  • не-пробельные многобайтовые символы, кроме % : каждый такой символ в строке формата потребляет ровно один идентичный символ из входного потока, или вызывает сбой функции, если следующий символ в потоке не совпадает.
  • пробельные символы: любой одиночный пробельный символ в строке формата потребляет все доступные последовательные пробельные символы из ввода (определяется как при многократном вызове std::isspace ). Заметьте, что нет разницы между " \n " , " " , " \t \t " , или другими пробельными символами в строке формата.
  • спецификации преобразования. Каждая спецификация преобразования имеет следующий формат:
  • вводный % символ.
  • (необязательный) символ подавления присваивания * . Если присутствует эта опция, функция не присваивает результат преобразования какому-либо принимающему аргументу.
  • (необязательно) целое число (больше нуля), которое указывает максимальную ширину поля , то есть максимальное количество символов, которое функция может обработать при выполнении преобразования, указанного текущей спецификацией преобразования. Обратите внимание, что % s и % [ могут привести к переполнению буфера, если ширина не указана.
  • (необязательный) модификатор длины , который указывает размер принимающего аргумента, то есть фактический тип назначения. Это влияет на точность преобразования и правила переполнения. Тип назначения по умолчанию различается для каждого типа преобразования (см. таблицу ниже).
  • спецификатор формата преобразования.

Доступны следующие спецификаторы формата:

Спецификатор
преобразования 		Объяснение Ожидаемый
тип аргумента
Модификатор длины→ hh h отсутствует l ll j z t L
Доступно только с C++11→ Да Да Да Да Да
%
Соответствует литералу % .
N/A N/A N/A N/A N/A N/A N/A N/A N/A
c

Соответствует символу или последовательности символов .

  • Если используется спецификатор ширины, соответствует ровно width символам (аргумент должен быть указателем на массив с достаточным местом).
  • В отличие от %s и %[, не добавляет нулевой символ в массив.
N/A N/A
char *
wchar_t *
N/A N/A N/A N/A N/A
s

Соответствует последовательности непробельных символов ( строка ).

  • Если используется спецификатор ширины, соответствует до width символов или до первого пробельного символа, в зависимости от того, что наступит раньше.
  • Всегда сохраняет нулевой символ в дополнение к сопоставленным символам (поэтому аргумент-массив должен иметь место как минимум для width+1 символов).
[ set  ]

Сопоставляет непустую последовательность символов из set набора символов.

  • Если первый символ набора - ^ , то сопоставляются все символы, не входящие в набор.
  • Если набор начинается с ] или ^] , то символ ] также включается в набор.
  • Определяется реализацией, может ли символ - в не-начальной позиции в сканирующем наборе указывать на диапазон, как в [0-9] .
  • Если используется спецификатор ширины, сопоставляет только до width .
  • Всегда сохраняет нулевой символ в дополнение к сопоставленным символам (поэтому аргумент-массив должен иметь место как минимум для width+1 символов).
d

Соответствует десятичному целому числу .

  • Формат числа совпадает с ожидаемым функцией std::strtol со значением 10 для аргумента base .
signed char * или unsigned char *
signed short * или unsigned short *
signed int * или unsigned int *
signed long * или unsigned long *
signed long long * или unsigned long long *
Н/Д
i

Соответствует целому числу .

  • Формат числа совпадает с ожидаемым функцией std::strtol со значением ​ 0 ​ для аргумента base (основание системы счисления определяется по первым разобранным символам).
u

Соответствует беззнаковому десятичному целому числу .

  • Формат числа совпадает с ожидаемым функцией std::strtoul со значением 10 для аргумента base .
o

Соответствует беззнаковому восьмеричному целому числу .

  • Формат числа совпадает с ожидаемым функцией std::strtoul со значением 8 для аргумента base .
x
X

Соответствует беззнаковому шестнадцатеричному целому числу .

  • Формат числа совпадает с ожидаемым функцией std::strtoul со значением 16 для аргумента base .
n

Возвращает количество символов, прочитанных на данный момент .

  • Ввод не потребляется. Не увеличивает счетчик присваиваний.
  • Если для спецификатора определен оператор подавления присваивания, поведение не определено.
a (C++11)
A (C++11)
e
E
f
F (C++11)
g
G

Соответствует числу с плавающей запятой .

  • Формат числа такой же, как ожидается в std::strtof .
N/A N/A
float *
double *
N/A N/A N/A N/A
long double *
p

Соответствует определяемой реализацией последовательности символов, определяющей указатель .

  • printf семейство функций должно производить ту же последовательность с использованием %p спецификатора формата.
N/A N/A
void **
N/A N/A N/A N/A N/A N/A
Примечания

Для каждого спецификатора преобразования, кроме n , из потока считывается самая длинная последовательность входных символов, которая не превышает указанную ширину поля и которая либо точно соответствует ожиданиям спецификатора преобразования, либо является префиксом последовательности, которую он ожидает. Первый символ, если таковой имеется, после этой считанной последовательности остается непрочитанным. Если длина считанной последовательности равна нулю или если считанная последовательность не может быть преобразована как указано выше, происходит ошибка сопоставления, если только конец файла, ошибка кодирования или ошибка чтения не предотвратили ввод из потока, в этом случае это ошибка ввода.

Все спецификаторы преобразования, кроме [ , c , и n , потребляют и отбрасывают все ведущие пробельные символы (определяемые как при вызове std::isspace ) перед попыткой разбора ввода. Эти потребленные символы не учитываются в указанной максимальной ширине поля.

Спецификаторы преобразования lc , ls , и l [ выполняют преобразование многобайтовых символов в широкие, как если бы вызывалась функция std::mbrtowc с объектом std::mbstate_t , инициализированным нулем до преобразования первого символа.

Спецификаторы преобразования s и [ всегда сохраняют нулевой терминатор в дополнение к сопоставленным символам. Размер целевого массива должен быть как минимум на единицу больше указанной ширины поля. Использование % s или % [ без указания размера целевого массива так же небезопасно, как std::gets .

Правильные спецификации преобразования для целочисленных типов фиксированной ширины ( std::int8_t и т.д.) определены в заголовочном файле <cinttypes> (хотя SCNdMAX , SCNuMAX и т.д. являются синонимами для % jd , % ju и т.д.).

Существует точка следования после действия каждого спецификатора преобразования; это позволяет сохранять несколько полей в одну и ту же переменную-приемник.

При разборе неполного значения с плавающей точкой, которое заканчивается экспонентой без цифр, например, разбор "100er" со спецификатором преобразования % f , последовательность "100e" (самый длинный префикс потенциально допустимого числа с плавающей точкой) потребляется, что приводит к ошибке сопоставления (потребленная последовательность не может быть преобразована в число с плавающей точкой), при этом "r" остается. Некоторые существующие реализации не следуют этому правилу и откатываются, потребляя только "100" , оставляя "er" , например, glibc bug 1765 .

Если спецификация преобразования недействительна, поведение не определено.

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

Количество аргументов, успешно прочитанных, или EOF в случае возникновения ошибки.

Примечания

Все эти функции вызывают va_arg как минимум один раз, значение arg становится неопределённым после возврата. Эти функции не вызывают va_end , и это должно быть выполнено вызывающей стороной.

Пример

Запустить этот код 
#include <cstdarg>
#include <cstdio>
#include <iostream>
#include <stdexcept>
void checked_sscanf(int count, const char* buf, const char *fmt, ...)
{
    std::va_list ap;
    va_start(ap, fmt);
    if (std::vsscanf(buf, fmt, ap) != count)
        throw std::runtime_error("parsing error");
    va_end(ap);
}
int main()
{
    try
    {
        int n, m;
        std::cout << "Parsing '1 2'... ";
        checked_sscanf(2, "1 2", "%d %d", &n, &m);
        std::cout << "success\n";
        std::cout << "Parsing '1 a'... ";
        checked_sscanf(2, "1 a", "%d %d", &n, &m);
        std::cout << "success\n";
    }
    catch (const std::exception& e)
    {
        std::cout << e.what() << '\n';
    }
}

Вывод: 

Parsing '1 2'... success
Parsing '1 a'... parsing error

Смотрите также

читает форматированный ввод из stdin , файлового потока или буфера
(функция)
(C++11)
выводит форматированные данные в stdout , файловый поток или буфер
используя список переменных аргументов
(функция)
Документация C для vscanf , vfscanf , vsscanf