RtlUnicodeStringCchCatStringNEx 関数 (ntstrsafe.h)
RtlUnicodeStringCchCatStringNEx 関数は、コピー先の文字列がUNICODE_STRING構造体に含まれるときに、追加された文字列のサイズを制限しながら、2 つの文字列を連結します。
構文
NTSTRSAFEDDI RtlUnicodeStringCchCatStringNEx(
[in, out] PUNICODE_STRING DestinationString,
[in] NTSTRSAFE_PCWSTR pszSrc,
[in] size_t cchToAppend,
[out, optional] PUNICODE_STRING RemainingString,
[in] DWORD dwFlags
);
パラメーター
[in, out] DestinationString
任意。 UNICODE_STRING構造体へのポインター。 この構造体には、入力時にソース文字列を連結する文字列を含むバッファーが含まれます。 出力時、このバッファーは、結果の文字列全体を含む宛先バッファーです。 ソース文字列 (終端の null を除く) は、変換先の文字列の末尾に追加されます。 構造体の文字列バッファー内の最大文字数はNTSTRSAFE_UNICODE_STRING_MAX_CCH。 DestinationString は NULL にできますが、 dwFlags でSTRSAFE_IGNORE_NULLSが設定されている場合にのみ使用できます。
[in] pszSrc
null で終わる文字列への呼び出し元が指定したポインター。 この文字列は、 DestinationString が記述する文字列の末尾に連結されます。 pszSrc は NULL にできますが、 dwFlags でSTRSAFE_IGNORE_NULLSが設定されている場合にのみ使用できます。
[in] cchToAppend
DestinationString パラメーターが記述する文字列に追加する最大文字数。
[out, optional] RemainingString
省略可能。 呼び出し元が、UNICODE_STRING構造体への NULL 以外のポインターを提供する場合、関数は、この構造体の Buffer メンバーを連結文字列の末尾に設定し、構造体の Length メンバーを 0 に設定し、構造体の MaximumLength メンバーを宛先バッファーに残っているバイト数に設定します。 RemainingString は NULL にできますが、 dwFlags でSTRSAFE_IGNORE_NULLSが設定されている場合にのみ使用できます。
[in] dwFlags
1 つ以上のフラグと、必要に応じて塗りつぶしバイト。 フラグは次のように定義されます。
| 値 | 意味 |
|---|---|
| STRSAFE_FILL_BEHIND | このフラグが設定され、関数が成功した場合、 dwFlags の下位バイトを使用して、文字列の最後の文字に続くコピー先バッファーの部分が埋まります。 |
| STRSAFE_IGNORE_NULLS | このフラグが設定されている場合、ソースポインターまたは宛先ポインター、またはその両方を NULL にすることができます。 RtlUnicodeStringCchCatStringNEx は 、NULL ソース バッファー ポインターを、コピーできる空の文字列 (TEXT("")) のように扱います。 **NULL** 宛先バッファー ポインターは、空でない文字列を受け取ることができません。 |
| STRSAFE_FILL_ON_FAILURE | このフラグが設定され、関数が失敗した場合は、 dwFlags の下位バイトを使用して、宛先バッファー全体を埋めます。 この操作により、既存のバッファーの内容が上書きされます。 |
| STRSAFE_NULL_ON_FAILURE | このフラグが設定され、関数が失敗した場合、宛先バッファーは空の文字列 (TEXT("")) に設定されます。 この操作により、既存のバッファーの内容が上書きされます。 |
| STRSAFE_NO_TRUNCATION |
このフラグが設定され、関数が STATUS_BUFFER_OVERFLOWを返す場合:
|
| STRSAFE_ZERO_LENGTH_ON_FAILURE | このフラグが設定され、関数がSTATUS_BUFFER_OVERFLOWを返す場合、変換先の文字列の長さは 0 バイトに設定されます。 |
戻り値
RtlUnicodeStringCchCatStringNEx は 、次の NTSTATUS 値のいずれかを返します。
| リターン コード | 説明 |
|---|---|
| STATUS_SUCCESS | この 成功 状態は、ソース データが存在し、文字列が切り捨てられずに連結されたことを意味します。 |
| STATUS_BUFFER_OVERFLOW | この 警告 状態は、ターゲット バッファーの領域が不足しているため、連結操作が完了しなかったことを意味します。 STRSAFE_NO_TRUNCATIONが設定されている場合は、dwFlags パラメーターを参照してください。 |
| STATUS_INVALID_PARAMETER | この エラー 状態は、関数が無効な入力パラメーターを受け取ったことを意味します。 詳細については、次の一覧を参照してください。 |
RtlUnicodeStringCchCatStringNEx は、次のいずれかの場合にSTATUS_INVALID_PARAMETER値を返します。
- UNICODE_STRING構造体の内容が無効です。
- dwFlags で無効なフラグが指定されています。
- 宛先バッファーは既にいっぱいです。
- バッファー ポインターが NULL であり、 dwFlags でSTRSAFE_IGNORE_NULLS フラグが指定されていません。
- 宛先バッファー ポインターは NULL ですが、バッファー サイズは 0 ではありません。
- 宛先バッファー ポインターが NULL であるか、その長さが 0 ですが、0 以外の長さのソース文字列が存在します。
- cchToAppend パラメーターの値がNTSTRSAFE_UNICODE_STRING_MAX_CCHより大きい。
NTSTATUS 値をテストする方法については、「 NTSTATUS 値の使用」を参照してください。
注釈
RtlUnicodeStringCchCatStringNEx 関数は、ターゲット バッファーのサイズを使用して、連結操作がバッファーの末尾を超えて書き込まれないようにします。 既定では、関数は null 文字値 (つまり、ゼロ) で結果の文字列を終了 しません 。 オプションとして、呼び出し元は、STRSAFE_FILL_BEHIND フラグと 0 のフィル バイト値を使用して、変換先バッファー全体を占有しない結果の文字列を null 終了できます。
RtlUnicodeStringCchCatStringNExは、宛先文字列の末尾とその文字列で使用されていないバイト数を識別するUNICODE_STRING構造体を返すことによって、RtlUnicodeStringCchCatStringN 関数の機能を追加します。 フラグは、追加の制御のために RtlUnicodeStringCchCatStringNEx に渡すことができます。
ソース文字列と変換先文字列が重複する場合、関数の動作は未定義です。
STRSAFE_IGNORE_NULLS フラグが dwFlags に設定されていない限り、pszSrc ポインターと DestinationString ポインターを NULL にすることはできません。 STRSAFE_IGNORE_NULLSが設定されている場合、これらのポインターの一方または両方を NULL にすることができます。 DestinationString ポインターが NULL の場合、pszSrc ポインターは NULL であるか、空の文字列を指す必要があります。
安全な文字列関数の詳細については、「安全な文字列関数の 使用」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows XP Service Pack 1 (SP1) 以降で使用できます。 |
| 対象プラットフォーム | デスクトップ |
| Header | ntstrsafe.h (Ntstrsafe.h を含む) |
| Library | Ntstrsafe.lib |
| IRQL | 操作されている文字列が常にメモリ内に存在する場合は 。それ以外の場合は PASSIVE_LEVEL |