StringCchPrintfA 関数 (strsafe.h)

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

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

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

構文

STRSAFEAPI StringCchPrintfA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cchDest,
  [in]  STRSAFE_LPCSTR pszFormat,
        ...            
);

パラメーター

[out] pszDest

種類: LPTSTR

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

[in] cchDest

種類: size_t

変換先バッファーのサイズ (文字数)。 この値は、最後に書式設定された文字列に 1 を加えて終端の null 文字を考慮するのに十分な大きさにする必要があります。 使用できる最大文字数は STRSAFE_MAX_CCH。

[in] pszFormat

種類: LPCTSTR

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

...

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

戻り値

型: HRESULT

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

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

 

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

注釈

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

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

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

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

文字列型 (String)	リテラル文字列	機能
char	"string"	StringCchPrintfA
TCHAR	TEXT("string")	StringCchPrintf
Wchar	L"string"	StringCchPrintfW

 

例

次の例は、4 つの引数を使用した StringCchPrintf の簡単な使用方法を示しています。

TCHAR pszDest[30]; 
size_t cchDest = 30;

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

HRESULT hr = StringCchPrintf(pszDest, cchDest, pszFormat, pszTxt, 1, 2, 3);

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

注意

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

要件

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

関連項目

参照

StringCbPrintf

StringCchPrintfEx

StringCchVPrintf