strncpy、_strncpy_l、wcsncpy、_wcsncpy_l、_mbsncpy、_mbsncpy_l

[アーティクル]
06/09/2015

文字列の文字をほかの文字列にコピーします。これらの関数のセキュリティを強化したバージョンについては、「strncpy_s、_strncpy_s_l、wcsncpy_s、_wcsncpy_s_l、_mbsncpy_s、_mbsncpy_s_l」を参照してください。

重要

_mbsncpy と _mbsncpy_l は、Windows ランタイムで実行するアプリケーションでは使用できません。詳細については、「/ZW でサポートされない CRT 関数」を参照してください。

char *strncpy(
   char *strDest,
   const char *strSource,
   size_t count 
);
char *_strncpy_l(
   char *strDest,
   const char *strSource,
   size_t count,
   locale_t locale 
);
wchar_t *wcsncpy(
   wchar_t *strDest,
   const wchar_t *strSource,
   size_t count 
);
wchar_t *_wcsncpy_l(
   wchar_t *strDest,
   const wchar_t *strSource,
   size_t count,
   locale_t locale 
);
unsigned char *_mbsncpy(
   unsigned char *strDest,
   const unsigned char *strSource,
   size_t count 
);
unsigned char *_mbsncpy_l(
   unsigned char *strDest,
   const unsigned char *strSource,
   size_t count,
   _locale_t locale
);
template <size_t size>
char *strncpy(
   char (&strDest)[size],
   const char *strSource,
   size_t count 
); // C++ only
template <size_t size>
char *_strncpy_l(
   char (&strDest)[size],
   const char *strSource,
   size_t count,
   locale_t locale 
); // C++ only
template <size_t size>
wchar_t *wcsncpy(
   wchar_t (&strDest)[size],
   const wchar_t *strSource,
   size_t count 
); // C++ only
template <size_t size>
wchar_t *_wcsncpy_l(
   wchar_t (&strDest)[size],
   const wchar_t *strSource,
   size_t count,
   locale_t locale 
); // C++ only
template <size_t size>
unsigned char *_mbsncpy(
   unsigned char (&strDest)[size],
   const unsigned char *strSource,
   size_t count 
); // C++ only
template <size_t size>
unsigned char *_mbsncpy_l(
   unsigned char (&strDest)[size],
   const unsigned char *strSource,
   size_t count,
   _locale_t locale
); // C++ only

パラメーター

strDest
対象文字列。
strSource
ソース文字列。
count
コピーする文字数。
locale
使用するロケール。

戻り値

strDest を返します。エラーを示す戻り値は予約されていません。

解説

strncpy 関数は strDest に strSource の count の最初の文字をコピーし、strDestを返します。 count が strSourceの長さ以下である場合、null 文字がコピーされた文字列に自動的に付けられません。 count が strSourceの長さを超える場合、コピー先の文字列は、長さ countまで空白文字で埋められます。コピー元とコピー先の文字列が重なり合っている場合の strncpy 関数の動作は未定義です。

セキュリティに関するメモ
strncpy は strDestの十分な容量を確認しない; これにより、バッファーオーバーランの場合に考えられる原因になります。count の引数は、コピーする文字数を制限します; これは strDestのサイズに制限があります。次の例を参照してください。詳細については、「Avoiding Buffer Overruns」を参照してください。

strncpy は strDestの十分な容量を確認しない; これにより、バッファーオーバーランの場合に考えられる原因になります。count の引数は、コピーする文字数を制限します; これは strDestのサイズに制限があります。次の例を参照してください。詳細については、「Avoiding Buffer Overruns」を参照してください。

strDest または strSource が NULL ポインターである場合、または count がゼロ以下の場合、無効なパラメーターハンドラーがパラメーターの検証"に説明されているように、呼び出されます。実行の継続が許可された場合、これらの関数は -1 を返し、errno を EINVAL に設定します。

wcsncpy 関数と _mbsncpy 関数は、strncpy 関数のワイド文字バージョンとマルチバイト文字バージョンです。 wcsncpy 引数や戻り値と _mbsncpy もそれに応じて異なります。それ以外では、これらの関数の動作は同じです。

これらの関数のうち _l サフィックスが付けられたバージョンは同じですが、ロケールに依存する動作に現在のロケールではなく渡されたロケールを使用するという点で異なります。詳細については、「ロケール」を参照してください。

C++ では、これらの関数にテンプレートのオーバーロードがあります。このオーバーロードは、これらの関数に対応するセキュリティで保護された新しい関数を呼び出します。詳細については、「セキュリティ保護されたテンプレートオーバーロード」を参照してください。

汎用テキストルーチンのマップ

TCHAR.H のルーチン	_UNICODE & _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_tcsncpy	strncpy	_mbsnbcpy	wcsncpy
_tcsncpy_l	_strncpy_l	_mbsnbcpy_l	_wcsncpy_l

注意

_strncpy_l と _wcsncpy_l はロケールに依存はありません; これらは _tcsncpy_l に用意されており、直接呼び出すためのものではありません。

必要条件

ルーチン	必須ヘッダー
strncpy	<string.h>
wcsncpy	<string.h> または <wchar.h>
_mbsncpy, _mbsncpy_l	<mbstring.h>

追加プラットフォームの互換性の詳細については、「互換性」を参照してください。

使用例

次の例は、プログラムバグとセキュリティの問題が発生するためにどのように適用できるか strncpy の使用方法を示しています。コンパイラは **crt_strncpy_x86.c(15) : warning C4996: 'strncpy': This function or variable may be unsafe. Consider using strncpy_s instead. To disable deprecation, use _CRT_SECURE_NO_WARNINGS. See online help for details.**に似た strncpy の呼び出しの警告が生成されます。

// crt_strncpy_x86.c
// Use this command in an x86 developer command prompt to compile: 
// cl /TC /W3 crt_strncpy_x86.c

#include <stdio.h>
#include <string.h>

int main() {
   char t[20];
   char s[20];
   char *p = 0, *q = 0;

   strcpy_s(s, sizeof(s), "AA BB CC");
   // Note: strncpy is deprecated; consider using strncpy_s instead
   strncpy(s, "aa", 2);     // "aa BB CC"         C4996
   strncpy(s + 3, "bb", 2); // "aa bb CC"         C4996
   strncpy(s, "ZZ", 3);     // "ZZ",              C4996
                            // count greater than strSource, null added
   printf("%s\n", s);

   strcpy_s(s, sizeof(s), "AA BB CC");
   p = strstr(s, "BB");
   q = strstr(s, "CC");
   strncpy(s, "aa", p - s - 1);   // "aa BB CC"   C4996
   strncpy(p, "bb", q - p - 1);   // "aa bb CC"   C4996
   strncpy(q, "cc",  q - s);      // "aa bb cc"   C4996
   strncpy(q, "dd", strlen(q));   // "aa bb dd"   C4996
   printf("%s\n", s);

   // some problems with strncpy
   strcpy_s(s, sizeof(s), "test");
   strncpy(t, "this is a very long string", 20 ); // C4996
   // Danger: at this point, t has no terminating null,
   // so the printf continues until it runs into one.
   // In this case, it will print "this is a very long test"
   printf("%s\n", t);

   strcpy_s(t, sizeof(t), "dogs like cats");
   printf("%s\n", t);

   strncpy(t + 10, "to chase cars.", 14); // C4996
   printf("%s\n", t);

   // strncpy has caused a buffer overrun and corrupted string s
   printf("Buffer overrun: s = '%s' (should be 'test')\n", s);
   // Since the stack grows from higher to lower addresses, buffer
   // overruns can corrupt function return addresses on the stack,
   // which can be exploited to run arbitrary code.
}

出力

エラー検出とコードの保護を自動変数とレベルのレイアウトが変化したコンパイラ設定と異なることがあります。この例では、他のコンパイル環境または他のコンパイラオプションでビルドすると、異なる結果が生じる可能性があります。

同等の .NET Framework 関数

System::String::Copy

次の方法で共有

strncpy、_strncpy_l、wcsncpy、_wcsncpy_l、_mbsncpy、_mbsncpy_l

パラメーター

戻り値

解説

必要条件

使用例

同等の .NET Framework 関数

参照

関連項目

その他のリソース