_vscprintf、_vscprintf_l、_vscwprintf、_vscwprintf_l

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

更新 : 2007 年 11 月

引数リストへのポインタを使用し、書式指定文字列内の文字数を返します。

int _vscprintf(
   const char *format,
      va_list argptr 
);
int _vscprintf_l(
      const char *format,
   locale_t locale,
      va_list argptr 
);
int _vscwprintf(
      const wchar_t *format,
   va_list argptr 
);
int _vscwprintf_l(
   const wchar_t *format,
   locale_t locale,
   va_list argptr 
);

パラメータ

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

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

戻り値

_vscprintf 関数は、引数リストが指す文字列が、指定の書式化コードを使用して出力されるか、またはファイルやバッファに送信された場合に生成される文字数を返します。戻り値には、終端の null 文字が含まれません。ワイド文字の場合、_vscwprintf が同じ機能です。

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

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

解説

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

セキュリティに関するメモ :
format がユーザー定義文字列の場合は、終端が null で、正しい数と型のパラメータが含まれていることを必ず確認してください。詳細については、「Avoiding Buffer Overruns」を参照してください。