_vcprintf、_vcprintf_l、_vcwprintf、_vcwprintf_l

[アーティクル]
08/09/2011

引数リストへのポインターを使用して、書式付き出力をコンソールに書き込みます。これらの関数のセキュリティを強化したバージョンについては、「_vcprintf_s、_vcprintf_s_l、_vcwprintf_s、_vcwprintf_s_l」を参照してください。

int _vcprintf(
   const char* format,
   va_list argptr
);
int _vcprintf_l(
   const char* format,
   locale_t locale,
   va_list argptr
);
int _vcwprintf(
   const wchar_t* format,
   va_list argptr
);
int _vcwprintf_l(
   const wchar_t* format,
   locale_t locale,
   va_list argptr
);

パラメーター

format
書式の指定。
argptr
引数リストへのポインター。
locale
使用するロケール。

詳細については、「printf 関数と wprintf 関数の書式指定フィールド」を参照してください。

戻り値

書き込まれた文字数。出力エラーが発生した場合は負の値を返します。 format が null ポインターの場合は、「パラメーターの検証」に説明されているように、無効なパラメーターハンドラーが呼び出されます。実行の継続が許可された場合、errno が EINVAL に設定され、関数から -1 が返されます。

解説

これらの関数は、引数リストへのポインターを使用して、指定されたデータを書式指定してコンソールに書き込みます。 _vcwprintf 関数は、_vcprintf 関数のワイド文字バージョンです。引数としてワイド文字列を使用します。

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

セキュリティに関するメモ
format にユーザー定義の文字列を指定しないでください。詳細については、「Avoiding Buffer Overruns」を参照してください。

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_vtcprintf	_vcprintf	_vcprintf	_vcwprintf
_vtcprintf_l	_vcprintf_l	_vcprintf_l	_vcwprintf_l

必要条件

ルーチン	必須ヘッダー	省略可能なヘッダー
_vcprintf, _vcprintf_l	<conio.h> および <stdarg.h>	<varargs.h>*
_vcwprintf, _vcwprintf_l	<conio.h> または <wchar.h>、および <stdarg.h>	<varargs.h>*

* UNIX V との互換性用

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

使用例

// crt_vcprintf.cpp
// compile with: /c
#include <conio.h>
#include <stdarg.h>

// An error formatting function used to print to the console.
int eprintf(const char* format, ...)
{
  va_list args;
  va_start(args, format);
  return _vcprintf(format, args);
}

int main()
{
   eprintf("  (%d:%d): Error %s%d : %s\n", 10, 23, "C", 2111,
           "<some error text>");
   eprintf("  (Related to symbol '%s' defined on line %d).\n",
           "<symbol>", 5 );
}