libs/log/doc/html/boost/log/extract__idm45711348300464.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__idm45711348308384.html" title="Function template extract_or_throw">
  10 <link rel="next" href="extract__idm45711348291024.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__idm45711348308384.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__idm45711348291024.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.extract__idm45711348300464"></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> DescriptorT<span class="special">,</span> <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="special">&gt;</span> <span class="keyword">class</span> ActorT<span class="special">,</span>
  29          <span class="keyword">typename</span> DefaultT<span class="special">&gt;</span>
  30   <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="keyword">typename</span> <span class="identifier">DescriptorT</span><span class="special">::</span><span class="identifier">value_type</span><span class="special">,</span> <span class="identifier">DefaultT</span><span class="special">,</span> <span class="identifier">DescriptorT</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>
  31   <span class="identifier">extract_or_default</span><span class="special">(</span><span class="identifier">expressions</span><span class="special">::</span><span class="identifier">attribute_keyword</span><span class="special">&lt;</span> <span class="identifier">DescriptorT</span><span class="special">,</span> <span class="identifier">ActorT</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> keyword<span class="special">,</span>
  32                      <a class="link" href="attribute_value_set.html" title="Class attribute_value_set">attribute_value_set</a> <span class="keyword">const</span> <span class="special">&amp;</span> attrs<span class="special">,</span>
  33                      <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>
  34 <div class="refsect1">
  35 <a name="idm45554749189792"></a><h2>Description</h2>
  36 <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 extracted.</p>
  37 <div class="note"><table border="0" summary="Note">
  38 <tr>
  39 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
  40 <th align="left">Note</th>
  41 </tr>
  42 <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>
  43 </table></div>
  44 <p>
  45
  46
  47 </p>
  48 <div class="variablelist"><table border="0" class="variablelist compact">
  49 <colgroup>
  50 <col align="left" valign="top">
  51 <col>
  52 </colgroup>
  53 <tbody>
  54 <tr>
  55 <td><p><span class="term">Parameters:</span></p></td>
  56 <td><div class="variablelist"><table border="0" class="variablelist compact">
  57 <colgroup>
  58 <col align="left" valign="top">
  59 <col>
  60 </colgroup>
  61 <tbody>
  62 <tr>
  63 <td><p><span class="term"><code class="computeroutput">attrs</code></span></p></td>
  64 <td><p>A set of attribute values in which to look for the specified attribute value. </p></td>
  65 </tr>
  66 <tr>
  67 <td><p><span class="term"><code class="computeroutput">def_val</code></span></p></td>
  68 <td><p>The default value </p></td>
  69 </tr>
  70 <tr>
  71 <td><p><span class="term"><code class="computeroutput">keyword</code></span></p></td>
  72 <td><p>The keyword of the attribute value to extract. </p></td>
  73 </tr>
  74 </tbody>
  75 </table></div></td>
  76 </tr>
  77 <tr>
  78 <td><p><span class="term">Returns:</span></p></td>
  79 <td><p>The extracted value, if found. The default value otherwise. </p></td>
  80 </tr>
  81 </tbody>
  82 </table></div>
  83 </div>
  84 </div>
  85 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  86 <td align="left"></td>
  87 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
  88         Distributed under the Boost Software License, Version 1.0. (See accompanying
  89         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>).
  90       </p>
  91 </div></td>
  92 </tr></table>
  93 <hr>
  94 <div class="spirit-nav">
  95 <a accesskey="p" href="extract__idm45711348308384.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__idm45711348291024.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  96 </div>
  97 </body>
  98 </html>