<!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: csStringReader 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>csStringReader Class Reference</h1><!-- doxytag: class="csStringReader" -->This is a convenience class that reads an input buffer line by line. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="stringreader_8h-source.html">csutil/stringreader.h</a>></code> <p> <p> <a href="classcsStringReader-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="classcsStringReader.html#b2a1174b2dd27472086c606a6b070734">csStringReader</a> (const char *input)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Open a new string reader on the given input. <a href="#b2a1174b2dd27472086c606a6b070734"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsStringReader.html#8e2134ceb91db678231f7dc714263c5e">csStringReader</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create an empty string reader. <a href="#8e2134ceb91db678231f7dc714263c5e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsStringReader.html#7cc168425104bfac3eddd328feca5bf1">GetLine</a> (<a class="el" href="classcsString.html">csString</a> &line)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next line from the input and put it in the string argument. <a href="#7cc168425104bfac3eddd328feca5bf1"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsStringReader.html#27c7b32500ee55c4ed8f1cddd4f4ab9d">HasMoreLines</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if there are more lines. <a href="#27c7b32500ee55c4ed8f1cddd4f4ab9d"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsStringReader.html#b40fc0ee3f6196b886d77671a70e0285">Reset</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the reading offset at the start of the input. <a href="#b40fc0ee3f6196b886d77671a70e0285"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsStringReader.html#c74850efea21dc4e7c32ecbb0417cbdc">SetInput</a> (const char *input)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set input buffer. <a href="#c74850efea21dc4e7c32ecbb0417cbdc"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> This is a convenience class that reads an input buffer line by line. <p> It takes care of OS specific line endings (CR or CR/LF). <p>Definition at line <a class="el" href="stringreader_8h-source.html#l00032">32</a> of file <a class="el" href="stringreader_8h-source.html">stringreader.h</a>.</p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="8e2134ceb91db678231f7dc714263c5e"></a><!-- doxytag: member="csStringReader::csStringReader" ref="8e2134ceb91db678231f7dc714263c5e" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csStringReader::csStringReader </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Create an empty string reader. <p> </div> </div><p> <a class="anchor" name="b2a1174b2dd27472086c606a6b070734"></a><!-- doxytag: member="csStringReader::csStringReader" ref="b2a1174b2dd27472086c606a6b070734" args="(const char *input)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csStringReader::csStringReader </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>input</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Open a new string reader on the given input. <p> 'input' must point to a null terminated character buffer. </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="7cc168425104bfac3eddd328feca5bf1"></a><!-- doxytag: member="csStringReader::GetLine" ref="7cc168425104bfac3eddd328feca5bf1" args="(csString &line)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool csStringReader::GetLine </td> <td>(</td> <td class="paramtype"><a class="el" href="classcsString.html">csString</a> & </td> <td class="paramname"> <em>line</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Get the next line from the input and put it in the string argument. <p> Returns true on success or false if there are no more lines left (the string will be made empty in that case). Note that the returned string will not contain a newline at the end. </div> </div><p> <a class="anchor" name="27c7b32500ee55c4ed8f1cddd4f4ab9d"></a><!-- doxytag: member="csStringReader::HasMoreLines" ref="27c7b32500ee55c4ed8f1cddd4f4ab9d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool csStringReader::HasMoreLines </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Returns true if there are more lines. <p> </div> </div><p> <a class="anchor" name="b40fc0ee3f6196b886d77671a70e0285"></a><!-- doxytag: member="csStringReader::Reset" ref="b40fc0ee3f6196b886d77671a70e0285" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void csStringReader::Reset </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Reset the reading offset at the start of the input. <p> </div> </div><p> <a class="anchor" name="c74850efea21dc4e7c32ecbb0417cbdc"></a><!-- doxytag: member="csStringReader::SetInput" ref="c74850efea21dc4e7c32ecbb0417cbdc" args="(const char *input)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void csStringReader::SetInput </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>input</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Set input buffer. <p> 'input' must point to a null terminated character buffer. </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li>csutil/<a class="el" href="stringreader_8h-source.html">stringreader.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>