_snprintf_s, _snprintf_s_l, , _snwprintf_s_snwprintf_s_l

Skriver formaterade data till en sträng. Dessa funktioner är versioner av snprintf, _snprintf, _snprintf_l, , _snwprintf_l_snwprintf med säkerhetsförbättringar som beskrivs i Säkerhetsfunktioner i CRT.

Syntax

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

Parameterar

buffer
Lagringsplats för utdata.

sizeOfBuffer
Storleken på lagringsplatsen för utdata. Storlek i byte för de funktioner som tar charoch ord för de som tar wchar_t.

count
Maximalt antal tecken att skriva. För de funktioner som tar wchar_tär det det maximala antalet breda tecken som ska skrivas. Eller _TRUNCATE.

format
Formatkontrollsträng.

argument
Valfria argument.

locale
Språkvarianten som ska användas.

Returvärde

Antalet tecken som skrivs, inklusive avslutande NULL. Ett negativt värde returneras om ett utdatafel inträffar. Mer information finns i Beteendesammanfattning .

Anmärkningar

Funktionen _snprintf_s formaterar och lagrar count eller färre tecken i buffer och lägger till en avslutande NULL. Varje argument (om något) konverteras och utdata enligt motsvarande formatspecifikation i format. Formateringen är konsekvent med funktionsfamiljen printf . Se Formatspecifikationssyntax: printf och wprintf funktioner. Om kopiering sker mellan strängar som överlappar varandra är beteendet odefinierat.

Beteendesammanfattning

För följande tabell:

– Låt oss len vara storleken på de formaterade data. Om funktionen tar en char buffert är storleken i byte. Om funktionen tar en wchar_t buffert anger storleken antalet 16-bitars ord.

• Tecken refererar till char tecken för funktioner som tar en char buffert och till wchar_t tecken för funktioner som tar en wchar_t buffert.
• Mer information om den ogiltiga parameterhanteraren finns i Parameterverifiering.

Information om dessa och andra felkoder finns i _doserrno, errno, _sys_errlistoch _sys_nerr.

_snwprintf_s är en bred teckenversion av _snprintf_s; pekarargumenten till _snwprintf_s är breda teckensträngar. Identifiering av kodningsfel i _snwprintf_s kan skilja sig från i _snprintf_s. _snwprintf_s swprintf_sskriver utdata till en sträng i stället för till ett mål av typen FILE.

Versionerna av dessa funktioner med suffixet _l är identiska, förutom att de använder parametern locale som skickas i stället för den aktuella trådspråkinställningen.

I C++ förenklas användningen av dessa funktioner av överbelastningar av mallar; Överlagringarna kan härleda buffertlängden automatiskt (vilket eliminerar behovet av att ange ett storleksargument) och de kan automatiskt ersätta äldre, icke-säkra funktioner med sina nyare, säkra motsvarigheter. För mer information, se Secure template overloads.

Allmän textrutinmappning

Kravspecifikation

Mer kompatibilitetsinformation finns i Kompatibilitet.

Exempel

// 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, size_t count )
{
   char dest[10];

   printf( "\n" );

   if ( count == _TRUNCATE )
      printf( "%zd-byte buffer; truncation semantics\n",
               _countof(dest) );
   else
      printf( "count = %zd; %zd-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();
}

count = 8; 10-byte buffer
    new contents of dest: '<<<121>>'

count = 9; 10-byte buffer
    new contents of dest: '<<<121>>>'

count = 10; 10-byte buffer
    new contents of dest: '<<<121>>>'

Destination buffer too small:

count = 10; 10-byte buffer
Invalid parameter handler invoked: ("Buffer too small", 0)
    new contents of dest: ''

Truncation examples:

10-byte buffer; truncation semantics
    new contents of dest: '<<<1221>>'
    truncation did occur

10-byte buffer; truncation semantics
    new contents of dest: '<<<121>>>'
    truncation did not occur

Secure template overload example:
Invalid parameter handler invoked: ("Buffer too small", 0)
    new contents of dest: ''

Se även

Strömma I/O
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
vprintf funktioner