Namespaces
Variants

strncpy, strncpy_s

From cppreference.net
< c ‎ | string ‎ | byte
C
Strings library
Null-terminated byte strings
Functions
Character manipulation
Conversions to and from numeric formats
String manipulation
(C11)
strncpy strncpy_s
(C11)
(C11)
String examination
Memory manipulation
Miscellaneous
(C11) (C11)
헤더 파일에 정의됨 <string.h>
(1)
char * strncpy ( char * dest, const char * src, size_t count ) ;
(C99 이전)
char * strncpy ( char * restrict dest, const char * restrict src, size_t count ) ;
(C99 이후)
errno_t strncpy_s ( char * restrict dest, rsize_t destsz,
const char * restrict src, rsize_t count ) ;
(2) (C11 이후)
1) src 가 가리키는 문자 배열에서 (종료 널 문자를 포함하지만, 널 문자 이후의 문자들은 포함하지 않음) 최대 count 개의 문자를 dest 가 가리키는 문자 배열로 복사합니다.
만약 count 가 전체 배열 src 가 복사되기 전에 도달하면, 결과 문자 배열은 null로 종료되지 않습니다.
만약 src 에서 종료 널 문자를 복사한 후에 count 에 도달하지 않았다면, 추가적인 널 문자들이 dest 에 총 count 개의 문자가 기록될 때까지 계속 기록됩니다.
문자 배열이 겹치는 경우, dest 또는 src 가 문자 배열을 가리키는 포인터가 아닌 경우( dest 또는 src 가 널 포인터인 경우 포함), dest 가 가리키는 배열의 크기가 count 보다 작은 경우, 또는 src 가 가리키는 배열의 크기가 count 보다 작으면서 널 문자를 포함하지 않는 경우, 동작은 정의되지 않습니다.
2) (1) 과 동일하지만, 이 함수는 count 까지 채우기 위해 대상 배열에 널 문자를 계속 기록하지 않고, 종료 널 문자를 기록한 후 중단합니다(소스에 널 문자가 없었다면 dest [ count ] 에 하나를 기록한 후 중단합니다). 또한 런타임에 다음 오류들이 감지되면 현재 설치된 constraint handler 함수를 호출합니다:
  • src 또는 dest 가 널 포인터인 경우
  • destsz 가 0이거나 RSIZE_MAX 보다 큰 경우
  • count 가 RSIZE_MAX 보다 큰 경우
  • count 가 destsz 보다 크거나 같지만, destsz 가 strnlen_s ( src, count ) 보다 작거나 같은 경우, 즉 잘림(truncation)이 발생할 경우
  • 소스 문자열과 대상 문자열 간에 중복(overlap)이 발생할 경우
dest 가 가리키는 문자 배열의 크기가 strnlen_s ( src, destsz ) <= destsz 보다 작은 경우 동작은 정의되지 않습니다. 다시 말해, destsz 의 잘못된 값은 임박한 버퍼 오버플로를 노출하지 않습니다. src 가 가리키는 문자 배열의 크기가 strnlen_s ( src, count ) < destsz 보다 작은 경우 동작은 정의되지 않습니다. 다시 말해, count 의 잘못된 값은 버퍼 오버플로를 허용할 수 있습니다.
모든 경계 검사 함수와 마찬가지로, strncpy_s 는 구현에 의해 __STDC_LIB_EXT1__ 가 정의되고 사용자가 <string.h> 를 포함하기 전에 __STDC_WANT_LIB_EXT1__ 를 정수 상수 1 로 정의한 경우에만 사용 가능함이 보장됩니다.

목차

매개변수

dest - 복사 대상 문자 배열을 가리키는 포인터
src - 복사 원본 문자 배열을 가리키는 포인터
count - 복사할 최대 문자 수
destsz - 대상 버퍼의 크기

반환값

1) dest 의 복사본을 반환합니다
2) 성공 시 0을 반환하고, 오류 시 0이 아닌 값을 반환합니다. 또한 오류 발생 시, dest [ 0 ] 에 0을 기록합니다 ( dest 가 널 포인터이거나 destsz 가 0이거나 RSIZE_MAX 보다 큰 경우는 제외). 그리고 대상 배열의 나머지 부분을 지정되지 않은 값으로 덮어쓸 수 있습니다.

참고 사항

C11 이후 수정된 DR 468에 따라, strncpy_s 는 strcpy_s 와 달리 오류 발생 시에만 대상 배열의 나머지 부분을 덮어쓸 수 있습니다.

strncpy 와 달리, strncpy_s 는 대상 배열을 0으로 채우지 않습니다. 이는 기존 코드를 경계 검사 버전으로 변환할 때 흔히 발생하는 오류 원인입니다.

대상 버퍼에 맞추기 위한 절단(truncation)은 보안 위험이므로 strncpy_s 의 런타임 제약 조건 위반이지만, count 를 대상 배열 크기에서 1을 뺀 값으로 지정하여 절단 동작을 얻는 것이 가능합니다: 이는 첫 번째 count 바이트를 복사하고 항상 그렇듯 널 종결자를 추가할 것입니다: strncpy_s ( dst, sizeof dst, src, ( sizeof dst ) - 1 ) ;

예제

이 코드 실행 
#define __STDC_WANT_LIB_EXT1__ 1
#include <string.h>
#include <stdio.h>
#include <stdlib.h>
#include <errno.h>
int main(void)
{
    char src[] = "hi";
    char dest[6] = "abcdef"; // 널 종결자 없음
    strncpy(dest, src, 5); // 다섯 문자 'h', 'i', '\0', '\0', '\0'를 dest에 기록
    printf("strncpy(dest, src, 5) to a 6-byte dest gives : ");
    for (size_t n = 0; n < sizeof dest; ++n) {
        char c = dest[n];
        c ? printf("'%c' ", c) : printf("'\\0' ");
    }
    printf("\nstrncpy(dest2, src, 2) to a 2-byte dst gives : ");
    char dest2[2];
    strncpy(dest2, src, 2); // 잘림: 두 문자 'h', 'i'를 dest2에 기록
    for (size_t n = 0; n < sizeof dest2; ++n) {
        char c = dest2[n];
        c ? printf("'%c' ", c) : printf("'\\0' ");
    }
    printf("\n");
#ifdef __STDC_LIB_EXT1__
    set_constraint_handler_s(ignore_handler_s);
    char dst1[6], src1[100] = "hello";
    errno_t r1 = strncpy_s(dst1, 6, src1, 100);  // r1에 0을, dst1에 6개 문자를 기록
    printf("dst1 = \"%s\", r1 = %d\n", dst1,r1); // dst1에 'h','e','l','l','o','\0' 기록
    char dst2[5], src2[7] = {'g','o','o','d','b','y','e'};
    errno_t r2 = strncpy_s(dst2, 5, src2, 7);    // 복사가 대상 배열을 오버플로우함
    printf("dst2 = \"%s\", r2 = %d\n", dst2,r2); // r2에 0이 아닌 값을, dst2[0]에 '\0'을 기록
    char dst3[5];
    errno_t r3 = strncpy_s(dst3, 5, src2, 4);    // r3에 0을, dst3에 5개 문자를 기록
    printf("dst3 = \"%s\", r3 = %d\n", dst3,r3); // dst3에 'g', 'o', 'o', 'd', '\0' 기록
#endif
}

가능한 출력: 

strncpy(dest, src, 5) to a 6-byte dst gives : 'h' 'i' '\0' '\0' '\0' 'f'
strncpy(dest2, src, 2) to a 2-byte dst gives : 'h' 'i'
dst1 = "hello", r1 = 0
dst2 = "", r2 = 22
dst3 = "good", r3 = 0

참조문헌

  • C17 표준 (ISO/IEC 9899:2018):
  • 7.24.2.4 The strncpy function (p: 265)
  • K.3.7.1.4 The strncpy_s function (p: 447-448)
  • C11 표준 (ISO/IEC 9899:2011):
  • 7.24.2.4 The strncpy function (p: 363-364)
  • K.3.7.1.4 The strncpy_s function (p: 616-617)
  • C99 표준 (ISO/IEC 9899:1999):
  • 7.21.2.4 strncpy 함수 (p: 326-327)
  • C89/C90 표준 (ISO/IEC 9899:1990):
  • 4.11.2.4 strncpy 함수

참고 항목

(C11)
문자열을 다른 문자열로 복사
(함수)
(C11)
버퍼를 다른 버퍼로 복사
(함수)
(dynamic memory TR)
지정된 크기까지 문자열 사본을 할당
(함수)
C++ documentation for strncpy