doc/html/boost/date_time/parse_match_result.html

   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=US-ASCII">
   5 <title>Struct template parse_match_result</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.string_parse_tree_hpp" title="Header &lt;boost/date_time/string_parse_tree.hpp&gt;">
  10 <link rel="prev" href="convert_string_type.html" title="Function template convert_string_type">
  11 <link rel="next" href="string_parse_tree.html" title="Struct template string_parse_tree">
  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="convert_string_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.string_parse_tree_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="string_parse_tree.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.date_time.parse_match_result"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Struct template parse_match_result</span></h2>
  30 <p>boost::date_time::parse_match_result</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: &lt;<a class="link" href="../../date_time/doxy.html#header.boost.date_time.string_parse_tree_hpp" title="Header &lt;boost/date_time/string_parse_tree.hpp&gt;">boost/date_time/string_parse_tree.hpp</a>&gt;
  34
  35 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> charT<span class="special">&gt;</span>
  36 <span class="keyword">struct</span> <a class="link" href="parse_match_result.html" title="Struct template parse_match_result">parse_match_result</a> <span class="special">{</span>
  37   <span class="comment">// types</span>
  38   <span class="keyword">typedef</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> <a name="boost.date_time.parse_match_result.string_type"></a><span class="identifier">string_type</span><span class="special">;</span>
  39
  40   <span class="keyword">enum</span> <a name="boost.date_time.parse_match_result.PARSE_STATE"></a>PARSE_STATE <span class="special">{</span> PARSE_ERROR = = -1 <span class="special">}</span><span class="special">;</span>
  41
  42   <span class="comment">// <a class="link" href="parse_match_result.html#boost.date_time.parse_match_resultconstruct-copy-destruct">construct/copy/destruct</a></span>
  43   <a class="link" href="parse_match_result.html#idp496907072-bb"><span class="identifier">parse_match_result</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  44
  45   <span class="comment">// <a class="link" href="parse_match_result.html#idp496902176-bb">public member functions</a></span>
  46   <span class="identifier">string_type</span> <a class="link" href="parse_match_result.html#idp496902736-bb"><span class="identifier">remaining</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  47   <span class="identifier">charT</span> <a class="link" href="parse_match_result.html#idp496903856-bb"><span class="identifier">last_char</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  48   <span class="keyword">bool</span> <a class="link" href="parse_match_result.html#idp496904976-bb"><span class="identifier">has_remaining</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  49
  50   <span class="comment">// public data members</span>
  51   <span class="identifier">string_type</span> <span class="identifier">cache</span><span class="special">;</span>
  52   <span class="keyword">unsigned</span> <span class="keyword">short</span> <span class="identifier">match_depth</span><span class="special">;</span>
  53   <span class="keyword">short</span> <span class="identifier">current_match</span><span class="special">;</span>
  54 <span class="special">}</span><span class="special">;</span></pre></div>
  55 <div class="refsect1">
  56 <a name="idp227534752"></a><h2>Description</h2>
  57 <div class="refsect2">
  58 <a name="idp227535168"></a><h3>
  59 <a name="boost.date_time.parse_match_resultconstruct-copy-destruct"></a><code class="computeroutput">parse_match_result</code>
  60         public
  61        construct/copy/destruct</h3>
  62 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp496907072-bb"></a><span class="identifier">parse_match_result</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div>
  63 </div>
  64 <div class="refsect2">
  65 <a name="idp227541136"></a><h3>
  66 <a name="idp496902176-bb"></a><code class="computeroutput">parse_match_result</code> public member functions</h3>
  67 <div class="orderedlist"><ol class="orderedlist" type="1">
  68 <li class="listitem"><pre class="literallayout"><span class="identifier">string_type</span> <a name="idp496902736-bb"></a><span class="identifier">remaining</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  69 <li class="listitem"><pre class="literallayout"><span class="identifier">charT</span> <a name="idp496903856-bb"></a><span class="identifier">last_char</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  70 <li class="listitem">
  71 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp496904976-bb"></a><span class="identifier">has_remaining</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns true if more characters were parsed than was necessary. <p>Should be used in conjunction with last_char() to get the remaining character. </p>
  72 </li>
  73 </ol></div>
  74 </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="convert_string_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.string_parse_tree_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="string_parse_tree.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  86 </div>
  87 </body>
  88 </html>