_strtime_s、_wstrtime_s

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

バッファーに現在の時刻をコピーします。これらの関数は、「CRT のセキュリティ機能」に説明されているように、_strtime、_wstrtime のセキュリティが強化されたバージョンです。

errno_t _strtime_s(
   char *buffer,
   size_t numberOfElements
);
errno_t _wstrtime_s(
   wchar_t *buffer,
   size_t numberOfElements
);
template <size_t size>
errno_t _strtime_s(
   char (&buffer)[size]
); // C++ only
template <size_t size>
errno_t _wstrtime_s(
   wchar_t (&buffer)[size]
); // C++ only

パラメーター

[出力] buffer
少なくとも 10 バイトのバッファーで、ここに時刻が書き込まれます。
[入力] numberOfElements
バッファーのサイズ。

戻り値

正常に終了した場合は 0 を返します。

エラー条件が発生した場合は、「パラメーターの検証」に説明されているように、無効なパラメーターハンドラーが呼び出されます。エラーが発生した場合の戻り値はエラーコードです。エラーコードは ERRNO.H で定義されています。この関数によって生じるエラーの正確な情報については次の表を参照してください。エラーコードの詳細については、「errno 定数」を参照してください。

エラー条件

buffer	numberOfElements	Return	buffer の内容
NULL	(任意)	EINVAL	変更されない
NULL 以外 (有効なバッファーを指し示している)	0	EINVAL	変更されない
NULL 以外 (有効なバッファーを指し示している)	0 < サイズ < 9	EINVAL	空の文字列
NULL 以外 (有効なバッファーを指し示している)	サイズ > 9	0	「解説」で詳述しているように、現在の時刻の形式が設定される

セキュリティの問題

numberOfElements パラメーターが 9 を超える場合に、バッファーに無効な NULL 以外の値を渡すと、アクセス違反が生じます。

実際のバッファーサイズを超える numberOfElements 値を渡すと、バッファーオーバーランが発生します。

解説

これらの関数は、_strtime 関数と _wstrtime 関数のセキュリティが強化されたバージョンです。 _strtime_s 関数は、timestr が指すバッファーに現在の現地時刻をコピーします。時刻は hh:mm:ss の形式で表されます。hh は時間を 24 時間表記で表す 2 桁の数値、mm は分を表す 2 桁の数値、および ss は秒を表す 2 桁の数値です。たとえば、文字列 18:23:44 は、午後 6 時 23 分 44 秒を表します。バッファーは、少なくとも 9 バイト必要です。実際のサイズは 2 番目のパラメーターで指定します。

ワイド文字を扱う場合は、_strtime ではなく _wstrtime を使用します。_wstrtime の場合、引数にはワイド文字列を指定します。また戻り値もワイド文字列です。それ以外では、これらの関数の動作は同じです。

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

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_tstrtime_s	_strtime_s	_strtime_s	_wstrtime_s

必要条件

ルーチン	必須ヘッダー
_strtime_s	<time.h>
_wstrtime_s	<time.h> または <wchar.h>

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

使用例

// strtime_s.c

#include <time.h>
#include <stdio.h>

int main()
{
    char tmpbuf[9];
    errno_t err;

    // Set time zone from TZ environment variable. If TZ is not set,
    // the operating system is queried to obtain the default value 
    // for the variable. 
    //
    _tzset();

    // Display operating system-style date and time. 
    err = _strtime_s( tmpbuf, 9 );
    if (err)
    {
       printf("_strdate_s failed due to an invalid argument.");
      exit(1);
    }
    printf( "OS time:\t\t\t\t%s\n", tmpbuf );
    err = _strdate_s( tmpbuf, 9 );
    if (err)
    {
       printf("_strdate_s failed due to an invalid argument.");
       exit(1);
    }
    printf( "OS date:\t\t\t\t%s\n", tmpbuf );

}