RtlStringCchCopyUnicodeString 関数 (ntstrsafe.h)

  • [アーティクル]

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

構文

NTSTRSAFEDDI RtlStringCchCopyUnicodeString(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cchDest,
  [in]  PCUNICODE_STRING SourceString
);

パラメーター

[out] pszDest

コピーした文字列を受け取るバッファーへのポインター。 SourceString パラメーターの UNICODE_STRING 構造体が指す文字列は、pszDest のバッファーにコピーされ、null 文字で終了します。

[in] cchDest

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

[in] SourceString

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

戻り値

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

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

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

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

注釈

RtlStringCchCopyUnicodeString 関数は、コピー先バッファーのサイズ (cchDest で指定) を使用して、コピー操作がバッファーの末尾を超えて書き込まないようにします。

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

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

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

要件

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

こちらもご覧ください

RtlStringCbCopyUnicodeString

RtlStringCchCopyUnicodeStringEx

UNICODE_STRING