次の方法で共有

StringCbVPrintfExA 関数 (strsafe.h)

  • [アーティクル]

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

StringCbVPrintfEx は、宛先文字列 の末尾へのポインターと、その文字列で使用されていない残りのバイト数を返すことによって、StringCbVPrintf の機能を追加します。 フラグは、追加の制御のために関数に渡すこともできます。

StringCbVPrintfEx は、次の関数の代わりに使用されます。

構文

STRSAFEAPI StringCbVPrintfExA(
  [out]           STRSAFE_LPSTR  pszDest,
  [in]            size_t         cbDest,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcbRemaining,
  [in]            DWORD          dwFlags,
  [in]            STRSAFE_LPCSTR pszFormat,
  [in]            va_list        argList
);

パラメーター

[out] pszDest

型: LPTSTR

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

[in] cbDest

型: size_t

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

[out, optional] ppszDestEnd

型: LPTSTR*

pszDestの末尾へのポインター アドレス。 ppszDestEnd が非NULL で、データがコピー先バッファーにコピーされる場合、これは文字列の末尾にある終端の null 文字を指します。

[out, optional] pcbRemaining

型: size_t*

pszDest内の未使用のバイト数 (終端の null 文字に使用されたものも含む)。 pcbRemaining が NULL場合、カウントは保持されず、返されません。

[in] dwFlags

型: DWORD

次の値のうち 1 つ以上。

価値 意味
STRSAFE_FILL_BEHIND_NULL
0x00000200
 関数が成功した場合、dwFlags (0) の下位バイトを使用して、終端の null 文字に続く pszDest 初期化されていない部分を埋めます。
STRSAFE_IGNORE_NULLS
0x00000100
 空 文字列 (TEXT("")) のように NULL 文字列ポインターを扱います。
STRSAFE_FILL_ON_FAILURE
0x00000400
 関数が失敗した場合、dwFlags (0) の下位バイトが pszDest バッファー全体 埋めるために使用され、バッファーは null で終了します。 STRSAFE_E_INSUFFICIENT_BUFFER エラーが発生した場合、返された切り捨てられた文字列は上書きされます。
STRSAFE_NULL_ON_FAILURE
0x00000800
 関数が失敗した場合、pszDest は空の文字列 (TEXT("")) に設定されます。 STRSAFE_E_INSUFFICIENT_BUFFER エラーが発生した場合は、切り捨てられた文字列が上書きされます。
STRSAFE_NO_TRUNCATION
0x00001000
 STRSAFE_NULL_ON_FAILUREの場合と同様に、関数が失敗した場合、pszDest 空の文字列 (TEXT("")) に設定されます。 STRSAFE_E_INSUFFICIENT_BUFFER エラーが発生した場合は、切り捨てられた文字列が上書きされます。

[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
 バッファー領域が不足しているため、コピー操作に失敗しました。 dwFlagsの値によっては、コピー先バッファーに、意図した結果の切り捨てられた null で終わるバージョンが含まれている場合があります。 切り捨てが許容される状況では、これは必ずしも失敗状態と見なされない場合があります。
 

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

備考

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

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

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

pszFormat pszDest は、STRSAFE_IGNORE_NULLS フラグを指定しない限り、NULL にすることはできません。この場合、両方とも NULL可能性があります。 ただし、NULL 値 無視しても、領域不足によるエラーが返される可能性があります。

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

文字列データ型 文字列リテラル 機能
char を する "string" StringCbVPrintfExA の
TCHAR の TEXT("string") StringCbVPrintfEx の
WCHAR の L"string" StringCbVPrintfExW の
 

手記

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

必要条件

要件 価値
サポートされる最小クライアント Windows XP と SP2 [デスクトップ アプリ |UWP アプリ]
サポートされる最小サーバー Windows Server 2003 SP1 [デスクトップ アプリ |UWP アプリ]
ターゲット プラットフォーム の ウィンドウズ
ヘッダー strsafe.h

関連項目

リファレンス

StringCbPrintfEx の

StringCbVPrintf の

StringCchVPrintfEx