sscanf_s, _sscanf_s_l, swscanf_s, _swscanf_s_l

Artigo
06/09/2015

Lê dados formatados de uma cadeia de caracteres. Essas versões de sscanf, _sscanf_l, swscanf, _swscanf_l têm aprimoramentos de segurança, como descrito em Recursos de segurança no CRT.

int sscanf_s(
   const char *buffer,
   const char *format [,
   argument ] ...
);
int _sscanf_s_l(
   const char *buffer,
   const char *format,
   locale_t locale [,
   argument ] ...
);
int swscanf_s(
   const wchar_t *buffer,
   const wchar_t *format [,
   argument ] ...
);
int _swscanf_s_l(
   const wchar_t *buffer,
   const wchar_t *format,
   locale_t locale [,
   argument ] ...
);

Parâmetros

buffer
Dados armazenados
format
Cadeia de caracteres de controle de formato. Para obter mais informações, consulte Campos de especificação de formato: funções scanf e wscanf.
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. O valor de retorno é EOF para um erro ou se o final da cadeia de caracteres for atingido antes da primeira conversão.

Se buffer ou format são um ponteiro nulo NULL, 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 -1 e definirão errno a EINVAL

Para obter informações sobre esses e outros códigos de erro, consulte errno, _doserrno, _sys_errlist e _sys_nerr.

Comentários

A função de sscanf_s ler dados de buffer no local que é determinado por cada argument. Os argumentos depois que a cadeia de formato especificar ponteiros para variáveis que têm um tipo que corresponde a um especificador do tipo em format. Diferentemente de menos seguro a versão sscanf, um parâmetro de tamanho do buffer é necessário quando você usa os caracteres c, C, s, S, ou conjuntos de campos do tipo de controle de cadeia de caracteres que estão incluídos em []. O tamanho do buffer em caracteres deve ser fornecido como um parâmetro adicional, imediatamente após cada parâmetro que o buffer requer. Por exemplo, se você está lendo em uma cadeia de caracteres, o tamanho do buffer para a cadeia de caracteres é passado como segue:

wchar_t ws[10];

swscanf_s(in_str, L"%9s", ws, _countof(ws)); // buffer size is 10, width specification is 9

O tamanho do buffer inclui a terminação nula. Um campo de especificação de largura pode ser usado para garantir que o símbolo que é lido cabe no buffer. Se nenhum campo de especificação de largura for usado e o token lido for muito grande para caber no buffer, nada será gravado ao buffer.

No caso de caracteres, um único caractere pode ser lido como segue:

wchar_t wc;

swscanf_s(in_str, L"%c", &wc, 1);

Este exemplo lê um único caractere da cadeia de caracteres de entrada e depois dos armazena em um buffer ampla de caracteres. Quando você leia mais caracteres para cadeias de caracteres encerradas não nulos, os números inteiros sem sinal é usado como a especificação de largura e o tamanho do buffer.

char c[4];

sscanf_s(input, "%4c", &c, _countof(c)); // not null terminated

Para obter mais informações, consulte scanf_s, _scanf_s_l, wscanf_s, _wscanf_s_l e Caracteres de campo de tipo scanf.

Dica

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

O argumento format controla a interpretação dos campos de entrada e tem o mesmo formulário e função que o argumento format para a função scanf_s. Se ocorrer cópia entre cadeias de caracteres que se sobrepõem, o comportamento será indefinido.

swscanf_s é uma versão de ampla caractere de sscanf_s; que os argumentos a swscanf_s são cadeias de caracteres de ampla caractere. O sscanf_s não trata caracteres hexadecimais de multibyte. O swscanf_s não trata caracteres hexadecimais de Unicode largos ou de "zona de compatibilidade". Caso contrário, swscanf_s e sscanf_s se comportam de forma idêntica.

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
_stscanf_s	sscanf_s	sscanf_s	swscanf_s
_stscanf_s_l	_sscanf_s_l	_sscanf_s_l	_swscanf_s_l

Requisitos

Rotina	Cabeçalho necessário
sscanf_s, _sscanf_s_l	<stdio.h>
swscanf_s, _swscanf_s_l	<stdio.h> ou <wchar.h>

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

Exemplo

// crt_sscanf_s.c
// This program uses sscanf_s to read data items
// from a string named tokenstring, then displays them.

#include <stdio.h>
#include <stdlib.h>

int main( void )
{
   char  tokenstring[] = "15 12 14...";
   char  s[81];
   char  c;
   int   i;
   float fp;

   // Input various data from tokenstring:
   // max 80 character string plus NULL terminator
   sscanf_s( tokenstring, "%s", s, _countof(s) );
   sscanf_s( tokenstring, "%c", &c, sizeof(char) );
   sscanf_s( tokenstring, "%d", &i );
   sscanf_s( tokenstring, "%f", &fp );

   // Output the data read
   printf_s( "String    = %s\n", s );
   printf_s( "Character = %c\n", c );
   printf_s( "Integer:  = %d\n", i );
   printf_s( "Real:     = %f\n", fp );
}