← Back to branch summary

~svn/ubuntu/oneiric/subversion/ppa

« back to all changes in this revision

Viewing changes to neon/doc/man/ne_buffer_append.3

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2006-12-13 17:57:16 UTC
  • mfrom: (1.1.6 upstream) (0.1.3 etch)
  • Revision ID: james.westby@ubuntu.com-20061213175716-2ysv6z4w5dpa2r2f
Tags: 1.4.2dfsg1-2ubuntu1
* Merge with Debian unstable; remaining changes:
  - Create pot file on build.

Show diffs side-by-side

added added

removed removed

Lines of Context:
neon/doc/man/ne_buffer_append.3
1
 
.\"Generated by db2man.xsl. Don't modify this, modify the source.
2
 
.de Sh \" Subsection
3
 
.br
4
 
.if t .Sp
5
 
.ne 5
6
 
.PP
7
 
\fB\\$1\fR
8
 
.PP
9
 
..
10
 
.de Sp \" Vertical space (when we can't use .PP)
11
 
.if t .sp .5v
12
 
.if n .sp
13
 
..
14
 
.de Ip \" List item
15
 
.br
16
 
.ie \\n(.$>=3 .ne \\$3
17
 
.el .ne 3
18
 
.IP "\\$1" \\$2
19
 
..
20
 
.TH "NE_BUFFER_APPEND" 3 "20 January 2006" "neon 0.25.5" "neon API reference"
21
 
.SH NAME
22
 
ne_buffer_append, ne_buffer_zappend, ne_buffer_concat \- append data to a string buffer
23
 
.SH "SYNOPSIS"
24
 
.ad l
25
 
.hy 0
26
 
 
27
 
#include <ne_string\&.h>
28
 
.sp
29
 
.HP 23
30
 
void\ \fBne_buffer_append\fR\ (ne_buffer\ *\fIbuf\fR, const\ char\ *\fIstring\fR, size_t\ \fIlen\fR);
31
 
.HP 24
32
 
void\ \fBne_buffer_zappend\fR\ (ne_buffer\ *\fIbuf\fR, const\ char\ *\fIstring\fR);
33
 
.HP 23
34
 
void\ \fBne_buffer_concat\fR\ (ne_buffer\ *\fIbuf\fR, const\ char\ *\fIstr\fR, \&.\&.\&.);
35
 
.ad
36
 
.hy
37
 
 
38
 
.SH "DESCRIPTION"
39
 
 
40
 
.PP
41
 
The \fBne_buffer_append\fR and \fBne_buffer_zappend\fR functions append a string to the end of a buffer; extending the buffer as necessary\&. The \fIlen\fR passed to \fBne_buffer_append\fR specifies the length of the string to append; there must be no NUL terminator in the first \fIlen\fR bytes of the string\&. \fBne_buffer_zappend\fR must be passed a NUL\-terminated string\&.
42
 
 
43
 
.PP
44
 
The \fBne_buffer_concat\fR function takes a variable\-length argument list following \fIstr\fR; each argument must be a \fBchar *\fR pointer to a NUL\-terminated string\&. A NULL pointer must be given as the last argument to mark the end of the list\&. The strings (including \fIstr\fR) are appended to the buffer in the order given\&. None of the strings passed to \fBne_buffer_concat\fR are modified\&.
45
 
 
46
 
.SH "EXAMPLES"
47
 
 
48
 
.PP
49
 
The following code will output "Hello, world\&. And goodbye\&."\&.
50
 
 
51
 
.nf
52
 
ne_buffer *buf = ne_buffer_create();
53
 
ne_buffer_zappend(buf, "Hello");
54
 
ne_buffer_concat(buf, ", world\&. ", "And ", "goodbye\&.", NULL);
55
 
puts(buf\->data);
56
 
ne_buffer_destroy(buf);
57
 
.fi
58
 
 
59
 
.SH "SEE ALSO"
60
 
 
61
 
.PP
62
 
\fBne_buffer\fR(3), \fBne_buffer_create\fR(3), \fBne_buffer_destroy\fR(3)
63
 
 
64
 
.SH AUTHOR
65
 
Joe Orton <neon@webdav\&.org>.