php-doc-en/reference/ingres-ii/functions/ingres-escape-string.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

115 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ingres-escape-string" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ingres_escape_string</refname>
<refpurpose>Escape special characters for use in a query</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ingres_escape_string</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>source_string</parameter></methodparam>
</methodsynopsis>
<para>
<function>ingres_escape_string</function> is used to escape certain
characters within a string before it is sent to the database server.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>link</parameter></term>
<listitem>
<para>
The connection link identifier
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>source_string</parameter></term>
<listitem>
<para>
The source string to be parsed
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a string containing the escaped data.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Escape special characters for use in a query</title>
<programlisting role="php">
<![CDATA[
<?php
$link = ingres_connect($database, $user, $password);
$last_name = "O'Connor";
$sql = sprintf("select * from user_profile where up_last = '%s'", ingres_escape_string( $link, $last_name));
$result = ingres_query($link, $sql);
while ($user = ingres_fetch_object($result))
{
echo $user->up_first . '<BR/>';
}
ingres_commit($link);
ingres_close($link);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ingres_query</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->