vsnprintf_s, , _vsnprintf_s_vsnprintf_s_l, _vsnwprintf_s_vsnwprintf_s_l

Запишите отформатированный вывод с помощью указателя на список аргументов. Эти функции являются версиями vsnprintf, , _vsnprintf, _vsnprintf_l, с _vsnwprintfулучшениями безопасности, _vsnwprintf_l как описано в разделе Функции безопасности в CRT.

Синтаксис

int vsnprintf_s(
   char *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const char *format,
   va_list argptr
);

int _vsnprintf_s(
   char *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const char *format,
   va_list argptr
);

int _vsnprintf_s_l(
   char *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const char *format,
   _locale_t locale,
   va_list argptr
);

int _vsnwprintf_s(
   wchar_t *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const wchar_t *format,
   va_list argptr
);

int _vsnwprintf_s_l(
   wchar_t *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const wchar_t *format,
   _locale_t locale,
   va_list argptr
);

template <size_t size>
int _vsnprintf_s(
   char (&buffer)[size],
   size_t count,
   const char *format,
   va_list argptr
); // C++ only

template <size_t size>
int _vsnwprintf_s(
   wchar_t (&buffer)[size],
   size_t count,
   const wchar_t *format,
   va_list argptr
); // C++ only

Параметры

buffer
Место хранения продукции.

sizeOfBuffer
Размер buffer вывода for. Размер в байтах для функций, принимающих , и char для тех, которые принимают wchar_t.

count
Максимальное количество записываемых символов без учета завершающего NULL. Для функций, которые принимают wchar_t, это количество широких символов для записи. или _TRUNCATE.

format
Спецификация формата.

argptr
Указатель на список аргументов.

locale
Языковой стандарт, используемый при форматировании выходных данных.

Дополнительные сведения см. в разделе Спецификации формата.

Возвращаемое значение

Количество записанных символов, не включая завершающий NULL, или отрицательное значение в случае возникновения ошибки вывода.

Дополнительные сведения см . в сводке по поведению.

Замечания

Каждая из этих функций принимает указатель на список аргументов, затем форматирует и записывает до count символов заданные данные в память, на buffer которую указывает , и добавляет завершающий NULL.

В отладочных сборках оставшиеся sizeOfBuffer байты после завершения NULL заполняются символом 'xFE', как описано в _CrtSetDebugFillThreshold.

Версии этих функций с _l суффиксом идентичны, за исключением того, что они используют переданный параметр locale вместо текущей локали потока.

vsnprintf_s идентичен _vsnprintf_s стандарту ANSI и включен в него для соответствия. _vnsprintf сохраняется для обратной совместимости.

Сводка по поведению

В следующей таблице:

• Допустим len , размер отформатированных данных. Если функция принимает char буфер, размер находится в байтах. Если функция принимает wchar_t буфер, размер указывает количество 16-разрядных слов.
• Символы относятся к char символам функций, которые принимают char буфер, а также wchar_t к символам для функций, которые принимают wchar_t буфер.
• Дополнительные сведения о обработчике недопустимых параметров см. в разделе "Проверка параметров".

Сведения об этих и других кодах ошибок см. в разделе _doserrno, errno_sys_errlistи _sys_nerr.

В C++ использование этих функций упрощается за счет перегрузок шаблонов; Перегрузки могут автоматически определять длину буфера (устраняя необходимость указывать аргумент size) и автоматически заменять старые, небезопасные функции на их новые, безопасные аналоги. Дополнительные сведения см. в разделе "Безопасные перегрузки шаблонов".

Сопоставления подпрограмм универсального текста

Требования

* Требуется для совместимости с UNIX V.

Дополнительные сведения о совместимости см. в разделе Совместимость.

Пример

// crt_vsnprintf_s.cpp
#include <stdio.h>
#include <wtypes.h>

void FormatOutput(LPCSTR formatstring, ...)
{
   int nSize = 0;
   char buff[10];
   memset(buff, 0, sizeof(buff));
   va_list args;
   va_start(args, formatstring);
   nSize = vsnprintf_s( buff, _countof(buff), _TRUNCATE, formatstring, args);
   printf("nSize: %d, buff: %s\n", nSize, buff);
   va_end(args);
}

int main() {
   FormatOutput("%s %s", "Hi", "there");
   FormatOutput("%s %s", "Hi", "there!");
   FormatOutput("%s %s", "Hi", "there!!");
}

nSize: 8, buff: Hi there
nSize: 9, buff: Hi there!
nSize: -1, buff: Hi there!

См. также

Потоковый ввод-вывод
vprintf функции
fprintf, , _fprintf_lfwprintf_fwprintf_l
printf, , _printf_lwprintf_wprintf_l
sprintf, _sprintf_l, , swprintf, _swprintf_l__swprintf_l
va_arg, , va_copyva_endva_start