STD::TIME_GET_BYNAME(3cxx)

📦

version 14-20240412 · 19 versions

🎀 std::time_get_byname< _CharT, _InIter > — 3cxx manual page 🎀

okay bestie, this is the std::time_get_byname< _CharT, _InIter > page from section 3cxx — and we folded the manual name up here instead of copy-pasting that header line twice. slay. 💅

💖 NAME 💖

std::time_get_byname< _CharT, _InIter > — literally class time_get_byname [22.2.5.2]. that's the whole name section, no cap. 🫶

✨ SYNOPSIS ✨

#include <locale>

Inherits std::time_get< _CharT, _InIter >. yes bestie, it's giving inheritance. 👑

🌸 Public Types 🌸

typedef _CharT char_type — the character type, iconic.
enum dateorder { no_order, dmy, mdy, ymd, ydm } — the enum for date ordering, exactly those values, periodt.
typedef _InIter iter_type — the iterator type, main character energy.

🦋 Public Member Functions 🦋

time_get_byname (const char *, size_t __refs=0) — constructor taking const char * and size_t __refs=0.
time_get_byname (const string &__s, size_t __refs=0) — constructor taking const string &__s and size_t __refs=0.
dateorder date_order () const — Return preferred order of month, day, and year.
iter_type get (iter_type __s, iter_type __end, ios_base &__io, ios_base::iostate &__err, tm *__tm, char __format, char __modifier=0) const — Parse input string according to format.
iter_type get (iter_type __s, iter_type __end, ios_base &__io, ios_base::iostate &__err, tm *__tm, const char_type *__fmt, const char_type *__fmtend) const — Parse input string according to format.
iter_type get_date (iter_type __beg, iter_type __end, ios_base &__io, ios_base::iostate &__err, tm *__tm) const — Parse input date string.
iter_type get_monthname (iter_type __beg, iter_type __end, ios_base &__io, ios_base::iostate &__err, tm *__tm) const — Parse input month string.
iter_type get_time (iter_type __beg, iter_type __end, ios_base &__io, ios_base::iostate &__err, tm *__tm) const — Parse input time string.
iter_type get_weekday (iter_type __beg, iter_type __end, ios_base &__io, ios_base::iostate &__err, tm *__tm) const — Parse input weekday string.
iter_type get_year (iter_type __beg, iter_type __end, ios_base &__io, ios_base::iostate &__err, tm *__tm) const — Parse input year string.

🎀 Static Public Attributes 🎀

static locale::id id — Numpunct facet id. yes, the page literally says Numpunct facet id. and we are keeping it exactly, no edits. 🫶

🌈 Protected Member Functions 🌈

_M_extract_name — exact signature:

iter_type _M_extract_name (iter_type __beg, iter_type __end, int
    &__member, const _CharT **__names, size_t __indexlen, ios_base
    &__io, ios_base::iostate &__err) const

_M_extract_num — exact signature:

iter_type _M_extract_num (iter_type __beg, iter_type __end, int
    &__member, int __min, int __max, size_t __len, ios_base &__io,
    ios_base::iostate &__err) const

_M_extract_via_format — exact signature:

iter_type _M_extract_via_format (iter_type __beg, iter_type __end,
    ios_base &__io, ios_base::iostate &__err, tm *__tm, const _CharT
    *__format) const

_M_extract_via_format — exact signature with __time_get_state:

iter_type _M_extract_via_format (iter_type __beg, iter_type __end,
    ios_base &__io, ios_base::iostate &__err, tm *__tm, const _CharT
    *__format, __time_get_state &__state) const

_M_extract_wday_or_month — exact signature:

iter_type _M_extract_wday_or_month (iter_type __beg, iter_type __end,
    int &__member, const _CharT **__names, size_t __indexlen, ios_base
    &__io, ios_base::iostate &__err) const

virtual dateorder do_date_order () const — Return preferred order of month, day, and year.
do_get — Parse input string according to format. exact signature:

iter_type do_get (iter_type __s, iter_type __end, ios_base &__f,
    ios_base::iostate &__err, tm *__tm, char __format, char __modifier)
    const

virtual iter_type do_get_date (...) const — Parse input date string. exact signature:

virtual iter_type do_get_date (iter_type __beg, iter_type __end,
    ios_base &__io, ios_base::iostate &__err, tm *__tm) const

virtual iter_type do_get_monthname (...) const — Parse input month string. exact signature:

virtual iter_type do_get_monthname (iter_type __beg, iter_type __end,
    ios_base &, ios_base::iostate &__err, tm *__tm) const

virtual iter_type do_get_time (...) const — Parse input time string. exact signature:

virtual iter_type do_get_time (iter_type __beg, iter_type __end,
    ios_base &__io, ios_base::iostate &__err, tm *__tm) const

virtual iter_type do_get_weekday (...) const — Parse input weekday string. exact signature:

virtual iter_type do_get_weekday (iter_type __beg, iter_type __end,
    ios_base &, ios_base::iostate &__err, tm *__tm) const

virtual iter_type do_get_year (...) const — Parse input year string. exact signature:

virtual iter_type do_get_year (iter_type __beg, iter_type __end,
    ios_base &__io, ios_base::iostate &__err, tm *__tm) const

🧚 Static Protected Member Functions 🧚

static __c_locale _S_clone_c_locale (__c_locale &__cloc) throw ()
static void _S_create_c_locale (__c_locale &__cloc, const char *__s, __c_locale __old=0)
static void _S_destroy_c_locale (__c_locale &__cloc)
static __c_locale _S_get_c_locale ()
static const char * _S_get_c_name () throw ()
static __c_locale _S_lc_ctype_c_locale (__c_locale __cloc, const char *__s)

💜 Detailed Description 💜

template<typename _CharT, typename _InIter>
    class std::time_get_byname< _CharT, _InIter >"class time_get_byname
    [22.2.5.2].

that's the detailed description, bestie — minimal but iconic. 🎀

🔥 Member Function Documentation 🔥

🌟 `date_order` 🌟

template<typename _CharT , typename _InIter >
dateorder std::time_get< _CharT, _InIter >::date_order () const

tagged [inline], [inherited]. 💅

Return preferred order of month, day, and year. This function returns an enum from time_base::dateorder giving the preferred ordering if the format x given to time_put::put() only uses month, day, and year. If the format x for the associated locale uses other fields, this function returns time_base::dateorder::noorder.

NOTE: The library always returns noorder at the moment. 😭

Returns: A member of time_base::dateorder.

References: std::time_get< _CharT, _InIter >::do_date_order().

🌟 `do_date_order` 🌟

template<typename _CharT , typename _InIter >
_GLIBCXX_END_NAMESPACE_LDBL_OR_CXX11 time_base::dateorder std::time_get<
    _CharT, _InIter >::do_date_order () const

tagged [protected], [virtual], [inherited]. 🦋

Return preferred order of month, day, and year. This function returns an enum from time_base::dateorder giving the preferred ordering if the format x given to time_put::put() only uses month, day, and year. This function is a hook for derived classes to change the value returned.

Returns: A member of time_base::dateorder.

Referenced by: std::time_get< _CharT, _InIter >::date_order().

🌟 `do_get` 🌟

template<typename _CharT , typename _InIter > _InIter std::time_get< _CharT,
    _InIter >::do_get (iter_type __s, iter_type __end, ios_base & __f,
    ios_base::iostate & __err, tm * __tm, char __format, char __modifier)
    const

tagged [inline], [protected], [inherited]. ✨

Parse input string according to format. This function parses the string according to the provided format and optional modifier. This function is a hook for derived classes to change the value returned.

See also: get() for more details.

Parameters:

__s — Start of string to parse.
__end — End of string to parse.
__f — Source of the locale.
__err — Error flags to set.
__tm — Pointer to struct tm to fill in.
__format — Format specifier.
__modifier — Format modifier.

Returns: Iterator to first char not parsed.

References: std::ios_base::_M_getloc(), std::ios_base::eofbit, std::ios_base::goodbit, and std::__ctype_abstract_base< _CharT >::widen().

Referenced by: std::time_get< _CharT, _InIter >::get(), and std::time_get< _CharT, _InIter >::get().

🌟 `do_get_date` 🌟

template<typename _CharT , typename _InIter > _InIter std::time_get< _CharT,
    _InIter >::do_get_date (iter_type __beg, iter_type __end, ios_base &
    __io, ios_base::iostate & __err, tm * __tm) const

tagged [protected], [virtual], [inherited]. 🎀

Parse input date string. This function parses a date according to the format X and puts the results into a user-supplied struct tm. This function is a hook for derived classes to change the value returned.

See also: get_date() for details.

Parameters:

__beg — Start of string to parse.
__end — End of string to parse.
__io — Source of the locale.
__err — Error flags to set.
__tm — Pointer to struct tm to fill in.

Returns: Iterator to first char beyond date string.

References: std::ios_base::_M_getloc(), and std::ios_base::eofbit.

Referenced by: std::time_get< _CharT, _InIter >::get_date().

🌟 `do_get_monthname` 🌟

template<typename _CharT , typename _InIter > _InIter std::time_get< _CharT,
    _InIter >::do_get_monthname (iter_type __beg, iter_type __end, ios_base
    & __io, ios_base::iostate & __err, tm * __tm) const

tagged [protected], [virtual], [inherited]. 🌸

Parse input month string. This function parses a month name and puts the results into a user-supplied struct tm. This function is a hook for derived classes to change the value returned.

See also: get_monthname() for details.

Parameters:

__beg — Start of string to parse.
__end — End of string to parse.
__io — Source of the locale.
__err — Error flags to set.
__tm — Pointer to struct tm to fill in.

Returns: Iterator to first char beyond month name.

References: std::ios_base::_M_getloc(), std::ios_base::eofbit, std::ios_base::failbit, and std::ios_base::goodbit.

Referenced by: std::time_get< _CharT, _InIter >::get_monthname().

🌟 `do_get_time` 🌟

template<typename _CharT , typename _InIter > _InIter std::time_get< _CharT,
    _InIter >::do_get_time (iter_type __beg, iter_type __end, ios_base &
    __io, ios_base::iostate & __err, tm * __tm) const

tagged [protected], [virtual], [inherited]. 🕰️

Parse input time string. This function parses a time according to the format x and puts the results into a user-supplied struct tm. This function is a hook for derived classes to change the value returned.

See also: get_time() for details.

Parameters:

__beg — Start of string to parse.
__end — End of string to parse.
__io — Source of the locale.
__err — Error flags to set.
__tm — Pointer to struct tm to fill in.

Returns: Iterator to first char beyond time string.

References: std::ios_base::_M_getloc(), and std::ios_base::eofbit.

Referenced by: std::time_get< _CharT, _InIter >::get_time().

🌟 `do_get_weekday` 🌟

template<typename _CharT , typename _InIter > _InIter std::time_get< _CharT,
    _InIter >::do_get_weekday (iter_type __beg, iter_type __end, ios_base &
    __io, ios_base::iostate & __err, tm * __tm) const

tagged [protected], [virtual], [inherited]. 🌈

Parse input weekday string. This function parses a weekday name and puts the results into a user-supplied struct tm. This function is a hook for derived classes to change the value returned.

See also: get_weekday() for details.

Parameters:

__beg — Start of string to parse.
__end — End of string to parse.
__io — Source of the locale.
__err — Error flags to set.
__tm — Pointer to struct tm to fill in.

Returns: Iterator to first char beyond weekday name.

References: std::ios_base::_M_getloc(), std::ios_base::eofbit, std::ios_base::failbit, and std::ios_base::goodbit.

Referenced by: std::time_get< _CharT, _InIter >::get_weekday().

🌟 `do_get_year` 🌟

template<typename _CharT , typename _InIter > _InIter std::time_get< _CharT,
    _InIter >::do_get_year (iter_type __beg, iter_type __end, ios_base &
    __io, ios_base::iostate & __err, tm * __tm) const

tagged [protected], [virtual], [inherited]. 🍓

Parse input year string. This function reads up to 4 characters to parse a year string and puts the results into a user-supplied struct tm. This function is a hook for derived classes to change the value returned.

See also: get_year() for details. 👀

Parameters

__beg — start of string to parse.
__end — end of string to parse.
__io — source of the locale.
__err — error flags to set.
__tm — pointer to struct tm to fill in.

Returns: iterator to first char beyond year. 🗓️

References: std::ios_base::_M_getloc(), std::ios_base::eofbit, std::ios_base::failbit, std::ios_base::goodbit, and std::__ctype_abstract_base< _CharT >::narrow().

Referenced by: std::time_get< _CharT, _InIter >::get_year().

get() — the char-format one 💅

template<typename _CharT , typename _InIter > iter_type std::time_get< _CharT, _InIter >::get (iter_type __s, iter_type __end, ios_base & __io, ios_base::iostate & __err, tm * __tm, char __format, char __modifier = 0) const [inline],  [inherited]

Parse input string according to format. This function calls time_get::do_get with the provided parameters. Slay, delegated. ✨

See also: do_get() and get().

Parameters

__s — start of string to parse.
__end — end of string to parse.
__io — source of the locale.
__err — error flags to set.
__tm — pointer to struct tm to fill in.
__format — format specifier.
__modifier — format modifier.

Returns: iterator to first char not parsed. 🫶

References: std::time_get< _CharT, _InIter >::do_get().

get() — the format-string one 🎀

template<typename _CharT , typename _InIter > _InIter std::time_get< _CharT, _InIter >::get (iter_type __s, iter_type __end, ios_base & __io, ios_base::iostate & __err, tm * __tm, const char_type * __fmt, const char_type * __fmtend) const [inline],  [inherited]

Parse input string according to format. This function parses the input string according to a provided format string. It does the inverse of time_put::put. The format string follows the format specified for strftime(3)/strptime(3). The actual parsing is done by time_get::do_get. Iconic little inverse-put situation, no cap. 🔥

Parameters

__s — start of string to parse.
__end — end of string to parse.
__io — source of the locale.
__err — error flags to set.
__tm — pointer to struct tm to fill in.
__fmt — start of the format string.
__fmtend — end of the format string.

Returns: iterator to first char not parsed. 🌈

References: std::ios_base::_M_getloc(), std::time_get< _CharT, _InIter >::do_get(), std::ios_base::eofbit, std::ios_base::failbit, std::ios_base::goodbit, std::__ctype_abstract_base< _CharT >::is(), std::__ctype_abstract_base< _CharT >::narrow(), std::__ctype_abstract_base< _CharT >::tolower(), and std::__ctype_abstract_base< _CharT >::toupper().

get_date() 📅

template<typename _CharT , typename _InIter > iter_type std::time_get< _CharT, _InIter >::get_date (iter_type __beg, iter_type __end, ios_base & __io, ios_base::iostate & __err, tm * __tm) const [inline], [inherited]

Parse input date string. This function parses a date according to the format x and puts the results into a user-supplied struct tm. The result is returned by calling time_get::do_get_date().

If there is a valid date string according to format x, tm will be filled in accordingly and the returned iterator will point to the first character beyond the date string. If an error occurs before the end, err |= ios_base::failbit. If parsing reads all the characters, err |= ios_base::eofbit. Flag drama handled correctly, bestie. 😤✨

Parameters

__beg — start of string to parse.
__end — end of string to parse.
__io — source of the locale.
__err — error flags to set.
__tm — pointer to struct tm to fill in.

Returns: iterator to first char beyond date string. 💖

References: std::time_get< _CharT, _InIter >::do_get_date().

get_monthname() 🌸

template<typename _CharT , typename _InIter > iter_type std::time_get< _CharT, _InIter >::get_monthname (iter_type __beg, iter_type __end, ios_base & __io, ios_base::iostate & __err, tm * __tm) const [inline], [inherited]

Parse input month string. This function parses a month name and puts the results into a user-supplied struct tm. The result is returned by calling time_get::do_get_monthname().

Parsing starts by parsing an abbreviated month name. If a valid abbreviation is followed by a character that would lead to the full month name, parsing continues until the full name is found or an error occurs. Otherwise parsing finishes at the end of the abbreviated name. Abbrev-to-full glow-up pipeline, love that. 🦋

If an error occurs before the end, err |= ios_base::failbit. If parsing reads all the characters, err |= ios_base::eofbit.

Parameters

__beg — start of string to parse.
__end — end of string to parse.
__io — source of the locale.
__err — error flags to set.
__tm — pointer to struct tm to fill in.

Returns: iterator to first char beyond month name. 🎀

References: std::time_get< _CharT, _InIter >::do_get_monthname().

get_time() ⏰

template<typename _CharT , typename _InIter > iter_type std::time_get< _CharT, _InIter >::get_time (iter_type __beg, iter_type __end, ios_base & __io, ios_base::iostate & __err, tm * __tm) const [inline], [inherited]

Parse input time string. This function parses a time according to the format X and puts the results into a user-supplied struct tm. The result is returned by calling time_get::do_get_time().

If there is a valid time string according to format X, tm will be filled in accordingly and the returned iterator will point to the first character beyond the time string. If an error occurs before the end, err |= ios_base::failbit. If parsing reads all the characters, err |= ios_base::eofbit.

Parameters

__beg — start of string to parse.
__end — end of string to parse.
__io — source of the locale.
__err — error flags to set.
__tm — pointer to struct tm to fill in.

Returns: iterator to first char beyond time string. 🕰️

References: std::time_get< _CharT, _InIter >::do_get_time().

get_weekday() 🗓️

template<typename _CharT , typename _InIter > iter_type std::time_get< _CharT, _InIter >::get_weekday (iter_type __beg, iter_type __end, ios_base & __io, ios_base::iostate & __err, tm * __tm) const [inline], [inherited]

Parse input weekday string. This function parses a weekday name and puts the results into a user-supplied struct tm. The result is returned by calling time_get::do_get_weekday().

Parsing starts by parsing an abbreviated weekday name. If a valid abbreviation is followed by a character that would lead to the full weekday name, parsing continues until the full name is found or an error occurs. Otherwise parsing finishes at the end of the abbreviated name. Same abbreviated-to-full-name excellence, periodt. 💅

If an error occurs before the end, err |= ios_base::failbit. If parsing reads all the characters, err |= ios_base::eofbit.

Parameters

__beg — start of string to parse.
__end — end of string to parse.
__io — source of the locale.
__err — error flags to set.
__tm — pointer to struct tm to fill in.

Returns: iterator to first char beyond weekday name. 🌟

References: std::time_get< _CharT, _InIter >::do_get_weekday().

get_year() 🧚

template<typename _CharT , typename _InIter > iter_type std::time_get< _CharT, _InIter >::get_year (iter_type __beg, iter_type __end, ios_base & __io, ios_base::iostate & __err, tm * __tm) const [inline], [inherited]

Parse input year string. This function reads up to 4 characters to parse a year string and puts the results into a user-supplied struct tm. The result is returned by calling time_get::do_get_year().

4 consecutive digits are interpreted as a full year. If there are exactly 2 consecutive digits, the library interprets this as the number of years since 1900. Two-digit year math: lowkey vintage, highkey real. 🕰️

If an error occurs before the end, err |= ios_base::failbit. If parsing reads all the characters, err |= ios_base::eofbit.

Parameters

__beg — start of string to parse.
__end — end of string to parse.
__io — source of the locale.
__err — error flags to set.
__tm — pointer to struct tm to fill in.

Returns: iterator to first char beyond year. 🍓

References: std::time_get< _CharT, _InIter >::do_get_year().

🗂️ Member Data Documentation 🗂️

id — the static, inherited facet-ID situation:

template<typename _CharT , typename _InIter > locale::id std::time_get< _CharT, _InIter >::id [static],  [inherited]

Numpunct facet id. Main character energy for a facet id, honestly. 👑

✍️ Author ✍️

Generated automatically by Doxygen for libstdc++ from the source code.

And the footer? It’s the source/version + date line for this (3cxx) page — consider it acknowledged with a lil sparkle instead of copy-pasted, bestie. 🎀✨

📦 where this page comes from

ubuntu noble: libstdc++-14-doc 14-20240412-0ubuntu1
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on 2026-11-06: a language model's rewrite of the original, under its terms

STD::TIME_GET_BYNAME(3cxx)

🎀 std::time_get_byname< _CharT, _InIter > — 3cxx manual page 🎀

💖 NAME 💖

✨ SYNOPSIS ✨

🌸 Public Types 🌸

🦋 Public Member Functions 🦋

🎀 Static Public Attributes 🎀

🌈 Protected Member Functions 🌈

🧚 Static Protected Member Functions 🧚

💜 Detailed Description 💜

🔥 Member Function Documentation 🔥

🌟 date_order 🌟

🌟 do_date_order 🌟

🌟 do_get 🌟

🌟 do_get_date 🌟

🌟 do_get_monthname 🌟

🌟 do_get_time 🌟

🌟 do_get_weekday 🌟

🌟 do_get_year 🌟

🗂️ Member Data Documentation 🗂️

✍️ Author ✍️

🌟 `date_order` 🌟

🌟 `do_date_order` 🌟

🌟 `do_get` 🌟

🌟 `do_get_date` 🌟

🌟 `do_get_monthname` 🌟

🌟 `do_get_time` 🌟

🌟 `do_get_weekday` 🌟

🌟 `do_get_year` 🌟