.TH "std::time_get_byname< _CharT, _InIter >" 3cxx "Sun Jan 6 2013" "libstdc++" \" -*- nroff -*- .ad l .nh .SH NAME std::time_get_byname< _CharT, _InIter > \- .SH SYNOPSIS .br .PP .PP Inherits \fBstd::time_get< _CharT, _InIter >\fP\&. .SS "Public Types" .in +1c .ti -1c .RI "typedef \fBbasic_string\fP< _CharT > \fB__string_type\fP" .br .ti -1c .RI "typedef _CharT \fBchar_type\fP" .br .ti -1c .RI "enum \fBdateorder\fP { \fBno_order\fP, \fBdmy\fP, \fBmdy\fP, \fBymd\fP, \fBydm\fP }" .br .ti -1c .RI "typedef _InIter \fBiter_type\fP" .br .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBtime_get_byname\fP (const char *, size_t __refs=0)" .br .ti -1c .RI "dateorder \fBdate_order\fP () const " .br .ti -1c .RI "\fBiter_type\fP \fBget_date\fP (\fBiter_type\fP __beg, \fBiter_type\fP __end, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err, tm *__tm) const " .br .ti -1c .RI "\fBiter_type\fP \fBget_monthname\fP (\fBiter_type\fP __beg, \fBiter_type\fP __end, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err, tm *__tm) const " .br .ti -1c .RI "\fBiter_type\fP \fBget_time\fP (\fBiter_type\fP __beg, \fBiter_type\fP __end, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err, tm *__tm) const " .br .ti -1c .RI "\fBiter_type\fP \fBget_weekday\fP (\fBiter_type\fP __beg, \fBiter_type\fP __end, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err, tm *__tm) const " .br .ti -1c .RI "\fBiter_type\fP \fBget_year\fP (\fBiter_type\fP __beg, \fBiter_type\fP __end, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err, tm *__tm) const " .br .in -1c .SS "Static Public Attributes" .in +1c .ti -1c .RI "static \fBlocale::id\fP \fBid\fP" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "\fBiter_type\fP \fB_M_extract_name\fP (\fBiter_type\fP __beg, \fBiter_type\fP __end, int &__member, const _CharT **__names, size_t __indexlen, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err) const " .br .ti -1c .RI "\fBiter_type\fP \fB_M_extract_num\fP (\fBiter_type\fP __beg, \fBiter_type\fP __end, int &__member, int __min, int __max, size_t __len, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err) const " .br .ti -1c .RI "\fBiter_type\fP \fB_M_extract_via_format\fP (\fBiter_type\fP __beg, \fBiter_type\fP __end, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err, tm *__tm, const _CharT *__format) const " .br .ti -1c .RI "\fBiter_type\fP \fB_M_extract_wday_or_month\fP (\fBiter_type\fP __beg, \fBiter_type\fP __end, int &__member, const _CharT **__names, size_t __indexlen, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err) const " .br .ti -1c .RI "virtual dateorder \fBdo_date_order\fP () const " .br .ti -1c .RI "virtual \fBiter_type\fP \fBdo_get_date\fP (\fBiter_type\fP __beg, \fBiter_type\fP __end, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err, tm *__tm) const " .br .ti -1c .RI "virtual \fBiter_type\fP \fBdo_get_monthname\fP (\fBiter_type\fP __beg, \fBiter_type\fP __end, \fBios_base\fP &, \fBios_base::iostate\fP &__err, tm *__tm) const " .br .ti -1c .RI "virtual \fBiter_type\fP \fBdo_get_time\fP (\fBiter_type\fP __beg, \fBiter_type\fP __end, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err, tm *__tm) const " .br .ti -1c .RI "virtual \fBiter_type\fP \fBdo_get_weekday\fP (\fBiter_type\fP __beg, \fBiter_type\fP __end, \fBios_base\fP &, \fBios_base::iostate\fP &__err, tm *__tm) const " .br .ti -1c .RI "virtual \fBiter_type\fP \fBdo_get_year\fP (\fBiter_type\fP __beg, \fBiter_type\fP __end, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err, tm *__tm) const " .br .in -1c .SS "Static Protected Member Functions" .in +1c .ti -1c .RI "static __c_locale \fB_S_clone_c_locale\fP (__c_locale &__cloc) throw ()" .br .ti -1c .RI "static void \fB_S_create_c_locale\fP (__c_locale &__cloc, const char *__s, __c_locale __old=0)" .br .ti -1c .RI "static void \fB_S_destroy_c_locale\fP (__c_locale &__cloc)" .br .ti -1c .RI "static __c_locale \fB_S_get_c_locale\fP ()" .br .ti -1c .RI "static const char * \fB_S_get_c_name\fP () throw ()" .br .ti -1c .RI "static __c_locale \fB_S_lc_ctype_c_locale\fP (__c_locale __cloc, const char *__s)" .br .in -1c .SH "Detailed Description" .PP .SS "templateclass std::time_get_byname< _CharT, _InIter >" class \fBtime_get_byname\fP [22\&.2\&.5\&.2]\&. .PP Definition at line 686 of file locale_facets_nonio\&.h\&. .SH "Member Function Documentation" .PP .SS "template dateorder \fBstd::time_get\fP< _CharT, _InIter >::date_order () const\fC [inline]\fP, \fC [inherited]\fP" .PP Return preferred order of month, day, and year\&. This function returns an enum from timebase::dateorder giving the preferred ordering if the format \fIx\fP given to \fBtime_put::put()\fP only uses month, day, and year\&. If the format \fIx\fP for the associated locale uses other fields, this function returns timebase::dateorder::noorder\&. .PP NOTE: The library always returns noorder at the moment\&. .PP \fBReturns:\fP .RS 4 A member of timebase::dateorder\&. .RE .PP .PP Definition at line 407 of file locale_facets_nonio\&.h\&. .PP References std::time_get< _CharT, _InIter >::do_date_order()\&. .SS "template time_base::dateorder \fBstd::time_get\fP< _CharT, _InIter >::do_date_order () const\fC [protected]\fP, \fC [virtual]\fP, \fC [inherited]\fP" .PP Return preferred order of month, day, and year\&. This function returns an enum from timebase::dateorder giving the preferred ordering if the format \fIx\fP given to \fBtime_put::put()\fP only uses month, day, and year\&. This function is a hook for derived classes to change the value returned\&. .PP \fBReturns:\fP .RS 4 A member of timebase::dateorder\&. .RE .PP .PP Definition at line 620 of file locale_facets_nonio\&.tcc\&. .PP Referenced by std::time_get< _CharT, _InIter >::date_order()\&. .SS "template _InIter \fBstd::time_get\fP< _CharT, _InIter >::do_get_date (\fBiter_type\fP__beg, \fBiter_type\fP__end, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err, tm *__tm) const\fC [protected]\fP, \fC [virtual]\fP, \fC [inherited]\fP" .PP Parse input date string\&. This function parses a date according to the format \fIX\fP and puts the results into a user-supplied struct tm\&. This function is a hook for derived classes to change the value returned\&. .PP \fBSee Also:\fP .RS 4 \fBget_date()\fP for details\&. .RE .PP \fBParameters:\fP .RS 4 \fI__beg\fP Start of string to parse\&. .br \fI__end\fP End of string to parse\&. .br \fI__io\fP Source of the locale\&. .br \fI__err\fP Error flags to set\&. .br \fI__tm\fP Pointer to struct tm to fill in\&. .RE .PP \fBReturns:\fP .RS 4 Iterator to first char beyond date string\&. .RE .PP .PP Definition at line 1047 of file locale_facets_nonio\&.tcc\&. .PP References std::ios_base::_M_getloc(), and std::ios_base::eofbit\&. .PP Referenced by std::time_get< _CharT, _InIter >::get_date()\&. .SS "template _InIter \fBstd::time_get\fP< _CharT, _InIter >::do_get_monthname (\fBiter_type\fP__beg, \fBiter_type\fP__end, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err, tm *__tm) const\fC [protected]\fP, \fC [virtual]\fP, \fC [inherited]\fP" .PP 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\&. .PP \fBSee Also:\fP .RS 4 \fBget_monthname()\fP for details\&. .RE .PP \fBParameters:\fP .RS 4 \fI__beg\fP Start of string to parse\&. .br \fI__end\fP End of string to parse\&. .br \fI__io\fP Source of the locale\&. .br \fI__err\fP Error flags to set\&. .br \fI__tm\fP Pointer to struct tm to fill in\&. .RE .PP \fBReturns:\fP .RS 4 Iterator to first char beyond month name\&. .RE .PP .PP Definition at line 1092 of file locale_facets_nonio\&.tcc\&. .PP References std::ios_base::_M_getloc(), std::ios_base::eofbit, std::ios_base::failbit, and std::ios_base::goodbit\&. .PP Referenced by std::time_get< _CharT, _InIter >::get_monthname()\&. .SS "template _InIter \fBstd::time_get\fP< _CharT, _InIter >::do_get_time (\fBiter_type\fP__beg, \fBiter_type\fP__end, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err, tm *__tm) const\fC [protected]\fP, \fC [virtual]\fP, \fC [inherited]\fP" .PP Parse input time string\&. This function parses a time according to the format \fIx\fP and puts the results into a user-supplied struct tm\&. This function is a hook for derived classes to change the value returned\&. .PP \fBSee Also:\fP .RS 4 \fBget_time()\fP for details\&. .RE .PP \fBParameters:\fP .RS 4 \fI__beg\fP Start of string to parse\&. .br \fI__end\fP End of string to parse\&. .br \fI__io\fP Source of the locale\&. .br \fI__err\fP Error flags to set\&. .br \fI__tm\fP Pointer to struct tm to fill in\&. .RE .PP \fBReturns:\fP .RS 4 Iterator to first char beyond time string\&. .RE .PP .PP Definition at line 1030 of file locale_facets_nonio\&.tcc\&. .PP References std::ios_base::_M_getloc(), and std::ios_base::eofbit\&. .PP Referenced by std::time_get< _CharT, _InIter >::get_time()\&. .SS "template _InIter \fBstd::time_get\fP< _CharT, _InIter >::do_get_weekday (\fBiter_type\fP__beg, \fBiter_type\fP__end, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err, tm *__tm) const\fC [protected]\fP, \fC [virtual]\fP, \fC [inherited]\fP" .PP 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\&. .PP \fBSee Also:\fP .RS 4 \fBget_weekday()\fP for details\&. .RE .PP \fBParameters:\fP .RS 4 \fI__beg\fP Start of string to parse\&. .br \fI__end\fP End of string to parse\&. .br \fI__io\fP Source of the locale\&. .br \fI__err\fP Error flags to set\&. .br \fI__tm\fP Pointer to struct tm to fill in\&. .RE .PP \fBReturns:\fP .RS 4 Iterator to first char beyond weekday name\&. .RE .PP .PP Definition at line 1064 of file locale_facets_nonio\&.tcc\&. .PP References std::ios_base::_M_getloc(), std::ios_base::eofbit, std::ios_base::failbit, and std::ios_base::goodbit\&. .PP Referenced by std::time_get< _CharT, _InIter >::get_weekday()\&. .SS "template _InIter \fBstd::time_get\fP< _CharT, _InIter >::do_get_year (\fBiter_type\fP__beg, \fBiter_type\fP__end, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err, tm *__tm) const\fC [protected]\fP, \fC [virtual]\fP, \fC [inherited]\fP" .PP 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\&. .PP \fBSee Also:\fP .RS 4 \fBget_year()\fP for details\&. .RE .PP \fBParameters:\fP .RS 4 \fI__beg\fP Start of string to parse\&. .br \fI__end\fP End of string to parse\&. .br \fI__io\fP Source of the locale\&. .br \fI__err\fP Error flags to set\&. .br \fI__tm\fP Pointer to struct tm to fill in\&. .RE .PP \fBReturns:\fP .RS 4 Iterator to first char beyond year\&. .RE .PP .PP Definition at line 1120 of file locale_facets_nonio\&.tcc\&. .PP References std::ios_base::_M_getloc(), std::ios_base::eofbit, std::ios_base::failbit, and std::ios_base::goodbit\&. .PP Referenced by std::time_get< _CharT, _InIter >::get_year()\&. .SS "template \fBiter_type\fP \fBstd::time_get\fP< _CharT, _InIter >::get_date (\fBiter_type\fP__beg, \fBiter_type\fP__end, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err, tm *__tm) const\fC [inline]\fP, \fC [inherited]\fP" .PP Parse input date string\&. This function parses a date according to the format \fIx\fP and puts the results into a user-supplied struct tm\&. The result is returned by calling \fBtime_get::do_get_date()\fP\&. .PP If there is a valid date string according to format \fIx\fP, \fItm\fP 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 |= \fBios_base::failbit\fP\&. If parsing reads all the characters, err |= \fBios_base::eofbit\fP\&. .PP \fBParameters:\fP .RS 4 \fI__beg\fP Start of string to parse\&. .br \fI__end\fP End of string to parse\&. .br \fI__io\fP Source of the locale\&. .br \fI__err\fP Error flags to set\&. .br \fI__tm\fP Pointer to struct tm to fill in\&. .RE .PP \fBReturns:\fP .RS 4 Iterator to first char beyond date string\&. .RE .PP .PP Definition at line 456 of file locale_facets_nonio\&.h\&. .PP References std::time_get< _CharT, _InIter >::do_get_date()\&. .SS "template \fBiter_type\fP \fBstd::time_get\fP< _CharT, _InIter >::get_monthname (\fBiter_type\fP__beg, \fBiter_type\fP__end, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err, tm *__tm) const\fC [inline]\fP, \fC [inherited]\fP" .PP 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 \fBtime_get::do_get_monthname()\fP\&. .PP 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\&. .PP If an error occurs before the end, err |= \fBios_base::failbit\fP\&. If parsing reads all the characters, err |= \fBios_base::eofbit\fP\&. .PP \fBParameters:\fP .RS 4 \fI__beg\fP Start of string to parse\&. .br \fI__end\fP End of string to parse\&. .br \fI__io\fP Source of the locale\&. .br \fI__err\fP Error flags to set\&. .br \fI__tm\fP Pointer to struct tm to fill in\&. .RE .PP \fBReturns:\fP .RS 4 Iterator to first char beyond month name\&. .RE .PP .PP Definition at line 513 of file locale_facets_nonio\&.h\&. .PP References std::time_get< _CharT, _InIter >::do_get_monthname()\&. .SS "template \fBiter_type\fP \fBstd::time_get\fP< _CharT, _InIter >::get_time (\fBiter_type\fP__beg, \fBiter_type\fP__end, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err, tm *__tm) const\fC [inline]\fP, \fC [inherited]\fP" .PP Parse input time string\&. This function parses a time according to the format \fIX\fP and puts the results into a user-supplied struct tm\&. The result is returned by calling \fBtime_get::do_get_time()\fP\&. .PP If there is a valid time string according to format \fIX\fP, \fItm\fP 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 |= \fBios_base::failbit\fP\&. If parsing reads all the characters, err |= \fBios_base::eofbit\fP\&. .PP \fBParameters:\fP .RS 4 \fI__beg\fP Start of string to parse\&. .br \fI__end\fP End of string to parse\&. .br \fI__io\fP Source of the locale\&. .br \fI__err\fP Error flags to set\&. .br \fI__tm\fP Pointer to struct tm to fill in\&. .RE .PP \fBReturns:\fP .RS 4 Iterator to first char beyond time string\&. .RE .PP .PP Definition at line 431 of file locale_facets_nonio\&.h\&. .PP References std::time_get< _CharT, _InIter >::do_get_time()\&. .SS "template \fBiter_type\fP \fBstd::time_get\fP< _CharT, _InIter >::get_weekday (\fBiter_type\fP__beg, \fBiter_type\fP__end, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err, tm *__tm) const\fC [inline]\fP, \fC [inherited]\fP" .PP 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 \fBtime_get::do_get_weekday()\fP\&. .PP 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\&. .PP If an error occurs before the end, err |= \fBios_base::failbit\fP\&. If parsing reads all the characters, err |= \fBios_base::eofbit\fP\&. .PP \fBParameters:\fP .RS 4 \fI__beg\fP Start of string to parse\&. .br \fI__end\fP End of string to parse\&. .br \fI__io\fP Source of the locale\&. .br \fI__err\fP Error flags to set\&. .br \fI__tm\fP Pointer to struct tm to fill in\&. .RE .PP \fBReturns:\fP .RS 4 Iterator to first char beyond weekday name\&. .RE .PP .PP Definition at line 484 of file locale_facets_nonio\&.h\&. .PP References std::time_get< _CharT, _InIter >::do_get_weekday()\&. .SS "template \fBiter_type\fP \fBstd::time_get\fP< _CharT, _InIter >::get_year (\fBiter_type\fP__beg, \fBiter_type\fP__end, \fBios_base\fP &__io, \fBios_base::iostate\fP &__err, tm *__tm) const\fC [inline]\fP, \fC [inherited]\fP" .PP 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 \fBtime_get::do_get_year()\fP\&. .PP 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\&. .PP If an error occurs before the end, err |= \fBios_base::failbit\fP\&. If parsing reads all the characters, err |= \fBios_base::eofbit\fP\&. .PP \fBParameters:\fP .RS 4 \fI__beg\fP Start of string to parse\&. .br \fI__end\fP End of string to parse\&. .br \fI__io\fP Source of the locale\&. .br \fI__err\fP Error flags to set\&. .br \fI__tm\fP Pointer to struct tm to fill in\&. .RE .PP \fBReturns:\fP .RS 4 Iterator to first char beyond year\&. .RE .PP .PP Definition at line 539 of file locale_facets_nonio\&.h\&. .PP References std::time_get< _CharT, _InIter >::do_get_year()\&. .SH "Member Data Documentation" .PP .SS "template \fBlocale::id\fP \fBstd::time_get\fP< _CharT, _InIter >::id\fC [static]\fP, \fC [inherited]\fP" .PP Numpunct facet id\&. .PP Definition at line 380 of file locale_facets_nonio\&.h\&. .SH "Author" .PP Generated automatically by Doxygen for libstdc++ from the source code\&.