次の方法で共有


RtlUnicodeStringCchCopyN 関数 (ntstrsafe.h)

RtlUnicodeStringCchCopyN 関数は、コピーした文字列のサイズを制限しながら、UNICODE_STRING 構造体間で文字列をコピーします。

構文

NTSTRSAFEDDI RtlUnicodeStringCchCopyN(
  [out] PUNICODE_STRING  DestinationString,
  [in]  PCUNICODE_STRING SourceString,
  [in]  size_t           cchToCopy
);

パラメーター

[out] DestinationString

コピーした文字列を受け取る UNICODE_STRING 構造体へのポインター。 SourceString パラメーターの UNICODE_STRING 構造体が指す文字列は、DestinationString パラメーターの UNICODE_STRING 構造体が指すバッファーにコピーされます。 構造体の文字列バッファー内の最大文字数はNTSTRSAFE_UNICODE_STRING_MAX_CCH。

[in] SourceString

コピーする文字列を含む UNICODE_STRING 構造体へのポインター。 構造体の文字列バッファー内の最大文字数はNTSTRSAFE_UNICODE_STRING_MAX_CCH。

[in] cchToCopy

コピー元からコピー先にコピーする文字数。

戻り値

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

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

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

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

備考

RtlUnicodeStringCchCopyN 関数は、コピー操作がバッファーの末尾を超えて書き込まれないように、コピー先バッファーのサイズを使用します。 この関数は、結果の文字列を null 文字で終了しません。

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

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

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

必要条件

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

関連項目

RtlUnicodeStringCchCopyN する

RtlUnicodeStringCchCopyNEx

UNICODE_STRING