RtlUnicodeStringCchCopyStringNEx 関数 (ntstrsafe.h)
RtlUnicodeStringCchCopyStringNEx 関数は、コピーした文字列のサイズを制限しながら、文字列をUNICODE_STRING構造体にコピーします。
構文
NTSTRSAFEDDI RtlUnicodeStringCchCopyStringNEx(
[out] PUNICODE_STRING DestinationString,
[in] NTSTRSAFE_PCWSTR pszSrc,
[in] size_t cchToCopy,
[out, optional] PUNICODE_STRING RemainingString,
[in] DWORD dwFlags
);
パラメーター
[out] DestinationString
任意。 コピーした文字列を受け取る UNICODE_STRING 構造体へのポインター。 *pszSrc *parameter が指す文字列 (終端の null を除く) は、 DestinationString パラメーターの UNICODE_STRING 構造体が指すバッファーにコピーされます。 文字列内の最大文字数はNTSTRSAFE_UNICODE_STRING_MAX_CCH。 DestinationString は NULL にできますが、 STRSAFE_IGNORE_NULLSが dwFlags で設定されている場合にのみ使用できます。
[in] pszSrc
省略可能。 コピーする文字列へのポインター。 このポインターは NULL にできますが、 STRSAFE_IGNORE_NULLSが dwFlags で設定されている場合にのみ使用できます。
[in] cchToCopy
ソースからコピー先にコピーする文字数。
[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 にすることができます。 RtlUnicodeStringCchCopyStringNEx は 、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 バイトに設定されます。 |
戻り値
RtlUnicodeStringCchCopyStringNEx は 、次のいずれかの NTSTATUS 値を返します。
| リターン コード | 説明 |
|---|---|
| STATUS_SUCCESS | この 成功 状態は、ソース データが存在し、文字列が切り捨てなしで連結されたことを意味します。 |
| STATUS_BUFFER_OVERFLOW | この 警告 状態は、コピー先バッファーの領域が不足しているため、コピー操作が完了しなかったことを意味します。 STRSAFE_NO_TRUNCATIONが dwFlags で設定されている場合、宛先バッファーは変更されません。 フラグが設定されていない場合、コピー先バッファーにはコピーされた文字列の切り捨てられたバージョンが含まれます。 |
| STATUS_INVALID_PARAMETER | この エラー 状態は、関数が無効な入力パラメーターを受け取ったことを意味します。 詳細については、次の一覧を参照してください。 |
RtlUnicodeStringCchCopyStringNEx は、次のいずれかが発生したときにSTATUS_INVALID_PARAMETER値を返します。
- UNICODE_STRING構造体の内容が無効です。
- dwFlags で無効なフラグが指定されています。
- 宛先バッファーは既にいっぱいです。
- バッファー ポインターが NULL であり、STRSAFE_IGNORE_NULLS フラグが dwFlags で指定されていません。
- 宛先バッファー ポインターは NULL ですが、バッファー サイズは 0 ではありません。
- コピー先バッファー ポインターが NULL であるか、その長さが 0 ですが、0 以外の長さのソース文字列が存在します。
- cchToCopy パラメーターの値がNTSTRSAFE_UNICODE_STRING_MAX_CCHより大きい。
NTSTATUS 値をテストする方法については、「 NTSTATUS 値の使用」を参照してください。
注釈
RtlUnicodeStringCchCopyStringNEx 関数は、コピー先バッファーのサイズを使用して、コピー操作がバッファーの末尾を超えて書き込まれないようにします。 既定では、関数は null 文字値 (つまり、0) で結果の文字列を終了 しません 。 オプションとして、呼び出し元は、STRSAFE_FILL_BEHIND フラグと 0 の塗りつぶしバイト値を使用して、宛先バッファー全体を占有しない結果の文字列を null で終了できます。
RtlUnicodeStringCchCopyStringNEx は、変換先の文字列の末尾とその文字列で使用されていないバイト数を識別するUNICODE_STRING構造体を返すことによって、RtlUnicodeStringCchCopyStringN 関数の機能を追加します。 RtlUnicodeStringCchCopyStringNEx にフラグを渡して、追加の制御を行うことができます。
ソース文字列と変換先の文字列が重複する場合、関数の動作は未定義です。
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 |