iteration_params_x.html 2.9 KB

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