fgets, fgetws

Obter uma cadeia de caracteres de um fluxo.

Sintaxe

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

Parâmetros

str
Local de armazenamento de dados.

numChars
O número máximo de caracteres a serem lidos.

stream
Ponteiro para a estrutura FILE.

Valor Retornado

Cada uma dessas funções retorna str. NULL é retornado para indicar um erro ou uma condição de fim de arquivo. Use feof ou ferror para determinar se ocorreu um erro. Se str ou stream é um ponteiro nulo ou numChars é menor ou igual a zero, essa função invoca o manipulador de parâmetro inválido, conforme descrito em Validação do parâmetro. Se a execução tiver permissão para continuar, errno será definido como EINVAL e a função retornará NULL.

Consulte _doserrno, errno, _sys_errliste para _sys_nerr obter mais informações sobre esses e outros códigos de erro.

Comentários

A função fgets lê uma cadeia de caracteres do argumento stream de entrada e o armazena em str. fgets lê caracteres da posição atual do fluxo para e incluindo o primeiro caractere de nova linha, até o final do fluxo ou numChars até que o número de caracteres lidos seja igual a - 1, o que ocorrer primeiro. O resultado armazenado em str é acrescentado com um caractere nulo. O caractere de nova linha, se lido, é incluído na cadeia de caracteres.

fgetws é uma versão de caractere largo de fgets.

fgetws copia o argumento de caractere largo str como uma cadeia de caracteres multibyte ou uma cadeia de caracteres largos, dependendo de stream ser aberto no modo de texto ou no modo binário, respectivamente. Para obter mais informações sobre como usar os modos de texto e binário em Unicode e E/S de fluxo multibyte, consulte E/S de texto e arquivo de modo binário e E/S de fluxo Unicode em modos de texto e binários.

Por padrão, o estado global dessa função tem como escopo o aplicativo. Para alterar isso, consulte Estado global no CRT.

Mapeamentos da rotina de texto genérico

TCHAR.H Rotina _UNICODE&_MBCS não definido _MBCS Definido _UNICODE Definido
_fgetts fgets fgets fgetws

Requisitos

Função Cabeçalho necessário
fgets <stdio.h>
fgetws <stdio.h> ou <wchar.h>

Para obter mais informações sobre compatibilidade, consulte Compatibilidade.

Exemplo

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

#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\numChars" );
      else
         printf( "%s", line);
      fclose( stream );
   }
}

Entrada: crt_fgets.txt

Line one.
Line two.

Saída

Line one.

Consulte também

E/S de fluxo
fputs, fputws
gets, _getws
puts, _putws