| <html> |
| <head> |
| <title>BOOST_PP_ARRAY_INSERT</title> |
| <link rel="stylesheet" type="text/css" href="../styles.css"> |
| </head> |
| <body> |
| <div style="margin-left: 0px;"> |
| The <b>BOOST_PP_ARRAY_INSERT</b> macro inserts an element into an <i>array</i>. |
| </div> |
| <h4>Usage</h4> |
| <div class="code"> |
| <b>BOOST_PP_ARRAY_INSERT</b>(<i>array</i>, <i>i</i>, <i>elem</i>) |
| </div> |
| <h4>Arguments</h4> |
| <dl> |
| <dt>array</dt> |
| <dd> |
| The <i>array</i> into which an element is to be inserted. |
| </dd> |
| <dt>i</dt> |
| <dd> |
| The zero-based position in <i>array</i> where an element is to be inserted. |
| Valid values range from <i>0</i> to <b>BOOST_PP_ARRAY_SIZE</b>(<i>array</i>). |
| </dd> |
| <dt>elem</dt> |
| <dd> |
| The element to insert. |
| </dd> |
| </dl> |
| <h4>Remarks</h4> |
| <div> |
| This macro inserts <i>elem</i> before the element at index <i>i</i>. |
| </div> |
| <div> |
| If the operation attempts to create an <i>array</i> that is larger than <b>BOOST_PP_LIMIT_TUPLE</b>, |
| the result is undefined. |
| </div> |
| <div> |
| This macro uses <b>BOOST_PP_WHILE</b> interally. |
| Therefore, to use the <i>d</i> parameter passed from other macros that use <b>BOOST_PP_WHILE</b>, |
| see <b>BOOST_PP_ARRAY_INSERT_D</b>. |
| </div> |
| <h4>See Also</h4> |
| <ul> |
| <li><a href="array_insert_d.html">BOOST_PP_ARRAY_INSERT_D</a></li> |
| </ul> |
| <h4>Requirements</h4> |
| <div> |
| <b>Header:</b> <a href="../headers/array/insert.html"><boost/preprocessor/array/insert.hpp></a> |
| </div> |
| <h4>Sample Code</h4> |
| <div><pre> |
| #include <<a href="../headers/array/insert.html">boost/preprocessor/array/insert.hpp</a>> |
| |
| #define ARRAY (3, (a, b, d)) |
| |
| <a href="array_insert.html">BOOST_PP_ARRAY_INSERT</a>(ARRAY, 2, c) // expands to (4, (a, b, c, d)) |
| </pre></div> |
| <hr size="1"> |
| <div style="margin-left: 0px;"> |
| <i>© Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i> |
| </br><i>© Copyright Paul Mensonides 2002</i> |
| </div> |
| <div style="margin-left: 0px;"> |
| <p><small>Distributed under the Boost Software License, Version 1.0. (See |
| accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or |
| copy at <a href= |
| "http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p> |
| </div> |
| </body> |
| </html> |
