RtlStringCbCopyUnicodeStringEx 関数 (ntstrsafe.h)

  • [アーティクル]

RtlStringCbCopyUnicodeStringEx 関数は、UNICODE_STRING構造体の内容を指定したコピー先にコピーします。

構文

NTSTRSAFEDDI RtlStringCbCopyUnicodeStringEx(
  [out]           NTSTRSAFE_PWSTR  pszDest,
  [in]            size_t           cbDest,
  [in]            PCUNICODE_STRING SourceString,
  [out]           NTSTRSAFE_PWSTR  *ppszDestEnd,
  [out, optional] size_t           *pcbRemaining,
  [in]            DWORD            dwFlags
);

パラメーター

[out] pszDest

任意。 コピーした文字列を受け取るバッファーへのポインター。 SourceString パラメーターの UNICODE_STRING 構造体が指す文字列は、pszDest のバッファーにコピーされ、null 文字で終了します。 このポインターは NULL にできますが、 STRSAFE_IGNORE_NULLSが dwFlags で設定されている場合にのみ使用できます。

[in] cbDest

コピー先バッファーのサイズ (バイト単位)。 バッファーは、文字列と終端の null 文字に十分な大きさにする必要があります。 バッファー内の最大バイト数は です NTSTRSAFE_MAX_CCH * sizeof(WCHAR)。

[in] SourceString

省略可能。 コピーする文字列を含む UNICODE_STRING 構造体へのポインター。 文字列内の最大バイト数は です NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR)。 このポインターは NULL にできますが、 STRSAFE_IGNORE_NULLSが dwFlags で設定されている場合にのみ使用できます。

[out] ppszDestEnd

省略可能。 呼び出し元が NULL 以外のアドレス ポインターを指定した場合、コピー操作が完了すると、関数は宛先バッファーの結果の NULL 文字列ターミネータへのポインターを使用してそのアドレスを読み込みます。

[out, optional] pcbRemaining

省略可能。 呼び出し元が NULL 以外のアドレス ポインターを提供する場合、関数は、 pszDest が指すバッファー内にある未使用のバイト数 (終端の null 文字に使用されるバイトを含む) を含むアドレスを読み込みます。

[in] dwFlags

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

値 意味
STRSAFE_FILL_BEHIND_NULL このフラグが設定され、関数が成功した場合、 dwFlags の下位バイトを使用して、終端の null 文字に続く宛先バッファーの部分を埋めます。
STRSAFE_IGNORE_NULLS このフラグが設定されている場合は、ソースポインターまたは宛先ポインター、またはその両方を NULL にすることができます。 RtlStringCbCopyUnicodeStringEx は、NULL ソース バッファー ポインターを、コピーできる空の文字列 (TEXT("")) のように扱います。 NULL 宛先バッファー ポインターは、空でない文字列を受け取ることができません。
STRSAFE_FILL_ON_FAILURE このフラグが設定され、関数が失敗した場合、 dwFlags の下位バイトを使用して宛先バッファー全体が埋め込まれます。バッファーは null で終了します。 この操作により、既存のバッファーの内容が上書きされます。
STRSAFE_NULL_ON_FAILURE このフラグが設定され、関数が失敗した場合、宛先バッファーは空の文字列 (TEXT("")) に設定されます。 この操作により、既存のバッファーの内容が上書きされます。
STRSAFE_NO_TRUNCATION

このフラグが設定され、関数が STATUS_BUFFER_OVERFLOWを返す場合:

  • STRSAFE_FILL_ON_FAILUREも指定した場合、STRSAFE_NO_TRUNCATIONはそれに応じて宛先バッファーを埋めます。
  • それ以外の場合、STRSAFE_NULL_ON_FAILUREが設定されていない場合でも、コピー先バッファー の 内容は空の文字列に設定されます。 STRSAFE_FILL_BEHIND_NULL は無視されます。

戻り値

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

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

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

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

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

注釈

RtlStringCbCopyUnicodeStringEx 関数は、コピー先バッファーのサイズ (cbDest パラメーターで指定) を使用して、コピー操作がバッファーの末尾を超えて書き込まれないことを確認します。

RtlStringCbCopyUnicodeStringEx は、宛先文字列の末尾へのポインターと、その文字列で使用されていないバイト数を返すことによって 、RtlStringCbCopyUnicodeString 関数の機能を追加します。 関数にフラグを渡して、追加の制御を行うことができます。

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

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

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

要件

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

こちらもご覧ください