libs/log/doc/html/boost/log/extract_or_def_idp62445344.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function template extract_or_default</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Log v2">
   8 <link rel="up" href="../../attributes.html#header.boost.log.attributes.value_extraction_hpp" title="Header &lt;boost/log/attributes/value_extraction.hpp&gt;">
   9 <link rel="prev" href="extract_or_def_idp62436304.html" title="Function template extract_or_default">
  10 <link rel="next" href="extract_or_def_idp62454384.html" title="Function template extract_or_default">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td></tr></table>
  14 <hr>
  15 <div class="spirit-nav">
  16 <a accesskey="p" href="extract_or_def_idp62436304.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../attributes.html#header.boost.log.attributes.value_extraction_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="extract_or_def_idp62454384.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.extract_or_def_idp62445344"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Function template extract_or_default</span></h2>
  22 <p>boost::log::extract_or_default</p>
  23 </div>
  24 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  25 <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="../../attributes.html#header.boost.log.attributes.value_extraction_hpp" title="Header &lt;boost/log/attributes/value_extraction.hpp&gt;">boost/log/attributes/value_extraction.hpp</a>&gt;
  26
  27 </span>
  28 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> TagT <span class="special">=</span> <span class="keyword">void</span><span class="special">,</span> <span class="keyword">typename</span> DefaultT<span class="special">&gt;</span>
  29   <a class="link" href="result_of/extract_or_default.html" title="Struct template extract_or_default">result_of::extract_or_default</a><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">DefaultT</span><span class="special">,</span> <span class="identifier">TagT</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>
  30   <span class="identifier">extract_or_default</span><span class="special">(</span><a class="link" href="attribute_name.html" title="Class attribute_name">attribute_name</a> <span class="keyword">const</span> <span class="special">&amp;</span> name<span class="special">,</span> <span class="identifier">record_view</span> <span class="keyword">const</span> <span class="special">&amp;</span> rec<span class="special">,</span>
  31                      <span class="identifier">DefaultT</span> <span class="keyword">const</span> <span class="special">&amp;</span> def_val<span class="special">)</span><span class="special">;</span></pre></div>
  32 <div class="refsect1">
  33 <a name="idp109772976"></a><h2>Description</h2>
  34 <p>The function extracts an attribute value from the view. The user has to explicitly specify the type or set of possible types of the attribute value to be visited.</p>
  35 <div class="note"><table border="0" summary="Note">
  36 <tr>
  37 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
  38 <th align="left">Note</th>
  39 </tr>
  40 <tr><td align="left" valign="top"><p>Caution must be exercised if the default value is a temporary object. Because the function returns a reference, if the temporary object is destroyed, the reference may become dangling.</p></td></tr>
  41 </table></div>
  42 <p>
  43
  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">def_val</code></span></p></td>
  62 <td><p>The default value </p></td>
  63 </tr>
  64 <tr>
  65 <td><p><span class="term"><code class="computeroutput">name</code></span></p></td>
  66 <td><p>The name of the attribute value to extract. </p></td>
  67 </tr>
  68 <tr>
  69 <td><p><span class="term"><code class="computeroutput">rec</code></span></p></td>
  70 <td><p>A log record view. The attribute value will be sought among those associated with the record. </p></td>
  71 </tr>
  72 </tbody>
  73 </table></div></td>
  74 </tr>
  75 <tr>
  76 <td><p><span class="term">Returns:</span></p></td>
  77 <td><p>The extracted value, if found. The default value otherwise. </p></td>
  78 </tr>
  79 </tbody>
  80 </table></div>
  81 </div>
  82 </div>
  83 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  84 <td align="left"></td>
  85 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
  86         Distributed under the Boost Software License, Version 1.0. (See accompanying
  87         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>).
  88       </p>
  89 </div></td>
  90 </tr></table>
  91 <hr>
  92 <div class="spirit-nav">
  93 <a accesskey="p" href="extract_or_def_idp62436304.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../attributes.html#header.boost.log.attributes.value_extraction_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="extract_or_def_idp62454384.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  94 </div>
  95 </body>
  96 </html>