RtlStringCchVPrintfExW 関数 (ntstrsafe.h)

  • [アーティクル]

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

構文

NTSTRSAFEDDI RtlStringCchVPrintfExW(
  [out]           NTSTRSAFE_PWSTR  pszDest,
  [in]            size_t           cchDest,
  [out, optional] NTSTRSAFE_PWSTR  *ppszDestEnd,
  [out, optional] size_t           *pcchRemaining,
  [in]            DWORD            dwFlags,
  [in, optional]  NTSTRSAFE_PCWSTR pszFormat,
  [in]            va_list          argList
);

パラメーター

[out] pszDest

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

[in] cchDest

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

[out, optional] ppszDestEnd

呼び出し元が非NULL アドレス ポインターを指定した場合、操作が完了すると、関数はそのアドレスを宛先バッファーの結果の null 文字列ターミネータへのポインターで読み込みます。

[out, optional] pcchRemaining

呼び出し元が非NULL アドレス ポインターを指定した場合、関数は、pszDest によって指されるバッファー内の未使用のバイト数 (終端の null 文字に使用されるバイトを含む) を持つアドレスを読み込みます。

[in] dwFlags

1 つ以上のフラグと、必要に応じてフィル バイト。 フラグは次のように定義されます。

価値 意味
STRSAFE_FILL_BEHIND_NULL
設定が成功し、関数が成功した場合、dwFlags の下位バイトを使用して、終端の null 文字に続く宛先バッファーの部分を埋めます。
STRSAFE_IGNORE_NULLS
設定した場合、pszDest NULLできます。 nullpszDest ポインターは、空でない文字列を受け取ることができません。
STRSAFE_FILL_ON_FAILURE
設定が失敗し、関数が失敗した場合、dwFlags の下位バイトが宛先バッファー全体を埋めるために使用され、バッファーは null で終了します。 この操作により、既存のバッファーの内容が上書きされます。
STRSAFE_NULL_ON_FAILURE
set と関数が失敗した場合、宛先バッファーは空の文字列 (TEXT("")) に設定されます。 この操作により、既存のバッファーの内容が上書きされます。
STRSAFE_NO_TRUNCATION
set を設定し、関数がSTATUS_BUFFER_OVERFLOWを返す場合、コピー先バッファーの内容は変更されません。

[in, optional] pszFormat

printfスタイルの書式設定ディレクティブ 含む null で終わるテキスト文字列へのポインター。 pszFormat ポインターは NULLできますが、dwFlagsでSTRSAFE_IGNORE_NULLSが設定されている場合にのみ 。

[in] argList

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

戻り値

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

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

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

  • 無効なフラグが指定されました。
  • cchDest の値が最大バッファー サイズを超えています。
  • 宛先バッファーは既にいっぱいでした。
  • NULL ポインターが、STRSAFE_IGNORE_NULLS フラグなしで存在していました。
  • 宛先バッファー ポインターは NULLされましたが、バッファー サイズは 0 ではありません。
  • 宛先バッファー ポインターが NULLされたか、長さが 0 であったが、0 以外の長さのソース文字列が存在していた。

備考

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

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

RtlStringCchVPrintfExW と RtlStringCchVPrintfExA 、宛先文字列の末尾へのポインターと、その文字列で使用されていない文字数を返すことで、RtlStringCchVPrintf を する機能を追加します。 フラグは、追加の制御のために関数に渡すことができます。

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

RtlStringCchVPrintfExW 使用して Unicode 文字列を処理し、ANSI 文字列を処理する RtlStringCchVPrintfExA を します。 使用するフォームは、データによって異なります。

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

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

STRSAFE_IGNORE_NULLS フラグが設定されていない限り、pszDest NULL を することはできません。

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

必要条件

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

関連項目

RtlStringCbVPrintfEx の

RtlStringCchPrintfEx の

RtlStringCchVPrintf の