StringCbVPrintfA 関数 (strsafe.h)

  • [アーティクル]

引数のリストへのポインターを使用して、書式設定されたデータを指定された文字列に書き込みます。 コピー先バッファーのサイズは、このバッファーの末尾を超えて書き込まれないようにするために、関数に提供されます。

StringCbVPrintf は、次の関数に代わる関数です。

構文

STRSAFEAPI StringCbVPrintfA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cbDest,
  [in]  STRSAFE_LPCSTR pszFormat,
  [in]  va_list        argList
);

パラメーター

[out] pszDest

種類: LPTSTR

pszFormat および argList から作成された、書式設定された null で終わる文字列を受け取る宛先バッファー。

[in] cbDest

種類: size_t

コピー先バッファーのサイズ (バイト単位)。 この値は、最終的な書式設定された文字列と終端の null 文字に対応するために十分な大きさにする必要があります。 許容される最大バイト数は です STRSAFE_MAX_CCH * sizeof(TCHAR)。

[in] pszFormat

種類: LPCTSTR

書式指定文字列。 この文字列は null で終わる必要があります。 詳細については、「 書式指定構文」を参照してください。

[in] argList

種類: va_list

pszFormat 文字列に挿入する引数。

戻り値

型: HRESULT

この関数は、次のいずれかの値を返すことができます。 この関数の戻り値をテストするには、 SUCCEEDED マクロと FAILED マクロを使用することを強くお勧めします。

リターン コード 説明
S_OK
 結果を切り捨てずに pszDest にコピーするのに十分な領域があり、バッファーは null で終了します。
STRSAFE_E_INVALID_PARAMETER
 cbDest の値は 0 または よりSTRSAFE_MAX_CCH * sizeof(TCHAR)大きいです。
STRSAFE_E_INSUFFICIENT_BUFFER
 バッファー領域が不足しているため、コピー操作に失敗しました。 コピー先バッファーには、目的の結果の null で終わる切り捨てられたバージョンが含まれています。 切り捨てが許容される状況では、これは必ずしも失敗状態と見なされない場合があります。
 

この関数は、置き換える関数とは異なり、 HRESULT 値を返します。

注釈

StringCbVPrintf は、コード内で適切なバッファー処理を行うための追加の処理を提供します。 バッファーの処理が不十分な場合は、バッファー オーバーランを伴う多くのセキュリティの問題に関係します。 StringCbVPrintf は、常に 0 以外の長さの宛先バッファーを null で終了します。

va_listsの詳細については、Stdarg.h で定義されている規則を参照してください。

pszDest、pszFormat、または引数文字列が指す文字列が重なる場合、動作は未定義です。

pszFormat も pszDest も NULL にすることはできません。 null 文字列ポインター値の処理が必要な場合は、「 StringCbVPrintfEx 」を参照してください。

StringCbVPrintf は、一般的な形式またはより具体的な形式で使用できます。 次の表に示すように、文字列のデータ型によって、使用する必要があるこの関数の形式が決まります。

文字列型 (String) リテラル文字列 機能
char "string" StringCbVPrintfA
TCHAR TEXT("string") StringCbVPrintf
Wchar L"string" StringCbVPrintfW
 

注意

strsafe.h ヘッダーは、StringCbVPrintf をエイリアスとして定義します。このエイリアスは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント SP2 を使用した Windows XP [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー WINDOWS Server 2003 SP1 [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム Windows
ヘッダー strsafe.h

関連項目

参照

StringCbPrintf

StringCbVPrintfEx

StringCchVPrintf