kc3-lang/SDL/visualtest/docs/html/rwhelper_8c.html
-
Show log
Commit
-
Hash : 3dcb451f
Author :
Date : 2014-04-09T21:29:19
Added a README file regarding WinRT support To note, this file is currently formatted with CRLF line endings, rather than LF, to allow the file to be viewed with Notepad.
-
visualtest/docs/html/rwhelper_8c.html
-
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.4"/> <title>SDL Visual Test: C:/Users/DELL/Work/sdlvisualtest/visualtest/src/rwhelper.c File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">SDL Visual Test </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.4 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">rwhelper.c File Reference</div> </div> </div><!--header--> <div class="contents"> <div class="textblock"><code>#include <SDL_test.h></code><br/> <code>#include "<a class="el" href="_s_d_l__visualtest__sut__configparser_8h_source.html">SDL_visualtest_sut_configparser.h</a>"</code><br/> <code>#include "SDL_visualtest_rwhelper.h"</code><br/> </div><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:aa7878508e6d851b11dc1d1186324064a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="rwhelper_8c.html#aa7878508e6d851b11dc1d1186324064a">SDLVisualTest_RWHelperResetBuffer</a> (<a class="el" href="struct_s_d_l_visual_test___r_w_helper_buffer.html">SDLVisualTest_RWHelperBuffer</a> *buffer)</td></tr> <tr class="separator:aa7878508e6d851b11dc1d1186324064a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a92794c04d5568bde0da9f3020d88f44c"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="rwhelper_8c.html#a92794c04d5568bde0da9f3020d88f44c">SDLVisualTest_RWHelperReadChar</a> (SDL_RWops *rw, <a class="el" href="struct_s_d_l_visual_test___r_w_helper_buffer.html">SDLVisualTest_RWHelperBuffer</a> *buffer)</td></tr> <tr class="separator:a92794c04d5568bde0da9f3020d88f44c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af97cfdf8d58f716efa8fd9204666df12"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="rwhelper_8c.html#af97cfdf8d58f716efa8fd9204666df12">SDLVisualTest_RWHelperReadLine</a> (SDL_RWops *rw, char *str, int size, <a class="el" href="struct_s_d_l_visual_test___r_w_helper_buffer.html">SDLVisualTest_RWHelperBuffer</a> *buffer, char comment_char)</td></tr> <tr class="separator:af97cfdf8d58f716efa8fd9204666df12"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac7f94417fa973af01a27452acd0043e8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="rwhelper_8c.html#ac7f94417fa973af01a27452acd0043e8">SDLVisualTest_RWHelperCountNonEmptyLines</a> (SDL_RWops *rw, <a class="el" href="struct_s_d_l_visual_test___r_w_helper_buffer.html">SDLVisualTest_RWHelperBuffer</a> *buffer, char comment_char)</td></tr> <tr class="separator:ac7f94417fa973af01a27452acd0043e8"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Header file with some helper functions for working with SDL_RWops.</p> <p>Source file with some helper functions for working with SDL_RWops. </p> </div><h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="ac7f94417fa973af01a27452acd0043e8"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int SDLVisualTest_RWHelperCountNonEmptyLines </td> <td>(</td> <td class="paramtype">SDL_RWops * </td> <td class="paramname"><em>rw</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___r_w_helper_buffer.html">SDLVisualTest_RWHelperBuffer</a> * </td> <td class="paramname"><em>buffer</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">char </td> <td class="paramname"><em>comment_char</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Counts the number of lines that are not all whitespace and comments using the SDL_RWops object pointed to by <code>rw</code>. <code>comment_char</code> indicates the character used for comments. Uses the buffer pointed to by <code>buffer</code> to read data in blocks.</p> <dl class="section return"><dt>Returns</dt><dd>Number of lines on success, -1 on failure. </dd></dl> </div> </div> <a class="anchor" id="a92794c04d5568bde0da9f3020d88f44c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char SDLVisualTest_RWHelperReadChar </td> <td>(</td> <td class="paramtype">SDL_RWops * </td> <td class="paramname"><em>rw</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___r_w_helper_buffer.html">SDLVisualTest_RWHelperBuffer</a> * </td> <td class="paramname"><em>buffer</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Reads a single character using the SDL_RWops object pointed to by <code>rw</code>. This function reads data in blocks and stores them in the buffer pointed to by <code>buffer</code>, so other SDL_RWops functions should not be used in conjunction with this function.</p> <dl class="section return"><dt>Returns</dt><dd>The character that was read. </dd></dl> </div> </div> <a class="anchor" id="af97cfdf8d58f716efa8fd9204666df12"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char* SDLVisualTest_RWHelperReadLine </td> <td>(</td> <td class="paramtype">SDL_RWops * </td> <td class="paramname"><em>rw</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">char * </td> <td class="paramname"><em>str</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>size</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___r_w_helper_buffer.html">SDLVisualTest_RWHelperBuffer</a> * </td> <td class="paramname"><em>buffer</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">char </td> <td class="paramname"><em>comment_char</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Reads characters using the SDL_RWops object pointed to by <code>rw</code> into the character array pointed to by <code>str</code> (of size <code>size</code>) until either the array is full or a new line is encountered. If <code>comment_char</code> is encountered, all characters from that position till the end of the line are ignored. The new line is not included as part of the buffer. Lines with only whitespace and comments are ignored. This function reads data in blocks and stores them in the buffer pointed to by <code>buffer</code>, so other SDL_RWops functions should not be used in conjunction with this function.</p> <dl class="section return"><dt>Returns</dt><dd>pointer to the string on success, NULL on failure or EOF. </dd></dl> </div> </div> <a class="anchor" id="aa7878508e6d851b11dc1d1186324064a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void SDLVisualTest_RWHelperResetBuffer </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___r_w_helper_buffer.html">SDLVisualTest_RWHelperBuffer</a> * </td> <td class="paramname"><em>buffer</em>)</td><td></td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Resets the buffer pointed to by <code>buffer</code> used by some of the helper functions. This function should be called when you're using one of the helper functions with a new SDL_RWops object. </p> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Thu Sep 26 2013 00:18:24 for SDL Visual Test by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.4 </small></address> </body> </html>