_vsprintf_p、_vsprintf_p_l、_vswprintf_p、_vswprintf_p_l

[アーティクル]
09/17/2008

更新 : 2007 年 11 月

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

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 に設定します。

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

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 との互換性用

互換性の詳細については、「C ランタイムライブラリ」の「互換性」を参照してください。

使用例

// 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 );
    }
}


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