RtlUnicodeStringCopy 関数 (ntstrsafe.h)

  • [アーティクル]

RtlUnicodeStringCopy 関数は、あるUNICODE_STRING構造体から別の構造体に文字列をコピーします。

構文

NTSTRSAFEDDI RtlUnicodeStringCopy(
  [out] PUNICODE_STRING  DestinationString,
  [in]  PCUNICODE_STRING SourceString
);

パラメーター

[out] DestinationString

UNICODE_STRING構造体へのポインター。 ソース文字列がコピー先の文字列にコピーされます。 構造体の文字列バッファー内の最大バイト数は NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR) です。

[in] SourceString

UNICODE_STRING構造体へのポインター。 この構造体には、ソース文字列を含むバッファーが含まれています。 この文字列はコピー先の文字列にコピーされます。 構造体の文字列バッファー内の最大バイト数は NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR) です。

戻り値

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

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

RtlUnicodeStringCopy は、次のいずれかが発生したときにSTATUS_INVALID_PARAMETER値を返します。

  • UNICODE_STRING構造体の内容が無効です。
  • 宛先バッファーは既にいっぱいです。
  • バッファー ポインターが NULL です。
  • コピー先バッファーの長さは 0 ですが、0 以外の長さのソース文字列が存在します。
NTSTATUS 値をテストする方法については、「 NTSTATUS 値の使用」を参照してください。

注釈

RtlUnicodeStringCopy 関数は、コピー先バッファーのサイズを使用して、コピー操作がバッファーの末尾を超えて書き込まれないことを確認します。 コピー先バッファーの末尾で文字列を切り捨てる必要がある場合、関数は結果の文字列を null 文字で終了しません。

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

SourceString ポインターと DestinationString ポインターを NULL にすることはできません。 NULL ポインター値を処理する必要がある場合は、RtlUnicodeStringCopyEx 関数を使用します。

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

要件

要件 値
サポートされている最小のクライアント Service Pack 1 (SP1) 以降のバージョンの Windows XP で使用できます。
対象プラットフォーム デスクトップ
Header ntstrsafe.h (Ntstrsafe.h を含む)
Library Ntstrsafe.lib
IRQL 操作される文字列が常にメモリ内に存在する場合は 、それ以外の場合は PASSIVE_LEVEL

こちらもご覧ください

RtlUnicodeStringCopyEx

UNICODE_STRING