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

概要

ワイド文字列を連結する。

ヘッダ

wchar.h

形式

引数

s1

連結先の配列。ヌルポインタは不可。

s1max

s1 の要素数。

s2

連結元のワイド文字列。ヌルポインタは不可

戻り値

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

詳細

などの危険を避けつつ、s1 の末尾へ s2 の内容を連結する。s2 のワイド文字列がワイド終端文字も含めて、すべて s1 へ連結できた場合に限って成功であり、0 を返す。0以外の値が返されるときは、実行時制約違反が起きている。

以下のいずれかの場合に、実行時制約違反となる。

• s1 や s2 がヌルポインタである
• s1max が 0 であるか、RSIZE_MAX より大きいとき
• 連結後のワイド文字列の長さが、s1max 以上になる
• s1 と s2 が使うメモリ領域に重複がある

実行時制約違反となった場合、s1 がヌルポインタでなく、s1max が 0 より大きく RSIZE_MAX 以下であれば、s1[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[10] = L"12345";

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

実行結果：

（停止）

関連

この関数が定義されていない場合は、wcscat関数やwcsncat関数を、バッファオーバーフローに注意しつつ使用する。

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

解説章