diff options
Diffstat (limited to 'docs/html/raptor2-section-stringbuffer.html')
| -rw-r--r-- | docs/html/raptor2-section-stringbuffer.html | 701 |
1 files changed, 701 insertions, 0 deletions
diff --git a/docs/html/raptor2-section-stringbuffer.html b/docs/html/raptor2-section-stringbuffer.html new file mode 100644 index 0000000..9d142ca --- /dev/null +++ b/docs/html/raptor2-section-stringbuffer.html @@ -0,0 +1,701 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>section-stringbuffer: Raptor RDF Syntax Library Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<link rel="home" href="index.html" title="Raptor RDF Syntax Library Manual"> +<link rel="up" href="reference-manual.html" title="Part II. Raptor Reference Manual"> +<link rel="prev" href="raptor2-section-serializer.html" title="section-serializer"> +<link rel="next" href="raptor2-section-triples.html" title="section-triples"> +<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#raptor2-section-stringbuffer.description" class="shortcut">Description</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="reference-manual.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="raptor2-section-serializer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="raptor2-section-triples.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="raptor2-section-stringbuffer"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="raptor2-section-stringbuffer.top_of_page"></a>section-stringbuffer</span></h2> +<p>section-stringbuffer</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="raptor2-section-stringbuffer.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_proto_type"> +<col class="functions_proto_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer" title="raptor_stringbuffer"><span class="returnvalue">raptor_stringbuffer</span></a> * +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-stringbuffer.html#raptor-new-stringbuffer" title="raptor_new_stringbuffer ()">raptor_new_stringbuffer</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-stringbuffer.html#raptor-free-stringbuffer" title="raptor_free_stringbuffer ()">raptor_free_stringbuffer</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer-append-counted-string" title="raptor_stringbuffer_append_counted_string ()">raptor_stringbuffer_append_counted_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer-append-decimal" title="raptor_stringbuffer_append_decimal ()">raptor_stringbuffer_append_decimal</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer-append-hexadecimal" title="raptor_stringbuffer_append_hexadecimal ()">raptor_stringbuffer_append_hexadecimal</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer-append-string" title="raptor_stringbuffer_append_string ()">raptor_stringbuffer_append_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer-append-stringbuffer" title="raptor_stringbuffer_append_stringbuffer ()">raptor_stringbuffer_append_stringbuffer</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer-append-uri-escaped-counted-string" title="raptor_stringbuffer_append_uri_escaped_counted_string ()">raptor_stringbuffer_append_uri_escaped_counted_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer-prepend-counted-string" title="raptor_stringbuffer_prepend_counted_string ()">raptor_stringbuffer_prepend_counted_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer-prepend-string" title="raptor_stringbuffer_prepend_string ()">raptor_stringbuffer_prepend_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">unsigned <span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer-as-string" title="raptor_stringbuffer_as_string ()">raptor_stringbuffer_as_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">size_t</span> +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer-length" title="raptor_stringbuffer_length ()">raptor_stringbuffer_length</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer-copy-to-string" title="raptor_stringbuffer_copy_to_string ()">raptor_stringbuffer_copy_to_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer-write" title="raptor_stringbuffer_write ()">raptor_stringbuffer_write</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="raptor2-section-stringbuffer.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="other_proto_type"> +<col class="other_proto_name"> +</colgroup> +<tbody><tr> +<td class="typedef_keyword">typedef</td> +<td class="function_name"><a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer" title="raptor_stringbuffer">raptor_stringbuffer</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="raptor2-section-stringbuffer.description"></a><h2>Description</h2> +</div> +<div class="refsect1"> +<a name="raptor2-section-stringbuffer.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="raptor-new-stringbuffer"></a><h3>raptor_new_stringbuffer ()</h3> +<pre class="programlisting"><a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer" title="raptor_stringbuffer"><span class="returnvalue">raptor_stringbuffer</span></a> * +raptor_new_stringbuffer (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p>Create a new stringbuffer.</p> +<div class="refsect3"> +<a name="raptor-new-stringbuffer.returns"></a><h4>Returns</h4> +<p> pointer to a raptor_stringbuffer object or NULL on failure</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-free-stringbuffer"></a><h3>raptor_free_stringbuffer ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +raptor_free_stringbuffer (<em class="parameter"><code><a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer" title="raptor_stringbuffer"><span class="type">raptor_stringbuffer</span></a> *stringbuffer</code></em>);</pre> +<p>Destroy a stringbuffer.</p> +<div class="refsect3"> +<a name="raptor-free-stringbuffer.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>stringbuffer</p></td> +<td class="parameter_description"><p>stringbuffer object to destroy.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-stringbuffer-append-counted-string"></a><h3>raptor_stringbuffer_append_counted_string ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +raptor_stringbuffer_append_counted_string + (<em class="parameter"><code><a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer" title="raptor_stringbuffer"><span class="type">raptor_stringbuffer</span></a> *stringbuffer</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *string</code></em>, + <em class="parameter"><code><span class="type">size_t</span> length</code></em>, + <em class="parameter"><code><span class="type">int</span> do_copy</code></em>);</pre> +<p>Add a counted string to the stringbuffer.</p> +<p>If <em class="parameter"><code>string</code></em> + is NULL or <em class="parameter"><code>length</code></em> + is 0, no work is performed.</p> +<p>If <em class="parameter"><code>do_copy</code></em> + is non-0, the passed-in string is copied into new memory +otherwise the stringbuffer becomes the owner of the string pointer +and will free it when the stringbuffer is destroyed.</p> +<div class="refsect3"> +<a name="raptor-stringbuffer-append-counted-string.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>stringbuffer</p></td> +<td class="parameter_description"><p>raptor stringbuffer</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>string</p></td> +<td class="parameter_description"><p>string</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>length</p></td> +<td class="parameter_description"><p>length of string</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>do_copy</p></td> +<td class="parameter_description"><p>non-0 to copy the string</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-stringbuffer-append-counted-string.returns"></a><h4>Returns</h4> +<p> non-0 on failure</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-stringbuffer-append-decimal"></a><h3>raptor_stringbuffer_append_decimal ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +raptor_stringbuffer_append_decimal (<em class="parameter"><code><a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer" title="raptor_stringbuffer"><span class="type">raptor_stringbuffer</span></a> *stringbuffer</code></em>, + <em class="parameter"><code><span class="type">int</span> integer</code></em>);</pre> +<p>Add an integer in decimal to the stringbuffer.</p> +<div class="refsect3"> +<a name="raptor-stringbuffer-append-decimal.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>stringbuffer</p></td> +<td class="parameter_description"><p>raptor stringbuffer</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>integer</p></td> +<td class="parameter_description"><p>integer to format as decimal and add</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-stringbuffer-append-decimal.returns"></a><h4>Returns</h4> +<p> non-0 on failure</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-stringbuffer-append-hexadecimal"></a><h3>raptor_stringbuffer_append_hexadecimal ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +raptor_stringbuffer_append_hexadecimal + (<em class="parameter"><code><a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer" title="raptor_stringbuffer"><span class="type">raptor_stringbuffer</span></a> *stringbuffer</code></em>, + <em class="parameter"><code><span class="type">int</span> hex</code></em>);</pre> +<p>Add an integer formatted in hexdecimal (base 16) to the stringbuffer.</p> +<div class="refsect3"> +<a name="raptor-stringbuffer-append-hexadecimal.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>stringbuffer</p></td> +<td class="parameter_description"><p>raptor stringbuffer</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>hex</p></td> +<td class="parameter_description"><p>integer to format</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-stringbuffer-append-hexadecimal.returns"></a><h4>Returns</h4> +<p> non-0 on failure</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-stringbuffer-append-string"></a><h3>raptor_stringbuffer_append_string ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +raptor_stringbuffer_append_string (<em class="parameter"><code><a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer" title="raptor_stringbuffer"><span class="type">raptor_stringbuffer</span></a> *stringbuffer</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *string</code></em>, + <em class="parameter"><code><span class="type">int</span> do_copy</code></em>);</pre> +<p>Add a string to the stringbuffer.</p> +<p>If <em class="parameter"><code>string</code></em> + is NULL, no work is performed.</p> +<p>If <em class="parameter"><code>do_copy</code></em> + is non-0, the passed-in string is copied into new memory +otherwise the stringbuffer becomes the owner of the string pointer +and will free it when the stringbuffer is destroyed.</p> +<div class="refsect3"> +<a name="raptor-stringbuffer-append-string.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>stringbuffer</p></td> +<td class="parameter_description"><p>raptor stringbuffer</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>string</p></td> +<td class="parameter_description"><p>string</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>do_copy</p></td> +<td class="parameter_description"><p>non-0 to copy the string</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-stringbuffer-append-string.returns"></a><h4>Returns</h4> +<p> non-0 on failure</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-stringbuffer-append-stringbuffer"></a><h3>raptor_stringbuffer_append_stringbuffer ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +raptor_stringbuffer_append_stringbuffer + (<em class="parameter"><code><a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer" title="raptor_stringbuffer"><span class="type">raptor_stringbuffer</span></a> *stringbuffer</code></em>, + <em class="parameter"><code><a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer" title="raptor_stringbuffer"><span class="type">raptor_stringbuffer</span></a> *append</code></em>);</pre> +<p>Add a stringbuffer to the stringbuffer.</p> +<p>This function removes the content from the appending stringbuffer, +making it empty and appends it to the supplied stringbuffer.</p> +<div class="refsect3"> +<a name="raptor-stringbuffer-append-stringbuffer.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>stringbuffer</p></td> +<td class="parameter_description"><p><a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer" title="raptor_stringbuffer"><span class="type">raptor_stringbuffer</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>append</p></td> +<td class="parameter_description"><p><a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer" title="raptor_stringbuffer"><span class="type">raptor_stringbuffer</span></a> to append</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-stringbuffer-append-stringbuffer.returns"></a><h4>Returns</h4> +<p> non-0 on failure</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-stringbuffer-append-uri-escaped-counted-string"></a><h3>raptor_stringbuffer_append_uri_escaped_counted_string ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +raptor_stringbuffer_append_uri_escaped_counted_string + (<em class="parameter"><code><a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer" title="raptor_stringbuffer"><span class="type">raptor_stringbuffer</span></a> *sb</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *string</code></em>, + <em class="parameter"><code><span class="type">size_t</span> length</code></em>, + <em class="parameter"><code><span class="type">int</span> space_is_plus</code></em>);</pre> +<p>Add a URI-escaped version of <em class="parameter"><code>string</code></em> + to the stringbuffer.</p> +<p>If <em class="parameter"><code>string</code></em> + is NULL or <em class="parameter"><code>length</code></em> + is 0, no work is performed.</p> +<div class="refsect3"> +<a name="raptor-stringbuffer-append-uri-escaped-counted-string.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>sb</p></td> +<td class="parameter_description"><p>raptor stringbuffer</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>string</p></td> +<td class="parameter_description"><p>string</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>length</p></td> +<td class="parameter_description"><p>length of string</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>space_is_plus</p></td> +<td class="parameter_description"><p>if non-0, escape spaces as '+' otherwise percent-encode them</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-stringbuffer-append-uri-escaped-counted-string.returns"></a><h4>Returns</h4> +<p> non-0 on failure</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-stringbuffer-prepend-counted-string"></a><h3>raptor_stringbuffer_prepend_counted_string ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +raptor_stringbuffer_prepend_counted_string + (<em class="parameter"><code><a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer" title="raptor_stringbuffer"><span class="type">raptor_stringbuffer</span></a> *stringbuffer</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *string</code></em>, + <em class="parameter"><code><span class="type">size_t</span> length</code></em>, + <em class="parameter"><code><span class="type">int</span> do_copy</code></em>);</pre> +<p>If do_copy is non-0, the passed-in string is copied into new memory +otherwise the stringbuffer becomes the owner of the string pointer +and will free it when the stringbuffer is destroyed.</p> +<p>Add a string to the start of the stringbuffer.</p> +<div class="refsect3"> +<a name="raptor-stringbuffer-prepend-counted-string.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>stringbuffer</p></td> +<td class="parameter_description"><p>raptor stringbuffer</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>string</p></td> +<td class="parameter_description"><p>string</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>length</p></td> +<td class="parameter_description"><p>length of string</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>do_copy</p></td> +<td class="parameter_description"><p>non-0 to copy the string</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-stringbuffer-prepend-counted-string.returns"></a><h4>Returns</h4> +<p> non-0 on failure</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-stringbuffer-prepend-string"></a><h3>raptor_stringbuffer_prepend_string ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +raptor_stringbuffer_prepend_string (<em class="parameter"><code><a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer" title="raptor_stringbuffer"><span class="type">raptor_stringbuffer</span></a> *stringbuffer</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *string</code></em>, + <em class="parameter"><code><span class="type">int</span> do_copy</code></em>);</pre> +<p>Add a string to the start of the stringbuffer.</p> +<p>If do_copy is non-0, the passed-in string is copied into new memory +otherwise the stringbuffer becomes the owner of the string pointer +and will free it when the stringbuffer is destroyed.</p> +<div class="refsect3"> +<a name="raptor-stringbuffer-prepend-string.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>stringbuffer</p></td> +<td class="parameter_description"><p>raptor stringbuffer</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>string</p></td> +<td class="parameter_description"><p>string</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>do_copy</p></td> +<td class="parameter_description"><p>non-0 to copy the string</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-stringbuffer-prepend-string.returns"></a><h4>Returns</h4> +<p> non-0 on failure</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-stringbuffer-as-string"></a><h3>raptor_stringbuffer_as_string ()</h3> +<pre class="programlisting">unsigned <span class="returnvalue">char</span> * +raptor_stringbuffer_as_string (<em class="parameter"><code><a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer" title="raptor_stringbuffer"><span class="type">raptor_stringbuffer</span></a> *stringbuffer</code></em>);</pre> +<p>Return the stringbuffer as a C string.</p> +<p>Note: the return value is a to a shared string that the stringbuffer +allocates and manages.</p> +<div class="refsect3"> +<a name="raptor-stringbuffer-as-string.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>stringbuffer</p></td> +<td class="parameter_description"><p>raptor stringbuffer</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-stringbuffer-as-string.returns"></a><h4>Returns</h4> +<p> NULL on failure or stringbuffer is empty, otherwise +a pointer to a shared copy of the string.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-stringbuffer-length"></a><h3>raptor_stringbuffer_length ()</h3> +<pre class="programlisting"><span class="returnvalue">size_t</span> +raptor_stringbuffer_length (<em class="parameter"><code><a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer" title="raptor_stringbuffer"><span class="type">raptor_stringbuffer</span></a> *stringbuffer</code></em>);</pre> +<p>Return the stringbuffer length.</p> +<div class="refsect3"> +<a name="raptor-stringbuffer-length.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>stringbuffer</p></td> +<td class="parameter_description"><p>raptor stringbuffer</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-stringbuffer-length.returns"></a><h4>Returns</h4> +<p> size of stringbuffer</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-stringbuffer-copy-to-string"></a><h3>raptor_stringbuffer_copy_to_string ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +raptor_stringbuffer_copy_to_string (<em class="parameter"><code><a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer" title="raptor_stringbuffer"><span class="type">raptor_stringbuffer</span></a> *stringbuffer</code></em>, + <em class="parameter"><code>unsigned <span class="type">char</span> *string</code></em>, + <em class="parameter"><code><span class="type">size_t</span> length</code></em>);</pre> +<p>Copy the stringbuffer into a string.</p> +<p>Copies the underlying string to a pre-allocated buffer. The +output string is always '\0' terminated.</p> +<div class="refsect3"> +<a name="raptor-stringbuffer-copy-to-string.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>stringbuffer</p></td> +<td class="parameter_description"><p>raptor stringbuffer</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>string</p></td> +<td class="parameter_description"><p>output string</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>length</p></td> +<td class="parameter_description"><p>size of output string</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-stringbuffer-copy-to-string.returns"></a><h4>Returns</h4> +<p> non-0 on failure such as stringbuffer is empty, buffer is too small</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-stringbuffer-write"></a><h3>raptor_stringbuffer_write ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +raptor_stringbuffer_write (<em class="parameter"><code><a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer" title="raptor_stringbuffer"><span class="type">raptor_stringbuffer</span></a> *sb</code></em>, + <em class="parameter"><code><a class="link" href="raptor2-section-iostream.html#raptor-iostream" title="raptor_iostream"><span class="type">raptor_iostream</span></a> *iostr</code></em>);</pre> +<p>Write a stringbuffer to an iostream.</p> +<div class="refsect3"> +<a name="raptor-stringbuffer-write.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>sb</p></td> +<td class="parameter_description"><p><a class="link" href="raptor2-section-stringbuffer.html#raptor-stringbuffer" title="raptor_stringbuffer"><span class="type">raptor_stringbuffer</span></a> to write</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>iostr</p></td> +<td class="parameter_description"><p>raptor iostream</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-stringbuffer-write.returns"></a><h4>Returns</h4> +<p> non-0 on failure</p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="raptor2-section-stringbuffer.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="raptor-stringbuffer"></a><h3>raptor_stringbuffer</h3> +<pre class="programlisting">raptor_stringbuffer* raptor_stringbuffer; +</pre> +<p>Raptor string buffer class</p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.33.1</div> +</body> +</html>
\ No newline at end of file |