Struct c_time

| Home | Libraries | People | FAQ | More

## Struct c_time

boost::date_time::c_time — Provides a uniform interface to some 'ctime' functions.

## Synopsis

    // In header: <boost/date_time/c_time.hpp>

    struct c_time {

      // public static functions
      static std::tm * localtime(const std::time_t *, std::tm *) ;
      static std::tm * gmtime(const std::time_t *, std::tm *) ;
      static std::tm * localtime(const std::time_t *, std::tm *) ;
      static std::tm * gmtime(const std::time_t *, std::tm *) ;
    };

## Description

Provides a uniform interface to some ctime functions and their '_r' counterparts. The '_r' functions require a pointer to a user created std::tm struct whereas the regular functions use a staticly created struct and return a pointer to that. These wrapper functions require the user to create a std::tm struct and send in a pointer to it. A pointer to the user created struct will be returned. All functions do proper checking of the C function results and throw exceptions on error. Therefore the functions will never return NULL.

### `c_time` public static functions

1.     static std::tm * localtime(const std::time_t * t, std::tm * result) ;

   requires a pointer to a user created std::tm struct

2.     static std::tm * gmtime(const std::time_t * t, std::tm * result) ;

   requires a pointer to a user created std::tm struct

3.     static std::tm * localtime(const std::time_t * t, std::tm * result) ;

   requires a pointer to a user created std::tm struct

4.     static std::tm * gmtime(const std::time_t * t, std::tm * result) ;

   requires a pointer to a user created std::tm struct