_snprintf_s, _snprintf_s_l, _snwprintf_s, _snwprintf_s_l

Článek
06/09/2015

Zápisy formátovaná data na řetězec.Tyto verze jsou _snprintf, _snprintf_l, _snwprintf, _snwprintf_l s vylepšení zabezpečení popsaným v Funkce zabezpečení v CRT.

int _snprintf_s(
   char *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const char *format [,
   argument] ... 
);
int _snprintf_s_l(
   char *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const char *format,
   locale_t locale [,
   argument] ... 
);
int _snwprintf_s(
   wchar_t *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const wchar_t *format [,
   argument] ... 
);
int _snwprintf_s_l(
   wchar_t *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const wchar_t *format,
   locale_t locale [,
   argument] ... 
);
template <size_t size>
int _snprintf_s(
   char (&buffer)[size],
   size_t count,
   const char *format [,
   argument] ... 
); // C++ only
template <size_t size>
int _snwprintf_s(
   wchar_t (&buffer)[size],
   size_t count,
   const wchar_t *format [,
   argument] ... 
); // C++ only

Parametry

buffer
Umístění úložiště pro výstup.
sizeOfBuffer
Velikost úložiště pro výstup.Size in bytes for _snprintf_s or size in words for _snwprintf_s.
Count
Maximální počet znaků, které chcete uložit, nebo _TRUNCATE.
format
Řetězec formátu řízení.
argument
Volitelné argumenty.
locale
Národní prostředí použít.

Vrácená hodnota

_snprintf_sVrátí počet znaků, které jsou uloženy v buffer, se nepočítají ukončujícím znakem null._snwprintf_sVrátí počet široké znaků, které jsou uloženy v buffer, se nepočítají ukončující širokým znakem null.

Pokud překročí úložiště pro ukládání dat a ukončující null sizeOfBuffer, vyvolat neplatný parametr popisovače, jak je popsáno v Ověření parametru.Pokud provádění pokračuje i po zpracování neplatný parametr, nastavte tyto funkce buffer nastavit na prázdný řetězec, errno na ERANGEa vrátí -1.

Pokud buffer nebo format je NULL ukazatele, nebo pokud count je menší nebo rovna nule, je vyvolána parametr neplatný popisovač.Pokud je povoleno spuštění pokračovat, nastavit tyto funkce errno na EINVAL a vrátí -1.

Informace o těchto a jiných kódů chyb naleznete v tématu _doserrno, kód chyby, _sys_errlist a _sys_nerr.

Poznámky

_snprintf_s Funkce formáty a obchody count nebo méně znaků v buffer a připojí ukončující null.Každý argument (pokud existuje) převedena a výstup podle odpovídající specifikaci formátu v format.Formátování je konzistentní s printf řady funkcí; see Syntaxe specifikace formátu: funkce printf a wprintf.Kopírování dojde-li mezi řetězce, které se překrývají, chování není definována.

Pokud count je _TRUNCATE, pak _snprintf_s zápisy největší řetězec jako se vejde do buffer a nechat prostor pro ukončující null.Pokud celý řetězec (s ukončující null) odpovídá buffer, pak _snprintf_s vrátí počet znaků, které jsou napsány (nikoli včetně ukončující null); jinak _snprintf_s vrátí -1 označuje, že zkrácení došlo k chybě.

Poznámka k zabezpečení
Zajistit, aby format není uživatelem definovaný řetězec.

_snwprintf_sje verze celého znaku _snprintf_s; ukazatel argumenty _snwprintf_s jsou celý znak řetězce.Zjišťování chyb v kódování _snwprintf_s , mohou lišit od v _snprintf_s._snwprintf_s, stejně jako swprintf_s, zapíše výstupní řetězec, místo určení typu FILE.

Verze těchto funkcí se _l přípony jsou shodné s výjimkou, že používají národní prostředí parametr předaný namísto aktuální podproces národní prostředí.

V jazyce C++ použití těchto funkcí je zjednodušeno díky šablony přetížení; přetížení automaticky odvodit vyrovnávací paměti (není tak nutné zadat argument velikost) a jsou automaticky nahradit starší, -secure funkce s jejich protějšky novější, zabezpečené.Další informace naleznete v tématu Přetížení zabezpečení šablony.

Obecný Text rutinní mapování

Rutina Tchar.h	_UNICODE a _MBCS není definován	_MBCS, definice	_UNICODE, definice
_sntprintf_s	_snprintf_s	_snprintf_s	_snwprintf_s
_sntprintf_s_l	_snprintf_s_l	_snprintf_s_l	_snwprintf_s_l

Požadavky

Rutina	Požadované záhlaví
_snprintf_s, _snprintf_s_l	<stdio.h>
_snwprintf_s, _snwprintf_s_l	<stdio.h> nebo <wchar.h>

Další informace o kompatibilitě v tématu Compatibility v úvodu.

Příklad

// crt_snprintf_s.cpp
// compile with: /MTd

// These #defines enable secure template overloads
// (see last part of Examples() below)
#define _CRT_SECURE_CPP_OVERLOAD_STANDARD_NAMES 1 
#define _CRT_SECURE_CPP_OVERLOAD_STANDARD_NAMES_COUNT 1

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <crtdbg.h>  // For _CrtSetReportMode
#include <errno.h>

// This example uses a 10-byte destination buffer.

int snprintf_s_tester( const char * fmt, int x, int count )
{
   char dest[10];

   printf( "\n" );

   if ( count == _TRUNCATE )
      printf( "%d-byte buffer; truncation semantics\n",
               _countof(dest) );
   else
      printf( "count = %d; %d-byte buffer\n",
               count, _countof(dest) );

   int ret = _snprintf_s( dest, _countof(dest), count, fmt, x );

   printf( "    new contents of dest: '%s'\n", dest );

   return ret;
}


void Examples()
{
   // formatted output string is 9 characters long: "<<<123>>>"
   snprintf_s_tester( "<<<%d>>>", 121, 8 );
   snprintf_s_tester( "<<<%d>>>", 121, 9 );
   snprintf_s_tester( "<<<%d>>>", 121, 10 );

   printf( "\nDestination buffer too small:\n" );

   snprintf_s_tester( "<<<%d>>>", 1221, 10 );

   printf( "\nTruncation examples:\n" );

   int ret = snprintf_s_tester( "<<<%d>>>", 1221, _TRUNCATE );
   printf( "    truncation %s occur\n", ret == -1 ? "did"
                                                  : "did not" );

   ret = snprintf_s_tester( "<<<%d>>>", 121, _TRUNCATE );
   printf( "    truncation %s occur\n", ret == -1 ? "did"
                                                  : "did not" );
   printf( "\nSecure template overload example:\n" );

   char dest[10];
   _snprintf( dest, 10, "<<<%d>>>", 12321 );
   // With secure template overloads enabled (see #defines
   // at top of file), the preceding line is replaced by
   //    _snprintf_s( dest, _countof(dest), 10, "<<<%d>>>", 12345 );
   // Instead of causing a buffer overrun, _snprintf_s invokes
   // the invalid parameter handler.
   // If secure template overloads were disabled, _snprintf would
   // write 10 characters and overrun the dest buffer.
   printf( "    new contents of dest: '%s'\n", dest );
}

void myInvalidParameterHandler(
   const wchar_t* expression,
   const wchar_t* function, 
   const wchar_t* file, 
   unsigned int line, 
   uintptr_t pReserved)
{
   wprintf(L"Invalid parameter handler invoked: %s\n", expression);
}

int main( void )
{
   _invalid_parameter_handler oldHandler, newHandler;

   newHandler = myInvalidParameterHandler;
   oldHandler = _set_invalid_parameter_handler(newHandler);
   // Disable the message box for assertions.
   _CrtSetReportMode(_CRT_ASSERT, 0);

   Examples();
}