doc/html/boost/date_time/gather_month_strings.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function template gather_month_strings</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../date_time/doxy.html#header.boost.date_time.strings_from_facet_hpp" title="Header &lt;boost/date_time/strings_from_facet.hpp&gt;">
   9 <link rel="prev" href="string_parse_tree.html" title="Struct template string_parse_tree">
  10 <link rel="next" href="gather_weekday_strings.html" title="Function template gather_weekday_strings">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="string_parse_tree.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="gather_weekday_strings.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.date_time.gather_month_strings"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function template gather_month_strings</span></h2>
  29 <p>boost::date_time::gather_month_strings &#8212; This function gathers up all the month 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"><span class="comment">// In header: &lt;<a class="link" href="../../date_time/doxy.html#header.boost.date_time.strings_from_facet_hpp" title="Header &lt;boost/date_time/strings_from_facet.hpp&gt;">boost/date_time/strings_from_facet.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> charT<span class="special">&gt;</span>
  36   <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special">&lt;</span> <span class="identifier">charT</span> <span class="special">&gt;</span> <span class="special">&gt;</span>
  37   <span class="identifier">gather_month_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">&amp;</span> locale<span class="special">,</span> <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>
  38 <div class="refsect1">
  39 <a name="idp194992976"></a><h2>Description</h2>
  40 <p>Using the time_put facet, this function creates a collection of all the month strings from a locale. This is handy when building custom date parsers or formatters that need to be localized.</p>
  41 <p>
  42
  43 </p>
  44 <div class="variablelist"><table border="0" class="variablelist compact">
  45 <colgroup>
  46 <col align="left" valign="top">
  47 <col>
  48 </colgroup>
  49 <tbody>
  50 <tr>
  51 <td><p><span class="term">Parameters:</span></p></td>
  52 <td><div class="variablelist"><table border="0" class="variablelist compact">
  53 <colgroup>
  54 <col align="left" valign="top">
  55 <col>
  56 </colgroup>
  57 <tbody>
  58 <tr>
  59 <td><p><span class="term"><code class="computeroutput">locale</code></span></p></td>
  60 <td><p>The locale to use when gathering the strings </p></td>
  61 </tr>
  62 <tr>
  63 <td><p><span class="term"><code class="computeroutput">short_strings</code></span></p></td>
  64 <td><p>True(default) to gather short strings, false for long strings. </p></td>
  65 </tr>
  66 </tbody>
  67 </table></div></td>
  68 </tr>
  69 <tr>
  70 <td><p><span class="term">Returns:</span></p></td>
  71 <td><p>A vector of strings containing the strings in order. eg: Jan, Feb, Mar, etc. </p></td>
  72 </tr>
  73 </tbody>
  74 </table></div>
  75 </div>
  76 </div>
  77 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  78 <td align="left"></td>
  79 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2005 CrystalClear Software, Inc<p>Subject to the Boost Software License, Version 1.0. (See accompanying file
  80     <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>
  81 </div></td>
  82 </tr></table>
  83 <hr>
  84 <div class="spirit-nav">
  85 <a accesskey="p" href="string_parse_tree.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="gather_weekday_strings.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  86 </div>
  87 </body>
  88 </html>