<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Crystal Space 1.2.1: csString Class Reference (Crystal Space 1.2.1 Public API Reference)</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <table border="0" cellpadding="0" cellspacing="0" width="100%" class="head"> <tr height="59"> <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td> <td class="head"><h2>Public API Reference</h2></td> </tr> <tr height="11"> <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td> </tr> </table> <div class="content"> <!-- Generated by Doxygen 1.5.3 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <h1>csString Class Reference</h1><!-- doxytag: class="csString" --><!-- doxytag: inherits="csStringFast" -->Thin wrapper around csStringFast<> with its default buffer size. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="csstring_8h-source.html">csutil/csstring.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for csString:</div> <div class="dynsection"> <p><center><img src="classcsString__inherit__graph.png" border="0" usemap="#csString__inherit__map" alt="Inheritance graph"></center> <map name="csString__inherit__map"> <area shape="rect" href="classcsStringFast.html" title="Subclass of csStringBase that contains an internal buffer which is faster than the..." alt="" coords="5,84,152,111"><area shape="rect" href="classcsStringBase.html" title="This is a string class with a range of useful operators and type-safe overloads." alt="" coords="27,7,131,33"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="classcsString-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#2063954e77d18fd0c2ca95d0fa87b6d1">csString</a> (unsigned char c)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classcsString.html" title="Thin wrapper around csStringFast<> with its default buffer size.">csString</a> object from a single unsigned character. <a href="#2063954e77d18fd0c2ca95d0fa87b6d1"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#612a5248c5600ee111bba3e9c0f1d329">csString</a> (char c)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classcsString.html" title="Thin wrapper around csStringFast<> with its default buffer size.">csString</a> object from a single signed character. <a href="#612a5248c5600ee111bba3e9c0f1d329"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#302e652ded98052ce79cb74539a5815f">csString</a> (const char *src, size_t _length)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classcsString.html" title="Thin wrapper around csStringFast<> with its default buffer size.">csString</a> object from a C string, given the length. <a href="#302e652ded98052ce79cb74539a5815f"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#d330b9390dbe0fb64c433289c98f8746">csString</a> (const char *src)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classcsString.html" title="Thin wrapper around csStringFast<> with its default buffer size.">csString</a> object from a null-terminated C string. <a href="#d330b9390dbe0fb64c433289c98f8746"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#84579973ccfd0eb9cba69462f97e6b7e">csString</a> (size_t Length)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classcsString.html" title="Thin wrapper around csStringFast<> with its default buffer size.">csString</a> object and reserve space for at least <code>Length</code> characters. <a href="#84579973ccfd0eb9cba69462f97e6b7e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#edaf372782d9a8799e024f2ac4c2c564">csString</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create an empty <a class="el" href="classcsString.html" title="Thin wrapper around csStringFast<> with its default buffer size.">csString</a> object. <a href="#edaf372782d9a8799e024f2ac4c2c564"></a><br></td></tr> <tr><td colspan="2"><div class="groupHeader"></div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="989fbef0bd275b1c116ec252086518d5"></a><!-- doxytag: member="csString::csString" ref="989fbef0bd275b1c116ec252086518d5" args="(const csStringBase &copy)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#989fbef0bd275b1c116ec252086518d5">csString</a> (const <a class="el" href="classcsStringBase.html">csStringBase</a> &copy)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#f7702500f67111de535b0d48f3e4ee4d">csString</a> (const <a class="el" href="classcsString.html">csString</a> &copy)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#f7702500f67111de535b0d48f3e4ee4d"></a><br></td></tr> <tr><td colspan="2"><div class="groupHeader"></div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7fd3632f90f30bbebf0d8f244cc869f1"></a><!-- doxytag: member="csString::operator=" ref="7fd3632f90f30bbebf0d8f244cc869f1" args="(ulonglong x)" --> const <a class="el" href="classcsString.html">csString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#7fd3632f90f30bbebf0d8f244cc869f1">operator=</a> (<a class="el" href="group__util.html#g8c42bcc74c4498c45586ad15fab3b829">ulonglong</a> x)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="78c05f2a2b99bf3e02907022ac60b93f"></a><!-- doxytag: member="csString::operator=" ref="78c05f2a2b99bf3e02907022ac60b93f" args="(longlong x)" --> const <a class="el" href="classcsString.html">csString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#78c05f2a2b99bf3e02907022ac60b93f">operator=</a> (<a class="el" href="group__util.html#g574e57efdc7bcebd6e3b5e043fdeb28c">longlong</a> x)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ddbecc5306d9bd847c8efea85bc2d3ca"></a><!-- doxytag: member="csString::operator=" ref="ddbecc5306d9bd847c8efea85bc2d3ca" args="(double x)" --> const <a class="el" href="classcsString.html">csString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#ddbecc5306d9bd847c8efea85bc2d3ca">operator=</a> (double x)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7f4b259ff070a565547d3cf65924f823"></a><!-- doxytag: member="csString::operator=" ref="7f4b259ff070a565547d3cf65924f823" args="(float x)" --> const <a class="el" href="classcsString.html">csString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#7f4b259ff070a565547d3cf65924f823">operator=</a> (float x)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c45c40af3ab73f4ea624682458ebc4fe"></a><!-- doxytag: member="csString::operator=" ref="c45c40af3ab73f4ea624682458ebc4fe" args="(unsigned long x)" --> const <a class="el" href="classcsString.html">csString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#c45c40af3ab73f4ea624682458ebc4fe">operator=</a> (unsigned long x)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1ab8e3eb61c7399f26c6cdb7049b154d"></a><!-- doxytag: member="csString::operator=" ref="1ab8e3eb61c7399f26c6cdb7049b154d" args="(long x)" --> const <a class="el" href="classcsString.html">csString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#1ab8e3eb61c7399f26c6cdb7049b154d">operator=</a> (long x)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c27f2601c65c004c8e34f52a7daef8ff"></a><!-- doxytag: member="csString::operator=" ref="c27f2601c65c004c8e34f52a7daef8ff" args="(unsigned int x)" --> const <a class="el" href="classcsString.html">csString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#c27f2601c65c004c8e34f52a7daef8ff">operator=</a> (unsigned int x)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="21cff66e111956686427ccd4bb7dad24"></a><!-- doxytag: member="csString::operator=" ref="21cff66e111956686427ccd4bb7dad24" args="(int x)" --> const <a class="el" href="classcsString.html">csString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#21cff66e111956686427ccd4bb7dad24">operator=</a> (int x)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="77141878a1a421a53b15dd9b74bd9d87"></a><!-- doxytag: member="csString::operator=" ref="77141878a1a421a53b15dd9b74bd9d87" args="(unsigned short x)" --> const <a class="el" href="classcsString.html">csString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#77141878a1a421a53b15dd9b74bd9d87">operator=</a> (unsigned short x)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6dbfff40cc5ec4ec2a9f29edc3cac3e"></a><!-- doxytag: member="csString::operator=" ref="a6dbfff40cc5ec4ec2a9f29edc3cac3e" args="(short x)" --> const <a class="el" href="classcsString.html">csString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#a6dbfff40cc5ec4ec2a9f29edc3cac3e">operator=</a> (short x)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6917232dae4e2766d4f05dc07ec8ba73"></a><!-- doxytag: member="csString::operator=" ref="6917232dae4e2766d4f05dc07ec8ba73" args="(bool x)" --> const <a class="el" href="classcsString.html">csString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#6917232dae4e2766d4f05dc07ec8ba73">operator=</a> (bool x)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4542d561e92c4bc8665b2e6b8d2b5292"></a><!-- doxytag: member="csString::operator=" ref="4542d561e92c4bc8665b2e6b8d2b5292" args="(unsigned char x)" --> const <a class="el" href="classcsString.html">csString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#4542d561e92c4bc8665b2e6b8d2b5292">operator=</a> (unsigned char x)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1bb401141f7d4911da777bf33730f7b9"></a><!-- doxytag: member="csString::operator=" ref="1bb401141f7d4911da777bf33730f7b9" args="(char x)" --> const <a class="el" href="classcsString.html">csString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#1bb401141f7d4911da777bf33730f7b9">operator=</a> (char x)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9655afb5282bffa56b1e85b8daeff6f1"></a><!-- doxytag: member="csString::operator=" ref="9655afb5282bffa56b1e85b8daeff6f1" args="(const char *copy)" --> const <a class="el" href="classcsString.html">csString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#9655afb5282bffa56b1e85b8daeff6f1">operator=</a> (const char *copy)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classcsString.html">csString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#a39053d32060564e963c094c9daa2f05">operator=</a> (const <a class="el" href="classcsStringBase.html">csStringBase</a> &copy)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Assign a value to this string. <a href="#a39053d32060564e963c094c9daa2f05"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classcsString.html">csString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsString.html#2a686d11fae9542186ebcc42129e8832">operator=</a> (const <a class="el" href="classcsString.html">csString</a> &copy)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Assign a value to this string. <a href="#2a686d11fae9542186ebcc42129e8832"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Thin wrapper around csStringFast<> with its default buffer size. <p>Definition at line <a class="el" href="csstring_8h-source.html#l01158">1158</a> of file <a class="el" href="csstring_8h-source.html">csstring.h</a>.</p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="edaf372782d9a8799e024f2ac4c2c564"></a><!-- doxytag: member="csString::csString" ref="edaf372782d9a8799e024f2ac4c2c564" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csString::csString </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Create an empty <a class="el" href="classcsString.html" title="Thin wrapper around csStringFast<> with its default buffer size.">csString</a> object. <p> <p>Definition at line <a class="el" href="csstring_8h-source.html#l01162">1162</a> of file <a class="el" href="csstring_8h-source.html">csstring.h</a>.</p> </div> </div><p> <a class="anchor" name="84579973ccfd0eb9cba69462f97e6b7e"></a><!-- doxytag: member="csString::csString" ref="84579973ccfd0eb9cba69462f97e6b7e" args="(size_t Length)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csString::csString </td> <td>(</td> <td class="paramtype">size_t </td> <td class="paramname"> <em>Length</em> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Create a <a class="el" href="classcsString.html" title="Thin wrapper around csStringFast<> with its default buffer size.">csString</a> object and reserve space for at least <code>Length</code> characters. <p> <p>Definition at line <a class="el" href="csstring_8h-source.html#l01167">1167</a> of file <a class="el" href="csstring_8h-source.html">csstring.h</a>.</p> </div> </div><p> <a class="anchor" name="f7702500f67111de535b0d48f3e4ee4d"></a><!-- doxytag: member="csString::csString" ref="f7702500f67111de535b0d48f3e4ee4d" args="(const csString &copy)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csString::csString </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsString.html">csString</a> & </td> <td class="paramname"> <em>copy</em> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Copy constructor. <p> <p>Definition at line <a class="el" href="csstring_8h-source.html#l01170">1170</a> of file <a class="el" href="csstring_8h-source.html">csstring.h</a>.</p> </div> </div><p> <a class="anchor" name="d330b9390dbe0fb64c433289c98f8746"></a><!-- doxytag: member="csString::csString" ref="d330b9390dbe0fb64c433289c98f8746" args="(const char *src)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csString::csString </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>src</em> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Create a <a class="el" href="classcsString.html" title="Thin wrapper around csStringFast<> with its default buffer size.">csString</a> object from a null-terminated C string. <p> <p>Definition at line <a class="el" href="csstring_8h-source.html#l01175">1175</a> of file <a class="el" href="csstring_8h-source.html">csstring.h</a>.</p> </div> </div><p> <a class="anchor" name="302e652ded98052ce79cb74539a5815f"></a><!-- doxytag: member="csString::csString" ref="302e652ded98052ce79cb74539a5815f" args="(const char *src, size_t _length)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csString::csString </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>src</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"> <em>_length</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Create a <a class="el" href="classcsString.html" title="Thin wrapper around csStringFast<> with its default buffer size.">csString</a> object from a C string, given the length. <p> <p>Definition at line <a class="el" href="csstring_8h-source.html#l01177">1177</a> of file <a class="el" href="csstring_8h-source.html">csstring.h</a>.</p> </div> </div><p> <a class="anchor" name="612a5248c5600ee111bba3e9c0f1d329"></a><!-- doxytag: member="csString::csString" ref="612a5248c5600ee111bba3e9c0f1d329" args="(char c)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csString::csString </td> <td>(</td> <td class="paramtype">char </td> <td class="paramname"> <em>c</em> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Create a <a class="el" href="classcsString.html" title="Thin wrapper around csStringFast<> with its default buffer size.">csString</a> object from a single signed character. <p> <p>Definition at line <a class="el" href="csstring_8h-source.html#l01179">1179</a> of file <a class="el" href="csstring_8h-source.html">csstring.h</a>.</p> </div> </div><p> <a class="anchor" name="2063954e77d18fd0c2ca95d0fa87b6d1"></a><!-- doxytag: member="csString::csString" ref="2063954e77d18fd0c2ca95d0fa87b6d1" args="(unsigned char c)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csString::csString </td> <td>(</td> <td class="paramtype">unsigned char </td> <td class="paramname"> <em>c</em> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Create a <a class="el" href="classcsString.html" title="Thin wrapper around csStringFast<> with its default buffer size.">csString</a> object from a single unsigned character. <p> <p>Definition at line <a class="el" href="csstring_8h-source.html#l01181">1181</a> of file <a class="el" href="csstring_8h-source.html">csstring.h</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="a39053d32060564e963c094c9daa2f05"></a><!-- doxytag: member="csString::operator=" ref="a39053d32060564e963c094c9daa2f05" args="(const csStringBase &copy)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="classcsString.html">csString</a>& csString::operator= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsStringBase.html">csStringBase</a> & </td> <td class="paramname"> <em>copy</em> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Assign a value to this string. <p> <p>Reimplemented from <a class="el" href="classcsStringFast.html#7fd076b23661571a4fbccb29cb61dde3">csStringFast< LEN ></a>.</p> <p>Definition at line <a class="el" href="csstring_8h-source.html#l01187">1187</a> of file <a class="el" href="csstring_8h-source.html">csstring.h</a>.</p> </div> </div><p> <a class="anchor" name="2a686d11fae9542186ebcc42129e8832"></a><!-- doxytag: member="csString::operator=" ref="2a686d11fae9542186ebcc42129e8832" args="(const csString &copy)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="classcsString.html">csString</a>& csString::operator= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsString.html">csString</a> & </td> <td class="paramname"> <em>copy</em> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Assign a value to this string. <p> <p>Definition at line <a class="el" href="csstring_8h-source.html#l01185">1185</a> of file <a class="el" href="csstring_8h-source.html">csstring.h</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li>csutil/<a class="el" href="csstring_8h-source.html">csstring.h</a></ul> <hr size="1"><address><small>Generated for Crystal Space 1.2.1 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 </small></address> </div></body> </html>