ceph/src/boost/libs/preprocessor/doc/ref/relative_finish.html

   1 <html>
   2 <head>
   3         <title>BOOST_PP_RELATIVE_FINISH</title>
   4         <link rel="stylesheet" type="text/css" href="../styles.css">
   5
   6 </head>
   7 <body>
   8         <div style="margin-left:  0px;">
   9                 The <b>BOOST_PP_RELATIVE_FINISH</b> macro expands to the upper bound of a <i>file-iteration</i> depth relative to the current depth.
  10         </div>
  11         <h4>Usage</h4>
  12                 <div class="code">
  13                         <b>BOOST_PP_RELATIVE_FINISH</b>(<i>i</i>)
  14                 </div>
  15         <h4>Arguments</h4>
  16                 <dl>
  17                         <dt>i</dt>
  18                         <dd>
  19                                 The relative depth of the frame whose upper bound is to be retreived.&nbsp;
  20                                 Valid values range from <i>0</i> to <b>BOOST_PP_ITERATION_DEPTH</b>() - <i>1</i>.
  21                         </dd>
  22                 </dl>
  23         <h4>Remarks</h4>
  24                 <div>
  25                         This macro is only valid when a <i>file-iteration</i> is in progress.
  26                 </div>
  27                 <div>
  28                         The argument <i>i</i> is interpreted as the number of frames <i>outward</i> from the current frame.
  29                 </div>
  30         <h4>Requirements</h4>
  31                 <div>
  32                         <b>Header:</b> &nbsp;<a href="../headers/iteration/iterate.html">&lt;boost/preprocessor/iteration/iterate.hpp&gt;</a>
  33                 </div>
  34         <hr size="1">
  35         <div style="margin-left: 0px;">
  36                 <i>© Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
  37                 </br><i>© Copyright Paul Mensonides 2002</i>
  38         </div>
  39         <div style="margin-left: 0px;">
  40                 <p><small>Distributed under the Boost Software License, Version 1.0. (See
  41                 accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
  42                 copy at <a href=
  43                 "http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
  44         </div>
  45 </body>
  46 </html>