RtlStringCchVPrintfA 関数 (ntstrsafe.h)

  • [アーティクル]

RtlStringCchVPrintfW 関数と RtlStringCchVPrintfA 関数は、指定された書式設定情報に基づく書式設定を使用して、文字カウントされたテキスト文字列を作成します。

構文

NTSTRSAFEDDI RtlStringCchVPrintfA(
  [out] NTSTRSAFE_PSTR  pszDest,
  [in]  size_t          cchDest,
  [in]  NTSTRSAFE_PCSTR pszFormat,
  [in]  va_list         argList
);

パラメーター

[out] pszDest

書式設定された null で終わる文字列を受け取る、呼び出し元が指定したバッファーへのポインター。 この関数は、 pszFormat によって提供される書式設定文字列と argList によって指定された引数の両方からこの文字列を作成します。

[in] cchDest

変換先バッファーのサイズ (文字数)。 バッファーは、書式設定された文字列と終端の null 文字を含むのに十分な大きさである必要があります。 使用できる最大文字数はNTSTRSAFE_MAX_CCH。

[in] pszFormat

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

[in] argList

va_list型指定された引数リスト。 引数リストに含まれる引数は、 pszFormat によって提供される書式設定文字列を使用して解釈されます。

戻り値

関数は、次の表に示す NTSTATUS 値のいずれかを返します。 NTSTATUS 値をテストする方法については、「 NTSTATUS 値の使用」を参照してください。

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

関数は、次の場合にSTATUS_INVALID_PARAMETER値を返します。

  • cchDest の値が最大バッファー サイズを超えています。
  • 宛先バッファーは既にいっぱいでした。
  • NULL ポインターが存在しました。
  • コピー先のバッファー長は 0 でしたが、0 以外の長さのソース文字列が存在しました。

注釈

RtlStringCchVPrintfW と RtlStringCchVPrintfA は、次の関数の代わりに使用する必要があります。

  • vsprintf
  • vswprintf
  • _vsnprintf
  • _vsnwprintf
これらの関数はすべて、va_list型引数リストとして提供される書式指定文字列とその 引数を受け入れ、書式設定された文字列を返します。 RtlStringCchVPrintfW と RtlStringCchVPrintfA は、関数がバッファーの末尾を超えて書き込まないようにするために、コピー先バッファーのサイズを文字単位で受け取ります。

va_list型指定された引数リストの詳細については、Microsoft Windows SDKのドキュメントを参照してください。

RtlStringCchVPrintfW を使用して Unicode 文字列を処理し、RtlStringCchVPrintfA を使用して ANSI 文字列を処理します。 次の表に示すように、使用するフォームはデータによって異なります。

文字列データ型 文字列リテラル 機能
WCHAR L"string" RtlStringCchVPrintfW
char "string" RtlStringCchVPrintfA
 

pszDest と pszFormat が重複する文字列を指している場合、または引数文字列が重複している場合、関数の動作は未定義です。

pszFormat も pszDest も NULL にすることはできません。 NULL 文字列ポインター値を処理する必要がある場合は、RtlStringCchVPrintfEx を使用します。

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

要件

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

こちらもご覧ください

RtlStringCbVPrintf

RtlStringCchPrintf

RtlStringCchVPrintfEx