RtlUnicodeStringInit 関数 (ntstrsafe.h)

  • [アーティクル]

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

構文

NTSTRSAFEDDI RtlUnicodeStringInit(
  [out]          PUNICODE_STRING  DestinationString,
  [in, optional] NTSTRSAFE_PCWSTR pszSrc
);

パラメーター

[out] DestinationString

初期化する UNICODE_STRING 構造体へのポインター。 pszSrc ポインターは DestinationString パラメーターのUNICODE_STRING構造体にコピーされます。 pszSrc が指す文字列内の最大文字数がNTSTRSAFE_UNICODE_STRING_MAX_CCH。

[in, optional] pszSrc

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

戻り値

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

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

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

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

注釈

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

  • pszSrc パラメーターが指すUNICODE_STRING構造体の Length メンバーを、pszSrc パラメーターが指す文字列の長さ (バイト単位) に設定します。
  • pszSrc パラメーターが指す文字列の長さ (バイト単位) に、UNICODE_STRING構造体の MaximumLength メンバーに 2 バイトを加算します。
  • pszSrc パラメーターが指定するアドレスに、UNICODE_STRING構造体の Buffer メンバーを設定します。
DestinationString ポインターは NULL にしないでください。 NULLDestinationString ポインター値を指定する必要がある場合は、RtlUnicodeStringInitEx 関数を使用します。

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

要件

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

こちらもご覧ください

RtlUnicodeStringInitEx

UNICODE_STRING