base

SDK/version_3/libs/neon-0.29.5/doc/man/ne_buffer.3

@@ -0,0 +1,76 @@
+'\" t
+.\"     Title: ne_buffer
+.\"    Author: 
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\"      Date: 14 October 2010
+.\"    Manual: neon API reference
+.\"    Source: neon 0.29.5
+.\"  Language: English
+.\"
+.TH "NE_BUFFER" "3" "14 October 2010" "neon 0.29.5" "neon API reference"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+ne_buffer \- string buffer handling
+.SH "SYNOPSIS"
+.sp
+.ft B
+.nf
+#include <ne_string\&.h>
+
+typedef struct {
+    char *data;
+    size_t used;
+    size_t length;
+} ne_buffer;
+.fi
+.ft
+.SH "DESCRIPTION"
+.PP
+The
+\fBne_buffer\fR
+type represents an expandable memory buffer for holding
+NUL\-terminated strings\&. The
+\fIdata\fR
+field points to the beginnning of the string, the length of which is given by the
+\fIused\fR
+field\&. The current size of memory allocated is given by the
+\fIlength\fR
+field\&. It is not recommended that the fields of a buffer are manipulated directly\&. The
+\fIdata\fR
+pointer may change when the buffer is modified\&.
+.PP
+A buffer is created using
+ne_buffer_create
+or
+ne_buffer_ncreate, and destroyed using
+ne_buffer_destroy
+or
+ne_buffer_finish\&. The functions
+ne_buffer_append,
+ne_buffer_zappend
+and
+ne_buffer_concat
+are used to append data to a buffer\&.
+.PP
+If the string referenced by the
+\fIdata\fR
+pointer is modified directly (rather than using one of the functions listed above),
+\fBne_buffer_altered\fR
+must be called\&.
+.SH "AUTHOR"
+.PP
+\fBJoe Orton\fR <\&neon@lists.manyfish.co.uk\&>
+.RS 4
+Author.
+.RE
+.SH "COPYRIGHT"
+.br