_vsprintf_p、 _vsprintf_p_l、 _vswprintf_p、 _vswprintf_p_l

  • [アーティクル]

引数リストへのポインターを使用して、書式付き出力を書き込みます。その際、引数を使用する順序を指定できます。

構文

int _vsprintf_p(
   char *buffer,
   size_t sizeInBytes,
   const char *format,
   va_list argptr
);
int _vsprintf_p_l(
   char *buffer,
   size_t sizeInBytes,
   const char *format,
   _locale_t locale,
   va_list argptr
);
int _vswprintf_p(
   wchar_t *buffer,
   size_t count,
   const wchar_t *format,
   va_list argptr
);
int _vswprintf_p_l(
   wchar_t *buffer,
   size_t count,
   const wchar_t *format,
   _locale_t locale,
   va_list argptr
);

パラメーター

buffer
出力の格納位置。

sizeInBytes
文字内の buffer のサイズ。

count
この関数の Unicode バージョンで格納する最大文字数。

format
書式の指定。

argptr
引数リストへのポインター。

locale
使用するロケール。

戻り値

_vsprintf_p 関数と _vswprintf_p 関数は、書き込まれた文字数を返します。終端の null 文字は含まれません。出力エラーが発生した場合は、負の値を返します。

解説

これらの関数は、引数リストへのポインターを使用し、指定されたデータを書式指定して buffer が指すメモリに書き込みます。

これらの関数は、位置指定パラメーターをサポートする点を除いて vsprintf_s および vswprintf_s と同じです。 詳細については、「printf_p の位置指定パラメーター」をご覧ください。

これらの関数のうち _l サフィックスが付けられたバージョンは、現在のスレッド ロケールの代わりに渡されたロケール パラメーターを使用する点を除いて同じです。

bufferまたはformatパラメーターがポインターNULL場合、count が 0 の場合、または書式指定文字列に無効な書式設定文字が含まれている場合は、「パラメーターの検証で説明されているように、無効なパラメーター ハンドラーが呼び出されます。 実行の継続が許可された場合、関数は -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 が定義されている
_vstprintf_p _vsprintf_p _vsprintf_p _vswprintf_p
_vstprintf_p_l _vsprintf_p_l _vsprintf_p_l _vswprintf_p_l

要件

ルーチンによって返される値 必須ヘッダー 省略可能なヘッダー
_vsprintf_p, _vsprintf_p_l <stdio.h> および <stdarg.h> <varargs.h>*
_vswprintf_p, _vswprintf_p_l <stdio.h> または <wchar.h>、および <stdarg.h> <varargs.h>*

* UNIX V の互換性のために必要です。

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

例

// crt__vsprintf_p.c
// This program uses vsprintf_p to write to a buffer.
// The size of the buffer is determined by _vscprintf_p.

#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>

void example( char * format, ... )
{
    va_list  args;
    int      len;
    char     *buffer = NULL;

    va_start( args, format );

    // _vscprintf doesn't count the
    // null terminating string so we add 1.
    len = _vscprintf_p( format, args ) + 1;

    // Allocate memory for our buffer
    buffer = (char*)malloc( len * sizeof(char) );
    if (buffer)
    {
        _vsprintf_p( buffer, len, format, args );
        puts( buffer );
        free( buffer );
    }
    va_end( args );
}

int main( void )
{
    // First example
    example( "%2$d %1$c %3$d", '<', 123, 456 );

    // Second example
    example( "%s", "This is a string" );
}

123 < 456
This is a string

関連項目

ストリーム入出力
vprintf 関数
書式指定構文: printf 関数と wprintf 関数
fprintf、 _fprintf_l、 fwprintf、 _fwprintf_l
printf、 _printf_l、 wprintf、 _wprintf_l
sprintf、 _sprintf_l、 swprintf、 _swprintf_l、 __swprintf_l
va_arg、 va_copy、 va_end、 va_start