Namespaces
Variants

    wscanf, fwscanf, swscanf, wscanf_s, fwscanf_s, swscanf_s

    De es.cppreference.net
    < c | io
     
    C
     
    Entrada/salida de archivos
    Tipos y objetos
            
    Funciones
    Acceso a archivos
    (C11)
    (C11)  
    (C95)
    Entrada/salida sin formato
    (C95)(C95)
    (C95)
    (C95)(C95)
    (C95)
    (C95)
    (C95)
    (C95)

    Entrada formateada
    (C99)(C99)(C99)(C11)(C11)(C11)
    (C99)(C99)(C99)(C11)(C11)(C11)  
    Entrada/salida directa
    Salida formateada
    Posicionamiento de archivos
    Manejo de errores
    Operaciones sobre archivos
     
    Definido en el encabezado <wchar.h> 
    int wscanf( const wchar_t* format, ... );
    		(1) (desde C95)
    (hasta C99)    		 
    int wscanf( const wchar_t* restrict format, ... );
    		(desde C99) 
    int fwscanf( FILE* stream, const wchar_t* format, ... );
    		(2) (desde C95)
    (hasta C99)    		 
    int fwscanf( FILE* restrict stream,
             const wchar_t* restrict format, ... );
    		(desde C99) 
    int swscanf( const wchar_t* buffer, const wchar_t* format, ... );
    		(3) (desde C95)
    (hasta C99)    		 
    int swscanf( const wchar_t* restrict buffer,
             const wchar_t* restrict format, ... );
    		(desde C99) 
    int wscanf_s( const wchar_t* restrict format, ...);
    		(4) (desde C11) 
    int fwscanf_s( FILE* restrict stream,
               const wchar_t* restrict format, ...);
    		(5) (desde C11) 
    int swscanf_s( const wchar_t* restrict s,
               const wchar_t* restrict format, ...);
    		(6) (desde C11)

    Lee datos de una variedad de fuentes, los interpreta de acuerdo con format y almacena los resultados en ubicaciones dadas.

    1) Lee los datos de stdin.
    2) Lee los datos del flujo de archivo stream.
    3) Lee los datos de la cadena ancha terminada en nulo buffer. Alcanzar el final de la cadena es equivalente a alcanzar la condición de fin de archivo para fwscanf
    4-6) Igual que (1-3), excepto que los especificadores de conversión %c, %s y %[ esperan cada uno dos argumentos (el puntero habitual y un valor de tipo rsize_t que indica el tamaño del arreglo receptor, que puede ser 1 cuando se lee con %lc en un carácter ancho único) y excepto que los siguientes errores se detectan en tiempo de ejecución y llaman a la función manejador de restricción actualmente instalada:
    • cualquiera de los argumentos de tipo puntero es un puntero nulo
    • format, stream o buffer es un puntero nulo
    • el número de caracteres que se escribirían por %c, %s o %[, más el carácter nulo de terminación, excedería el segundo argumento (rsize_t) proporcionado para cada uno de esos especificadores de conversión
    • opcionalmente, cualquier otro error detectable, como un especificador de conversión desconocido
    Como todas las funciones con verificación de límites, wscanf_s, fwscanf_s y swscanf_s solo se garantiza que estén disponibles si __STDC_LIB_EXT1__ está definido por la implementación y si el usuario define __STDC_WANT_LIB_EXT1__ como la constante entera 1 antes de incluir <wchar.h>.

    Parámetros

    stream - flujo de archivo de entrada desde el que leer
    buffer - puntero a una cadena ancha terminada en nulo desde la que leer
    format - puntero a una cadena ancha terminada en nulo que especifica cómo leer la entrada
    ... - argumentos receptores.


    La cadena format consiste en

    • caracteres anchos que no son espacio en blanco excepto %: cada uno de esos caracteres en la cadena de formato consume exactamente un carácter idéntico del flujo de entrada, o causa que la función falle si el siguiente carácter en el flujo no es igual.
    • caracteres de espacio en blanco: cualquier carácter de espacio en blanco individual en la cadena de formato consume todos los caracteres de espacio en blanco consecutivos disponibles de la entrada (determinado como si se llamara a iswspace en un bucle). Note que no hay diferencia entre "\n", " ", "\t\t" u otros espacios en blanco en la cadena de formato.
    • especificaciones de conversión. Cada especificación de conversión tiene el siguiente formato:
    • carácter introductorio % (opcional)
    • carácter de supresión de asignación (opcional). Si esta opción está presente, la función no asigna el resultado de la conversión a ningún argumento receptor.*(opcional)
    • número entero (mayor que cero) que especifica el ancho de campo máximo, es decir, el número máximo de caracteres que la función puede consumir al realizar la conversión especificada por la especificación de conversión actual. Note que y %s pueden causar desbordamiento del búfer si no se proporciona el ancho.%[(opcional)
    • modificador de longitud que especifica el tamaño del argumento receptor, es decir, el tipo de destino real. Esto afecta la precisión de la conversión y las reglas de desbordamiento. El tipo de destino predeterminado es diferente para cada tipo de conversión (ver tabla a continuación).especificador de formato de conversión.
    • Los siguientes especificadores de formato están disponibles:

    Especificador

    de conversión
    Explicación     		Tipo de argumento esperado
    Modificador de Longitud→
    ninguno hh h Solo disponible desde C99→ l ll j z t L
    Sí Sí Sí Sí Sí Coincide con literal
    %
    .%N/A
    		 N/A N/A N/A N/A N/A N/A N/A N/A N/A
    c

    Coincide con un carácter o una secuencia de caracteres.

    • Si se usa un especificador de ancho, coincide exactamente con ancho caracteres anchos (el argumento debe ser un puntero a un arreglo con suficiente espacio).
    • A diferencia de %s y %[, no agrega el carácter nulo al arreglo.
    		 N/A N/A
    char*
    wchar_t*
    		 N/A N/A N/A N/A N/A
    s

    Coincide con una secuencia de caracteres que no son espacios en blanco (una cadena).

    • Si se usa especificador de ancho, coincide hasta ancho caracteres o hasta el primer carácter de espacio en blanco, lo que ocurra primero.
    • Siempre almacena un carácter nulo además de los caracteres coincidentes (por lo que el arreglo argumento debe tener espacio para al menos ancho+1 caracteres).
    [conjunto ]

    Coincide con una secuencia no vacía de caracteres del conjunto de caracteres.

    • Si el primer carácter del conjunto es ^, entonces se coinciden todos los caracteres que no están en el conjunto.
    • Si el conjunto comienza con ] o ^] entonces el carácter ] también se incluye en el conjunto.
    • Está definido por la implementación si el carácter - en una posición no inicial en el conjunto de exploración puede indicar un rango, como en [0-9].
    • Si se usa especificador de ancho, coincide solo hasta ancho.
    • Siempre almacena un carácter nulo además de los caracteres coincidentes (por lo que el arreglo argumento debe tener espacio para al menos ancho+1 caracteres).
    d

    Coincide con un entero decimal.

    • El formato del número es el mismo que el esperado por wcstol con el valor 10 para el argumento base.
    signed char* o unsigned char*
    signed short* o unsigned short*
    signed int* o unsigned int*
    signed long* o unsigned long*
    signed long long* o unsigned long long*
    intmax_t* o uintmax_t*
    size_t*
    ptrdiff_t*
    		 N/A
    b (C23)

    Coincide con un entero binario sin signo.

    • El formato del número es el mismo que el esperado por wcstoul con el valor 2 para el argumento base.
    i

    Coincide con un entero.

    • El formato del número es el mismo que el esperado por wcstol con el valor 0 para el argumento base (la base se determina por los primeros caracteres analizados).
    u

    Coincide con un entero decimal sin signo.

    • El formato del número es el mismo que el esperado por wcstoul con el valor 10 para el argumento base.
    o

    Coincide con un entero octal sin signo.

    • El formato del número es el mismo que el esperado por wcstoul con el valor 8 para el argumento base.
    x
    X

    Coincide con un entero hexadecimal sin signo.

    • El formato del número es el mismo que el esperado por wcstoul con el valor 16 para el argumento base.
    n

    Devuelve el número de caracteres leídos hasta ahora.

    • No se consume entrada. No incrementa el contador de asignación.
    • Si el especificador tiene el operador de supresión de asignación definido, el comportamiento no está definido.
    a (C99)
    A (C99)
    e
    E
    f
    F (C99)
    g
    G

    Coincide con un número de punto flotante.

    • El formato del número es el mismo que el esperado por wcstof.
    		 N/A N/A
    float*
    double*
    		 N/A N/A N/A N/A
    long double*
    p

    Coincide con una secuencia de caracteres definida por la implementación que define un puntero.

    • printfLa familia de funciones %p debe producir la misma secuencia usando el especificador de formato
    		. N/A
    void**
    		 N/A N/A N/A N/A N/A N/A
    Notas

    Para cada especificador de conversión que no sea n, la secuencia más larga de caracteres de entrada que no excede ningún ancho de campo especificado y que o es exactamente lo que espera el especificador de conversión o es un prefijo de una secuencia que esperaría, es lo que se consume del flujo. El primer carácter, si lo hay, después de esta secuencia consumida permanece sin leer. Si la secuencia consumida tiene longitud cero o si la secuencia consumida no se puede convertir como se especificó anteriormente, ocurre un error de coincidencia a menos que el fin de archivo, un error de codificación o un error de lectura impidan la entrada del flujo, en cuyo caso es un error de entrada.

    Excepto para el especificador %, el elemento de entrada (o, para %n, el recuento de caracteres de entrada) primero se convierte a un tipo apropiado para el especificador de conversión. A menos que se haya suprimido la asignación con *, el resultado de la conversión se escribe en el objeto apuntado por el siguiente argumento que aún no se haya escrito. Si este objeto no tiene un tipo apropiado, o si el resultado de la conversión no se puede representar en el objeto, el comportamiento no está definido.

    Todos los especificadores de conversión que no sean [, c y n consumen y descartan todos los caracteres de espacio en blanco iniciales (determinado como si se llamara a iswspace) antes de intentar analizar la entrada. Estos caracteres consumidos no cuentan para el ancho de campo máximo especificado.

    Si el especificador de longitud l no se usa, los especificadores de conversión c, s y [ realizan la conversión de caracteres anchos a multibyte como si se llamara a wcrtomb con un objeto mbstate_t inicializado a cero antes de que se convierta el primer carácter.

    Los especificadores de conversión s y [ siempre almacenan el terminador nulo además de los caracteres coincidentes. El tamaño del arreglo de destino debe ser al menos uno mayor que el ancho de campo especificado. El uso de %s o %[, sin especificar el tamaño del arreglo de destino, es tan inseguro como gets.

    Los especificadores de conversión correctos para los tipos enteros de ancho fijo (int8_t, etc.) se definen en el encabezado <inttypes.h> (aunque SCNdMAX, SCNuMAX, etc. son sinónimos de %jd, %ju, etc.).

    Hay un punto de secuencia después de la acción de cada especificador de conversión; esto permite almacenar múltiples campos en la misma variable "sumidero".

    Al analizar un valor de punto flotante incompleto que termina en el exponente sin dígitos, como analizar "100er" con el especificador de conversión %f, la secuencia "100e" (el prefijo más largo de un número de punto flotante posiblemente válido) se consume, resultando en un error de coincidencia (la secuencia consumida no se puede convertir a un número de punto flotante), con "r" restante. Algunas implementaciones existentes no siguen esta regla y retroceden para consumir solo "100", dejando "er", por ejemplo, error glibc 1765.

    Si una especificación de conversión no es válida, el comportamiento no está definido.

    Valor de retorno

    1-3) Número de argumentos receptores asignados con éxito, o EOF si ocurre un error de lectura antes de que se asigne el primer argumento receptor.
    4-6) Igual que (1-3), excepto que EOF también se devuelve si hay una violación de restricción en tiempo de ejecución.

    Ejemplo

    Ejecutar este código
    #include <stdio.h>
#include <string.h>
#include <wchar.h>

#define NUM_VARS   3
#define ERR_READ   2
#define ERR_WRITE  3

int main(void)
{
    wchar_t state[64];
    wchar_t capital[64];
    unsigned int population = 0;
    int elevation = 0;
    int age = 0;
    float pi = 0;

#if INTERACTIVE_MODE
    wprintf(L"Enter state, age, and pi value: ");
    if (wscanf(L"%ls%d%f", state, &age, &pi) != NUM_VARS)
    {
        fprintf(stderr, "Error reading input.\n");
        return ERR_READ;
    }
#else
    wchar_t* input = L"California 170 3.141592";
    if (swscanf(input, L"%ls%d%f", state, &age, &pi) != NUM_VARS)
    {
        fprintf(stderr, "Error reading input.\n");
        return ERR_READ;
    }
#endif
    wprintf(L"State: %ls\nAge  : %d years\nPi   : %.5f\n\n", state, age, pi);

    FILE* fp = tmpfile();
    if (fp)
    {
        // write some data to temp file
        if (!fwprintf(fp, L"Mississippi Jackson 420000 807"))
        {
            fprintf(stderr, "Error writing to file.\n");
            fclose(fp);
            return ERR_WRITE;
        }
        // rewind file pointer
        rewind(fp);

        // read data into variables
        fwscanf(fp, L"%ls%ls%u%d", state, capital, &population, &elevation);
        wprintf(L"State  : %ls\nCapital: %ls\nJackson population (in 2020): %u\n"
                L"Highest elevation: %dft\n",
                state, capital, population, elevation);
        fclose(fp);
    }
}

    Posible salida: 

    State: California
Age  : 170 years
Pi   : 3.14159

State  : Mississippi
Capital: Jackson
Jackson population (in 2020): 420000
Highest elevation: 807ft

    Referencias

    • Estándar C23 (ISO/IEC 9899:2024):
    • 7.29.2.2 La función fwscanf (p: TBD)
    • 7.29.2.4 La función swscanf (p: TBD)
    • 7.29.2.12 La función wscanf (p: TBD)
    • K.3.9.1.2 La función fwscanf_s (p: TBD)
    • K.3.9.1.5 La función swscanf_s (p: TBD)
    • K.3.9.1.14 La función wscanf_s (p: TBD)
    • Estándar C17 (ISO/IEC 9899:2018):
    • 7.29.2.2 La función fwscanf (p: TBD)
    • 7.29.2.4 La función swscanf (p: TBD)
    • 7.29.2.12 La función wscanf (p: TBD)
    • K.3.9.1.2 La función fwscanf_s (p: TBD)
    • K.3.9.1.5 La función swscanf_s (p: TBD)
    • K.3.9.1.14 La función wscanf_s (p: TBD)
    • Estándar C11 (ISO/IEC 9899:2011):
    • 7.29.2.2 La función fwscanf (p: 410-416)
    • 7.29.2.4 La función swscanf (p: 417)
    • 7.29.2.12 La función wscanf (p: 421)
    • K.3.9.1.2 La función fwscanf_s (p: 628-629)
    • K.3.9.1.5 La función swscanf_s (p: 631)
    • K.3.9.1.14 La función wscanf_s (p: 638)
    • Estándar C99 (ISO/IEC 9899:1999):
    • 7.24.2.2 La función fwscanf (p: 356-362)
    • 7.24.2.4 La función swscanf (p: 362)
    • 7.24.2.12 La función wscanf (p: 366-367)

    Véase también

    (C99)(C99)(C99)(C11)(C11)(C11)
    		 lee entrada de caracteres anchos formateada desde stdin, un flujo de archivo
    o un búfer usando una lista de argumentos variable
    (función)
    Documentación de C++ para wscanf, fwscanf, swscanf