RtlUnicodeStringCatEx 関数 (ntstrsafe.h)

RtlUnicodeStringCatEx 関数は、UNICODE_STRING構造体に含まれる 2 つの文字列を連結します。

構文

NTSTRSAFEDDI RtlUnicodeStringCatEx(
  [in, out]       PUNICODE_STRING  DestinationString,
  [in]            PCUNICODE_STRING SourceString,
  [out, optional] PUNICODE_STRING  RemainingString,
  [in]            DWORD            dwFlags
);

パラメーター

[in, out] DestinationString

任意。 UNICODE_STRING構造体へのポインター。 この構造体には、入力時に、ソース文字列を連結する宛先文字列を含むバッファーが含まれます。 出力時、このバッファーは、結果の文字列全体を含む宛先バッファーです。 変換元の文字列は、コピー先の文字列の末尾に追加されます。 構造体の文字列バッファー内の最大バイト数は です NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR)。 DestinationString は NULL にできますが、 STRSAFE_IGNORE_NULLSが dwFlags で設定されている場合にのみ使用できます。

[in] SourceString

省略可能。 UNICODE_STRING構造体へのポインター。 この構造体には、ソース文字列を含むバッファーが含まれています。 この文字列は、変換先の文字列の末尾に追加されます。 構造体の文字列バッファー内の最大バイト数は です NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR)。 SourceString は NULL にできますが、 STRSAFE_IGNORE_NULLSが dwFlags で設定されている場合にのみ使用できます。

[out, optional] RemainingString

省略可能。 呼び出し元がUNICODE_STRING構造体への NULL 以外のポインターを提供する場合、関数はこの構造体の Buffer メンバーを連結文字列の末尾に設定し、構造体の Length メンバーを 0 に設定し、構造体の MaximumLength メンバーを宛先バッファーに残っているバイト数に設定します。 RemainingString は NULL にできますが、 dwFlags でSTRSAFE_IGNORE_NULLSが設定されている場合にのみ使用できます。

[in] dwFlags

1 つ以上のフラグと、必要に応じて塗りつぶしバイト。 フラグは次のように定義されます。

戻り値

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

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

• UNICODE_STRING構造体の内容が無効です。
• dwFlags で無効なフラグが指定されています。
• 宛先バッファーは既にいっぱいです。
• バッファー ポインターが NULL で、STRSAFE_IGNORE_NULLS フラグが指定されていません。
• 宛先バッファー ポインターは NULL ですが、バッファー サイズは 0 ではありません。
• コピー先バッファー ポインターが NULL であるか、その長さが 0 ですが、0 以外の長さのソース文字列が存在します。

NTSTATUS 値をテストする方法については、「 NTSTATUS 値の使用」を参照してください。

注釈

RtlUnicodeStringCatEx 関数は、コピー先バッファーのサイズを使用して、連結操作がバッファーの末尾を超えて書き込まれないことを確認します。 既定では、関数は null 文字値 (つまり、0) で結果の文字列を終了 しません 。 オプションとして、呼び出し元は、STRSAFE_FILL_BEHIND フラグと 0 の塗りつぶしバイト値を使用して、宛先バッファー全体を占有しない結果の文字列を null で終了できます。

RtlUnicodeStringCatEx は、変換先の文字列の末尾とその文字列で使用されていないバイト数を識別するUNICODE_STRING構造体を返すことによって、RtlUnicodeStringCat 関数の機能を追加します。 RtlUnicodeStringCatEx にフラグを渡して、追加の制御を行うことができます。

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

sourceString ポインターと DestinationString ポインターは、dwFlags でSTRSAFE_IGNORE_NULLS フラグが設定されていない限り NULL にすることはできません。 STRSAFE_IGNORE_NULLSが設定されている場合、これらのポインターの一方または両方を NULL にすることができます。 DestinationString ポインターが NULL の場合、SourceString ポインターは NULL であるか、UNICODE_STRING構造体が空の文字列を記述する必要があります。

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

要件

こちらもご覧ください

• RtlUnicodeStringCat
• UNICODE_STRING