次の方法で共有

RtlUnicodeStringPrintf 関数 (ntstrsafe.h)

  • [アーティクル]

RtlUnicodeStringPrintf 関数は、指定された書式設定情報に基づいて書式設定されたテキスト文字列を作成し、文字列を UNICODE_STRING 構造体に格納します。

構文

NTSTRSAFEDDI RtlUnicodeStringPrintf(
  [out] PUNICODE_STRING  DestinationString,
  [in]  NTSTRSAFE_PCWSTR pszFormat,
        ...              
);

パラメーター

[out] DestinationString

書式設定された文字列を受け取る UNICODE_STRING 構造体へのポインター。 RtlUnicodeStringPrintf 、pszFormat で指定 書式設定文字列と関数の引数リストからこの文字列を作成します。 文字列内の最大文字数はNTSTRSAFE_UNICODE_STRING_MAX_CCH。

[in] pszFormat

printf スタイルの書式設定ディレクティブ含む null で終わるテキスト文字列へのポインター。

...

随意。 pszFormat 文字列に含まれる書式設定ディレクティブに基づいて、関数が解釈する引数のリスト。

戻り値

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

リターン コード 形容
STATUS_SUCCESS
 この 成功 状態は、ソース データが存在し、文字列が切り捨てられずにコピーされ、結果の宛先バッファーが null で終了したことを意味します。
STATUS_BUFFER_OVERFLOW
 この 警告 状態は、バッファー領域が不足しているために操作が完了しなかったことを意味します。 コピー先バッファーには、意図した結果の、null で終わる切り捨てられたバージョンが含まれています。
STATUS_INVALID_PARAMETER
 この エラー 状態は、関数が無効な入力パラメーターを受け取ったことを意味します。 詳細については、次の一覧を参照してください。
 

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

  • DestinationString パラメーターが指す UNICODE_STRING 構造体の内容は無効です。
  • 宛先バッファーは既にいっぱいです。
  • NULL ポインターが存在します。
  • コピー先バッファーの長さは 0 ですが、0 以外の長さのソース文字列が存在します。
NTSTATUS 値をテストする方法については、「NTSTATUS 値の使用」を参照してください。

備考

RtlUnicodeStringPrintf 関数は、コピー先バッファーのサイズを使用して、文字列の書式設定操作がバッファーの末尾を超えて書き込まれないことを確認します。 この関数は、結果の文字列を null 文字で終了しません。

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

pszFormat ポインターと DestinationString ポインターを NULL することはできません。 null ポインター値 処理する必要がある場合は、RtlUnicodeStringPrintfEx 関数を使用します。

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

必要条件

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

関連項目

RtlUnicodeStringPrintfEx の

RtlUnicodeStringVPrintf の

RtlUnicodeStringVPrintfEx の

UNICODE_STRING