1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Function template gather_weekday_strings</title> 6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../../date_time/doxy.html#header.boost.date_time.strings_from_facet_hpp" title="Header <boost/date_time/strings_from_facet.hpp>"> 10<link rel="prev" href="gather_month_strings.html" title="Function template gather_month_strings"> 11<link rel="next" href="base_time.html" title="Class template base_time"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 16<td align="center"><a href="../../../../index.html">Home</a></td> 17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<a accesskey="p" href="gather_month_strings.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.strings_from_facet_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="base_time.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.date_time.gather_weekday_strings"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Function template gather_weekday_strings</span></h2> 30<p>boost::date_time::gather_weekday_strings — This function gathers up all the weekday strings from a std::locale. </p> 31</div> 32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 33<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../date_time/doxy.html#header.boost.date_time.strings_from_facet_hpp" title="Header <boost/date_time/strings_from_facet.hpp>">boost/date_time/strings_from_facet.hpp</a>> 34 35</span> 36<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> charT<span class="special">></span> 37 <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <span class="special">></span> 38 <span class="identifier">gather_weekday_strings</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <span class="special">&</span> locale<span class="special">,</span> 39 <span class="keyword">bool</span> short_strings <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span></pre></div> 40<div class="refsect1"> 41<a name="id-1.3.14.15.3.43.4.4"></a><h2>Description</h2> 42<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> 43<p> 44 45</p> 46<div class="variablelist"><table border="0" class="variablelist compact"> 47<colgroup> 48<col align="left" valign="top"> 49<col> 50</colgroup> 51<tbody> 52<tr> 53<td><p><span class="term">Parameters:</span></p></td> 54<td><div class="variablelist"><table border="0" class="variablelist compact"> 55<colgroup> 56<col align="left" valign="top"> 57<col> 58</colgroup> 59<tbody> 60<tr> 61<td><p><span class="term"><code class="computeroutput">locale</code></span></p></td> 62<td><p>The locale to use when gathering the strings </p></td> 63</tr> 64<tr> 65<td><p><span class="term"><code class="computeroutput">short_strings</code></span></p></td> 66<td><p>True(default) to gather short strings, false for long strings. </p></td> 67</tr> 68</tbody> 69</table></div></td> 70</tr> 71<tr> 72<td><p><span class="term">Returns:</span></p></td> 73<td><p>A vector of strings containing the weekdays in order. eg: Sun, Mon, Tue, Wed, Thu, Fri, Sat </p></td> 74</tr> 75</tbody> 76</table></div> 77</div> 78</div> 79<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 80<td align="left"></td> 81<td align="right"><div class="copyright-footer">Copyright © 2001-2005 CrystalClear Software, Inc<p>Subject to the Boost Software License, Version 1.0. (See accompanying file 82 <code class="filename">LICENSE_1_0.txt</code> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)</p> 83</div></td> 84</tr></table> 85<hr> 86<div class="spirit-nav"> 87<a accesskey="p" href="gather_month_strings.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.strings_from_facet_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="base_time.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 88</div> 89</body> 90</html> 91
