StringCbPrintfExA 関数 (strsafe.h)
指定した文字列に書式設定されたデータを書き込みます。 コピー先バッファーのサイズは、このバッファーの末尾を越えて書き込まれないように、関数に提供されます。
StringCbPrintfEx は、次の関数の代わりに使用されます。
構文
STRSAFEAPI StringCbPrintfExA(
[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,
...
);
パラメーター
[out] pszDest
型: LPTSTR
pszFormat とその引数から作成された、書式設定された null で終わる文字列
[in] cbDest
型: size_t
コピー先バッファーのサイズ (バイト単位)。 この値は、最終的な書式設定された文字列に終端の null 文字を加えるのに十分な大きさにする必要があります。 許容される最大バイト数は STRSAFE_MAX_CCH * sizeof(TCHAR)
です。
[out, optional] ppszDestEnd
型: LPTSTR*
pszDestの末尾へのポインター
[out, optional] pcbRemaining
型: size_t*
pszDest内の未使用のバイト数 (終端の null 文字に使用されたものも含む)。
[in] dwFlags
型: DWORD
次の値のうち 1 つ以上。
[in] pszFormat
型: LPCTSTR
書式指定文字列。 この文字列は null で終わる必要があります。 詳細については、「書式指定構文 」を参照してください。
...
pszFormat 文字列に挿入する引数。
戻り値
型: HRESULT
この関数は、次のいずれかの値を返すことができます。 この関数の戻り値をテストするには、
リターン コード | 形容 |
---|---|
|
結果を切り捨てずに pszDest |
|
cbDest の値が 0 または STRSAFE_MAX_CCH * sizeof(TCHAR) より大きいか、または宛先バッファーが既にいっぱいです。
|
|
バッファー領域が不足しているため、コピー操作に失敗しました。 dwFlagsの値によっては、コピー先バッファーに、意図した結果の切り捨てられた null で終わるバージョンが含まれている場合があります。 切り捨てが許容される状況では、これは必ずしも失敗状態と見なされない場合があります。 |
この関数は、置き換える関数とは異なり、HRESULT 値を返します。
備考
置き換える関数と比較して、StringCbPrintfEx
pszDest、
pszFormat
StringCbPrintfEx は、その一般的な形式またはより具体的な形式で使用できます。 文字列のデータ型によって、使用する必要があるこの関数の形式が決まります。
文字列データ型 | 文字列リテラル | 機能 |
---|---|---|
char を |
"string" | StringCbPrintfExA |
TCHAR の |
TEXT("string") | StringCbPrintfEx の |
WCHAR の |
L"string" | StringCbPrintfExW の |
手記
strsafe.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして StringCbPrintfEx を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
要件 | 価値 |
---|---|
サポートされる最小クライアント | Windows XP と SP2 [デスクトップ アプリ |UWP アプリ] |
サポートされる最小サーバー | Windows Server 2003 SP1 [デスクトップ アプリ |UWP アプリ] |
ターゲット プラットフォーム の |
ウィンドウズ |
ヘッダー | strsafe.h |
関連項目
リファレンス
StringCbVPrintfEx の