<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.sqlsrv.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.sqlsrv-cancel.php',
    1 => 'sqlsrv_cancel',
    2 => 'Cancela uma declara&ccedil;&atilde;o',
  ),
  'up' => 
  array (
    0 => 'ref.sqlsrv.php',
    1 => 'Fun&ccedil;&otilde;es SQLSRV',
  ),
  'prev' => 
  array (
    0 => 'function.sqlsrv-begin-transaction.php',
    1 => 'sqlsrv_begin_transaction',
  ),
  'next' => 
  array (
    0 => 'function.sqlsrv-client-info.php',
    1 => 'sqlsrv_client_info',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/sqlsrv/functions/sqlsrv-cancel.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.sqlsrv-cancel" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">sqlsrv_cancel</h1>
  <p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">sqlsrv_cancel</span> &mdash; <span class="dc-title">Cancela uma declaração</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.sqlsrv-cancel-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>sqlsrv_cancel</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$stmt</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   Cancela uma declaração. Quaisquer resultados associados à declaração que não
   tenham sido consumidos são excluídos. Depois que <span class="function"><strong>sqlsrv_cancel()</strong></span> for
   chamado, a declaração especificada pode ser reexecutada se tiver sido criada com
   <span class="function"><a href="function.sqlsrv-prepare.php" class="function">sqlsrv_prepare()</a></span>. Chamar <span class="function"><strong>sqlsrv_cancel()</strong></span>
   não é necessário se todos os resultados associados à declaração tiverem sido
   consumidos.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.sqlsrv-cancel-parameters">
  <h3 class="title">Parâmetros</h3>
  <dl>
   
    <dt><code class="parameter">stmt</code></dt>
    <dd>
     <span class="simpara">
      O recurso de declaração a ser cancelado.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.sqlsrv-cancel-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="simpara">
   Retorna <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> em caso de sucesso ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> em caso de falha.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.sqlsrv-cancel-examples">
  <h3 class="title">Exemplos</h3>
  <div class="example" id="example-1">
   <p><strong>Exemplo #1 Exemplo de <span class="function"><strong>sqlsrv_cancel()</strong></span></strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$serverName </span><span style="color: #007700">= </span><span style="color: #DD0000">"serverName\sqlexpress"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$connectionInfo </span><span style="color: #007700">= array(</span><span style="color: #DD0000">"Database"</span><span style="color: #007700">=&gt;</span><span style="color: #DD0000">"dbName"</span><span style="color: #007700">, </span><span style="color: #DD0000">"UID"</span><span style="color: #007700">=&gt;</span><span style="color: #DD0000">"username"</span><span style="color: #007700">, </span><span style="color: #DD0000">"PWD"</span><span style="color: #007700">=&gt;</span><span style="color: #DD0000">"password"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">sqlsrv_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$serverName</span><span style="color: #007700">, </span><span style="color: #0000BB">$connectionInfo</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$conn </span><span style="color: #007700">=== </span><span style="color: #0000BB">false</span><span style="color: #007700">) {<br />     die(</span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">sqlsrv_errors</span><span style="color: #007700">(), </span><span style="color: #0000BB">true</span><span style="color: #007700">));<br />}<br /><br /></span><span style="color: #0000BB">$sql </span><span style="color: #007700">= </span><span style="color: #DD0000">"SELECT Sales FROM Table_1"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$stmt </span><span style="color: #007700">= </span><span style="color: #0000BB">sqlsrv_prepare</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #0000BB">$sql</span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">$stmt </span><span style="color: #007700">=== </span><span style="color: #0000BB">false</span><span style="color: #007700">) {<br />     die(</span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">sqlsrv_errors</span><span style="color: #007700">(), </span><span style="color: #0000BB">true</span><span style="color: #007700">));<br />}<br /><br />if (</span><span style="color: #0000BB">sqlsrv_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">) === </span><span style="color: #0000BB">false</span><span style="color: #007700">) {<br />     die(</span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">sqlsrv_errors</span><span style="color: #007700">(), </span><span style="color: #0000BB">true</span><span style="color: #007700">));<br />}<br /><br /></span><span style="color: #0000BB">$salesTotal </span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$count </span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">;<br /><br />while ((</span><span style="color: #0000BB">$row </span><span style="color: #007700">= </span><span style="color: #0000BB">sqlsrv_fetch_array</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">)) &amp;&amp; </span><span style="color: #0000BB">$salesTotal </span><span style="color: #007700">&lt;=</span><span style="color: #0000BB">100000</span><span style="color: #007700">)<br />{<br />     </span><span style="color: #0000BB">$qty </span><span style="color: #007700">= </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #0000BB">0</span><span style="color: #007700">];<br />     </span><span style="color: #0000BB">$price </span><span style="color: #007700">= </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #0000BB">1</span><span style="color: #007700">];<br />     </span><span style="color: #0000BB">$salesTotal </span><span style="color: #007700">+= (</span><span style="color: #0000BB">$price </span><span style="color: #007700">* </span><span style="color: #0000BB">$qty</span><span style="color: #007700">);<br />     </span><span style="color: #0000BB">$count</span><span style="color: #007700">++;<br />}<br /><br />echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$count</span><span style="color: #DD0000"> sales accounted for the first $</span><span style="color: #0000BB">$salesTotal</span><span style="color: #DD0000"> in revenue.&lt;br /&gt;"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// Cancela os resultados pendentes. A declaração pode ser reutilizada.<br /></span><span style="color: #0000BB">sqlsrv_cancel</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 notes" id="refsect1-function.sqlsrv-cancel-notes">
  <h3 class="title">Notas</h3>
  <p class="simpara">
   A principal diferença entre <span class="function"><strong>sqlsrv_cancel()</strong></span> e
   <span class="function"><a href="function.sqlsrv-free-stmt.php" class="function">sqlsrv_free_stmt()</a></span> é que um recurso de declaração cancelado com
   <span class="function"><strong>sqlsrv_cancel()</strong></span> pode ser reexecutado se tiver sido criado com
   <span class="function"><a href="function.sqlsrv-prepare.php" class="function">sqlsrv_prepare()</a></span>. Um recurso de declaração cancelado com
   <span class="function"><strong>sqlsrv_free_statement()</strong></span> não pode ser reexecutado.
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.sqlsrv-cancel-seealso">
  <h3 class="title">Veja Também</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.sqlsrv-free-stmt.php" class="function" rel="rdfs-seeAlso">sqlsrv_free_stmt()</a> - Libera todos os recursos para a declara&ccedil;&atilde;o especificada</span></li>
   <li><span class="function"><a href="function.sqlsrv-prepare.php" class="function" rel="rdfs-seeAlso">sqlsrv_prepare()</a> - Prepara uma consulta para execu&ccedil;&atilde;o</span></li>
  </ul>
 </div>

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