snprintf
, _snprintf
, _snprintf_l
, _snwprintf
, _snwprintf_l
Grava dados formatados em uma cadeia de caracteres. Versões mais seguras dessas funções estão disponíveis; confira _snprintf_s
, _snprintf_s_l
, _snwprintf_s
, _snwprintf_s_l
.
Sintaxe
int snprintf(
char *buffer,
size_t count,
const char *format [,
argument] ...
);
int _snprintf(
char *buffer,
size_t count,
const char *format [,
argument] ...
);
int _snprintf_l(
char *buffer,
size_t count,
const char *format,
_locale_t locale [,
argument] ...
);
int _snwprintf(
wchar_t *buffer,
size_t count,
const wchar_t *format [,
argument] ...
);
int _snwprintf_l(
wchar_t *buffer,
size_t count,
const wchar_t *format,
_locale_t locale [,
argument] ...
);
template <size_t size>
int _snprintf(
char (&buffer)[size],
size_t count,
const char *format [,
argument] ...
); // C++ only
template <size_t size>
int _snprintf_l(
char (&buffer)[size],
size_t count,
const char *format,
_locale_t locale [,
argument] ...
); // C++ only
template <size_t size>
int _snwprintf(
wchar_t (&buffer)[size],
size_t count,
const wchar_t *format [,
argument] ...
); // C++ only
template <size_t size>
int _snwprintf_l(
wchar_t (&buffer)[size],
size_t count,
const wchar_t *format,
_locale_t locale [,
argument] ...
); // C++ only
Parâmetros
buffer
Local de armazenamento para a saída.
count
O número máximo de caracteres a serem gravados. Para as funções que usam wchar_t
, é o número máximo de caracteres largos a serem gravados.
format
Cadeia de caracteres de controle de formato.
argument
Argumentos opcionais.
locale
A localidade a ser usada para formatar a saída.
Para obter mais informações, consulte Sintaxe de especificação de formato: printf
e wprintf
funções.
Valor retornado
O número de caracteres que teriam sido gravados no buffer se count
fosse ignorado. A contagem não inclui o caractere de terminação NULL
.
Seja len
o comprimento da cadeia de caracteres de dados formatada, não incluindo o .NULL
Para todas as funções, se len < count
, os len
caracteres são armazenados em buffer
, um terminador nulo é anexado e o número de caracteres gravados, não incluindo o , de terminação NULL
é retornado.
As versões de caracteres largos dessas funções retornam o número de caracteres largos gravados, não incluindo o .NULL
Consulte Resumo do comportamento para obter detalhes.
Comentários
Começando com o UCRT no Visual Studio 2015 e Windows 10, snprintf
não é mais idêntico a _snprintf
. O comportamento agora está em conformidade com o snprintf
padrão C99. A diferença é que, se você ficar sem buffer, o terminará em nulo o final do buffer e retornará o número de caracteres que seriam necessários, snprintf
enquanto _snprintf
não encerrará o buffer em nulo e retornará -1. Além disso, snprintf()
inclui mais um caractere na saída porque ele não termina o buffer em nulidade.
snprintf
e a família de funções formatar_snprintf
e armazenarcount
ou menos caracteres embuffer
.snprintf
sempre armazena um caractere de terminaçãoNULL
, truncando a saída, se necessário.- Se
snprintf
retornar um valor >count
- 1, a saída foi truncada. - A
_snprintf
família de funções só acrescenta um caractere de terminaçãoNULL
se o comprimento da cadeia de caracteres formatada for estritamente menor quecount
os caracteres. - Cada
argument
(se houver) é convertido e gerado de acordo com a especificação de formato correspondente emformat
. O formato consiste em caracteres comuns e tem o mesmo formato e função que o argumentoformat
paraprintf
. Se ocorrer cópia entre cadeias de caracteres que se sobrepõem, o comportamento será indefinido.
Resumo do comportamento
Para a tabela a seguir:
- Seja
sizeOfBuffer
do tamanho debuffer
. Se a função usar umchar
buffer, o tamanho será em bytes. Se a função usar umwchar_t
buffer, o tamanho especificará o número de palavras de 16 bits. - Seja
len
o tamanho dos dados formatados. Se a função usar umchar
buffer, o tamanho será em bytes. Se a função usar umwchar_t
buffer, o tamanho especificará o número de palavras de 16 bits. - Caracteres referem-se a
char
caracteres para funções que usam umchar
buffer e awchar_t
caracteres para funções que usam umwchar_t
buffer. - Para obter mais informações sobre o manipulador de parâmetro inválido, consulte Validação de parâmetro.
Condição | Comportamento | Valor retornado | errno |
Invoca um manipulador de parâmetro inválido |
---|---|---|---|---|
Êxito | Grava os caracteres no buffer usando a cadeia de caracteres de formato especificada. | O número de caracteres gravados. | N/D | Não |
Erro de codificação durante a formatação | Se o processamento do especificador s de cadeia de caracteres , S , ou Z , o processamento da especificação de formato for interrompido, a NULL será colocado no início do buffer. |
-1 | EILSEQ (42) |
Não |
Erro de codificação durante a formatação | Se estiver processando especificador c de caracteres ou C , o caractere inválido será ignorado. O número de caracteres gravados não é incrementado para o caractere ignorado, nem nenhum dado é gravado para ele. O processamento da especificação de formato continua depois de ignorar o especificador com o erro de codificação. |
O número de caracteres escritos, sem incluir o .NULL |
EILSEQ (42) |
Não |
buffer == NULL e count != 0 |
Se a execução continuar após a execução do manipulador de parâmetros inválidos, definirá errno e retornará um valor negativo. |
-1 | EINVAL (22) |
Sim |
count == 0 |
O número de caracteres que teriam sido gravados, não incluindo o .NULL Você pode usar esse resultado para alocar espaço de buffer suficiente para a cadeia de caracteres e um terminando NULL e, em seguida, chamar a função novamente para preencher o buffer. |
N/D | Não | |
count < 0 |
Não seguro: o valor é tratado como não assinado, provavelmente criando um valor grande que resulta na substituição da memória que segue o buffer. | O número de caracteres gravados | N/D | Não |
count < sizeOfBuffer e len <= count |
Todos os dados são gravados e uma terminação NULL é anexada. |
O número de caracteres escritos, sem incluir o .NULL |
N/D | Não |
count < sizeOfBuffer e len > count |
Os primeiros count-1 caracteres são gravados seguidos por um terminador nulo. |
O número de caracteres que teriam sido gravados correspondeu count ao número de caracteres a serem gerados, sem incluir o terminador nulo. |
N/D | Não |
count >= sizeOfBuffer e len < sizeOfBuffer |
Todos os dados são gravados com um .NULL |
O número de caracteres escritos, sem incluir o .NULL |
N/D | Não |
count >= sizeOfBuffer e len >= sizeOfBuffer |
Não seguro: substitui a memória que segue o buffer. | O número de caracteres escritos, sem incluir o .NULL |
N/D | Não |
format == NULL |
Nenhum dado é gravado. Se a execução continuar após a execução do manipulador de parâmetros inválidos, definirá errno e retornará um valor negativo. |
-1 | EINVAL (22) |
Sim |
Para obter informações sobre esses e outros códigos de erro, confira _doserrno
, errno
, _sys_errlist
e _sys_nerr
.
Importante
Verifique se format
não é uma cadeia de caracteres definida pelo usuário. Já que as funções _snprintf
não asseguram a terminação null – especificamente, quando o valor retornado é count
– certifique-se de que elas sejam seguidas pelo código que adiciona o terminador nulo. Para obter mais informações, confira Como evitar sobrecargas de buffer.
Começando pelo Windows 10 versão 2004 (build 19041), a família de funções printf
imprime números de ponto flutuante exatamente representáveis de acordo com as regras do IEEE 754 para arredondamento. Em versões anteriores do Windows, números de ponto flutuante que pudessem ser representados com exatidão e que terminassem em '5' eram sempre arredondados para cima. O IEEE 754 afirma que eles precisam arredondar para o dígito par mais próximo (também conhecido como "arredondamento bancário"). Por exemplo, ambos printf("%1.0f", 1.5)
e printf("%1.0f", 2.5)
devem ser arredondados para 2. Anteriormente, 1,5 seria arredondado para 2 e 2,5 para 3. Essa alteração afeta apenas números que possam ser representados com exatidão. Por exemplo, 2,35 (que, quando representado na memória, está mais próximo de 2,35000000000000008) continua arredondando para 2,4. O arredondamento feito por essas funções agora também respeita o modo de arredondamento de ponto flutuante definido por fesetround
. Anteriormente, o arredondamento sempre escolhia o comportamento FE_TONEAREST
. Essa alteração afeta apenas os programas criados usando o Visual Studio 2019 versão 16.2 e posteriores. Para usar o comportamento de arredondamento de ponto flutuante herdado, vincule-o a legacy_stdio_float_rounding.obj
.
_snwprintf
é uma versão de caractere largo de _snprintf
; os argumentos de ponteiro para _snwprintf
são cadeias de caracteres largos. A detecção de erros de codificação em _snwprintf
pode ser diferente da detecção em _snprintf
. _snwprintf
, assim como swprintf
, grava o resultado em uma cadeia de caracteres em vez de um destino do tipo FILE
.
As versões dessas funções que têm o sufixo _l
são idênticas, exceto que elas usam o parâmetro de localidade informado em vez da localidade do thread atual.
Em C++, essas funções têm sobrecargas de modelo que invocam as contrapartes mais recentes e mais seguras. Para obter mais informações, consulte Sobrecargas de modelo seguras.
Mapeamentos de rotina de texto genérico
Rotina Tchar.h |
_UNICODE e _MBCS não definidos |
_MBCS definido |
_UNICODE definido |
---|---|---|---|
_sntprintf |
_snprintf |
_snprintf |
_snwprintf |
_sntprintf_l |
_snprintf_l |
_snprintf_l |
_snwprintf_l |
Requisitos
Rotina | Cabeçalho necessário |
---|---|
snprintf , _snprintf , _snprintf_l |
<stdio.h> |
_snwprintf , _snwprintf_l |
<stdio.h> ou <wchar.h> |
Para obter informações sobre compatibilidade, consulte Compatibilidade.
Exemplo
// crt_snprintf.c
// compile with: /W3
#include <stdio.h>
#include <stdlib.h>
#if !defined(__cplusplus)
typedef int bool;
const bool true = 1;
const bool false = 0;
#endif
#define FAIL 0 // change to 1 and see what happens
int main(void)
{
char buffer[200];
const static char s[] = "computer"
#if FAIL
"computercomputercomputercomputercomputercomputercomputercomputer"
"computercomputercomputercomputercomputercomputercomputercomputer"
"computercomputercomputercomputercomputercomputercomputercomputer"
"computercomputercomputercomputercomputercomputercomputercomputer"
#endif
;
const char c = 'l';
const int i = 35;
#if FAIL
const double fp = 1e300; // doesn't fit in the buffer
#else
const double fp = 1.7320534;
#endif
/* !subtract one to prevent "squeezing out" the terminal null! */
const int bufferSize = sizeof(buffer)/sizeof(buffer[0]) - 1;
int bufferUsed = 0;
int bufferLeft = bufferSize - bufferUsed;
bool bSuccess = true;
buffer[0] = 0;
/* Format and print various data: */
if (bufferLeft > 0)
{
int perElementBufferUsed = _snprintf(&buffer[bufferUsed],
bufferLeft, " String: %s\n", s ); // C4996
// Note: _snprintf is deprecated; consider _snprintf_s instead
if (bSuccess = (perElementBufferUsed >= 0))
{
bufferUsed += perElementBufferUsed;
bufferLeft -= perElementBufferUsed;
if (bufferLeft > 0)
{
int perElementBufferUsed = _snprintf(&buffer[bufferUsed],
bufferLeft, " Character: %c\n", c ); // C4996
if (bSuccess = (perElementBufferUsed >= 0))
{
bufferUsed += perElementBufferUsed;
bufferLeft -= perElementBufferUsed;
if (bufferLeft > 0)
{
int perElementBufferUsed = _snprintf(&buffer
[bufferUsed], bufferLeft, " Integer: %d\n", i ); // C4996
if (bSuccess = (perElementBufferUsed >= 0))
{
bufferUsed += perElementBufferUsed;
bufferLeft -= perElementBufferUsed;
if (bufferLeft > 0)
{
int perElementBufferUsed = _snprintf(&buffer
[bufferUsed], bufferLeft, " Real: %f\n", fp ); // C4996
if (bSuccess = (perElementBufferUsed >= 0))
{
bufferUsed += perElementBufferUsed;
}
}
}
}
}
}
}
}
if (!bSuccess)
{
printf("%s\n", "failure");
}
else
{
/* !store null because _snprintf doesn't necessarily (if the string
* fits without the terminal null, but not with it)!
* bufferUsed might be as large as bufferSize, which normally is
* like going one element beyond a buffer, but in this case
* subtracted one from bufferSize, so we're ok.
*/
buffer[bufferUsed] = 0;
printf( "Output:\n%s\ncharacter count = %d\n", buffer, bufferUsed );
}
return EXIT_SUCCESS;
}
Output:
String: computer
Character: l
Integer: 35
Real: 1.732053
character count = 69
Confira também
E/S de fluxo
sprintf
, _sprintf_l
, swprintf
, _swprintf_l
, __swprintf_l
fprintf
, _fprintf_l
, fwprintf
, _fwprintf_l
printf
, _printf_l
, wprintf
, _wprintf_l
scanf
, _scanf_l
, wscanf
, _wscanf_l
sscanf
, _sscanf_l
, swscanf
, _swscanf_l
Funções vprintf