_sprintf_p, _sprintf_p_l, _swprintf_p, _swprintf_p_l

  • [アーティクル]

パラメーターが書式文字列で使用される順序を指定できる文字列に、書式付きデータを書き込みます。

構文

int _sprintf_p(
   char *buffer,
   size_t sizeOfBuffer,
   const char *format [,
   argument_list]
);
int _sprintf_p_l(
   char *buffer,
   size_t sizeOfBuffer,
   const char *format,
   _locale_t locale [,
   argument_list]
);
int _swprintf_p(
   wchar_t *buffer,
   size_t sizeOfBuffer,
   const wchar_t *format [,
   argument_list]
);
int _swprintf_p_l(
   wchar_t *buffer,
   size_t sizeOfBuffer,
   const wchar_t *format,
   _locale_t locale [,
   argument_list]
);

パラメーター

buffer
出力の格納場所。

sizeOfBuffer
格納する最大文字数。

format
書式指定文字列。

argument_list
書式指定文字列への省略可能な引数。

locale
使用するロケール。

詳細については、「書式指定構文」を参照してください。

戻り値

書き込まれた文字数を返します。エラーが発生した場合は -1 を返します。

解説

_sprintf_p 関数は、一連の文字と値の書式を指定して、 bufferに格納します。 argument_list 内の各引数 (ある場合) は、format 内の対応する書式指定に応じて変換され、出力されます。 format 引数では、printf および wprintf 関数の書式指定構文を使用します。 最後に書き込まれる文字の後に NULL 文字が追加されます。 重なり合う文字列間でコピーした場合の動作は未定義です。 _sprintf_p と sprintf_s の違いは、_sprintf_p では位置指定パラメーターをサポートし、これによって、書式指定文字列で引数を使用する順序を指定できることです。 詳細については、「printf_p の位置指定パラメーター」を参照してください。

_swprintf_p は _sprintf_pのワイド文字バージョンであり、 _swprintf_p のポインター引数はワイド文字列です。 でのエンコード エラー _swprintf_p の検出 _sprintf_pは、. _swprintf_p と fwprintf_p の動作は同じですが、_swprintf_p は FILE 型の出力先ではなく文字列に出力を書き込む点と、_swprintf_p には書き込む最大文字数を指定する count パラメーターが必要である点が異なります。 これらの関数のうち _l サフィックスが付けられたバージョンは、現在のスレッド ロケールの代わりに渡されたロケール パラメーターを使用する点を除いて同じです。

_sprintf_p 関数は、 bufferに格納されているバイト数を返します。終端の null 文字は含まれません。 _swprintf_p は、buffer に格納されているワイド文字数を返します。終端の null ワイド文字は含まれません。 null ポインターのformat場合、または書式指定文字列に無効な書式指定文字が含まれている場合bufferは、「パラメーターの検証」の説明に従って無効なパラメーター ハンドラーが呼び出されます。 実行の継続が許可された場合、これらの関数は -1 を返し、errno を EINVAL に設定します。

重要

Windows 10 バージョン 2004 (ビルド 19041) 以降の printf ファミリの関数では、丸め処理の IEEE 754 の規則に従って、正確に表現可能な浮動小数点数が出力されます。 以前のバージョンの Windows では、"5" で終わる正確に表現可能な浮動小数点数は常に切り上げられていました。 IEEE 754 では、最も近い偶数に丸める ("銀行型丸め" とも呼ばれます) 必要があることが示されています。 たとえば、printf("%1.0f", 1.5) と printf("%1.0f", 2.5) の両方を 2 に丸める必要があります。 以前は、1.5 は 2 に、2.5 は 3 に丸められていました。 この変更は、正確に表現可能な数値にのみ影響します。 たとえば、2.35 (メモリで表される場合は 2.35000000000000008 に近い) は、2.4 に切り上げられます。 これらの関数によって実行される丸め処理では、fesetround によって設定された浮動小数点丸めモードにも従うようになりました。 以前は、丸め処理には常に FE_TONEAREST の動作が選択されていました。 この変更は、Visual Studio 2019 バージョン 16.2 以降を使用してビルドされたプログラムにのみ影響します。 従来の浮動小数点丸め動作を使用するには、'legacy_stdio_float_rounding.obj' にリンクします。

汎用テキスト ルーチンのマップ

TCHAR.H ルーチン _UNICODE と _MBCS が定義されていない _MBCS が定義されている _UNICODE が定義されている
_stprintf_p _sprintf_p _sprintf_p _swprintf_p
_stprintf_p_l _sprintf_p_l _sprintf_p_l _swprintf_p_l

必要条件

ルーチンによって返される値 必須ヘッダー
_sprintf_p, _sprintf_p_l <stdio.h>
_swprintf_p, _swprintf_p_l <stdio.h> または <wchar.h>

互換性の詳細については、「 Compatibility」を参照してください。

例: _sprintf_p を使用してデータの書式を設定する

// crt_sprintf_p.c
// This program uses _sprintf_p to format various
// data and place them in the string named buffer.
//

#include <stdio.h>

int main( void )
{
    char     buffer[200],
            s[] = "computer", c = 'l';
    int      i = 35,
            j;
    float    fp = 1.7320534f;

    // Format and print various data:
    j  = _sprintf_p( buffer, 200,
                     "   String:    %s\n", s );
    j += _sprintf_p( buffer + j, 200 - j,
                     "   Character: %c\n", c );
    j += _sprintf_p( buffer + j, 200 - j,
                     "   Integer:   %d\n", i );
    j += _sprintf_p( buffer + j, 200 - j,
                     "   Real:      %f\n", fp );

    printf( "Output:\n%s\ncharacter count = %d\n",
            buffer, j );
}

Output:
   String:    computer
   Character: l
   Integer:   35
   Real:      1.732053

character count = 79

例: エラー コードの処理

// crt_swprintf_p.c
// This is the wide character example which
// also demonstrates _swprintf_p returning
// error code.
#include <stdio.h>

#define BUFFER_SIZE 100

int main( void )
{
    wchar_t buffer[BUFFER_SIZE];
    int     len;

    len = _swprintf_p(buffer, BUFFER_SIZE, L"%2$s %1$d",
                      0, L" marbles in your head.");
    _printf_p( "Wrote %d characters\n", len );

    // _swprintf_p fails because string contains WEOF (\xffff)
    len = _swprintf_p(buffer, BUFFER_SIZE, L"%s",
                      L"Hello\xffff world" );
    _printf_p( "Wrote %d characters\n", len );
}

Wrote 24 characters
Wrote -1 characters

関連項目

ストリーム入出力
_fprintf_p, _fprintf_p_l, _fwprintf_p, _fwprintf_p_l
fprintf, _fprintf_l, fwprintf, _fwprintf_l
_printf_p, _printf_p_l, _wprintf_p, _wprintf_p_l
printf, _printf_l, wprintf, _wprintf_l
sprintf, _sprintf_l, swprintf, _swprintf_l, __swprintf_l
scanf, _scanf_l, wscanf, _wscanf_l
sscanf, _sscanf_l, swscanf, _swscanf_l
sscanf_s, _sscanf_s_l, swscanf_s, _swscanf_s_l
vprintf 関数
printf_p 位置指定パラメーター