fscanf, _fscanf_l, fwscanf, _fwscanf_l

Artigo
06/09/2015

Ler dados formatados de um fluxo. Versões mais seguras dessas funções estão disponíveis; consulte fscanf_s, _fscanf_s_l, fwscanf_s, _fwscanf_s_l.

int fscanf( 
   FILE *stream,
   const char *format [,
   argument ]... 
);
int _fscanf_l( 
   FILE *stream,
   const char *format,
   locale_t locale [,
   argument ]... 
);
int fwscanf( 
   FILE *stream,
   const wchar_t *format [,
   argument ]... 
);
int _fwscanf_l( 
   FILE *stream,
   const wchar_t *format,
   locale_t locale [,
   argument ]... 
);

Parâmetros

stream
Ponteiro a estrutura de FILE .
format
Cadeia de caracteres de controle de formato.
argument
Argumentos opcionais.
locale
A localidade a ser usada.

Valor de retorno

Cada uma dessas funções retorna o número de campos com êxito convertidos e atribuídos; o valor de retorno não inclui os campos que foram lidos mas não atribuído. Um valor de retorno 0 indica que nenhum campo foi atribuído. Se ocorrer um erro ou se o final do fluxo de arquivos for atingido antes da primeira conversão, o valor do retorno será EOF para fscanf e fwscanf.

Essas funções validam seus parâmetros. Se stream ou format são um ponteiro nulo, o parâmetro de manipulador inválido é invocado, como descrito em Validação do parâmetro. Se a execução puder continuar, essas funções retornarão EOF e definirão errno para EINVAL.

Comentários

A função de fscanf ler dados da posição atual de stream em locais dados por argument (se houver). Cada argument deve ser um ponteiro para uma variável de tipo que corresponde a um especificador do tipo em format. format controla a interpretação dos campos de entrada e tem o mesmo formulário e função que o argumento de format para scanf; consulte scanf para obter uma descrição de format*.*

fwscanf é uma versão de caractere largo de fscanf; os argumentos de formato para fwscanf referem-se à cadeia de caracteres ampla. Essas funções se comportam de forma idêntica se o fluxo for aberto no modo de ANSI. fscanf não oferece suporte a entrada de um fluxo de UNICODE.

As versões dessas funções com o sufixo _l são idênticas, exceto que usam o parâmetro de localidade passado em vez da localidade de thread atual.

Mapeamentos da rotina de texto genérico

Rotina TCHAR.H	_UNICODE & _MBCS não definido	_MBCS definido	_UNICODE definido
_ftscanf	fscanf	fscanf	fwscanf
_ftscanf_l	_fscanf_l	_fscanf_l	_fwscanf_l

Para obter mais informações, consulte Formatar campos da especificação – funções de scanf e funções de wscanf.

Requisitos

Função	Cabeçalho necessário
fscanf, _fscanf_l	<stdio.h>
fwscanf, _fwscanf_l	<stdio.h> ou <wchar.h>

Para informações adicionais de compatibilidade, consulte Compatibilidade na Introdução.

Exemplo

// crt_fscanf.c
// compile with: /W3
// This program writes formatted
// data to a file. It then uses fscanf to
// read the various data back from the file.
 
#include <stdio.h>

FILE *stream;

int main( void )
{
   long l;
   float fp;
   char s[81];
   char c;

   if( fopen_s( &stream, "fscanf.out", "w+" ) != 0 )
      printf( "The file fscanf.out was not opened\n" );
   else
   {
      fprintf( stream, "%s %ld %f%c", "a-string", 
               65000, 3.14159, 'x' );
      // Security caution!
      // Beware loading data from a file without confirming its size,
      // as it may lead to a buffer overrun situation.

      // Set pointer to beginning of file:
      fseek( stream, 0L, SEEK_SET );

      // Read data back from file:
      fscanf( stream, "%s", s );   // C4996
      fscanf( stream, "%ld", &l ); // C4996

      fscanf( stream, "%f", &fp ); // C4996
      fscanf( stream, "%c", &c );  // C4996
      // Note: fscanf is deprecated; consider using fscanf_s instead

      // Output data read: 
      printf( "%s\n", s );
      printf( "%ld\n", l );
      printf( "%f\n", fp );
      printf( "%c\n", c );

      fclose( stream );
   }
}