]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
1 | <html> |
2 | <head> | |
3 | <meta content="text/html; charset=windows-1252" http-equiv="content-type"> | |
4 | <title>BOOST_PP_ARRAY_POP_FRONT</title> | |
5 | <link rel="stylesheet" type="text/css" href="../styles.css"> | |
6 | </head> | |
7 | <body> | |
8 | <div style="margin-left: 0px;"> The <b>BOOST_PP_ARRAY_POP_FRONT</b> macro | |
9 | pops an element from the beginning of an <i>array</i>.</div> | |
10 | <h4>Usage</h4> | |
11 | <div class="code"> <b>BOOST_PP_ARRAY_POP_FRONT</b>(<i>array</i>) </div> | |
12 | <h4>Arguments</h4> | |
13 | <dl> | |
14 | <dt>array</dt> | |
15 | <dd> The <i>array</i> to pop an element from. </dd> | |
16 | </dl> | |
17 | <h4>Remarks</h4> | |
18 | <div> This macro returns <i>array</i> after removing the first | |
19 | element. If <i>array</i> has no elements, the result of applying | |
20 | this macro is undefined. </div> | |
21 | <div> This macro uses <b>BOOST_PP_REPEAT</b> internally. Therefore, | |
22 | to use the <i>z</i> parameter passed from other macros that use <b>BOOST_PP_REPEAT</b>, | |
23 | see <b>BOOST_PP_ARRAY_POP_FRONT_Z</b> </div> | |
24 | <h4>See Also</h4> | |
25 | <ul> | |
26 | <li><a href="array_pop_front_z.html">BOOST_PP_ARRAY_POP_FRONT_Z</a></li> | |
27 | </ul> | |
28 | <h4>Requirements</h4> | |
29 | <div> <b>Header:</b> <a href="../headers/array/pop_front.html"><boost/preprocessor/array/pop_front.hpp></a> | |
30 | </div> | |
31 | <h4>Sample Code</h4> | |
32 | <div> | |
33 | <pre>#include <<a href="../headers/array/pop_front.html">boost/preprocessor/array/pop_front.hpp</a>> | |
34 | ||
35 | #define ARRAY (3, (a, b, c)) | |
36 | ||
37 | <a href="array_pop_front.html">BOOST_PP_ARRAY_POP_FRONT</a>(ARRAY) // expands to (2, (b, c)) | |
38 | </pre></div> | |
39 | <hr size="1"> | |
40 |