fscanf_s, _fscanf_s_l, fwscanf_s, _fwscanf_s_l

Artigo
06/09/2015

Lê dados formatados de um fluxo. Essas versões de fscanf, _fscanf_l, fwscanf, _fwscanf_l têm aprimoramentos de segurança, como descrito em Recursos de segurança no CRT.

int fscanf_s( 
   FILE *stream,
   const char *format [,
   argument ]... 
);
int _fscanf_s_l( 
   FILE *stream,
   const char *format,
   locale_t locale [,
   argument ]... 
);
int fwscanf_s( 
   FILE *stream,
   const wchar_t *format [,
   argument ]... 
);
int _fwscanf_s_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 que com êxito são convertidos e atribuídos; o valor de retorno não inclui os campos que foram lidos mas não atribuídos. 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_s e fwscanf_s.

Essas funções validam seus parâmetros. Se stream for um ponteiro de arquivo inválido ou se format for um ponteiro nulo, essas funções invocarão o manipulador de parâmetro inválido, conforme 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_s ler dados da posição atual de stream nos locais são 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_s; consulte Campos de especificação de formato: funções scanf e wscanf para obter uma descrição de format. fwscanf_s é uma versão de ampla caractere de fscanf_s; o argumento de formato a fwscanf_s é uma cadeia de caracteres de ampla caractere. Essas funções se comportam de forma idêntica, se o fluxo for aberto no modo de ANSI. fscanf_s não oferece suporte a entrada de um fluxo de UNICODE.

A principal diferença entre as funções mais seguras (que possuem o sufixo de _s) e as outras versões é que as funções mais seguras requerem o tamanho em caracteres de cada c, de C, de s, de S, e que o campo de tipo [ seja passado como um argumento imediatamente após a variável. Para obter mais informações, consulte scanf_s, _scanf_s_l, wscanf_s, _wscanf_s_l e Especificação de largura scanf Width.

Dica

O parâmetro de tamanho é do tipo unsigned, e não size_t.

As versões dessas funções que têm o sufixo de _l são idênticas a qual delass usam o parâmetro de localidade que é passado em vez de localidade do thread atual.

Mapeamentos da rotina de texto genérico

Rotina TCHAR.H	_UNICODE & _MBCS não definido	_MBCS definido	_UNICODE definido
_ftscanf_s	fscanf_s	fscanf_s	fwscanf_s
_ftscanf_s_l	_fscanf_s_l	_fscanf_s_l	_fwscanf_s_l

Requisitos

Função	Cabeçalho necessário
fscanf_s, _fscanf_s_l	<stdio.h>
fwscanf_s, _fwscanf_s_l	<stdio.h> ou <wchar.h>

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

Exemplo

// crt_fscanf_s.c
// This program writes formatted
// data to a file. It then uses fscanf to
// read the various data back from the file.
 
#include <stdio.h>
#include <stdlib.h>

FILE *stream;

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

   errno_t err = fopen_s( &stream, "fscanf.out", "w+" );
   if( err )
      printf_s( "The file fscanf.out was not opened\n" );
   else
   {
      fprintf_s( stream, "%s %ld %f%c", "a-string", 
               65000, 3.14159, 'x' );
      // Set pointer to beginning of file:
      fseek( stream, 0L, SEEK_SET );

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

      fscanf_s( stream, "%f", &fp );
      fscanf_s( stream, "%c", &c, 1 );

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

      fclose( stream );
   }
}