StringCchPrintfExA 関数 (strsafe.h)

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

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

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

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

構文

STRSAFEAPI StringCchPrintfExA(
  [out]           STRSAFE_LPSTR  pszDest,
  [in]            size_t         cchDest,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcchRemaining,
  [in]            DWORD          dwFlags,
  [in]            STRSAFE_LPCSTR pszFormat,
                  ...            
);

パラメーター

[out] pszDest

種類: LPTSTR

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

[in] cchDest

種類: size_t

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

[out, optional] ppszDestEnd

種類: LPTSTR*

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

[out, optional] pcchRemaining

種類: size_t*

pszDest の未使用文字の数 (終端の null 文字を含む)。 pcchRemaining が NULL の場合、カウントは保持されず、返されません。

[in] dwFlags

型: DWORD

次の値のうち 1 つ以上。

[in] pszFormat

種類: LPCTSTR

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

...

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

戻り値

型: HRESULT

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

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

解説

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

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

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

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

要件

関連項目

参照

StringCbPrintfEx

StringCchPrintf

StringCchVPrintfEx