StringCbPrintfA 関数 (strsafe.h)

  • [アーティクル]

指定した文字列に書式設定されたデータを書き込みます。 コピー先バッファーのサイズは、 関数に提供され、このバッファーの末尾を越えて書き込まれないことを確認します。

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

構文

STRSAFEAPI StringCbPrintfA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cbDest,
  [in]  STRSAFE_LPCSTR pszFormat,
        ...            
);

パラメーター

[out] pszDest

種類: LPSTR

pszFormat とその引数から作成された、null で終わる書式設定された文字列を受け取る宛先バッファー。

[in] cbDest

種類: size_t

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

[in] pszFormat

種類: LPCSTR

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

...

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 値を返します。

注釈

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

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

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

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

文字列型 (String) リテラル文字列 機能
char "string" StringCbPrintfA
TCHAR TEXT("string") StringCbPrintf
Wchar L"string" StringCbPrintfW
 

例

次の例は、4 つの引数を使用した StringCbPrintf の基本的な使用方法を示しています。

int const arraysize = 30;
TCHAR pszDest[arraysize]; 
size_t cbDest = arraysize * sizeof(TCHAR);

LPCTSTR pszFormat = TEXT("%s %d + %d = %d.");
TCHAR* pszTxt = TEXT("The answer is");

HRESULT hr = StringCbPrintf(pszDest, cbDest, pszFormat, pszTxt, 1, 2, 3);

// The resultant string at pszDest is "The answer is 1 + 2 = 3."

注意

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

要件

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

関連項目

参照

StringCbPrintfEx

StringCbVPrintf

StringCchPrintf