RtlUnicodeStringInitEx 関数 (ntstrsafe.h)

  • [アーティクル]

RtlUnicodeStringInitEx 関数は、UNICODE_STRING構造体を初期化します。

構文

NTSTRSAFEDDI RtlUnicodeStringInitEx(
  [out]          PUNICODE_STRING  DestinationString,
  [in, optional] NTSTRSAFE_PCWSTR pszSrc,
  [in]           DWORD            dwFlags
);

パラメーター

[out] DestinationString

任意。 初期化する UNICODE_STRING 構造体へのポインター。 pszSrc ポインターは、DestinationString パラメーターの UNICODE_STRING 構造体にコピーされます。 pszSrc が指す文字列内の最大文字数はNTSTRSAFE_UNICODE_STRING_MAX_CCH。 DestinationString は NULL にできますが、 STRSAFE_IGNORE_NULLSが dwFlags で設定されている場合にのみ使用できます。

[in, optional] pszSrc

省略可能。 null で終わる文字列定数へのポインター。 この文字列ポインターは、DestinationString パラメーターによって指されるUNICODE_STRING構造体の Buffer メンバーにコピーされます。 この文字列ポインターには NULL を指定できます。

[in] dwFlags

次のフラグが定義されています。

STRSAFE_IGNORE_NULLS

このフラグが設定されている場合、ソース ポインターは NULL にすることができます。 RtlUnicodeStringInitEx は 、NULL ソース バッファー ポインターを、コピーできる空の文字列 (TEXT("")) のように扱います。

戻り値

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

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

RtlUnicodeStringInitEx は、次のいずれかの場合にSTATUS_INVALID_PARAMETER値を返します。

  • pszSrc パラメーターが指す文字列の長さがNTSTRSAFE_UNICODE_STRING_MAX_CCH文字を超えています。
  • DestinationString ポインターは NULL ですが、pszSrc ポインターは NULL ではありません。
NTSTATUS 値をテストする方法については、「 NTSTATUS 値の使用」を参照してください。

注釈

RtlUnicodeStringInitEx 関数は、次の処理を行います。

  • pszSrc パラメーターが指す文字列の長さ (バイト単位) に、UNICODE_STRING構造体の Length メンバーを設定します。
  • pszSrc パラメーターが指す文字列の長さ (バイト単位) に、UNICODE_STRING構造体の MaximumLength メンバーを 2 バイトを加算して設定します。
  • pszSrc パラメーターが指定するアドレスに、UNICODE_STRING構造体の Buffer メンバーを設定します。
destinationString ポインターは、STRSAFE_IGNORE_NULLS フラグが設定されていない限り NULL にすることはできません。

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

要件

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

こちらもご覧ください

RtlUnicodeStringInit

UNICODE_STRING