~maria-captains/mariadb-native-client/trunk

« back to all changes in this revision

Viewing changes to docs/funcref/mysql_get_client_version.xml

  • Committer: Georg Richter
  • Date: 2012-11-26 10:23:56 UTC
  • Revision ID: georg@linux-eozo-20121126102356-llqrnqevaypb2nc6
- Added documentation (docbook based)
- To build the documentation use cmake . -DBUILD_DOCS=yes
- minor fixes in tests

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version='1.0' encoding='UTF-8'?>
 
2
    <refentry id="functions.mysql_get_client_version" display-name="0">
 
3
      <refmeta>
 
4
        <refentrytitle>mysql_get_client_version</refentrytitle>
 
5
      </refmeta>
 
6
      <refnamediv>
 
7
        <refname>mysql_get_client_version</refname>
 
8
        <refpurpose>Returns a number representing the client library version</refpurpose>
 
9
      </refnamediv>
 
10
      <refsect1 role="description">
 
11
        <methodsynopsis>
 
12
          <type>unsigned long</type>
 
13
          <methodname>mysql_get_client_version</methodname>
 
14
          <methodparam><type>void</type><parameter></parameter></methodparam>
 
15
        </methodsynopsis>
 
16
        <para>Returns a number representing the client library version</para>
 
17
      </refsect1>
 
18
      <refsect1 role="returnvalue">
 
19
        <title>Return value</title>
 
20
        <para>A number representing the version of the client library</para>
 
21
      </refsect1>
 
22
      <refsect1 role="returnvalue">
 
23
        <note>
 
24
          <title></title>
 
25
          <para>To obtain a string containing the client library version use <function>mysql_get_client_info()</function> function.</para>
 
26
        </note> 
 
27
      </refsect1>
 
28
      <refsect1 role="seealso">
 
29
        <title>See also</title>
 
30
        <para><function>mysql_get_client_info()</function></para>
 
31
      </refsect1>
 
32
    </refentry>