_gcvt_s

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

浮動小数点値を文字列に変換します。この関数は、「CRT のセキュリティ機能」に説明されているように、_gcvt のセキュリティが強化されたバージョンです。

errno_t _gcvt_s( 
   char *buffer,
   size_t sizeInBytes,
   double value,
   int digits 
);
template <size_t cchStr>
errno_t _gcvt_s( 
   char (&buffer)[cchStr],
   double value,
   int digits 
); // C++ only

パラメーター

[出力] buffer
変換結果を格納するバッファー。
[入力] sizeInBytes
バッファーのサイズ。
[入力] value
変換される数値。
[入力] digits
格納する有効数字の桁数。

戻り値

正常に終了した場合は 0 を返します。無効なパラメーター (無効な値については以下の表を参照) によるエラーが発生した場合は、「パラメーターの検証」に説明されているように、無効なパラメーターハンドラーが呼び出されます。実行の継続が許可された場合、エラーコードが返されます。エラーコードは、Errno.h で定義されています。これらのエラーの一覧については、「errno、_doserrno、_sys_errlist、および _sys_nerr」を参照してください。

エラー条件

buffer	sizeInBytes	value	digits	Return	buffer の値
NULL	any	any	any	EINVAL	変更されない。
NULL 以外 (有効なメモリを指し示している)	0	any	any	EINVAL	変更されない。
NULL 以外 (有効なメモリを指し示している)	any	any	>= sizeInBytes	EINVAL	変更されない。

セキュリティの問題

buffer が有効なメモリを指し示さず、かつ NULL 以外の場合、_gcvt_s 関数はアクセス違反を生成することがあります。

解説

_gcvt_s 関数は、浮動小数点数の value を文字列 (小数点、場合によっては符号バイトも含む) に変換し、その文字列を buffer に格納します。 buffer は、変換された値に加え、自動的に追加される終端の NULL 文字を格納できるような大きさにする必要があります。長さが _CVTBUFSIZE のバッファーは、すべての浮動小数点値に対応します。 digits + 1 のバッファーサイズを使用すると、関数がバッファーの末尾を上書きすることはないため、この操作には十分なバッファーを用意してください。 _gcvt_s 関数は、digits 桁を小数形式で生成しようとします。生成できない場合は、digits 桁を指数形式で生成します。後続のゼロは、変換時に生成されない可能性があります。

C++ では、この関数の使用はテンプレートのオーバーロードによって簡素化されます。オーバーロードでは、バッファーの長さを自動的に推論できるため、サイズの引数を指定する必要がなくなります。詳細については、「セキュリティ保護されたテンプレートオーバーロード」を参照してください。

この関数のデバッグバージョンは、最初にバッファーを 0xFD で埋めます。この動作を無効にするには、_CrtSetDebugFillThreshold を使用します。

必要条件

ルーチン	必須ヘッダー	オプションヘッダー
_gcvt_s	<stdlib.h>	<error.h>

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

使用例

// crt_gcvt_s.c
#include <stdio.h>
#include <stdlib.h>
#include <errno.h>

int main()
{
  char buf[_CVTBUFSIZE];
  int decimal;
  int sign;
  int err;

  err = _gcvt_s(buf, _CVTBUFSIZE, 1.2, 5);
  
  if (err != 0)
  {
     printf("_gcvt_s failed with error code %d\n", err);
     exit(1);
  }

  printf("Converted value: %s\n", buf);  
  
}