Blob Blame History Raw
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Library Utilities: Gcr Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Gcr Library Reference Manual">
<link rel="up" href="misc.html" title="Part VI. Miscellaneous">
<link rel="prev" href="misc.html" title="Part VI. Miscellaneous">
<link rel="next" href="gcr-Library-PKCS#11.html" title="Library PKCS#11">
<meta name="generator" content="GTK-Doc V1.27.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gcr-Library-Utilities.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="misc.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="misc.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gcr-Library-PKCS#11.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gcr-Library-Utilities"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gcr-Library-Utilities.top_of_page"></a>Library Utilities</span></h2>
<p>Library Utilities — Library utilities such as version checks</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gcr-Library-Utilities.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody><tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="gcr-Library-Utilities.html#GCR-CHECK-VERSION:CAPS" title="GCR_CHECK_VERSION()">GCR_CHECK_VERSION</a><span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gcr-Library-Utilities.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gcr-Library-Utilities.html#GCR-MAJOR-VERSION:CAPS" title="GCR_MAJOR_VERSION">GCR_MAJOR_VERSION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gcr-Library-Utilities.html#GCR-MICRO-VERSION:CAPS" title="GCR_MICRO_VERSION">GCR_MICRO_VERSION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gcr-Library-Utilities.html#GCR-MINOR-VERSION:CAPS" title="GCR_MINOR_VERSION">GCR_MINOR_VERSION</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gcr-Library-Utilities.description"></a><h2>Description</h2>
<p>Basic library utilities such as version checks.</p>
</div>
<div class="refsect1">
<a name="gcr-Library-Utilities.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GCR-CHECK-VERSION:CAPS"></a><h3>GCR_CHECK_VERSION()</h3>
<pre class="programlisting">#define             GCR_CHECK_VERSION(major,minor,micro)</pre>
<p>Checks the version of the Gcr libarry that is being compiled
against.</p>
<div class="example">
<a name="id-1.7.2.6.2.5"></a><p class="title"><b>Example 1. Checking the version of the Gcr library</b></p>
<div class="example-contents">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="preproc">#if</span><span class="normal"> </span><span class="symbol">!</span><span class="function"><a href="gcr-Library-Utilities.html#GCR-CHECK-VERSION:CAPS">GCR_CHECK_VERSION</a></span><span class="normal"> </span><span class="symbol">(</span><span class="number">3</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">)</span>
<span class="preproc">#warning</span><span class="normal"> Old </span><span class="usertype">Gcr</span><span class="normal"> version</span><span class="symbol">,</span><span class="normal"> disabling functionality</span>
<span class="preproc">#endif</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

</div>
<br class="example-break"><div class="refsect3">
<a name="GCR-CHECK-VERSION.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>major</p></td>
<td class="parameter_description"><p>the major version to check for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>minor</p></td>
<td class="parameter_description"><p>the minor version to check for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>micro</p></td>
<td class="parameter_description"><p>the micro version to check for</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="GCR-CHECK-VERSION.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the version of the Gcr header files
is the same as or newer than the passed-in version.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="gcr-Library-Utilities.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GCR-MAJOR-VERSION:CAPS"></a><h3>GCR_MAJOR_VERSION</h3>
<pre class="programlisting">#define GCR_MAJOR_VERSION (3)
</pre>
<p>The major version number of the Gcr library.</p>
</div>
<hr>
<div class="refsect2">
<a name="GCR-MICRO-VERSION:CAPS"></a><h3>GCR_MICRO_VERSION</h3>
<pre class="programlisting">#define GCR_MICRO_VERSION (0)
</pre>
<p>The micro version number of the Gcr library.</p>
</div>
<hr>
<div class="refsect2">
<a name="GCR-MINOR-VERSION:CAPS"></a><h3>GCR_MINOR_VERSION</h3>
<pre class="programlisting">#define GCR_MINOR_VERSION (28)
</pre>
<p>The minor version number of the Gcr library.</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27.1</div>
</body>
</html>