<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Rolls back a distributed/XA transaction among MySQL servers</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mysqlnd-ms-xa-gc.html">mysqlnd_ms_xa_gc</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysqlnd-ms.changes.html">Change History</a></div>
<div class="up"><a href="ref.mysqlnd-ms.html">Mysqlnd_ms Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.mysqlnd-ms-xa-rollback" class="refentry">
<div class="refnamediv">
<h1 class="refname">mysqlnd_ms_xa_rollback</h1>
<p class="verinfo">(PECL mysqlnd_ms < 1.6.0)</p><p class="refpurpose"><span class="refname">mysqlnd_ms_xa_rollback</span> — <span class="dc-title">Rolls back a distributed/XA transaction among MySQL servers</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.mysqlnd-ms-xa-rollback-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span>
<span class="methodname"><strong>mysqlnd_ms_xa_rollback</strong></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$connection</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$gtrid</code></span>
)</div>
<p class="para rdfs-comment">
Rolls back a global transaction among MySQL servers started by
<span class="function"><a href="function.mysqlnd-ms-xa-begin.html" class="function">mysqlnd_ms_xa_begin()</a></span>.
</p>
<p class="para">
If any of the global transaction participants fails to rollback
the situation is left to be solved by the garbage collection.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<strong>Experimental</strong><br />
<p class="para">
The feature is currently under development. There may be issues and/or
feature limitations. Do not use in production environments.
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-function.mysqlnd-ms-xa-rollback-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">connection</code></dt>
<dd>
<p class="para">
A MySQL connection handle obtained from any of the
connect functions of the <a href="ref.mysqli.html" class="link">mysqli</a>,
<a href="ref.mysql.html" class="link">mysql</a> or
<a href="ref.pdo-mysql.html" class="link">PDO_MYSQL</a> extensions.
</p>
</dd>
<dt>
<code class="parameter">gtrid</code></dt>
<dd>
<p class="para">
Global transaction identifier (gtrid).
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.mysqlnd-ms-xa-rollback-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> if the global transaction has been rolled back. Otherwise, returns <strong><code>FALSE</code></strong>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.mysqlnd-ms-xa-rollback-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member">
<a href="mysqlnd-ms.quickstart.xa_transactions.html" class="link">Quickstart XA/Distributed transactions</a>
</li>
<li class="member">
<a href="mysqlnd-ms.configuration.html" class="link">Runtime configuration</a>
</li>
<li class="member">
<span class="function"><a href="function.mysqlnd-ms-get-stats.html" class="function" rel="rdfs-seeAlso">mysqlnd_ms_get_stats()</a> - Returns query distribution and connection statistics</span>
</li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mysqlnd-ms-xa-gc.html">mysqlnd_ms_xa_gc</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysqlnd-ms.changes.html">Change History</a></div>
<div class="up"><a href="ref.mysqlnd-ms.html">Mysqlnd_ms Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
