RtlStringCchCopyUnicodeStringEx 関数 (ntstrsafe.h)

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

構文

NTSTRSAFEDDI RtlStringCchCopyUnicodeStringEx(
  [out]           NTSTRSAFE_PWSTR  pszDest,
  [in]            size_t           cchDest,
  [in]            PCUNICODE_STRING SourceString,
  [out]           NTSTRSAFE_PWSTR  *ppszDestEnd,
  [out, optional] size_t           *pcchRemaining,
  [in]            DWORD            dwFlags
);

パラメーター

[out] pszDest

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

[in] cchDest

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

[in] SourceString

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

[out] ppszDestEnd

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

[out, optional] pcchRemaining

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

[in] dwFlags

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

戻り値

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

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

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

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

注釈

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

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

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

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

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

要件

こちらもご覧ください

• RtlStringCbCopyUnicodeStringEx
• RtlStringCchCopyUnicodeString
• UNICODE_STRING