BOOST_LO_idm45711347583312.html 6.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Macro BOOST_LOG_ATTRIBUTE_KEYWORD_TYPE</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="expressions.html#header.boost.log.expressions.keyword_hpp" title="Header &lt;boost/log/expressions/keyword.hpp&gt;">
  9. <link rel="prev" href="boost/log/expressions/keyword_descriptor.html" title="Struct keyword_descriptor">
  10. <link rel="next" href="BOOST_LO_idm45711347575568.html" title="Macro BOOST_LOG_ATTRIBUTE_KEYWORD">
  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="boost/log/expressions/keyword_descriptor.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="expressions.html#header.boost.log.expressions.keyword_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="BOOST_LO_idm45711347575568.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  17. </div>
  18. <div class="refentry">
  19. <a name="BOOST_LO_idm45711347583312"></a><div class="titlepage"></div>
  20. <div class="refnamediv">
  21. <h2><span class="refentrytitle">Macro BOOST_LOG_ATTRIBUTE_KEYWORD_TYPE</span></h2>
  22. <p>BOOST_LOG_ATTRIBUTE_KEYWORD_TYPE &#8212; The macro declares an attribute keyword type. </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="expressions.html#header.boost.log.expressions.keyword_hpp" title="Header &lt;boost/log/expressions/keyword.hpp&gt;">boost/log/expressions/keyword.hpp</a>&gt;
  26. </span>BOOST_LOG_ATTRIBUTE_KEYWORD_TYPE(keyword_, name_, value_type_)</pre></div>
  27. <div class="refsect1">
  28. <a name="idm45554743936016"></a><h2>Description</h2>
  29. <p>The macro should be used at a namespace scope. It expands into an attribute keyword type definition, including the <code class="computeroutput">tag</code> namespace and the keyword tag type within which has the following layout:</p>
  30. <pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">tag</span>
  31. <span class="special">{</span>
  32. <span class="keyword">struct</span> <span class="identifier">keyword_</span> <span class="special">:</span>
  33. <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">log</span><span class="special">::</span><span class="identifier">expressions</span><span class="special">::</span><span class="identifier">keyword_descriptor</span>
  34. <span class="special">{</span>
  35. <span class="keyword">typedef</span> <span class="identifier">value_type_</span> <span class="identifier">value_type</span><span class="special">;</span>
  36. <span class="keyword">static</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">log</span><span class="special">::</span><span class="identifier">attribute_name</span> <span class="identifier">get_name</span><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  37. <span class="special">}</span><span class="special">;</span>
  38. <span class="special">}</span>
  39. <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">log</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">tag</span><span class="special">::</span><span class="identifier">keyword_</span> <span class="special">&gt;</span> <span class="identifier">keyword_type</span><span class="special">;</span>
  40. </pre>
  41. <p>The <code class="computeroutput">get_name</code> method returns the attribute name.</p>
  42. <div class="note"><table border="0" summary="Note">
  43. <tr>
  44. <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
  45. <th align="left">Note</th>
  46. </tr>
  47. <tr><td align="left" valign="top"><p>This macro only defines the type of the keyword. To also define the keyword object, use the <code class="computeroutput">BOOST_LOG_ATTRIBUTE_KEYWORD</code> macro instead.</p></td></tr>
  48. </table></div>
  49. <p>
  50. </p>
  51. <div class="variablelist"><table border="0" class="variablelist compact">
  52. <colgroup>
  53. <col align="left" valign="top">
  54. <col>
  55. </colgroup>
  56. <tbody><tr>
  57. <td><p><span class="term">Parameters:</span></p></td>
  58. <td><div class="variablelist"><table border="0" class="variablelist compact">
  59. <colgroup>
  60. <col align="left" valign="top">
  61. <col>
  62. </colgroup>
  63. <tbody>
  64. <tr>
  65. <td><p><span class="term"><code class="computeroutput">keyword_</code></span></p></td>
  66. <td><p>Keyword name </p></td>
  67. </tr>
  68. <tr>
  69. <td><p><span class="term"><code class="computeroutput">name_</code></span></p></td>
  70. <td><p>Attribute name string </p></td>
  71. </tr>
  72. <tr>
  73. <td><p><span class="term"><code class="computeroutput">value_type_</code></span></p></td>
  74. <td><p>Attribute value type </p></td>
  75. </tr>
  76. </tbody>
  77. </table></div></td>
  78. </tr></tbody>
  79. </table></div>
  80. </div>
  81. </div>
  82. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  83. <td align="left"></td>
  84. <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
  85. Distributed under the Boost Software License, Version 1.0. (See accompanying
  86. 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>).
  87. </p>
  88. </div></td>
  89. </tr></table>
  90. <hr>
  91. <div class="spirit-nav">
  92. <a accesskey="p" href="boost/log/expressions/keyword_descriptor.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="expressions.html#header.boost.log.expressions.keyword_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="BOOST_LO_idm45711347575568.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  93. </div>
  94. </body>
  95. </html>