StringCbPrintfW 関数 (strsafe.h)

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

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

• sprintf、swprintf、_stprintf
• wsprintf の
• wnsprintf
• _snprintf、_snwprintf、_sntprintf

構文

STRSAFEAPI StringCbPrintfW(
  [out] STRSAFE_LPWSTR  pszDest,
  [in]  size_t          cbDest,
  [in]  STRSAFE_LPCWSTR pszFormat,
        ...             
);

パラメーター

[out] pszDest

型: LPTSTR

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

[in] cbDest

型: size_t

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

[in] pszFormat

型: LPCTSTR

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

...

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

戻り値

型: HRESULT

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

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

 

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

備考

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

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

pszFormat pszDest を NULLしないでください。 null 文字列ポインター値 処理が必要な場合は、StringCbPrintfEx を参照してください。

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

文字列データ型	文字列リテラル	機能
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 を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。

必要条件

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

関連項目

リファレンス

StringCbPrintfEx の

StringCbVPrintf の

StringCchPrintf