wcscpy_s | Programming Place Plus　Ｃ言語編　標準ライブラリのリファレンス

概要

ワイド文字列をコピーする。

ヘッダ

wchar.h

形式

errno_t wcscpy_s(wchar_t* dest, rsize_t destmax, const wchar_t* src);

引数

dest

コピー先の配列。ヌルポインタは不可。

destmax

dest の要素数。

src

コピー元のワイド文字列。ヌルポインタは不可。また、文字列の長さは destmax よりも小さくなければならない。

戻り値

コピーに成功したら 0 が返される。何らかのエラーが発生したら 0以外が返される。

詳細

バッファオーバーフローなどの危険を避けつつ、dest へ src の内容を終端文字を含めてコピーする。src のワイド文字列が終端文字も含めて、すべて dest へコピーできた場合に限って成功であり、0 を返す。

dest がヌルポインタである場合や、destmax が 0 または RSIZE_MAX より大きい場合には、実行時制約違反となる。dest がヌルポインタでなければ、dest[0] にはヌルワイド文字が書き込まれる。

実行時制約違反となった場合、実行時制約ハンドラとして登録されている関数が呼び出される。デフォルトで登録されている関数の動作は処理系定義である。set_constraint_handler_s関数を使うと、独自で定義した関数を実行時制約ハンドラとして登録でき、動作を置き換えられる。

この関数は、__STDC_LIB_EXT1__ が定義されている処理系でのみ使用できる。また、この関数を使用するのなら、<wchar.h> をインクルードする前に、__STDC_WANT_LIB_EXT1__ という名前のマクロを、置換結果 1 として定義することが作法となっているが、これを行わずとも関数を使用できる処理系もあり得る。

注意

使用例

#define __STDC_WANT_LIB_EXT1__ 1
#include <wchar.h>

int main(void)
{
    wchar_t s[20];

    if (wcscpy_s(s, sizeof(s) / sizeof(s[0]), L"abcde") == 0) {
        wprintf(L"%ls\n", s);
    }
}

実行結果：

abcde

関連

この関数が定義されていない場合は、wcscpy関数やwcsncpy関数を検討する。

マルチバイト文字列版の strcpy_s関数がある。

解説章