| 1 | <html> |
|---|
| 2 | <head> |
|---|
| 3 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
|---|
| 4 | <title>Function template gather_weekday_strings</title> |
|---|
| 5 | <link rel="stylesheet" href="boostbook.css" type="text/css"> |
|---|
| 6 | <meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> |
|---|
| 7 | <link rel="start" href="index.html" title="The Boost C++ Libraries"> |
|---|
| 8 | <link rel="up" href="date_time/doxy.html#id2481608" title="Header <boost/date_time/strings_from_facet.hpp>"> |
|---|
| 9 | <link rel="prev" href="gather_month_strings.html" title="Function template gather_month_strings"> |
|---|
| 10 | <link rel="next" href="base_time.html" title="Class template base_time"> |
|---|
| 11 | </head> |
|---|
| 12 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
|---|
| 13 | <table cellpadding="2" width="100%"> |
|---|
| 14 | <td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td> |
|---|
| 15 | <td align="center"><a href="../../index.htm">Home</a></td> |
|---|
| 16 | <td align="center"><a href="../../libs/libraries.htm">Libraries</a></td> |
|---|
| 17 | <td align="center"><a href="../../people/people.htm">People</a></td> |
|---|
| 18 | <td align="center"><a href="../../more/faq.htm">FAQ</a></td> |
|---|
| 19 | <td align="center"><a href="../../more/index.htm">More</a></td> |
|---|
| 20 | </table> |
|---|
| 21 | <hr> |
|---|
| 22 | <div class="spirit-nav"> |
|---|
| 23 | <a accesskey="p" href="gather_month_strings.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id2481608"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="base_time.html"><img src="images/next.png" alt="Next"></a> |
|---|
| 24 | </div> |
|---|
| 25 | <div class="refentry" lang="en"> |
|---|
| 26 | <a name="gather_weekday_strings"></a><div class="titlepage"></div> |
|---|
| 27 | <div class="refnamediv"> |
|---|
| 28 | <h2><span class="refentrytitle">Function template gather_weekday_strings</span></h2> |
|---|
| 29 | <p>boost::date_time::gather_weekday_strings — This function gathers up all the weekday strings from a std::locale. </p> |
|---|
| 30 | </div> |
|---|
| 31 | <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> |
|---|
| 32 | <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"> |
|---|
| 33 | <span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> charT> |
|---|
| 34 | <span class="type">std::vector< std::basic_string< charT > ></span> |
|---|
| 35 | gather_weekday_strings(<span class="bold"><strong>const</strong></span> std::locale & locale, |
|---|
| 36 | <span class="bold"><strong>bool</strong></span> short_strings = true);</pre></div> |
|---|
| 37 | <div class="refsect1" lang="en"> |
|---|
| 38 | <a name="id2651485"></a><h2>Description</h2> |
|---|
| 39 | <p>Using the time_put facet, this function creates a collection of all the weekday strings from a locale starting with the string for 'Sunday'. This is handy when building custom date parsers or formatters that need to be localized.</p> |
|---|
| 40 | <p></p> |
|---|
| 41 | <div class="variablelist"> |
|---|
| 42 | <p class="title"><b>Parameters</b></p> |
|---|
| 43 | <dl> |
|---|
| 44 | <dt><span class="term">locale</span></dt> |
|---|
| 45 | <dd><p>The locale to use when gathering the strings </p></dd> |
|---|
| 46 | <dt><span class="term">short_strings</span></dt> |
|---|
| 47 | <dd><p>True(default) to gather short strings, false for long strings. </p></dd> |
|---|
| 48 | </dl> |
|---|
| 49 | </div> |
|---|
| 50 | <p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>: |
|---|
| 51 | |
|---|
| 52 | A vector of strings containing the weekdays in order. eg: Sun, Mon, Tue, Wed, Thu, Fri, Sat </p> |
|---|
| 53 | </div> |
|---|
| 54 | </div> |
|---|
| 55 | <table width="100%"><tr> |
|---|
| 56 | <td align="left"></td> |
|---|
| 57 | <td align="right"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td> |
|---|
| 58 | </tr></table> |
|---|
| 59 | <hr> |
|---|
| 60 | <div class="spirit-nav"> |
|---|
| 61 | <a accesskey="p" href="gather_month_strings.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id2481608"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="base_time.html"><img src="images/next.png" alt="Next"></a> |
|---|
| 62 | </div> |
|---|
| 63 | </body> |
|---|
| 64 | </html> |
|---|
