std::time_get::get

(1) single format specifier

This version simply calls the virtual protected member do_get, which by default parses the sequence following the same format produced by strftime using a string formed by a percentage sign ('%') followed by argument format, with modifier optionally inserted in between (when not equal to zero).

(2) format string

This version reads the characters in the range [fmt_begin,fmt_end) sequentially and interprets them in the same way scanf treats its format string, except that the format specifiers recognized by the function are those used by strftime instead. For each sequence of characters that would be recognized as an specifier for strftime, the virtual protected member do_get is called with the proper arguments.
The function uses the ctype facet of str's locale to determine whitespace characters.

Parameters

s, end

Iterators pointing to the beginning and end characters of the sequence. The range used is [s,end), which contains all the characters between s and end, including the character pointed by s but not the character pointed by end.
Member type iter_type is the facet's iterator type (defined as an alias of time_get's second template parameter, InputIterator). By default, this is an istreambuf_iterator, allowing implicit conversions from basic_istream objects.

str

Object of a class derived from ios_base (generally an input stream object). It is only used to obtain formatting information.

err

Stream error state object, of type ios_base::iostate where the error states are stored.

t

Pointer to an object of type struct tm (defined in header <ctime>), whose members are set by a successful call to this member function.

format

Format specifier indicating the valid format for the sequence; For the default implementation of do_get, this shall be one of the specifiers accepted by strftime.

modifier

Some implementations allow for a format modifier to the specifier.
A value of 0 ('\0') is interpreted as no modifier.

fmt_begin, fmt_end

Pointers to the beginning and end characters of the sequence that forms the format string for the function.
Member type char_type is the facet's character type (defined as an alias of time_get's first template parameter, charT).

Return value

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

// time_get::get example #include <iostream> // std::cout, std::ios #include <string> // std::string #include <sstream> // std::istringstream #include <ctime> // std::tm #include <locale> // std::locale, std::time_get, std::use_facet int main () { std::locale loc; // classic "C" locale // get time_get facet: auto& tmget = std::use_facet <std::time_get<char> > (loc); std::ios::iostate state; std::istringstream iss ("year:2013 month:09 day:10"); std::string format ("year:%Y month:%m day:%d"); std::tm when; tmget.get (iss, std::time_get<char>::iter_type(), iss, state, &when, format.data(), format.data()+format.length() ); std::cout << "year: " << when.tm_year << '\n'; std::cout << "mon: " << when.tm_mon << '\n'; std::cout << "mday: " << when.tm_mday << '\n'; return 0; }

 year: 113 mon: 8 mday: 10 

Data races

Exception safety

See also

time_get::get_date

Read date (public member function)

time_get::get_time

Read time (public member function)

time_put::put

Write time and date (public member function)