cmdline_8h.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.6"/>
  7. <title>GRPC Core: include/grpc/support/cmdline.h File Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">GRPC Core
  26. &#160;<span id="projectnumber">4.0.0</span>
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.6 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  44. <li class="current"><a href="files.html"><span>Files</span></a></li>
  45. <li>
  46. <div id="MSearchBox" class="MSearchBoxInactive">
  47. <span class="left">
  48. <img id="MSearchSelect" src="search/mag_sel.png"
  49. onmouseover="return searchBox.OnSearchSelectShow()"
  50. onmouseout="return searchBox.OnSearchSelectHide()"
  51. alt=""/>
  52. <input type="text" id="MSearchField" value="Search" accesskey="S"
  53. onfocus="searchBox.OnSearchFieldFocus(true)"
  54. onblur="searchBox.OnSearchFieldFocus(false)"
  55. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  56. </span><span class="right">
  57. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  58. </span>
  59. </div>
  60. </li>
  61. </ul>
  62. </div>
  63. <div id="navrow2" class="tabs2">
  64. <ul class="tablist">
  65. <li><a href="files.html"><span>File&#160;List</span></a></li>
  66. <li><a href="globals.html"><span>Globals</span></a></li>
  67. </ul>
  68. </div>
  69. <!-- window showing the filter options -->
  70. <div id="MSearchSelectWindow"
  71. onmouseover="return searchBox.OnSearchSelectShow()"
  72. onmouseout="return searchBox.OnSearchSelectHide()"
  73. onkeydown="return searchBox.OnSearchSelectKey(event)">
  74. <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>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  75. <!-- iframe showing the search results (closed by default) -->
  76. <div id="MSearchResultsWindow">
  77. <iframe src="javascript:void(0)" frameborder="0"
  78. name="MSearchResults" id="MSearchResults">
  79. </iframe>
  80. </div>
  81. <div id="nav-path" class="navpath">
  82. <ul>
  83. <li class="navelem"><a class="el" href="dir_bda73758a0a4d8c0ff603a7983866e1c.html">include</a></li><li class="navelem"><a class="el" href="dir_8ae8e534eeef321a81935092729b7078.html">grpc</a></li><li class="navelem"><a class="el" href="dir_692cef9a660803f4b5efbe2b781d2071.html">support</a></li> </ul>
  84. </div>
  85. </div><!-- top -->
  86. <div class="header">
  87. <div class="summary">
  88. <a href="#typedef-members">Typedefs</a> &#124;
  89. <a href="#func-members">Functions</a> </div>
  90. <div class="headertitle">
  91. <div class="title">cmdline.h File Reference</div> </div>
  92. </div><!--header-->
  93. <div class="contents">
  94. <div class="textblock"><code>#include &lt;<a class="el" href="support_2port__platform_8h_source.html">grpc/support/port_platform.h</a>&gt;</code><br/>
  95. </div>
  96. <p><a href="cmdline_8h_source.html">Go to the source code of this file.</a></p>
  97. <table class="memberdecls">
  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  99. Typedefs</h2></td></tr>
  100. <tr class="memitem:aaad93cd9bfc32c54fc89f7c2f3b74eb6"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a></td></tr>
  101. <tr class="memdesc:aaad93cd9bfc32c54fc89f7c2f3b74eb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simple command line parser. <a href="#aaad93cd9bfc32c54fc89f7c2f3b74eb6">More...</a><br/></td></tr>
  102. <tr class="separator:aaad93cd9bfc32c54fc89f7c2f3b74eb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. </table><table class="memberdecls">
  104. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  105. Functions</h2></td></tr>
  106. <tr class="memitem:a31fa94e5c43847c82e90bb40087f5aa9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#a31fa94e5c43847c82e90bb40087f5aa9">gpr_cmdline_create</a> (const char *description)</td></tr>
  107. <tr class="memdesc:a31fa94e5c43847c82e90bb40087f5aa9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a command line parser: takes a short description of the tool doing the parsing. <a href="#a31fa94e5c43847c82e90bb40087f5aa9">More...</a><br/></td></tr>
  108. <tr class="separator:a31fa94e5c43847c82e90bb40087f5aa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a87c433155b5df21be39818d658cfe93f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#a87c433155b5df21be39818d658cfe93f">gpr_cmdline_add_int</a> (<a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a> *cl, const char *name, const char *help, int *value)</td></tr>
  110. <tr class="memdesc:a87c433155b5df21be39818d658cfe93f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add an integer parameter, with a name (used on the command line) and some helpful text (used in the command usage) <a href="#a87c433155b5df21be39818d658cfe93f">More...</a><br/></td></tr>
  111. <tr class="separator:a87c433155b5df21be39818d658cfe93f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:aea1a46a5feb84307dc9e3796ca13c481"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#aea1a46a5feb84307dc9e3796ca13c481">gpr_cmdline_add_flag</a> (<a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a> *cl, const char *name, const char *help, int *value)</td></tr>
  113. <tr class="memdesc:aea1a46a5feb84307dc9e3796ca13c481"><td class="mdescLeft">&#160;</td><td class="mdescRight">The same, for a boolean flag. <a href="#aea1a46a5feb84307dc9e3796ca13c481">More...</a><br/></td></tr>
  114. <tr class="separator:aea1a46a5feb84307dc9e3796ca13c481"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:ad361141d2df046516b472df11e2712fb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#ad361141d2df046516b472df11e2712fb">gpr_cmdline_add_string</a> (<a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a> *cl, const char *name, const char *help, char **value)</td></tr>
  116. <tr class="memdesc:ad361141d2df046516b472df11e2712fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">And for a string. <a href="#ad361141d2df046516b472df11e2712fb">More...</a><br/></td></tr>
  117. <tr class="separator:ad361141d2df046516b472df11e2712fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:ac3b6905c4e9c88abd4936c593b0f5b12"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#ac3b6905c4e9c88abd4936c593b0f5b12">gpr_cmdline_on_extra_arg</a> (<a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a> *cl, const char *name, const char *help, void(*on_extra_arg)(void *user_data, const char *arg), void *user_data)</td></tr>
  119. <tr class="memdesc:ac3b6905c4e9c88abd4936c593b0f5b12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a callback for non-named arguments. <a href="#ac3b6905c4e9c88abd4936c593b0f5b12">More...</a><br/></td></tr>
  120. <tr class="separator:ac3b6905c4e9c88abd4936c593b0f5b12"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a191878e568149fffade0786592d13c37"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#a191878e568149fffade0786592d13c37">gpr_cmdline_set_survive_failure</a> (<a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a> *cl)</td></tr>
  122. <tr class="memdesc:a191878e568149fffade0786592d13c37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable surviving failure: default behavior is to exit the process. <a href="#a191878e568149fffade0786592d13c37">More...</a><br/></td></tr>
  123. <tr class="separator:a191878e568149fffade0786592d13c37"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:acc2f66f6bcdf05c8b761419bf2d40509"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#acc2f66f6bcdf05c8b761419bf2d40509">gpr_cmdline_parse</a> (<a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a> *cl, int argc, char **argv)</td></tr>
  125. <tr class="memdesc:acc2f66f6bcdf05c8b761419bf2d40509"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse the command line; returns 1 on success, on failure either dies (by default) or returns 0 if <a class="el" href="cmdline_8h.html#a191878e568149fffade0786592d13c37" title="Enable surviving failure: default behavior is to exit the process. ">gpr_cmdline_set_survive_failure()</a> has been called. <a href="#acc2f66f6bcdf05c8b761419bf2d40509">More...</a><br/></td></tr>
  126. <tr class="separator:acc2f66f6bcdf05c8b761419bf2d40509"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:acfe85f2db2b17fc82e614618ce5a09a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#acfe85f2db2b17fc82e614618ce5a09a8">gpr_cmdline_destroy</a> (<a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a> *cl)</td></tr>
  128. <tr class="memdesc:acfe85f2db2b17fc82e614618ce5a09a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the parser. <a href="#acfe85f2db2b17fc82e614618ce5a09a8">More...</a><br/></td></tr>
  129. <tr class="separator:acfe85f2db2b17fc82e614618ce5a09a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:af9bfcaca695b8e0f84fa410f733dced5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#af9bfcaca695b8e0f84fa410f733dced5">gpr_cmdline_usage_string</a> (<a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a> *cl, const char *argv0)</td></tr>
  131. <tr class="memdesc:af9bfcaca695b8e0f84fa410f733dced5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a string describing usage. <a href="#af9bfcaca695b8e0f84fa410f733dced5">More...</a><br/></td></tr>
  132. <tr class="separator:af9bfcaca695b8e0f84fa410f733dced5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. </table>
  134. <h2 class="groupheader">Typedef Documentation</h2>
  135. <a class="anchor" id="aaad93cd9bfc32c54fc89f7c2f3b74eb6"></a>
  136. <div class="memitem">
  137. <div class="memproto">
  138. <table class="memname">
  139. <tr>
  140. <td class="memname">typedef struct <a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a> <a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a></td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. <p>Simple command line parser. </p>
  145. <p>Supports flags that can be specified as -foo, &ndash;foo, &ndash;no-foo, -no-foo, etc And integers, strings that can be specified as -foo=4, -foo blah, etc</p>
  146. <p>No support for short command line options (but we may get that in the future.)</p>
  147. <p>Usage (for a program with a single flag argument 'foo'):</p>
  148. <p>int main(int argc, char **argv) { gpr_cmdline *cl; int verbose = 0;</p>
  149. <p>cl = gpr_cmdline_create("My cool tool"); gpr_cmdline_add_int(cl, "verbose", "Produce verbose output?", &amp;verbose); gpr_cmdline_parse(cl, argc, argv); gpr_cmdline_destroy(cl);</p>
  150. <p>if (verbose) { gpr_log(GPR_INFO, "Goodbye cruel world!"); }</p>
  151. <p>return 0; } </p>
  152. </div>
  153. </div>
  154. <h2 class="groupheader">Function Documentation</h2>
  155. <a class="anchor" id="aea1a46a5feb84307dc9e3796ca13c481"></a>
  156. <div class="memitem">
  157. <div class="memproto">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_cmdline_add_flag </td>
  161. <td>(</td>
  162. <td class="paramtype"><a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a> *&#160;</td>
  163. <td class="paramname"><em>cl</em>, </td>
  164. </tr>
  165. <tr>
  166. <td class="paramkey"></td>
  167. <td></td>
  168. <td class="paramtype">const char *&#160;</td>
  169. <td class="paramname"><em>name</em>, </td>
  170. </tr>
  171. <tr>
  172. <td class="paramkey"></td>
  173. <td></td>
  174. <td class="paramtype">const char *&#160;</td>
  175. <td class="paramname"><em>help</em>, </td>
  176. </tr>
  177. <tr>
  178. <td class="paramkey"></td>
  179. <td></td>
  180. <td class="paramtype">int *&#160;</td>
  181. <td class="paramname"><em>value</em>&#160;</td>
  182. </tr>
  183. <tr>
  184. <td></td>
  185. <td>)</td>
  186. <td></td><td></td>
  187. </tr>
  188. </table>
  189. </div><div class="memdoc">
  190. <p>The same, for a boolean flag. </p>
  191. </div>
  192. </div>
  193. <a class="anchor" id="a87c433155b5df21be39818d658cfe93f"></a>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_cmdline_add_int </td>
  199. <td>(</td>
  200. <td class="paramtype"><a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a> *&#160;</td>
  201. <td class="paramname"><em>cl</em>, </td>
  202. </tr>
  203. <tr>
  204. <td class="paramkey"></td>
  205. <td></td>
  206. <td class="paramtype">const char *&#160;</td>
  207. <td class="paramname"><em>name</em>, </td>
  208. </tr>
  209. <tr>
  210. <td class="paramkey"></td>
  211. <td></td>
  212. <td class="paramtype">const char *&#160;</td>
  213. <td class="paramname"><em>help</em>, </td>
  214. </tr>
  215. <tr>
  216. <td class="paramkey"></td>
  217. <td></td>
  218. <td class="paramtype">int *&#160;</td>
  219. <td class="paramname"><em>value</em>&#160;</td>
  220. </tr>
  221. <tr>
  222. <td></td>
  223. <td>)</td>
  224. <td></td><td></td>
  225. </tr>
  226. </table>
  227. </div><div class="memdoc">
  228. <p>Add an integer parameter, with a name (used on the command line) and some helpful text (used in the command usage) </p>
  229. </div>
  230. </div>
  231. <a class="anchor" id="ad361141d2df046516b472df11e2712fb"></a>
  232. <div class="memitem">
  233. <div class="memproto">
  234. <table class="memname">
  235. <tr>
  236. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_cmdline_add_string </td>
  237. <td>(</td>
  238. <td class="paramtype"><a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a> *&#160;</td>
  239. <td class="paramname"><em>cl</em>, </td>
  240. </tr>
  241. <tr>
  242. <td class="paramkey"></td>
  243. <td></td>
  244. <td class="paramtype">const char *&#160;</td>
  245. <td class="paramname"><em>name</em>, </td>
  246. </tr>
  247. <tr>
  248. <td class="paramkey"></td>
  249. <td></td>
  250. <td class="paramtype">const char *&#160;</td>
  251. <td class="paramname"><em>help</em>, </td>
  252. </tr>
  253. <tr>
  254. <td class="paramkey"></td>
  255. <td></td>
  256. <td class="paramtype">char **&#160;</td>
  257. <td class="paramname"><em>value</em>&#160;</td>
  258. </tr>
  259. <tr>
  260. <td></td>
  261. <td>)</td>
  262. <td></td><td></td>
  263. </tr>
  264. </table>
  265. </div><div class="memdoc">
  266. <p>And for a string. </p>
  267. </div>
  268. </div>
  269. <a class="anchor" id="a31fa94e5c43847c82e90bb40087f5aa9"></a>
  270. <div class="memitem">
  271. <div class="memproto">
  272. <table class="memname">
  273. <tr>
  274. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a>* gpr_cmdline_create </td>
  275. <td>(</td>
  276. <td class="paramtype">const char *&#160;</td>
  277. <td class="paramname"><em>description</em></td><td>)</td>
  278. <td></td>
  279. </tr>
  280. </table>
  281. </div><div class="memdoc">
  282. <p>Construct a command line parser: takes a short description of the tool doing the parsing. </p>
  283. </div>
  284. </div>
  285. <a class="anchor" id="acfe85f2db2b17fc82e614618ce5a09a8"></a>
  286. <div class="memitem">
  287. <div class="memproto">
  288. <table class="memname">
  289. <tr>
  290. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_cmdline_destroy </td>
  291. <td>(</td>
  292. <td class="paramtype"><a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a> *&#160;</td>
  293. <td class="paramname"><em>cl</em></td><td>)</td>
  294. <td></td>
  295. </tr>
  296. </table>
  297. </div><div class="memdoc">
  298. <p>Destroy the parser. </p>
  299. </div>
  300. </div>
  301. <a class="anchor" id="ac3b6905c4e9c88abd4936c593b0f5b12"></a>
  302. <div class="memitem">
  303. <div class="memproto">
  304. <table class="memname">
  305. <tr>
  306. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_cmdline_on_extra_arg </td>
  307. <td>(</td>
  308. <td class="paramtype"><a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a> *&#160;</td>
  309. <td class="paramname"><em>cl</em>, </td>
  310. </tr>
  311. <tr>
  312. <td class="paramkey"></td>
  313. <td></td>
  314. <td class="paramtype">const char *&#160;</td>
  315. <td class="paramname"><em>name</em>, </td>
  316. </tr>
  317. <tr>
  318. <td class="paramkey"></td>
  319. <td></td>
  320. <td class="paramtype">const char *&#160;</td>
  321. <td class="paramname"><em>help</em>, </td>
  322. </tr>
  323. <tr>
  324. <td class="paramkey"></td>
  325. <td></td>
  326. <td class="paramtype">void(*)(void *user_data, const char *arg)&#160;</td>
  327. <td class="paramname"><em>on_extra_arg</em>, </td>
  328. </tr>
  329. <tr>
  330. <td class="paramkey"></td>
  331. <td></td>
  332. <td class="paramtype">void *&#160;</td>
  333. <td class="paramname"><em>user_data</em>&#160;</td>
  334. </tr>
  335. <tr>
  336. <td></td>
  337. <td>)</td>
  338. <td></td><td></td>
  339. </tr>
  340. </table>
  341. </div><div class="memdoc">
  342. <p>Set a callback for non-named arguments. </p>
  343. </div>
  344. </div>
  345. <a class="anchor" id="acc2f66f6bcdf05c8b761419bf2d40509"></a>
  346. <div class="memitem">
  347. <div class="memproto">
  348. <table class="memname">
  349. <tr>
  350. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> int gpr_cmdline_parse </td>
  351. <td>(</td>
  352. <td class="paramtype"><a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a> *&#160;</td>
  353. <td class="paramname"><em>cl</em>, </td>
  354. </tr>
  355. <tr>
  356. <td class="paramkey"></td>
  357. <td></td>
  358. <td class="paramtype">int&#160;</td>
  359. <td class="paramname"><em>argc</em>, </td>
  360. </tr>
  361. <tr>
  362. <td class="paramkey"></td>
  363. <td></td>
  364. <td class="paramtype">char **&#160;</td>
  365. <td class="paramname"><em>argv</em>&#160;</td>
  366. </tr>
  367. <tr>
  368. <td></td>
  369. <td>)</td>
  370. <td></td><td></td>
  371. </tr>
  372. </table>
  373. </div><div class="memdoc">
  374. <p>Parse the command line; returns 1 on success, on failure either dies (by default) or returns 0 if <a class="el" href="cmdline_8h.html#a191878e568149fffade0786592d13c37" title="Enable surviving failure: default behavior is to exit the process. ">gpr_cmdline_set_survive_failure()</a> has been called. </p>
  375. </div>
  376. </div>
  377. <a class="anchor" id="a191878e568149fffade0786592d13c37"></a>
  378. <div class="memitem">
  379. <div class="memproto">
  380. <table class="memname">
  381. <tr>
  382. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_cmdline_set_survive_failure </td>
  383. <td>(</td>
  384. <td class="paramtype"><a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a> *&#160;</td>
  385. <td class="paramname"><em>cl</em></td><td>)</td>
  386. <td></td>
  387. </tr>
  388. </table>
  389. </div><div class="memdoc">
  390. <p>Enable surviving failure: default behavior is to exit the process. </p>
  391. </div>
  392. </div>
  393. <a class="anchor" id="af9bfcaca695b8e0f84fa410f733dced5"></a>
  394. <div class="memitem">
  395. <div class="memproto">
  396. <table class="memname">
  397. <tr>
  398. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> char* gpr_cmdline_usage_string </td>
  399. <td>(</td>
  400. <td class="paramtype"><a class="el" href="cmdline_8h.html#aaad93cd9bfc32c54fc89f7c2f3b74eb6">gpr_cmdline</a> *&#160;</td>
  401. <td class="paramname"><em>cl</em>, </td>
  402. </tr>
  403. <tr>
  404. <td class="paramkey"></td>
  405. <td></td>
  406. <td class="paramtype">const char *&#160;</td>
  407. <td class="paramname"><em>argv0</em>&#160;</td>
  408. </tr>
  409. <tr>
  410. <td></td>
  411. <td>)</td>
  412. <td></td><td></td>
  413. </tr>
  414. </table>
  415. </div><div class="memdoc">
  416. <p>Get a string describing usage. </p>
  417. </div>
  418. </div>
  419. </div><!-- contents -->
  420. <!-- start footer part -->
  421. <hr class="footer"/><address class="footer"><small>
  422. Generated on Wed Jun 21 2017 14:13:07 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  423. <img class="footer" src="doxygen.png" alt="doxygen"/>
  424. </a> 1.8.6
  425. </small></address>
  426. </body>
  427. </html>