次の方法で共有

RtlStringCbVPrintfA 関数 (ntstrsafe.h)

RtlStringCbVPrintfW および RtlStringCbVPrintfA 関数 は、指定された書式設定情報に基づく書式設定を使用して、バイトカウントテキスト文字列を作成します。

構文

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

パラメーター

[out] pszDest

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

[in] cbDest

コピー先バッファーのサイズ (バイト単位)。 バッファーは、書式設定された文字列と終端の null 文字を含めるのに十分な大きさである必要があります。

Unicode 文字列の場合、最大バイト数は NTSTRSAFE_MAX_CCH * sizeof(WCHAR) です。

ANSI 文字列の場合、最大バイト数は NTSTRSAFE_MAX_CCH * sizeof(char) です。

[in] pszFormat

printf-styled formatting ディレクティブを含む null で終わるテキスト文字列へのポインター。

[in] argList

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

戻り値

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

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

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

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

備考

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

  • vsprintf の
  • vswprintf を する
  • _vsnprintf
  • _ vsnwprintf
これらの関数はすべて、書式指定文字列と、va_list型指定された引数リスト内の引数のセットを受け取り、書式設定された文字列を返します。 コピー先バッファーのサイズ (バイト単位) は、RtlStringCbVPrintfW を し、RtlStringCbVPrintfA を して、バッファーの末尾を越えて書き込まないようにします。

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

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

文字列データ型 文字列リテラル 機能
WCHAR L"string" RtlStringCbVPrintfW の
char を する "string" RtlStringCbVPrintfA の
 

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

pszFormat pszDest を NULL しないでください。 null 文字列ポインター値 処理する必要がある場合は、RtlStringCbVPrintfEx 使用します。

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

必要条件

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

関連項目

RtlStringCbPrintf の

RtlStringCbVPrintfEx の

RtlStringCchVPrintf の