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 関数を使用します。

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

要件

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

こちらもご覧ください

RtlUnicodeStringPrintfEx

RtlUnicodeStringVPrintf

RtlUnicodeStringVPrintfEx

UNICODE_STRING