`strncpy_s`, `_strncpy_s_l`, `wcsncpy_s`, `_wcsncpy_s_l`, `_mbsncpy_s`, `_mbsncpy_s_l`

Статья
04/03/2023

Копирует символы одной строки в другую. Эти версии strncpy, _strncpy_l, wcsncpy, _wcsncpy_l, _mbsncpy, имеют _mbsncpy_l улучшения безопасности, как описано в разделе Функции безопасности в CRT.

Важно!

Функции _mbsncpy_s и _mbsncpy_s_l не могут использоваться в приложениях, запускаемых в среде выполнения Windows. Дополнительные сведения: Функции CRT, которые не поддерживаются в приложениях универсальной платформы Windows.

Синтаксис

errno_t strncpy_s(
   char *strDest,
   size_t numberOfElements,
   const char *strSource,
   size_t count
);
errno_t _strncpy_s_l(
   char *strDest,
   size_t numberOfElements,
   const char *strSource,
   size_t count,
   _locale_t locale
);
errno_t wcsncpy_s(
   wchar_t *strDest,
   size_t numberOfElements,
   const wchar_t *strSource,
   size_t count
);
errno_t _wcsncpy_s_l(
   wchar_t *strDest,
   size_t numberOfElements,
   const wchar_t *strSource,
   size_t count,
   _locale_t locale
);
errno_t _mbsncpy_s(
   unsigned char *strDest,
   size_t numberOfElements,
   const unsigned char *strSource,
   size_t count
);
errno_t _mbsncpy_s_l(
   unsigned char *strDest,
   size_t numberOfElements,
   const unsigned char *strSource,
   size_t count,
   _locale_t locale
);
template <size_t size>
errno_t strncpy_s(
   char (&strDest)[size],
   const char *strSource,
   size_t count
); // C++ only
template <size_t size>
errno_t _strncpy_s_l(
   char (&strDest)[size],
   const char *strSource,
   size_t count,
   _locale_t locale
); // C++ only
template <size_t size>
errno_t wcsncpy_s(
   wchar_t (&strDest)[size],
   const wchar_t *strSource,
   size_t count
); // C++ only
template <size_t size>
errno_t _wcsncpy_s_l(
   wchar_t (&strDest)[size],
   const wchar_t *strSource,
   size_t count,
   _locale_t locale
); // C++ only
template <size_t size>
errno_t _mbsncpy_s(
   unsigned char (&strDest)[size],
   const unsigned char *strSource,
   size_t count
); // C++ only
template <size_t size>
errno_t _mbsncpy_s_l(
   unsigned char (&strDest)[size],
   const unsigned char *strSource,
   size_t count,
   _locale_t locale
); // C++ only

Параметры

strDest
Конечная строка.

numberOfElements
Размер конечной строки в символах.

strSource
Исходная строка.

count
Число копируемых символов или _TRUNCATE.

locale
Используемый языковой стандарт.

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

Ноль при успешном завершении, STRUNCATE, если произошло усечение, в противном случае код ошибки.

Условия ошибок

`strDest`	`numberOfElements`	`strSource`	Возвращаемое значение	Содержимое `strDest`
`NULL`	any	any	`EINVAL`	не изменено
any	any	`NULL`	`EINVAL`	`strDest[0]` имеет значение 0;
any	0	any	`EINVAL`	не изменено
не `NULL`	слишком мало	any	`ERANGE`	`strDest[0]` имеет значение 0;

Эти функции будут пытаться скопировать первые D символов strSource в strDest, где D — наименьшее из count и длины strSource. Если эти D символы будут помещаться в strDest (размер которого указан как numberOfElements) и по-прежнему оставлять место для признака конца NULL, эти символы копируются и добавляется завершающее значение NULL; в противном случае устанавливается значение NULL и strDest[0] вызывается обработчик недопустимых параметров, как описано в разделе Проверка параметров.

Существует исключение из приведенного выше абзаца. Если count имеет значение _TRUNCATE, то копируется столько значений strSource , сколько вместится в strDest , при этом остается место для завершающего значения NULL, которое всегда добавляется.

Например,

char dst[5];
strncpy_s(dst, 5, "a long string", 5);

означает, что strncpy_s копирует пять символов в 5-байтовый буфер. Эта копия не оставляет места для конца null, поэтому strncpy_s обнуляет строку и вызывает обработчик недопустимых параметров.

Если требуется усечение, используйте _TRUNCATE или (size - 1):

strncpy_s(dst, 5, "a long string", _TRUNCATE);
strncpy_s(dst, 5, "a long string", 4);

В отличие от strncpy, если count значение больше длины strSource, конечная строка НЕ заполняется символами NULL до длины count.

При перекрытии исходного и конечного буферов поведение strncpy_s не определено.

Если параметр strDest или strSource имеет значение NULL или параметр numberOfElements равен 0, вызывается обработчик недопустимого параметра. Если выполнение может быть продолжено, функция возвращает EINVAL и устанавливает для параметра errno значение EINVAL.

Функцииwcsncpy_s и _mbsncpy_s are wide-character и multibyte-character versions of strncpy_sдля расширенных и многобайтовых символов. Аргументы и возвращаемое значение wcsncpy_s для и mbsncpy_s различаются соответствующим образом. В остальном эти шесть функций ведут себя идентично.

На выходное значение влияет настройка LC_CTYPE категории языкового стандарта. Для получения дополнительной информации см. setlocale. Версии этих функций без суффикса _l используют текущий языковой стандарт для данного поведения, зависимого от языкового стандарта. Версии с суффиксом _l идентичны, однако они используют переданный параметр языкового стандарта. Для получения дополнительной информации см. Locale.

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

Версии отладочной библиотеки этих функций сначала заполняют буфер 0xFE. Чтобы отключить это поведение, используйте ._CrtSetDebugFillThreshold

По умолчанию глобальное состояние этой функции ограничивается приложением. Чтобы изменить это поведение, см. статью Глобальное состояние в CRT.

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

`TCHAR.H` Обычной	`_UNICODE` и `_MBCS` не определены	`_MBCS` Определенные	`_UNICODE` Определенные
`_tcsncpy_s`	`strncpy_s`	`_mbsnbcpy_s`	`wcsncpy_s`
`_tcsncpy_s_l`	`_strncpy_s_l`	`_mbsnbcpy_s_l`	`_wcsncpy_s_l`

Примечание

_strncpy_s_l_mbsncpy_s_l и _wcsncpy_s_l не имеют зависимости от языкового стандарта. Они предоставляются только для _tcsncpy_s_l и не предназначены для вызова напрямую.

Требования

Подпрограмма	Обязательный заголовок
`strncpy_s`, `_strncpy_s_l`	`<string.h>`
`wcsncpy_s`, `_wcsncpy_s_l`	`<string.h>` либо `<wchar.h>`
`_mbsncpy_s`, `_mbsncpy_s_l`	`<mbstring.h>`

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

Пример. Копирование символов в буфер

// crt_strncpy_s_1.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.

errno_t strncpy_s_tester( const char * src,
                          int count )
{
   char dest[10];

   printf( "\n" );

   if ( count == _TRUNCATE )
      printf( "Copying '%s' to %d-byte buffer dest with truncation semantics\n",
               src, _countof(dest) );
   else
      printf( "Copying %d chars of '%s' to %d-byte buffer dest\n",
              count, src, _countof(dest) );

   errno_t err = strncpy_s( dest, _countof(dest), src, count );

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

   return err;
}

void Examples()
{
   strncpy_s_tester( "howdy", 4 );
   strncpy_s_tester( "howdy", 5 );
   strncpy_s_tester( "howdy", 6 );

   printf( "\nDestination buffer too small:\n" );
   strncpy_s_tester( "Hi there!!", 10 );

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

   errno_t err = strncpy_s_tester( "How do you do?", _TRUNCATE );
   printf( "    truncation %s occur\n", err == STRUNCATE ? "did"
                                                       : "did not" );

   err = strncpy_s_tester( "Howdy.", _TRUNCATE );
   printf( "    truncation %s occur\n", err == STRUNCATE ? "did"
                                                       : "did not" );

   printf( "\nSecure template overload example:\n" );

   char dest[10];
   strncpy( dest, "very very very long", 15 );
   // With secure template overloads enabled (see #defines at
   // top of file), the preceding line is replaced by
   //    strncpy_s( dest, _countof(dest), "very very very long", 15 );
   // Instead of causing a buffer overrun, strncpy_s invokes
   // the invalid parameter handler.
   // If secure template overloads were disabled, strncpy would
   // copy 15 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();
}

Copying 4 chars of 'howdy' to 10-byte buffer dest
    new contents of dest: 'howd'

Copying 5 chars of 'howdy' to 10-byte buffer dest
    new contents of dest: 'howdy'

Copying 6 chars of 'howdy' to 10-byte buffer dest
    new contents of dest: 'howdy'

Destination buffer too small:

Copying 10 chars of 'Hi there!!' to 10-byte buffer dest
Invalid parameter handler invoked: (L"Buffer is too small" && 0)
    new contents of dest: ''

Truncation examples:

Copying 'How do you do?' to 10-byte buffer dest with truncation semantics
    new contents of dest: 'How do yo'
    truncation did occur

Copying 'Howdy.' to 10-byte buffer dest with truncation semantics
    new contents of dest: 'Howdy.'
    truncation did not occur

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

Пример: `strncpy` и `strncpy_s`

// crt_strncpy_s_2.c
// contrasts strncpy and strncpy_s

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

int main( void )
{
   char a[20] = "test";
   char s[20];

   // simple strncpy usage:

   strcpy_s( s, 20, "dogs like cats" );
   printf( "Original string:\n   '%s'\n", s );

   // Here we can't use strncpy_s since we don't
   // want null termination
   strncpy( s, "mice", 4 );
   printf( "After strncpy (no null-termination):\n   '%s'\n", s );
   strncpy( s+5, "love", 4 );
   printf( "After strncpy into middle of string:\n   '%s'\n", s );

   // If we use strncpy_s, the string is terminated
   strncpy_s( s, _countof(s), "mice", 4 );
   printf( "After strncpy_s (with null-termination):\n   '%s'\n", s );

}

Original string:
   'dogs like cats'
After strncpy (no null-termination):
   'mice like cats'
After strncpy into middle of string:
   'mice love cats'
After strncpy_s (with null-termination):
   'mice'

См. также раздел

Манипуляция со строками
Локаль
Интерпретация последовательностей многобайтовых символов
_mbsnbcpy, _mbsnbcpy_l
strcat_s, wcscat_s, _mbscat_s
strcmp, wcscmp, _mbscmp
strcpy_s, wcscpy_s, _mbscpy_s
strncat_s, _strncat_s_l, wcsncat_s, _wcsncat_s_l, _mbsncat_s, _mbsncat_s_l
strncmp, wcsncmp, _mbsncmp, _mbsncmp_l
_strnicmp, _wcsnicmp, _mbsnicmp, _strnicmp_l, _wcsnicmp_l, _mbsnicmp_l
strrchr, wcsrchr, _mbsrchr, _mbsrchr_l
_strset, _strset_l, _wcsset, _wcsset_l, _mbsset, _mbsset_l
strspn, wcsspn, _mbsspn, _mbsspn_l

`strncpy_s`, `_strncpy_s_l`, `wcsncpy_s`, `_wcsncpy_s_l`, `_mbsncpy_s`, `_mbsncpy_s_l`

Синтаксис

Параметры

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

Условия ошибок

Комментарии

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

Требования

Пример. Копирование символов в буфер

Пример: `strncpy` и `strncpy_s`

См. также раздел

Обратная связь

Обратная связь

Дополнительные ресурсы

strncpy_s, _strncpy_s_l, wcsncpy_s, _wcsncpy_s_l, _mbsncpy_s, _mbsncpy_s_l

Синтаксис

Параметры

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

Условия ошибок

Комментарии

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

Требования

Пример. Копирование символов в буфер

Пример: strncpy и strncpy_s

См. также раздел

Обратная связь

Обратная связь

Дополнительные ресурсы

`strncpy_s`, `_strncpy_s_l`, `wcsncpy_s`, `_wcsncpy_s_l`, `_mbsncpy_s`, `_mbsncpy_s_l`

Пример: `strncpy` и `strncpy_s`