RtlUnicodeStringCbCatN 関数 (ntstrsafe.h)

  • [アーティクル]

RtlUnicodeStringCbCatN 関数は、コピーした文字列のサイズを制限しながら、UNICODE_STRING構造体に含まれる 2 つの文字列を連結します。

構文

NTSTRSAFEDDI RtlUnicodeStringCbCatN(
  [in, out] PUNICODE_STRING  DestinationString,
  [in]      PCUNICODE_STRING SourceString,
  [in]      size_t           cbToAppend
);

パラメーター

[in, out] DestinationString

UNICODE_STRING構造体へのポインター。 この構造体には、入力時に、ソース文字列を連結する宛先文字列を含むバッファーが含まれます。 出力時、このバッファーは、結果の文字列全体を含む宛先バッファーです。 ソース文字列は、変換先の文字列の末尾に追加されます。 構造体の文字列バッファー内の最大バイト数は NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR) です。

[in] SourceString

UNICODE_STRING構造体へのポインター。 この構造体には、ソース文字列を含むバッファーが含まれています。 この文字列は、変換先の文字列の末尾に追加されます。 構造体の文字列バッファー内の最大バイト数は NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR) です。

[in] cbToAppend

DestinationString パラメーターが記述する文字列に追加する最大バイト数。

戻り値

RtlUnicodeStringCbCatN は 、次のいずれかの NTSTATUS 値を返します。

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

RtlUnicodeStringCbCatN は、次のいずれかの場合にSTATUS_INVALID_PARAMETER値を返します。

  • UNICODE_STRING構造体の内容が無効です。
  • 宛先バッファーは既にいっぱいです。
  • バッファー ポインターが NULL です。
  • 宛先バッファーの長さは 0 ですが、0 以外の長さのソース文字列が存在します。
  • cbToAppend パラメーターの値が NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR) を超えています。
NTSTATUS 値をテストする方法については、「 NTSTATUS 値の使用」を参照してください。

注釈

RtlUnicodeStringCbCatN 関数は、ターゲット バッファーのサイズを使用して、連結操作がバッファーの末尾を超えて書き込まれないようにします。 関数は、null 文字値 (つまり、ゼロ) で結果の文字列を終了 しません 。

ソース文字列と変換先文字列が重複する場合、関数の動作は未定義です。

SourceString ポインターと DestinationString ポインターを NULL にすることはできません。 NULL ポインター値を処理する必要がある場合は、RtlUnicodeStringCbCatNEx 関数を使用します。

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

要件

要件 値
サポートされている最小のクライアント Service Pack 1 (SP1) 以降のバージョンの Windows XP で使用できます。
対象プラットフォーム デスクトップ
Header ntstrsafe.h (Ntstrsafe.h を含む)
Library Ntstrsafe.lib
IRQL PASSIVE_LEVEL

こちらもご覧ください

RtlUnicodeStringCbCatNEx

RtlUnicodeStringCchCatN

UNICODE_STRING