mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
125 lines
3.3 KiB
XML
125 lines
3.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.db2-escape-string" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>db2_escape_string</refname>
|
|
<refpurpose>
|
|
Used to escape certain characters
|
|
</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>db2_escape_string</methodname>
|
|
<methodparam><type>string</type><parameter>string_literal</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Prepends backslashes to special characters in the string argument.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>string_literal</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The string that contains special characters that need to be modified.
|
|
Characters that are prepended with a backslash are <literal>\x00</literal>,
|
|
<literal>\n</literal>, <literal>\r</literal>, <literal>\</literal>,
|
|
<literal>'</literal>, <literal>"</literal> and <literal>\x1a</literal>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns <parameter>string_literal</parameter> with the special characters
|
|
noted above prepended with backslashes.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>A <function>db2_escape_string</function> example</title>
|
|
<para>
|
|
Result of using the <function>db2_escape_string</function> function
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$conn = db2_connect($database, $user, $password);
|
|
|
|
if ($conn) {
|
|
$str[0] = "All characters: \x00 , \n , \r , \ , ' , \" , \x1a .";
|
|
$str[1] = "Backslash (\). Single quote ('). Double quote (\")";
|
|
$str[2] = "The NULL character \0 must be quoted as well";
|
|
$str[3] = "Intersting characters: \x1a , \x00 .";
|
|
$str[4] = "Nothing to quote";
|
|
$str[5] = 200676;
|
|
$str[6] = "";
|
|
|
|
foreach( $str as $string ) {
|
|
echo "db2_escape_string: " . db2_escape_string($string). "\n";
|
|
}
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
db2_escape_string: All characters: \0 , \n , \r , \\ , \' , \" , \Z .
|
|
db2_escape_string: Backslash (\\). Single quote (\'). Double quote (\")
|
|
db2_escape_string: The NULL character \0 must be quoted as well
|
|
db2_escape_string: Intersting characters: \Z , \0 .
|
|
db2_escape_string: Nothing to quote
|
|
db2_escape_string: 200676
|
|
db2_escape_string:
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>db2_prepare</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
|
|
-->
|