RtlStringCchCatNW 関数 (ntstrsafe.h)

  • [アーティクル]

RtlStringCchCatNW 関数と RtlStringCchCatNA 関数は、追加された文字列のサイズを制限しながら、2 つの文字カウント文字列を連結します。

構文

NTSTRSAFEDDI RtlStringCchCatNW(
  [in, out] NTSTRSAFE_PWSTR pszDest,
  [in]      size_t          cchDest,
  [in]      STRSAFE_PCNZWCH pszSrc,
            size_t          cchToAppend
);

パラメーター

[in, out] pszDest

入力時に pszSrc が連結される null で終わる文字列を含むバッファーへのポインター。 出力時に、これは結果の文字列全体を含む宛先バッファーです。 pszSrc の文字列 (cchMaxAppend 文字まで) は、pszDest の文字列の末尾に追加され、null 文字で終了します。

[in] cchDest

変換先バッファーのサイズ (文字数)。 使用できる最大文字数はNTSTRSAFE_MAX_CCH。

[in] pszSrc

null 終端文字列へのポインター。 この文字列は、 pszDest のバッファーに含まれる文字列の末尾に連結されます。

cchToAppend

pszDest のバッファーに含まれる文字列に追加する最大文字数。

戻り値

関数は、次の表に示す NTSTATUS 値のいずれかを返します。 NTSTATUS 値をテストする方法については、「 NTSTATUS 値の使用」を参照してください。

リターン コード 説明
STATUS_SUCCESS
 この 成功 状態は、ソース データが存在し、文字列が切り捨てなしで連結され、結果の宛先バッファーが null で終了したことを意味します。
STATUS_BUFFER_OVERFLOW
 この 警告 状態は、バッファー領域が不足しているため、連結操作が完了しなかったことを意味します。 コピー先バッファーには、目的の結果の null で終わる切り捨てられたバージョンが含まれています。
STATUS_INVALID_PARAMETER
 この エラー 状態は、関数が無効な入力パラメーターを受信したことを意味します。 詳細については、次の段落を参照してください。

関数は、次の場合にSTATUS_INVALID_PARAMETER値を返します。

  • cchDest の値が最大バッファー サイズを超えています。
  • 宛先バッファーは既にいっぱいでした。
  • NULL ポインターが存在しました。
  • コピー先バッファーの長さが 0 ですが、0 以外の長さのソース文字列が存在しました。

注釈

RtlStringCchCatNW と RtlStringCchCatNA は、次の関数の代わりに使用する必要があります。

  • strncat
  • wcsncat
コピー先バッファーのサイズ (文字数) は、 RtlStringCchCatNW と RtlStringCchCatNA がバッファーの末尾を超えて書き込まれないようにするために、関数に提供されます。

RtlStringCchCatNW を使用して Unicode 文字列を処理し、RtlStringCchCatNA を使用して ANSI 文字列を処理します。 次の表に示すように、使用するフォームはデータによって異なります。

文字列データ型 文字列リテラル 機能
WCHAR L"string" RtlStringCchCatNW
Char "string" RtlStringCchCatNA
 

pszSrc と pszDest が重複する文字列を指している場合、関数の動作は未定義です。

pszSrc も pszDest も NULL にすることはできません。 NULL 文字列ポインター値を処理する必要がある場合は、RtlStringCchCatNEx を使用します。

安全な文字列関数の詳細については、「安全な文字列関数の 使用」を参照してください。

要件

要件 値
サポートされている最小のクライアント Service Pack 1 (SP1) 以降のバージョンの Windows XP で使用できます。
対象プラットフォーム デスクトップ
Header ntstrsafe.h (Ntstrsafe.h を含む)
Library Ntstrsafe.lib
IRQL 操作される文字列が常にメモリ内に存在する場合は 、それ以外の場合は PASSIVE_LEVEL

こちらもご覧ください

RtlStringCbCatN

RtlStringCchCat

RtlStringCchCatNEx