Source of: /manual/en/function.ingres-escape-string.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ingres.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.ingres-escape-string.php',
1 => 'ingres_escape_string',
),
'up' =>
array (
0 => 'ref.ingres.php',
1 => 'Ingres Functions',
),
'prev' =>
array (
0 => 'function.ingres-errsqlstate.php',
1 => 'ingres_errsqlstate',
),
'next' =>
array (
0 => 'function.ingres-execute.php',
1 => 'ingres_execute',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.ingres-escape-string" class="refentry">
<div class="refnamediv">
<h1 class="refname">ingres_escape_string</h1>
<p class="verinfo">(PECL ingres >= 2.1.0)</p><p class="refpurpose"><span class="refname">ingres_escape_string</span> — <span class="dc-title">Escape special characters for use in a query</span></p>
</div>
<a name="function.ingres-escape-string.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><b>ingres_escape_string</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$link</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$source_string</tt></span>
)</div>
<p class="para rdfs-comment">
<b>ingres_escape_string()</b> is used to escape certain
characters within a string before it is sent to the database server.
</p>
</div>
<a name="function.ingres-escape-string.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">link</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The connection link identifier
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">source_string</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The source string to be parsed
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.ingres-escape-string.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a string containing the escaped data.
</p>
</div>
<a name="function.ingres-escape-string.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 Escape special characters for use in a query</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$link </span><span style="color: #007700">= </span><span style="color: #0000BB">ingres_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$database</span><span style="color: #007700">, </span><span style="color: #0000BB">$user</span><span style="color: #007700">, </span><span style="color: #0000BB">$password</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$last_name </span><span style="color: #007700">= </span><span style="color: #DD0000">"O'Connor"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$sql </span><span style="color: #007700">= </span><span style="color: #0000BB">sprintf</span><span style="color: #007700">(</span><span style="color: #DD0000">"select * from user_profile where up_last = '%s'"</span><span style="color: #007700">, </span><span style="color: #0000BB">ingres_escape_string</span><span style="color: #007700">( </span><span style="color: #0000BB">$link</span><span style="color: #007700">, </span><span style="color: #0000BB">$last_name</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">ingres_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">, </span><span style="color: #0000BB">$sql</span><span style="color: #007700">);<br /><br />while (</span><span style="color: #0000BB">$user </span><span style="color: #007700">= </span><span style="color: #0000BB">ingres_fetch_object</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">))<br />{<br /> echo </span><span style="color: #0000BB">$user</span><span style="color: #007700">-></span><span style="color: #0000BB">up_first </span><span style="color: #007700">. </span><span style="color: #DD0000">'<BR/>'</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">ingres_commit</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">ingres_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.ingres-escape-string.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.ingres-query.php" class="function" rel="rdfs-seeAlso">ingres_query()</a> - Send an SQL query to Ingres</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>