← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/funcref/mysql_escape_string.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:
docs/funcref/mysql_escape_string.xml
 
1
<?xml version='1.0' encoding='UTF-8'?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 
3
               "docbook/dtd/xml/4.2/docbookx.dtd" [
 
4
<!ENTITY % global_ents SYSTEM "../global.ent">
 
5
%global_ents;
 
6
]>
 
7
    <refentry id="functions.mysql_escape_string" display-name="0">
 
8
      <refmeta>
 
9
        <refentrytitle>mysql_escape_string</refentrytitle>
 
10
      </refmeta>
 
11
      <refnamediv>
 
12
        <refname>mysql_escape_string</refname>
 
13
        <refpurpose>escapes a string using the default character set</refpurpose>
 
14
      </refnamediv>
 
15
      <refsect1 role="description">
 
16
        <methodsynopsis>
 
17
          <type>unsigned long</type>
 
18
          <methodname>mysql_escape_string</methodname>
 
19
           <methodparam><type>char *</type><parameter>to</parameter></methodparam>
 
20
           <methodparam><type>const char *</type><parameter>from</parameter></methodparam>
 
21
           <methodparam><type>unsigned</type><parameter>long</parameter></methodparam>
 
22
 
 
23
        </methodsynopsis>
 
24
        <warning>
 
25
          <title></title>
 
26
          <para>&deprecated.function;</para>
 
27
          <para>Please use <function>mysql_real_escape_string()</function> instead.</para>
 
28
        </warning>
 
29
      </refsect1>
 
30
      <refsect1 role="seealso">
 
31
        <title>See also</title>
 
32
        <para><function>mysql_real_escape_string()</function></para>
 
33
      </refsect1>
 
34
    </refentry>