_scprintf、_scprintf_l、_scwprintf、_scwprintf_l

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

更新 : 2007 年 11 月

書式指定文字列内の文字数を返します。

int _scprintf(
   const char *format [,
      argument] ... 
);
int _scprintf_l(
   const char *format,
   locale_t locale [,
      argument] ... 
);
int _scwprintf(
   const wchar_t *format [,
      argument] ... 
);
int _scwprintf_l(
   const wchar_t *format,
   locale_t locale [,
      argument] ... 
);

パラメータ

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

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

戻り値

指定されている書式指定文字列を使用して、文字列を出力するかファイルまたはバッファに送る場合は、出力される文字数を返します。戻り値には、終端の null 文字が含まれません。ワイド文字の場合、_scwprintf が同じ機能です。

format が NULL ポインタの場合は、「パラメータの検証」に説明されているように、無効なパラメータハンドラが呼び出されます。実行の継続が許可された場合、これらの関数は -1 を返し、errno を EINVAL に設定します。

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

解説

各 argument (指定されている場合) は、format 中の対応する書式指定に従って変換されます。format は通常の文字で構成し、その形式と機能は printf 関数の format と同じです。

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

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

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

Tchar.h のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_sctprintf	_scprintf	_scprintf	_scwprintf
_sctprintf_l	_scprintf_l	_scprintf_l	_scwprintf_l

必要条件

ルーチン	必須ヘッダー
_scprintf, _scprintf_l	<stdio.h>
_scwprintf, _scwprintf_l	<stdio.h> または <wchar.h>

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

使用例

// crt__scprintf.c

#define _USE_MATH_DEFINES

#include <stdio.h>
#include <math.h>
#include <malloc.h>

int main( void )
{
   int count;
   int size;
   char *s = NULL;

   count = _scprintf( "The value of Pi is calculated to be %f.\n",
                      M_PI);

   size = count + 1; // the string will need one more char for the null terminator
   s = malloc(sizeof(char) * size);
   sprintf_s(s, size, "The value of Pi is calculated to be %f.\n",
                      M_PI);
   printf("The length of the following string will be %i.\n", count);
   printf("%s", s);
   free( s );
}

The length of the following string will be 46.
The value of Pi is calculated to be 3.141593.