printf_s、_printf_s_l、wprintf_s、_wprintf_s_l

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

標準出力ストリームに書式付きで出力します。これらの関数は、「CRT のセキュリティ機能」に説明されているように、printf、_printf_l、wprintf、_wprintf_l のセキュリティが強化されたバージョンです。

int printf_s(
   const char *format [,
   argument]... 
);
int _printf_s_l(
   const char *format,
   locale_t locale [,
   argument]... 
);
int wprintf_s(
   const wchar_t *format [,
   argument]... 
);
int _wprintf_s_l(
   const wchar_t *format,
   locale_t locale [,
   argument]... 
);

パラメーター

format
書式指定文字列。
argument
省略可能な引数。
locale
使用するロケール。

戻り値

出力した文字数を返します。エラーが発生した場合は負の値を返します。

解説

printf_s 関数は、一連の文字や値の書式を指定し、標準出力ストリーム stdout に出力します。 format 文字列の後に引数を指定する場合は、format 文字列に引数の出力形式を指定する必要があります。

printf_s と printf 間の主な違いとしては、printf_s は書式指定文字列の有効な書式指定文字をチェックしますが、printf は書式指定文字列が null ポインターかどうかのみをチェックします。いずれかのチェックが失敗した場合、「パラメーターの検証」に説明されているように無効なパラメーターハンドラーが起動します。実行の継続が許可された場合、関数は -1 を返し、errno を EINVAL に設定します。

errno とエラーコードの詳細については、「_doserrno、errno、_sys_errlist、および _sys_nerr」を参照してください。

printf_s と fprintf_s の動作は、printf_s が FILE 型の出力先ではなく stdout に出力することを除いて同じです。詳細については、「fprintf_s、_fprintf_s_l、fwprintf_s、_fwprintf_s_l」を参照してください。

wprintf_s 関数は printf_s のワイド文字バージョンで、format はワイド文字列です。ストリームが ANSI モードで開かれている場合、wprintf_s と printf_s の動作は同じになります。 printf_s では、UNICODE ストリームへの出力はサポートされていません。

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

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_Unicode が定義されている場合
_tprintf_s	printf_s	printf_s	wprintf_s
_tprintf_s_l	_printf_s_l	_printf_s_l	_wprintf_s_l

format 引数は、通常の文字、エスケープシーケンス、および書式指定 (format の後に引数を指定する場合) で構成されます。通常の文字とエスケープシーケンスは、記述した順序で stdout に出力されます。たとえば、次の関数を呼び出します。

printf_s("Line one\n\t\tLine two\n");

この例では、次のように出力されます。

Line one
        Line two

書式指定は必ずパーセント記号 (%) で始まり、左から右に読み取られます。 printf_s 関数は、最初の書式指定 (指定されている場合) を見つけると、format の後の引数の値を書式指定に従って変換して出力します。 2 番目の書式指定を見つけると、2 番目の引数を変換して出力します。書式指定よりも引数の数が多い場合、余分な引数は無視されます。書式指定より引数が少ないと、結果は予測できません。

セキュリティに関するメモ
format にユーザー定義の文字列を指定しないでください。

必要条件

ルーチン	必須ヘッダー
printf_s, _printf_s_l	<stdio.h>
wprintf_s, _wprintf_s_l	<stdio.h> または <wchar.h>

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

使用例

// crt_printf_s.c
/* This program uses the printf_s and wprintf_s functions
 * to produce formatted output.
 */

#include <stdio.h>

int main( void )
{
   char   ch = 'h', *string = "computer";
   int    count = -9234;
   double fp = 251.7366;
   wchar_t wch = L'w', *wstring = L"Unicode";

   /* Display integers. */
   printf_s( "Integer formats:\n"
           "   Decimal: %d  Justified: %.6d  Unsigned: %u\n",
           count, count, count );

   printf_s( "Decimal %d as:\n   Hex: %Xh  C hex: 0x%x  Octal: %o\n",
            count, count, count, count );

   /* Display in different radixes. */
   printf_s( "Digits 10 equal:\n   Hex: %i  Octal: %i  Decimal: %i\n",
            0x10, 010, 10 );

   /* Display characters. */

   printf_s("Characters in field (1):\n%10c%5hc%5C%5lc\n", ch, ch, wch, wch);
   wprintf_s(L"Characters in field (2):\n%10C%5hc%5c%5lc\n", ch, ch, wch, wch);

   /* Display strings. */

   printf_s("Strings in field (1):\n%25s\n%25.4hs\n   %S%25.3ls\n",
   string, string, wstring, wstring);
   wprintf_s(L"Strings in field (2):\n%25S\n%25.4hs\n   %s%25.3ls\n",
       string, string, wstring, wstring);

   /* Display real numbers. */
   printf_s( "Real numbers:\n   %f %.2f %e %E\n", fp, fp, fp, fp );

   /* Display pointer. */
   printf_s( "\nAddress as:   %p\n", &count);

}

出力例

Integer formats:
   Decimal: -9234  Justified: -009234  Unsigned: 4294958062
Decimal -9234 as:
   Hex: FFFFDBEEh  C hex: 0xffffdbee  Octal: 37777755756
Digits 10 equal:
   Hex: 16  Octal: 8  Decimal: 10
Characters in field (1):
         h    h    w    w
Characters in field (2):
         h    h    w    w
Strings in field (1):
                 computer
                     comp
   Unicode                      Uni
Strings in field (2):
                 computer
                     comp
   Unicode                      Uni
Real numbers:
   251.736600 251.74 2.517366e+002 2.517366E+002

Address as:   0012FF78