<?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 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.sqlsrv-rollback.php',
    1 => 'sqlsrv_rollback',
    2 => 'Rolls back a transaction that was begun with
  sqlsrv_begin_transaction',
  ),
  'up' => 
  array (
    0 => 'ref.sqlsrv.php',
    1 => 'SQLSRV Functions',
  ),
  'prev' => 
  array (
    0 => 'function.sqlsrv-query.php',
    1 => 'sqlsrv_query',
  ),
  'next' => 
  array (
    0 => 'function.sqlsrv-rows-affected.php',
    1 => 'sqlsrv_rows_affected',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/sqlsrv/functions/sqlsrv-rollback.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.sqlsrv-rollback" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">sqlsrv_rollback</h1>
  <p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">sqlsrv_rollback</span> &mdash; <span class="dc-title">Rolls back a transaction that was begun with
  <span class="function"><a href="function.sqlsrv-begin-transaction.php" class="function">sqlsrv_begin_transaction()</a></span></span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.sqlsrv-rollback-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>sqlsrv_rollback</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$conn</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   Rolls back a transaction that was begun with <span class="function"><a href="function.sqlsrv-begin-transaction.php" class="function">sqlsrv_begin_transaction()</a></span>
   and returns the connection to auto-commit mode.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.sqlsrv-rollback-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
    <dt><code class="parameter">conn</code></dt>
    <dd>
     <span class="simpara">
      The connection resource returned by a call to <span class="function"><a href="function.sqlsrv-connect.php" class="function">sqlsrv_connect()</a></span>.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.sqlsrv-rollback-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="simpara">
   Returns <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on failure.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.sqlsrv-rollback-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-1">
   <p><strong>Example #1 <span class="function"><strong>sqlsrv_rollback()</strong></span> example</strong></p>
   <div class="example-contents"><p>
   The following example demonstrates how to use <span class="function"><a href="function.sqlsrv-begin-transaction.php" class="function">sqlsrv_begin_transaction()</a></span>
   together with <span class="function"><a href="function.sqlsrv-commit.php" class="function">sqlsrv_commit()</a></span> and <span class="function"><strong>sqlsrv_rollback()</strong></span>.
   </p></div>
   <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: #FF8000">/* Begin the transaction. */<br /></span><span style="color: #007700">if ( </span><span style="color: #0000BB">sqlsrv_begin_transaction</span><span style="color: #007700">( </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: #FF8000">/* Initialize parameter values. */<br /></span><span style="color: #0000BB">$orderId </span><span style="color: #007700">= </span><span style="color: #0000BB">1</span><span style="color: #007700">; </span><span style="color: #0000BB">$qty </span><span style="color: #007700">= </span><span style="color: #0000BB">10</span><span style="color: #007700">; </span><span style="color: #0000BB">$productId </span><span style="color: #007700">= </span><span style="color: #0000BB">100</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">/* Set up and execute the first query. */<br /></span><span style="color: #0000BB">$sql1 </span><span style="color: #007700">= </span><span style="color: #DD0000">"INSERT INTO OrdersTable (ID, Quantity, ProductID)<br />         VALUES (?, ?, ?)"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$params1 </span><span style="color: #007700">= array( </span><span style="color: #0000BB">$orderId</span><span style="color: #007700">, </span><span style="color: #0000BB">$qty</span><span style="color: #007700">, </span><span style="color: #0000BB">$productId </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$stmt1 </span><span style="color: #007700">= </span><span style="color: #0000BB">sqlsrv_query</span><span style="color: #007700">( </span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #0000BB">$sql1</span><span style="color: #007700">, </span><span style="color: #0000BB">$params1 </span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Set up and execute the second query. */<br /></span><span style="color: #0000BB">$sql2 </span><span style="color: #007700">= </span><span style="color: #DD0000">"UPDATE InventoryTable<br />         SET Quantity = (Quantity - ?)<br />         WHERE ProductID = ?"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$params2 </span><span style="color: #007700">= array(</span><span style="color: #0000BB">$qty</span><span style="color: #007700">, </span><span style="color: #0000BB">$productId</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$stmt2 </span><span style="color: #007700">= </span><span style="color: #0000BB">sqlsrv_query</span><span style="color: #007700">( </span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #0000BB">$sql2</span><span style="color: #007700">, </span><span style="color: #0000BB">$params2 </span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* If both queries were successful, commit the transaction. */<br />/* Otherwise, rollback the transaction. */<br /></span><span style="color: #007700">if( </span><span style="color: #0000BB">$stmt1 </span><span style="color: #007700">&amp;&amp; </span><span style="color: #0000BB">$stmt2 </span><span style="color: #007700">) {<br />     </span><span style="color: #0000BB">sqlsrv_commit</span><span style="color: #007700">( </span><span style="color: #0000BB">$conn </span><span style="color: #007700">);<br />     echo </span><span style="color: #DD0000">"Transaction committed.&lt;br /&gt;"</span><span style="color: #007700">;<br />} else {<br />     </span><span style="color: #0000BB">sqlsrv_rollback</span><span style="color: #007700">( </span><span style="color: #0000BB">$conn </span><span style="color: #007700">);<br />     echo </span><span style="color: #DD0000">"Transaction rolled back.&lt;br /&gt;"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.sqlsrv-rollback-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.sqlsrv-begin-transaction.php" class="function" rel="rdfs-seeAlso">sqlsrv_begin_transaction()</a> - Begins a database transaction</span></li>
   <li><span class="function"><a href="function.sqlsrv-commit.php" class="function" rel="rdfs-seeAlso">sqlsrv_commit()</a> - Commits a transaction that was begun with sqlsrv_begin_transaction</span></li>
  </ul>
 </div>

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