<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ibm-db2.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.db2-escape-string.php',
    1 => 'db2_escape_string',
    2 => 'Used to escape certain characters',
  ),
  'up' => 
  array (
    0 => 'ref.ibm-db2.php',
    1 => 'IBM DB2 Functions',
  ),
  'prev' => 
  array (
    0 => 'function.db2-cursor-type.php',
    1 => 'db2_cursor_type',
  ),
  'next' => 
  array (
    0 => 'function.db2-exec.php',
    1 => 'db2_exec',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/ibm_db2/functions/db2-escape-string.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.db2-escape-string" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">db2_escape_string</h1>
  <p class="verinfo">(PECL ibm_db2 &gt;= 1.6.0)</p><p class="refpurpose"><span class="refname">db2_escape_string</span> &mdash; <span class="dc-title">
   Used to escape certain characters
  </span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.db2-escape-string-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>db2_escape_string</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$string_literal</code></span>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

  <p class="simpara">
   Prepends backslashes to special characters in the string argument.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.db2-escape-string-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
    <dt><code class="parameter">string_literal</code></dt>
    <dd>
     <span class="simpara">
      The string that contains special characters that need to be modified.
      Characters that are prepended with a backslash are <code class="literal">\x00</code>,
      <code class="literal">\n</code>, <code class="literal">\r</code>, <code class="literal">\</code>,
      <code class="literal">&#039;</code>, <code class="literal">&quot;</code> and <code class="literal">\x1a</code>.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.db2-escape-string-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="simpara">
   Returns <code class="parameter">string_literal</code> with the special characters
   noted above prepended with backslashes.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.db2-escape-string-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-1">
   <p><strong>Example #1 A <span class="function"><strong>db2_escape_string()</strong></span> example</strong></p>
   <div class="example-contents"><p>
    Result of using the <span class="function"><strong>db2_escape_string()</strong></span> function
   </p></div>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_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 />if (</span><span style="color: #0000BB">$conn</span><span style="color: #007700">) {<br />    </span><span style="color: #0000BB">$str</span><span style="color: #007700">[</span><span style="color: #0000BB">0</span><span style="color: #007700">] = </span><span style="color: #DD0000">"All characters: \x00 , \n , \r , \ , ' , \" , \x1a ."</span><span style="color: #007700">;<br />    </span><span style="color: #0000BB">$str</span><span style="color: #007700">[</span><span style="color: #0000BB">1</span><span style="color: #007700">] = </span><span style="color: #DD0000">"Backslash (\). Single quote ('). Double quote (\")"</span><span style="color: #007700">;<br />    </span><span style="color: #0000BB">$str</span><span style="color: #007700">[</span><span style="color: #0000BB">2</span><span style="color: #007700">] = </span><span style="color: #DD0000">"The NULL character \0 must be quoted as well"</span><span style="color: #007700">;<br />    </span><span style="color: #0000BB">$str</span><span style="color: #007700">[</span><span style="color: #0000BB">3</span><span style="color: #007700">] = </span><span style="color: #DD0000">"Intersting characters: \x1a , \x00 ."</span><span style="color: #007700">;<br />    </span><span style="color: #0000BB">$str</span><span style="color: #007700">[</span><span style="color: #0000BB">4</span><span style="color: #007700">] = </span><span style="color: #DD0000">"Nothing to quote"</span><span style="color: #007700">;<br />    </span><span style="color: #0000BB">$str</span><span style="color: #007700">[</span><span style="color: #0000BB">5</span><span style="color: #007700">] = </span><span style="color: #0000BB">200676</span><span style="color: #007700">;<br />    </span><span style="color: #0000BB">$str</span><span style="color: #007700">[</span><span style="color: #0000BB">6</span><span style="color: #007700">] = </span><span style="color: #DD0000">""</span><span style="color: #007700">;<br /><br />    foreach( </span><span style="color: #0000BB">$str </span><span style="color: #007700">as </span><span style="color: #0000BB">$string </span><span style="color: #007700">) {<br />        echo </span><span style="color: #DD0000">"db2_escape_string: " </span><span style="color: #007700">. </span><span style="color: #0000BB">db2_escape_string</span><span style="color: #007700">(</span><span style="color: #0000BB">$string</span><span style="color: #007700">). </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />    }<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>The above example will output:</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">db2_escape_string: All characters: \0 , \n , \r , \\ , \&#039; , \&quot; , \Z .
db2_escape_string: Backslash (\\). Single quote (\&#039;). Double quote (\&quot;)
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:</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.db2-escape-string-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.db2-prepare.php" class="function" rel="rdfs-seeAlso">db2_prepare()</a> - Prepares an SQL statement to be executed</span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>