contrib/libyaml/doc/html/group__version.html

   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 <title>yaml: Version Information</title>
   6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   7 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
   8 </head>
   9 <body>
  10 <!-- Generated by Doxygen 1.7.1 -->
  11 <div class="navigation" id="top">
  12   <div class="tabs">
  13     <ul class="tablist">
  14       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  15       <li><a href="modules.html"><span>Modules</span></a></li>
  16       <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  17       <li><a href="files.html"><span>Files</span></a></li>
  18     </ul>
  19   </div>
  20 </div>
  21 <div class="header">
  22   <div class="summary">
  23 <a href="#func-members">Functions</a>  </div>
  24   <div class="headertitle">
  25 <h1>Version Information</h1>  </div>
  26 </div>
  27 <div class="contents">
  28 <table class="memberdecls">
  29 <tr><td colspan="2"><h2><a name="func-members"></a>
  30 Functions</h2></td></tr>
  31 <tr><td class="memItemLeft" align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#gaf1ba5c1c34e809db5047d79a9fa85a73">yaml_get_version_string</a> (void)</td></tr>
  32 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the library version as a string.  <a href="#gaf1ba5c1c34e809db5047d79a9fa85a73"></a><br/></td></tr>
  33 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#gaec764c91f3e181ae63d3d59b7980fe78">yaml_get_version</a> (int *major, int *minor, int *patch)</td></tr>
  34 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the library version numbers.  <a href="#gaec764c91f3e181ae63d3d59b7980fe78"></a><br/></td></tr>
  35 </table>
  36 <hr/><h2>Function Documentation</h2>
  37 <a class="anchor" id="gaf1ba5c1c34e809db5047d79a9fa85a73"></a><!-- doxytag: member="yaml.h::yaml_get_version_string" ref="gaf1ba5c1c34e809db5047d79a9fa85a73" args="(void)" -->
  38 <div class="memitem">
  39 <div class="memproto">
  40       <table class="memname">
  41         <tr>
  42           <td class="memname">const char* yaml_get_version_string </td>
  43           <td>(</td>
  44           <td class="paramtype">void&nbsp;</td>
  45           <td class="paramname"></td>
  46           <td>&nbsp;)&nbsp;</td>
  47           <td></td>
  48         </tr>
  49       </table>
  50 </div>
  51 <div class="memdoc">
  52
  53 <p>Get the library version as a string. </p>
  54 <dl class="return"><dt><b>Returns:</b></dt><dd>The function returns the pointer to a static string of the form <code>"X.Y.Z"</code>, where <code>X</code> is the major version number, <code>Y</code> is a minor version number, and <code>Z</code> is the patch version number. </dd></dl>
  55
  56 </div>
  57 </div>
  58 <a class="anchor" id="gaec764c91f3e181ae63d3d59b7980fe78"></a><!-- doxytag: member="yaml.h::yaml_get_version" ref="gaec764c91f3e181ae63d3d59b7980fe78" args="(int *major, int *minor, int *patch)" -->
  59 <div class="memitem">
  60 <div class="memproto">
  61       <table class="memname">
  62         <tr>
  63           <td class="memname">void yaml_get_version </td>
  64           <td>(</td>
  65           <td class="paramtype">int *&nbsp;</td>
  66           <td class="paramname"> <em>major</em>, </td>
  67         </tr>
  68         <tr>
  69           <td class="paramkey"></td>
  70           <td></td>
  71           <td class="paramtype">int *&nbsp;</td>
  72           <td class="paramname"> <em>minor</em>, </td>
  73         </tr>
  74         <tr>
  75           <td class="paramkey"></td>
  76           <td></td>
  77           <td class="paramtype">int *&nbsp;</td>
  78           <td class="paramname"> <em>patch</em></td><td>&nbsp;</td>
  79         </tr>
  80         <tr>
  81           <td></td>
  82           <td>)</td>
  83           <td></td><td></td><td></td>
  84         </tr>
  85       </table>
  86 </div>
  87 <div class="memdoc">
  88
  89 <p>Get the library version numbers. </p>
  90 <dl><dt><b>Parameters:</b></dt><dd>
  91   <table border="0" cellspacing="2" cellpadding="0">
  92     <tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>major</em>&nbsp;</td><td>Major version number. </td></tr>
  93     <tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>minor</em>&nbsp;</td><td>Minor version number. </td></tr>
  94     <tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>patch</em>&nbsp;</td><td>Patch version number. </td></tr>
  95   </table>
  96   </dd>
  97 </dl>
  98
  99 </div>
 100 </div>
 101 </div>
 102 <hr class="footer"/><address class="footer"><small>Generated on Mon May 30 2011 22:00:00 for yaml by&nbsp;
 103 <a href="http://www.doxygen.org/index.html">
 104 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
 105 </body>
 106 </html>