libs/preprocessor/doc/ref/array_pop_front.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

<html>
  <head>
    <meta content="text/html; charset=windows-1252" http-equiv="content-type">
    <title>BOOST_PP_ARRAY_POP_FRONT</title>
    <link rel="stylesheet" type="text/css" href="../styles.css">
  </head>
  <body>
    <div style="margin-left:  0px;"> The <b>BOOST_PP_ARRAY_POP_FRONT</b> macro
      pops an element from the beginning of an <i>array</i>.</div>
    <h4>Usage</h4>
    <div class="code"> <b>BOOST_PP_ARRAY_POP_FRONT</b>(<i>array</i>) </div>
    <h4>Arguments</h4>
    <dl>
      <dt>array</dt>
      <dd> The <i>array</i> to pop an element from. </dd>
    </dl>
    <h4>Remarks</h4>
    <div> This macro returns <i>array</i> after removing the first
      element.&nbsp; If <i>array</i> has no elements, the result of applying
      this macro is undefined. </div>
    <div> This macro uses <b>BOOST_PP_REPEAT</b> internally.&nbsp; Therefore,
      to use the <i>z</i> parameter passed from other macros that use <b>BOOST_PP_REPEAT</b>,
      see <b>BOOST_PP_ARRAY_POP_FRONT_Z</b> </div>
    <h4>See Also</h4>
    <ul>
      <li><a href="array_pop_front_z.html">BOOST_PP_ARRAY_POP_FRONT_Z</a></li>
    </ul>
    <h4>Requirements</h4>
    <div> <b>Header:</b> &nbsp;<a href="../headers/array/pop_front.html">&lt;boost/preprocessor/array/pop_front.hpp&gt;</a>
    </div>
    <h4>Sample Code</h4>
    <div>
      <pre>#include &lt;<a href="../headers/array/pop_front.html">boost/preprocessor/array/pop_front.hpp</a>&gt;

#define ARRAY (3, (a, b, c))

<a href="array_pop_front.html">BOOST_PP_ARRAY_POP_FRONT</a>(ARRAY) // expands to (2, (b, c))
</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<br>
      </i><i>© Copyright Edward Diener 2013</i><br>
    </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>