fscanf

(PHP 4 >= 4.0.1, PHP 5, PHP 7, PHP 8)

fscanfAnaliza un archivo según un formato

Descripción

fscanf(resource $stream, string $format, mixed &...$vars): array|int|false|null

La función fscanf() es similar a la función sscanf(), excepto que toma un archivo como entrada, representado por el recurso stream e interpreta la entrada según el formato format especificado.

Todos los caracteres en blanco de la cadena de formato corresponden a tantos espacios en el flujo de entrada. Esto significa que una tabulación (\t) en la cadena de formato puede reemplazar un espacio simple en el flujo de entrada.

Cada llamada a la función fscanf() lee una línea del archivo.

Parámetros

stream

Un puntero del sistema de archivos de tipo resource que es habitualmente creado utilizando la función fopen().

format

El formato interpretado para string se describe en la documentación de la sprintf() con las siguientes diferencias:

  • La función no tiene en cuenta el contexto local.
  • F, g, G y b no son soportados.
  • D representa un número decimal.
  • i representa un número entero con detección de base.
  • n representa el número de caracteres tratados hasta este punto.
  • s detiene la lectura en cada carácter de espacio.
  • * en lugar de argnum$ elimina la asignación de esta especificación de conversión.

vars

Los valores opcionales a asignar.

Valores devueltos

Si solo se pasan 2 argumentos a la función, el valor analizado será devuelto en forma de un array. Si se pasan argumentos opcionales, la función devolverá el número de valores asignados. Los argumentos opcionales deben ser pasados por referencia.

Si se esperan más subcadenas en el format de las disponibles en string, null será devuelto. En otros casos de error, false será devuelto.

Ejemplos

Ejemplo #1 Ejemplo con fscanf()

<?php
$handle
= fopen("users.txt", "r");
while (
$userinfo = fscanf($handle, "%s\t%s\t%s\n")) {
list (
$name, $profession, $countrycode) = $userinfo;
//... procesamiento de datos
}
fclose($handle);
?>

Ejemplo #2 Contenido del archivo users.txt

javier  argonaut        pe
hiroshi sculptor        jp
robert  slacker us
luigi   florist it

Ver también

  • fread() - Lectura del archivo en modo binario
  • fgets() - Recupera la línea actual a partir de la posición del puntero de archivo
  • fgetss() - Obtiene un línea desde un puntero a un archivo y elimina las etiquetas HTML
  • sscanf() - Analiza una cadena utilizando un formato
  • printf() - Muestra una string formateada
  • sprintf() - Devuelve una string formateada