Debian Codegraph @

deps/libneon/doc/ref/bufcr.xml

raw
1 <refentry id="refbufcr">
2
3 <refmeta>
4 <refentrytitle>ne_buffer_create</refentrytitle>
5 <manvolnum>3</manvolnum>
6 </refmeta>
7
8 <refnamediv>
9 <refname id="ne_buffer_create">ne_buffer_create</refname>
10 <refname id="ne_buffer_create_sized">ne_buffer_ncreate</refname>
11 <refpurpose>create a string buffer</refpurpose>
12 </refnamediv>
13
14 <refsynopsisdiv>
15
16 <funcsynopsis>
17
18 <funcsynopsisinfo>#include &lt;ne_alloc.h&gt;</funcsynopsisinfo>
19
20 <funcprototype>
21 <funcdef>ne_buffer *<function>ne_buffer_create</function></funcdef>
22 <void/>
23 </funcprototype>
24
25 <funcprototype>
26 <funcdef>ne_buffer *<function>ne_buffer_ncreate</function></funcdef>
27 <paramdef>size_t <parameter>size</parameter></paramdef>
28 </funcprototype>
29
30 </funcsynopsis>
31
32 </refsynopsisdiv>
33
34 <refsect1>
35 <title>Description</title>
36
37 <para><function>ne_buffer_create</function> creates a new
38 buffer object, with an implementation-defined initial size.
39 <function>ne_buffer_ncreate</function> creates an
40 <type>ne_buffer</type> where the minimum initial size is given in the
41 <parameter>size</parameter> parameter. The buffer created will
42 contain the empty string (<literal>""</literal>).</para>
43
44 </refsect1>
45
46 <refsect1>
47 <title>Return value</title>
48
49 <para>Both functions return a pointer to a new buffer object,
50 and never &null;.</para>
51
52 </refsect1>
53
54 <refsect1>
55 <title>See also</title>
56
57 <para><xref linkend="ne_buffer"/></para>
58 </refsect1>
59
60 </refentry>