libs/vmd/doc/html/BOOST_VMD_GET_TYPE.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Macro BOOST_VMD_GET_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;The Variadic Macro Data Library 1.9">
   8 <link rel="up" href="header/boost/vmd/get_type_hpp.html" title="Header &lt;boost/vmd/get_type.hpp&gt;">
   9 <link rel="prev" href="header/boost/vmd/get_type_hpp.html" title="Header &lt;boost/vmd/get_type.hpp&gt;">
  10 <link rel="next" href="BOOST_VMD_GET_TYPE_D.html" title="Macro BOOST_VMD_GET_TYPE_D">
  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/get_type_hpp.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/vmd/get_type_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_GET_TYPE_D.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="BOOST_VMD_GET_TYPE"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Macro BOOST_VMD_GET_TYPE</span></h2>
  29 <p>BOOST_VMD_GET_TYPE &#8212; Returns the type of a sequence as a VMD type. </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/get_type_hpp.html" title="Header &lt;boost/vmd/get_type.hpp&gt;">boost/vmd/get_type.hpp</a>&gt;
  33
  34 </span>BOOST_VMD_GET_TYPE(...)</pre></div>
  35 <div class="refsect1">
  36 <a name="idm45529680853664"></a><h2>Description</h2>
  37 <p>... = variadic parameters.</p>
  38 <p>The first variadic parameter is required and is the sequence whose type we are getting.</p>
  39 <p>The optional variadic parameters are return type parameters.</p>
  40 <p>The macro returns the type of a sequence as a VMD type. The type of an empty sequence is always BOOST_VMD_TYPE_EMPTY and the type of a multi-element is always BOOST_VMD_TYPE_SEQUENCE. The type of a single-element sequence is the type of that single element.</p>
  41 <p>The type returned can be modified by specifying an optional return type parameter.</p>
  42 <p>If BOOST_VMD_RETURN_TYPE, the default, is specified the specific type of the element is returned.</p>
  43 <p>If BOOST_VMD_RETURN_TYPE_ARRAY is specified an array type is returned if the element is an array, else a tuple type is returned if the element is a tuple, else the actual type is returned for non-tuple data.</p>
  44 <p>If BOOST_VMD_RETURN_TYPE_LIST is specified a list type is returned if the element is a list, else a tuple type is returned if the element is a tuple, else the actual type is returned for non-tuple data.</p>
  45 <p>If BOOST_VMD_RETURN_TYPE_TUPLE is specified a tuple type is returned for all tuple-like data, else the actual type is returned for non-tuple data.</p>
  46 <p>If BOOST_VMD_RETURN_NO_TYPE is specified it is ignored since the macro always returns the type of the sequence.</p>
  47 <p>If more than one return type optional parameter is specified the last one specified determines the return type.</p>
  48 <p>returns = the type of the sequence as a VMD type. </p>
  49 </div>
  50 </div>
  51 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  52 <td align="left"></td>
  53 <td align="right"><div class="copyright-footer">Copyright &#169; 2010-2017 Tropic Software
  54       East Inc</div></td>
  55 </tr></table>
  56 <hr>
  57 <div class="spirit-nav">
  58 <a accesskey="p" href="header/boost/vmd/get_type_hpp.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/vmd/get_type_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_GET_TYPE_D.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  59 </div>
  60 </body>
  61 </html>