次の方法で共有

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 をできますが、dwFlags でSTRSAFE_IGNORE_NULLS設定されている場合に限ります。

[in, optional] pszSrc

随意。 null で終わる文字列定数へのポインター。 この文字列ポインターは、DestinationString パラメーターが指す UNICODE_STRING 構造体の Buffer メンバーにコピーされます。 この文字列ポインターは NULL できます。

[in] dwFlags

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

STRSAFE_IGNORE_NULLS

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

戻り値

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 関数は、次の処理を行います。

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

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

必要条件

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

関連項目

RtlUnicodeStringInit の

UNICODE_STRING