libs/vmd/doc/html/BOOST_VMD_IDENTITY.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Macro BOOST_VMD_IDENTITY</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;The Variadic Macro Data Library 1.9">
   8 <link rel="up" href="header/boost/vmd/identity_hpp.html" title="Header &lt;boost/vmd/identity.hpp&gt;">
   9 <link rel="prev" href="header/boost/vmd/identity_hpp.html" title="Header &lt;boost/vmd/identity.hpp&gt;">
  10 <link rel="next" href="BOOST_VMD_IDENTITY_RESULT.html" title="Macro BOOST_VMD_IDENTITY_RESULT">
  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="header/boost/vmd/identity_hpp.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/vmd/identity_hpp.html"><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_VMD_IDENTITY_RESULT.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="BOOST_VMD_IDENTITY"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Macro BOOST_VMD_IDENTITY</span></h2>
  29 <p>BOOST_VMD_IDENTITY &#8212; Macro which expands to its argument when invoked with any number of parameters. </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="header/boost/vmd/identity_hpp.html" title="Header &lt;boost/vmd/identity.hpp&gt;">boost/vmd/identity.hpp</a>&gt;
  33
  34 </span>BOOST_VMD_IDENTITY(item)</pre></div>
  35 <div class="refsect1">
  36 <a name="idp84606080"></a><h2>Description</h2>
  37 <p>item = any single argument</p>
  38 <p>When BOOST_VMD_IDENTITY(item) is subsequently invoked with any number of parameters it expands to 'item'. Subsequently invoking the macro is done as 'BOOST_VMD_IDENTITY(item)(zero_or_more_arguments)'.</p>
  39 <p>The macro is equivalent to the Boost PP macro BOOST_PP_IDENTITY(item) with the difference being that BOOST_PP_IDENTITY(item) is always invoked with no arguments, as in 'BOOST_VMD_IDENTITY(item)()' whereas BOOST_VMD_IDENTITY can be invoked with any number of arguments.</p>
  40 <p>The macro is meant to be used in BOOST_PP_IF and BOOST_PP_IIF statements when only one of the clauses needs to be invoked with calling another macro and the other is meant to return an 'item'.</p>
  41 <p>returns = the macro as 'BOOST_VMD_IDENTITY(item)', when invoked with any number of parameters as in '(zero_or_more_arguments)', returns 'item'. The macro itself returns 'item BOOST_VMD_EMPTY'. </p>
  42 </div>
  43 </div>
  44 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  45 <td align="left"></td>
  46 <td align="right"><div class="copyright-footer">Copyright &#169; 2010-2017 Tropic Software
  47       East Inc</div></td>
  48 </tr></table>
  49 <hr>
  50 <div class="spirit-nav">
  51 <a accesskey="p" href="header/boost/vmd/identity_hpp.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/vmd/identity_hpp.html"><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_VMD_IDENTITY_RESULT.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  52 </div>
  53 </body>
  54 </html>