mboeren Tue Oct 29 09:28:36 2002 EDT
Added files:
/phpdoc/en/reference/dbx/functions dbx-escape-string.xml
Log:
Added documentation for new dbx_escape_string function.
Index: phpdoc/en/reference/dbx/functions/dbx-escape-string.xml
+++ phpdoc/en/reference/dbx/functions/dbx-escape-string.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.dbx-escape-string">
<refnamediv>
<refname>dbx_escape_string</refname>
<refpurpose>
Escape a string so it can safely be used in an sql-statement.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>dbx_escape_string</methodname>
<methodparam><type>object</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>text</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>dbx_escape_string</function> returns the text, escaped
where necessary (such as quotes, backslashes etc). It returns
NULL on error.
</simpara>
<example>
<title><function>dbx_escape_string</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$link = dbx_connect(DBX_MYSQL, "localhost", "db", "username", "password")
or die ("Could not connect");
$text = dbx_escape_string($link, "It\'s quoted and backslashed (\\).");
$result = dbx_query($link, "insert into tbl (txt) values ('".$text."')");
if ( $result == 0 ) {
echo dbx_error ($link);
}
dbx_close ($link);
?>
]]>
</programlisting>
</example>
<note>
<para>
This function is only available in CVS.
</para>
</note>
</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:"../../../../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
-->
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
