[libyaml.git] / doc / html / group__version.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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>yaml: Version Information</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="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 id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">yaml
   &#160;<span id="projectnumber">0.2.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Version Information</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaf1ba5c1c34e809db5047d79a9fa85a73"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#gaf1ba5c1c34e809db5047d79a9fa85a73">yaml_get_version_string</a> (void)</td></tr>
<tr class="memdesc:gaf1ba5c1c34e809db5047d79a9fa85a73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the library version as a string.  <a href="#gaf1ba5c1c34e809db5047d79a9fa85a73">More...</a><br /></td></tr>
<tr class="separator:gaf1ba5c1c34e809db5047d79a9fa85a73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaec764c91f3e181ae63d3d59b7980fe78"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
<tr class="memdesc:gaec764c91f3e181ae63d3d59b7980fe78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the library version numbers.  <a href="#gaec764c91f3e181ae63d3d59b7980fe78">More...</a><br /></td></tr>
<tr class="separator:gaec764c91f3e181ae63d3d59b7980fe78"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaf1ba5c1c34e809db5047d79a9fa85a73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf1ba5c1c34e809db5047d79a9fa85a73">&#9670;&nbsp;</a></span>yaml_get_version_string()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* yaml_get_version_string </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the library version as a string. </p>
<dl class="section return"><dt>Returns</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>

</div>
</div>
<a id="gaec764c91f3e181ae63d3d59b7980fe78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaec764c91f3e181ae63d3d59b7980fe78">&#9670;&nbsp;</a></span>yaml_get_version()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void yaml_get_version </td>
          <td>(</td>
          <td class="paramtype">int *&#160;</td>
          <td class="paramname"><em>major</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int *&#160;</td>
          <td class="paramname"><em>minor</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int *&#160;</td>
          <td class="paramname"><em>patch</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the library version numbers. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">major</td><td>Major version number. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">minor</td><td>Minor version number. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">patch</td><td>Patch version number. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
Commit	Line	Data
0fbeb4dc AK	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"/>
059850b5	5	<meta http-equiv="X-UA-Compatible" content="IE=9"/>
c45550e5 AK	6	<meta name="generator" content="Doxygen 1.8.14"/>
c45550e5 AK	7	<meta name="viewport" content="width=device-width, initial-scale=1"/>
b9668ba4	8	<title>yaml: Version Information</title>
0fbeb4dc	9	<link href="tabs.css" rel="stylesheet" type="text/css"/>
0044e680 AK	10	<script type="text/javascript" src="jquery.js"></script>
0044e680 AK	11	<script type="text/javascript" src="dynsections.js"></script>
059850b5	12	<link href="doxygen.css" rel="stylesheet" type="text/css" />
0fbeb4dc AK	13	</head>
0fbeb4dc AK	14	<body>
0044e680	15	<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
059850b5 AK	16	<div id="titlearea">
	17	<table cellspacing="0" cellpadding="0">
	18	<tbody>
	19	<tr style="height: 56px;">
c45550e5	20	<td id="projectalign" style="padding-left: 0.5em;">
059850b5	21	<div id="projectname">yaml
5070705b	22	<span id="projectnumber">0.2.2</span>
059850b5	23	</div>
059850b5	24	</td>
059850b5 AK	25	</tr>
	26	</tbody>
	27	</table>
	28	</div>
0044e680	29	<!-- end header part -->
c45550e5 AK	30	<!-- Generated by Doxygen 1.8.14 -->
	31	<script type="text/javascript" src="menudata.js"></script>
	32	<script type="text/javascript" src="menu.js"></script>
	33	<script type="text/javascript">
	34	/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
	35	$(function() {
	36	initMenu('',false,false,'search.php','Search');
	37	});
	38	/* @license-end */</script>
	39	<div id="main-nav"></div>
0044e680	40	</div><!-- top -->
0fbeb4dc AK	41	<div class="header">
	42	<div class="summary">
	43	<a href="#func-members">Functions</a> </div>
	44	<div class="headertitle">
059850b5 AK	45	<div class="title">Version Information</div> </div>
059850b5 AK	46	</div><!--header-->
5c706339	47	<div class="contents">
0fbeb4dc	48	<table class="memberdecls">
0044e680	49	<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
0fbeb4dc	50	Functions</h2></td></tr>
0044e680	51	<tr class="memitem:gaf1ba5c1c34e809db5047d79a9fa85a73"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#gaf1ba5c1c34e809db5047d79a9fa85a73">yaml_get_version_string</a> (void)</td></tr>
c45550e5	52	<tr class="memdesc:gaf1ba5c1c34e809db5047d79a9fa85a73"><td class="mdescLeft"> </td><td class="mdescRight">Get the library version as a string. <a href="#gaf1ba5c1c34e809db5047d79a9fa85a73">More...</a><br /></td></tr>
0044e680 AK	53	<tr class="separator:gaf1ba5c1c34e809db5047d79a9fa85a73"><td class="memSeparator" colspan="2"> </td></tr>
0044e680 AK	54	<tr class="memitem:gaec764c91f3e181ae63d3d59b7980fe78"><td class="memItemLeft" align="right" valign="top">void </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>
c45550e5	55	<tr class="memdesc:gaec764c91f3e181ae63d3d59b7980fe78"><td class="mdescLeft"> </td><td class="mdescRight">Get the library version numbers. <a href="#gaec764c91f3e181ae63d3d59b7980fe78">More...</a><br /></td></tr>
0044e680	56	<tr class="separator:gaec764c91f3e181ae63d3d59b7980fe78"><td class="memSeparator" colspan="2"> </td></tr>
b9668ba4	57	</table>
0044e680 AK	58	<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
0044e680 AK	59	<h2 class="groupheader">Function Documentation</h2>
c45550e5 AK	60	<a id="gaf1ba5c1c34e809db5047d79a9fa85a73"></a>
	61	<h2 class="memtitle"><span class="permalink"><a href="#gaf1ba5c1c34e809db5047d79a9fa85a73">◆ </a></span>yaml_get_version_string()</h2>
	62
b9668ba4 AK	63	<div class="memitem">
	64	<div class="memproto">
	65	<table class="memname">
	66	<tr>
0044e680	67	<td class="memname">const char* yaml_get_version_string </td>
b9668ba4	68	<td>(</td>
059850b5 AK	69	<td class="paramtype">void </td>
059850b5 AK	70	<td class="paramname"></td><td>)</td>
5c706339	71	<td></td>
b9668ba4 AK	72	</tr>
b9668ba4 AK	73	</table>
0044e680	74	</div><div class="memdoc">
b9668ba4	75
0fbeb4dc	76	<p>Get the library version as a string. </p>
0044e680	77	<dl class="section return"><dt>Returns</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>
b9668ba4 AK	78
b9668ba4 AK	79	</div>
0fbeb4dc	80	</div>
c45550e5 AK	81	<a id="gaec764c91f3e181ae63d3d59b7980fe78"></a>
	82	<h2 class="memtitle"><span class="permalink"><a href="#gaec764c91f3e181ae63d3d59b7980fe78">◆ </a></span>yaml_get_version()</h2>
	83
b9668ba4 AK	84	<div class="memitem">
	85	<div class="memproto">
	86	<table class="memname">
	87	<tr>
0044e680	88	<td class="memname">void yaml_get_version </td>
b9668ba4	89	<td>(</td>
059850b5 AK	90	<td class="paramtype">int * </td>
059850b5 AK	91	<td class="paramname"><em>major</em>, </td>
b9668ba4 AK	92	</tr>
	93	<tr>
	94	<td class="paramkey"></td>
	95	<td></td>
059850b5 AK	96	<td class="paramtype">int * </td>
059850b5 AK	97	<td class="paramname"><em>minor</em>, </td>
b9668ba4 AK	98	</tr>
	99	<tr>
	100	<td class="paramkey"></td>
	101	<td></td>
059850b5 AK	102	<td class="paramtype">int * </td>
059850b5 AK	103	<td class="paramname"><em>patch</em> </td>
b9668ba4 AK	104	</tr>
	105	<tr>
	106	<td></td>
	107	<td>)</td>
059850b5	108	<td></td><td></td>
b9668ba4 AK	109	</tr>
b9668ba4 AK	110	</table>
0044e680	111	</div><div class="memdoc">
b9668ba4	112
0fbeb4dc	113	<p>Get the library version numbers. </p>
0044e680	114	<dl class="params"><dt>Parameters</dt><dd>
059850b5 AK	115	<table class="params">
	116	<tr><td class="paramdir">[out]</td><td class="paramname">major</td><td>Major version number. </td></tr>
	117	<tr><td class="paramdir">[out]</td><td class="paramname">minor</td><td>Minor version number. </td></tr>
	118	<tr><td class="paramdir">[out]</td><td class="paramname">patch</td><td>Patch version number. </td></tr>
b9668ba4	119	</table>
0fbeb4dc	120	</dd>
b9668ba4 AK	121	</dl>
	122
	123	</div>
5c706339	124	</div>
059850b5	125	</div><!-- contents -->
0044e680	126	<!-- start footer part -->
059850b5	127	<hr class="footer"/><address class="footer"><small>
c45550e5	128	Generated by  <a href="http://www.doxygen.org/index.html">
059850b5	129	<img class="footer" src="doxygen.png" alt="doxygen"/>
c45550e5	130	</a> 1.8.14
059850b5	131	</small></address>
b9668ba4 AK	132	</body>
b9668ba4 AK	133	</html>