1<html> 2<head> 3 <title>BOOST_PP_ITERATION_PARAMS_x</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_ITERATION_PARAMS_<i>x</i></b> macro is a user-defined <i>named external argument</i> used by <b>BOOST_PP_ITERATE</b>. 10 It denotes the lower bound, upper bound, and the filename of a <i>file-iteration</i>. It can optionally denote flags associated with a <i>file-iteration</i> as well. 11 </div> 12 <h4>Usage</h4> 13 <div class="code"> 14 #define <b>BOOST_PP_ITERATION_PARAMS_<i>x</i></b> (<i>c</i>, (<i>start</i>, <i>finish</i>, <i>filename</i> [, <i>flags</i>])) 15 </div> 16 <h4>Arguments</h4> 17 <dl> 18 <dt>x</dt> 19 <dd> 20 The iteration depth of the next <i>file-iteration</i>. 21 This value <i>must</i> be the current iteration depth + <i>1</i>. 22 </dd> 23 <dt>c</dt> 24 <dd> 25 The number of parameters. 26 If <i>flags</i> is specified, this value must be <i>4</i>. 27 Otherwise, it must be <i>3</i>. 28 </dd> 29 <dt>start</dt> 30 <dd> 31 The lower bound (inclusive) of a <i>file-iteration</i>. 32 Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_ITERATION</b>. 33 </dd> 34 <dt>finish</dt> 35 <dd> 36 The upper bound (inclusive) of a <i>file-iteration</i>. 37 Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_ITERATION</b>. 38 </dd> 39 <dt>filename</dt> 40 <dd> 41 A quoted or angle-bracketed filename to used as the target of a <i>file-iteration</i>. 42 </dd> 43 <dt>[flags]</dt> 44 <dd> 45 The flags associated with this <i>file-iteration</i> used to discriminate between different <i>file-iterations</i> in the same file. 46 </dd> 47 </dl> 48 <h4>Remarks</h4> 49 <div> 50 Note that there is a whitespace character after the macro identifier. 51 </div> 52 <div> 53 This macro is must be defined as an <i>array</i> of arguments in one of the two formats above (with or without <i>flags</i>). 54 It is the primary method of passing arguments to <b>BOOST_PP_ITERATE</b>. 55 Both <i>start</i> and <i>finish</i> are <i>evaluated parameters</i>, which implies that simple arithmetic can be used. 56 </div> 57 <div> 58 This macro is automatically undefined for reuse by a call to <b>BOOST_PP_ITERATE</b>. 59 </div> 60 <h4>See Also</h4> 61 <ul> 62 <li><a href="iterate.html">BOOST_PP_ITERATE</a></li> 63 <li><a href="limit_iteration.html">BOOST_PP_LIMIT_ITERATION</a></li> 64 </ul> 65 <hr size="1"> 66 <div style="margin-left: 0px;"> 67 <i>� Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i> 68 </br><i>� Copyright Paul Mensonides 2002</i> 69 </div> 70 <div style="margin-left: 0px;"> 71 <p><small>Distributed under the Boost Software License, Version 1.0. (See 72 accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or 73 copy at <a href= 74 "http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p> 75 </div> 76</body> 77</html> 78