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