• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3	<title>BOOST_PP_ENUM_PARAMS</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_ENUM_PARAMS</b> macro generates a comma-separated list of parameters.
9	</div>
10	<h4>Usage</h4>
11		<div class="code">
12			<b>BOOST_PP_ENUM_PARAMS</b>(<i>count</i>, <i>param</i>)
13		</div>
14	<h4>Arguments</h4>
15		<dl>
16			<dt>count</dt>
17			<dd>
18				The number of parameters to generate.&nbsp;
19				Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_REPEAT</b>.
20			</dd>
21			<dt>param</dt>
22			<dd>
23				The text of the parameter.&nbsp;
24				<b>BOOST_PP_ENUM_PARAMS</b> concatenates numbers ranging from <i>0</i> to <i>count</i> - <i>1</i>
25				to generate parameters.
26			</dd>
27		</dl>
28	<h4>Remarks</h4>
29		<div>
30			This macro expands to the comma-separated sequence:
31			<div>
32				<i>param</i> ## <i>0</i>, <i>param</i> ## <i>1</i>, ... <i>param</i> ## <i>count</i> - <i>1</i>
33			</div>
34		</div>
35		<div>
36			To use the <i>z</i> parameter passed from other macros that use <b>BOOST_PP_REPEAT</b>, see <b>BOOST_PP_ENUM_PARAMS_Z</b>.
37		</div>
38		<div>
39			Previously, this macro could not be used recursively inside <b>BOOST_PP_REPEAT</b>.&nbsp;
40			This limitation no longer exists, as the library can automatically detect the next available repetition depth.
41		</div>
42	<h4>See Also</h4>
43		<ul>
44			<li><a href="enum_params_z.html">BOOST_PP_ENUM_PARAMS_Z</a></li>
45			<li><a href="limit_repeat.html">BOOST_PP_LIMIT_REPEAT</a></li>
46		</ul>
47	<h4>Requirements</h4>
48		<div>
49			<b>Header:</b> &nbsp;<a href="../headers/repetition/enum_params.html">&lt;boost/preprocessor/repetition/enum_params.hpp&gt;</a>
50		</div>
51	<h4>Sample Code</h4>
52<div><pre>
53#include &lt;<a href="../headers/repetition/enum_params.html">boost/preprocessor/repetition/enum_params.hpp</a>&gt;
54
55<a href="enum_params.html">BOOST_PP_ENUM_PARAMS</a>(3, class T) // expands to class T0, class T1, class T2
56</pre></div>
57	<hr size="1">
58	<div style="margin-left: 0px;">
59		<i>� Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
60		</br><i>� Copyright Paul Mensonides 2002</i>
61	</div>
62	<div style="margin-left: 0px;">
63		<p><small>Distributed under the Boost Software License, Version 1.0. (See
64		accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
65		copy at <a href=
66		"http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
67	</div>
68</body>
69</html>
70