<html>
<head>
<title>BOOST_PP_LOCAL_MACRO</title>
<link rel="stylesheet" type="text/css" href="../styles.css">
</head>
<body>
<div style="margin-left: 0px;">
The <b>BOOST_PP_LOCAL_MACRO</b> macro is a user-defined <i>named external argument</i> used by <b>BOOST_PP_LOCAL_ITERATE</b>.
</div>
<h4>Usage</h4>
<div class="code">
#define <b>BOOST_PP_LOCAL_MACRO</b>(<i>n</i>) ...
</div>
<h4>Arguments</h4>
<dl>
<dt>n</dt>
<dd>
The current iteration value received from the <i>local-iteration</i> mechanism.
</dd>
</dl>
<h4>Remarks</h4>
<div>
This macro is automatically undefined for reuse by a call to <b>BOOST_PP_LOCAL_ITERATE</b>.
</div>
<h4>See Also</h4>
<ul>
<li><a href="local_iterate.html">BOOST_PP_LOCAL_ITERATE</a></li>
</ul>
<h4>Sample Code</h4>
<div><pre>
#include <<a href="../headers/iteration/local.hpp.html">boost/preprocessor/iteration/local.hpp</a>>
template<int> struct sample;
#define <a href="local_macro.html">BOOST_PP_LOCAL_MACRO</a>(n) \
template<> struct sample<n> { \
enum { value = n }; \
}; \
/**/
#define <a href="local_limits.html">BOOST_PP_LOCAL_LIMITS</a> (1, 5)
#include <a href="local_iterate.html">BOOST_PP_LOCAL_ITERATE</a>()
/* expands to...
template<> struct sample<1> { enum { value = 1 }; };
template<> struct sample<2> { enum { value = 2 }; };
template<> struct sample<3> { enum { value = 3 }; };
template<> struct sample<4> { enum { value = 4 }; };
template<> struct sample<5> { enum { value = 5 }; };
*/
</pre></div>
</body>
</html>
