doc/html/group__version.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>yaml: Version Information</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.6 -->
   8 <div class="navigation" id="top">
   9   <div class="tabs">
  10     <ul>
  11       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  12       <li><a href="modules.html"><span>Modules</span></a></li>
  13       <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  14       <li><a href="files.html"><span>Files</span></a></li>
  15     </ul>
  16   </div>
  17 </div>
  18 <div class="contents">
  19 <h1>Version Information</h1><table border="0" cellpadding="0" cellspacing="0">
  20 <tr><td></td></tr>
  21 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
  22 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#gf1ba5c1c34e809db5047d79a9fa85a73">yaml_get_version_string</a> (void)</td></tr>
  23
  24 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the library version as a string.  <a href="#gf1ba5c1c34e809db5047d79a9fa85a73"></a><br></td></tr>
  25 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#gec764c91f3e181ae63d3d59b7980fe78">yaml_get_version</a> (int *major, int *minor, int *patch)</td></tr>
  26
  27 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the library version numbers.  <a href="#gec764c91f3e181ae63d3d59b7980fe78"></a><br></td></tr>
  28 </table>
  29 <hr><h2>Function Documentation</h2>
  30 <a class="anchor" name="gf1ba5c1c34e809db5047d79a9fa85a73"></a><!-- doxytag: member="yaml.h::yaml_get_version_string" ref="gf1ba5c1c34e809db5047d79a9fa85a73" args="(void)" -->
  31 <div class="memitem">
  32 <div class="memproto">
  33       <table class="memname">
  34         <tr>
  35           <td class="memname">const char* yaml_get_version_string           </td>
  36           <td>(</td>
  37           <td class="paramtype">void&nbsp;</td>
  38           <td class="paramname">          </td>
  39           <td>&nbsp;)&nbsp;</td>
  40           <td></td>
  41         </tr>
  42       </table>
  43 </div>
  44 <div class="memdoc">
  45
  46 <p>
  47 Get the library version as a string.
  48 <p>
  49 <dl class="return" compact><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>
  50
  51 </div>
  52 </div><p>
  53 <a class="anchor" name="gec764c91f3e181ae63d3d59b7980fe78"></a><!-- doxytag: member="yaml.h::yaml_get_version" ref="gec764c91f3e181ae63d3d59b7980fe78" args="(int *major, int *minor, int *patch)" -->
  54 <div class="memitem">
  55 <div class="memproto">
  56       <table class="memname">
  57         <tr>
  58           <td class="memname">void yaml_get_version           </td>
  59           <td>(</td>
  60           <td class="paramtype">int *&nbsp;</td>
  61           <td class="paramname"> <em>major</em>, </td>
  62         </tr>
  63         <tr>
  64           <td class="paramkey"></td>
  65           <td></td>
  66           <td class="paramtype">int *&nbsp;</td>
  67           <td class="paramname"> <em>minor</em>, </td>
  68         </tr>
  69         <tr>
  70           <td class="paramkey"></td>
  71           <td></td>
  72           <td class="paramtype">int *&nbsp;</td>
  73           <td class="paramname"> <em>patch</em></td><td>&nbsp;</td>
  74         </tr>
  75         <tr>
  76           <td></td>
  77           <td>)</td>
  78           <td></td><td></td><td></td>
  79         </tr>
  80       </table>
  81 </div>
  82 <div class="memdoc">
  83
  84 <p>
  85 Get the library version numbers.
  86 <p>
  87 <dl compact><dt><b>Parameters:</b></dt><dd>
  88   <table border="0" cellspacing="2" cellpadding="0">
  89     <tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>major</em>&nbsp;</td><td>Major version number. </td></tr>
  90     <tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>minor</em>&nbsp;</td><td>Minor version number. </td></tr>
  91     <tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>patch</em>&nbsp;</td><td>Patch version number. </td></tr>
  92   </table>
  93 </dl>
  94
  95 </div>
  96 </div><p>
  97 </div>
  98 <hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 28 01:19:28 2008 for yaml by&nbsp;
  99 <a href="http://www.doxygen.org/index.html">
 100 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 101 </body>
 102 </html>