RtlUnicodeStringCbCopyStringNEx 関数 (ntstrsafe.h)

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

構文

NTSTRSAFEDDI RtlUnicodeStringCbCopyStringNEx(
  [out]           PUNICODE_STRING  DestinationString,
  [in]            NTSTRSAFE_PCWSTR pszSrc,
  [in]            size_t           cbToCopy,
  [out, optional] PUNICODE_STRING  RemainingString,
  [in]            DWORD            dwFlags
);

パラメーター

[out] DestinationString

任意。 コピーした文字列を受け取る UNICODE_STRING 構造体へのポインター。 pszSrc パラメーターが指す文字列 (終端の null を除く) は、DestinationString パラメーターの UNICODE_STRING 構造体が指すバッファーにコピーされます。 文字列内の最大バイト数は です NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR)。 DestinationString は NULL にできますが、 STRSAFE_IGNORE_NULLSが dwFlags で設定されている場合にのみ使用できます。

[in] pszSrc

省略可能。 コピーする文字列へのポインター。 このポインターは NULL にできますが、 STRSAFE_IGNORE_NULLSが dwFlags で設定されている場合にのみ使用できます。

[in] cbToCopy

ソースからコピー先にコピーされるバイト数。

[out, optional] RemainingString

省略可能。 呼び出し元がUNICODE_STRING構造体への NULL 以外のポインターを提供する場合、関数はこの構造体の Buffer メンバーを連結文字列の末尾に設定し、構造体の Length メンバーを 0 に設定し、構造体の MaximumLength メンバーを宛先バッファーに残っているバイト数に設定します。 RemainingString は NULL にできますが、 dwFlags でSTRSAFE_IGNORE_NULLSが設定されている場合にのみ使用できます。

[in] dwFlags

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

戻り値

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

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

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

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

注釈

RtlUnicodeStringCbCopyStringNEx 関数は、コピー先バッファーのサイズを使用して、コピー操作がバッファーの末尾を超えて書き込まれないようにします。 既定では、関数は null 文字値 (つまり、0) で結果の文字列を終了 しません 。 オプションとして、呼び出し元は、STRSAFE_FILL_BEHIND フラグと 0 の塗りつぶしバイト値を使用して、宛先バッファー全体を占有しない結果の文字列を null で終了できます。

RtlUnicodeStringCbCopyStringNEx は、変換先文字列の末尾とその文字列で使用されていないバイト数を識別するUNICODE_STRING構造体を返すことによって、RtlUnicodeStringCbCopyStringN 関数の機能を追加します。 追加のコントロールには、 RtlUnicodeStringCbCopyStringNEx フラグを渡すことができます。

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

STRSAFE_IGNORE_NULLS フラグが dwFlags で設定されていない限り、pszSrc ポインターと DestinationString ポインターを NULL にすることはできません。 STRSAFE_IGNORE_NULLSが設定されている場合、これらのポインターの一方または両方を NULL にすることができます。 DestinationString ポインターが NULL の場合、pszSrc ポインターは NULL であるか、空の文字列を指している必要があります。

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

要件

こちらもご覧ください

• RtlUnicodeStringCbCopyStringN
• RtlUnicodeStringCchCopyStringNEx
• UNICODE_STRING