fgets, fgetws

Artículo
06/09/2015

Obtenga una cadena de una secuencia.

char *fgets( 
   char *str,
   int n,
   FILE *stream 
);
wchar_t *fgetws( 
   wchar_t *str,
   int n,
   FILE *stream 
);

Parámetros

str
Ubicación de almacenamiento de los datos.
n
Número máximo de caracteres para leer.
stream
Puntero a la estructura FILE.

Valor devuelto

Cada una de estas funciones devuelve str. NULL se devuelve para indicar un error o una condición final de archivo. Utilice feof o ferror para determinar si se ha producido un error. Si str o stream es un puntero NULL, o n es menor o igual que cero, esta función invoca el controlador no válido de parámetro, tal y como se describe en Validación de parámetros. Si la ejecución puede continuar, errno se establece en EINVAL y la función devuelve NULL.

Vea _doserrno, errno, _sys_errlist y _sys_nerr para obtener más información sobre estos y otros códigos de error.

Comentarios

La función de fgets lee una cadena de argumento de stream de entrada y la almacena en str. fgets lee los caracteres de la secuencia actual colocar a e incluir el primer carácter de nueva línea, al final de la secuencia, o hasta la lectura del número de caracteres es igual a n – 1, lo que encuentre primero. El resultado almacenado en str se anexa con un carácter nulo. El carácter de nueva línea, si se lee, se incluye en la cadena.

fgetws es una versión con caracteres anchos de fgets.

fgetws lee el argumento str de carácter ancho como una cadena de multibyte- carácter o cadena de caracteres como si stream está abierta en modo de texto o modo binario, respectivamente. Para obtener más información sobre el uso de los modos de texto y binario en E/S de flujos Unicode y multibyte, vea E/S de archivo de modo de texto y binario y E/S de flujos Unicode en los modos de texto y binario.

Asignaciones de rutina de texto genérico

Rutina TCHAR.H	_UNICODE y _MBCS no definidos	_MBCS definido	_UNICODE definido
_fgetts	fgets	fgets	fgetws

Requisitos

Función	Encabezado necesario
fgets	<stdio.h>
fgetws	<stdio.h> o <wchar.h>

Para obtener información adicional de compatibilidad, vea Compatibilidad en la Introducción.

Ejemplo

// crt_fgets.c
// This program uses fgets to display
// a line from a file on the screen.
//

#include <stdio.h>

int main( void )
{
   FILE *stream;
   char line[100];

   if( fopen_s( &stream, "crt_fgets.txt", "r" ) == 0 )
   {
      if( fgets( line, 100, stream ) == NULL)
         printf( "fgets error\n" );
      else
         printf( "%s", line);
      fclose( stream );
   }
}