• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3	<title>BOOST_PP_ARRAY_REMOVE</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_ARRAY_REMOVE</b> macro removes an element from an <i>array</i>.
9	</div>
10	<h4>Usage</h4>
11		<div class="code">
12			<b>BOOST_PP_ARRAY_REMOVE</b>(<i>array</i>, <i>i</i>)
13		</div>
14	<h4>Arguments</h4>
15		<dl>
16			<dt>array</dt>
17			<dd>
18				The <i>array</i> from which an element is to be removed.
19			</dd>
20			<dt>i</dt>
21			<dd>
22				The zero-based position in <i>array</i> of the element to be removed.&nbsp;
23				Valid values range from <i>0</i> to <b>BOOST_PP_ARRAY_SIZE</b>(<i>array</i>) - <i>1</i>.
24			</dd>
25		</dl>
26	<h4>Remarks</h4>
27		<div>
28			This macro uses <b>BOOST_PP_WHILE</b> interally.&nbsp;
29			Therefore, to use the <i>d</i> parameter passed from other macros that use <b>BOOST_PP_WHILE</b>,
30			see <b>BOOST_PP_ARRAY_REMOVE_D</b>.
31		</div>
32	<h4>See Also</h4>
33		<ul>
34			<li><a href="array_remove_d.html">BOOST_PP_ARRAY_REMOVE_D</a></li>
35		</ul>
36	<h4>Requirements</h4>
37		<div>
38			<b>Header:</b> &nbsp;<a href="../headers/array/remove.html">&lt;boost/preprocessor/array/remove.hpp&gt;</a>
39		</div>
40	<h4>Sample Code</h4>
41<div><pre>
42#include &lt;<a href="../headers/array/remove.html">boost/preprocessor/array/remove.hpp</a>&gt;
43
44#define ARRAY (3, (a, b, d))
45
46<a href="array_remove.html">BOOST_PP_ARRAY_REMOVE</a>(ARRAY, 2) // expands to (2, (a, b))
47</pre></div>
48	<hr size="1">
49	<div style="margin-left: 0px;">
50		<i>� Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
51		</br><i>� Copyright Paul Mensonides 2002</i>
52	</div>
53	<div style="margin-left: 0px;">
54		<p><small>Distributed under the Boost Software License, Version 1.0. (See
55		accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
56		copy at <a href=
57		"http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
58	</div>
59</body>
60</html>
61