Edit

kc3-lang/SDL/visualtest/docs/html/harness__argparser_8c.html

Branch :

  • Show log

    Commit

  • Author : David Ludwig
    Date : 2014-04-09 21:29:19
    Hash : 3dcb451f
    Message : 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/harness__argparser_8c.html
  • <!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/harness_argparser.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&#160;Page</span></a></li>
          <li><a href="annotated.html"><span>Data&#160;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&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</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="#define-members">Macros</a> &#124;
    <a href="#func-members">Functions</a>  </div>
      <div class="headertitle">
    <div class="title">harness_argparser.c File Reference</div>  </div>
    </div><!--header-->
    <div class="contents">
    <div class="textblock"><code>#include &lt;SDL_test.h&gt;</code><br/>
    <code>#include &lt;stdio.h&gt;</code><br/>
    <code>#include &lt;string.h&gt;</code><br/>
    <code>#include &quot;<a class="el" href="_s_d_l__visualtest__harness__argparser_8h_source.html">SDL_visualtest_harness_argparser.h</a>&quot;</code><br/>
    <code>#include &quot;SDL_visualtest_rwhelper.h&quot;</code><br/>
    </div><table class="memberdecls">
    <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
    Macros</h2></td></tr>
    <tr class="memitem:a7186273cd88640b740b6333cd98ae243"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="harness__argparser_8c.html#a7186273cd88640b740b6333cd98ae243">MAX_CONFIG_LINE_LEN</a>&#160;&#160;&#160;400</td></tr>
    <tr class="separator:a7186273cd88640b740b6333cd98ae243"><td class="memSeparator" colspan="2">&#160;</td></tr>
    <tr class="memitem:a6669f8e5a07e7a0e4622dd23362831e7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="harness__argparser_8c.html#a6669f8e5a07e7a0e4622dd23362831e7">DEFAULT_SUT_TIMEOUT</a>&#160;&#160;&#160;(60 * 1000)</td></tr>
    <tr class="separator:a6669f8e5a07e7a0e4622dd23362831e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
    </table><table class="memberdecls">
    <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    Functions</h2></td></tr>
    <tr class="memitem:a629609acc04ef21a21fdfbbf6c1589c8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="harness__argparser_8c.html#a629609acc04ef21a21fdfbbf6c1589c8">SDLVisualTest_ParseHarnessArgs</a> (char **argv, <a class="el" href="struct_s_d_l_visual_test___harness_state.html">SDLVisualTest_HarnessState</a> *state)</td></tr>
    <tr class="separator:a629609acc04ef21a21fdfbbf6c1589c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
    <tr class="memitem:a833147d8da541982c615645a797627cc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="harness__argparser_8c.html#a833147d8da541982c615645a797627cc">SDLVisualTest_FreeHarnessState</a> (<a class="el" href="struct_s_d_l_visual_test___harness_state.html">SDLVisualTest_HarnessState</a> *state)</td></tr>
    <tr class="separator:a833147d8da541982c615645a797627cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
    </table>
    <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    <div class="textblock"><p>Source file for functions to parse arguments to the test harness. </p>
    </div><h2 class="groupheader">Macro Definition Documentation</h2>
    <a class="anchor" id="a6669f8e5a07e7a0e4622dd23362831e7"></a>
    <div class="memitem">
    <div class="memproto">
          <table class="memname">
            <tr>
              <td class="memname">#define DEFAULT_SUT_TIMEOUT&#160;&#160;&#160;(60 * 1000)</td>
            </tr>
          </table>
    </div><div class="memdoc">
    <p>Default value for the timeout after which the SUT is forcefully killed </p>
    
    </div>
    </div>
    <a class="anchor" id="a7186273cd88640b740b6333cd98ae243"></a>
    <div class="memitem">
    <div class="memproto">
          <table class="memname">
            <tr>
              <td class="memname">#define MAX_CONFIG_LINE_LEN&#160;&#160;&#160;400</td>
            </tr>
          </table>
    </div><div class="memdoc">
    <p>Maximum length of one line in the config file </p>
    
    </div>
    </div>
    <h2 class="groupheader">Function Documentation</h2>
    <a class="anchor" id="a833147d8da541982c615645a797627cc"></a>
    <div class="memitem">
    <div class="memproto">
          <table class="memname">
            <tr>
              <td class="memname">void SDLVisualTest_FreeHarnessState </td>
              <td>(</td>
              <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___harness_state.html">SDLVisualTest_HarnessState</a> *&#160;</td>
              <td class="paramname"><em>state</em>)</td><td></td>
              <td></td>
            </tr>
          </table>
    </div><div class="memdoc">
    <p>Frees any resources associated with the state object pointed to by <code>state</code>. </p>
    
    </div>
    </div>
    <a class="anchor" id="a629609acc04ef21a21fdfbbf6c1589c8"></a>
    <div class="memitem">
    <div class="memproto">
          <table class="memname">
            <tr>
              <td class="memname">int SDLVisualTest_ParseHarnessArgs </td>
              <td>(</td>
              <td class="paramtype">char **&#160;</td>
              <td class="paramname"><em>argv</em>, </td>
            </tr>
            <tr>
              <td class="paramkey"></td>
              <td></td>
              <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___harness_state.html">SDLVisualTest_HarnessState</a> *&#160;</td>
              <td class="paramname"><em>state</em>&#160;</td>
            </tr>
            <tr>
              <td></td>
              <td>)</td>
              <td></td><td></td>
            </tr>
          </table>
    </div><div class="memdoc">
    <p>Parse command line paramters to the test harness and populate a state object.</p>
    <dl class="params"><dt>Parameters</dt><dd>
      <table class="params">
        <tr><td class="paramname">argv</td><td>The array of command line parameters. </td></tr>
        <tr><td class="paramname">state</td><td>Pointer to the state object to be populated.</td></tr>
      </table>
      </dd>
    </dl>
    <dl class="section return"><dt>Returns</dt><dd>Non-zero on success, zero on failure. </dd></dl>
    
    </div>
    </div>
    </div><!-- contents -->
    <!-- start footer part -->
    <hr class="footer"/><address class="footer"><small>
    Generated on Thu Sep 26 2013 00:18:23 for SDL Visual Test by &#160;<a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/>
    </a> 1.8.4
    </small></address>
    </body>
    </html>