<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdbuserror.cpp -->
<title>Qt 4.8: QDBusError Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtdbus.html">QtDBus</a></li>
<li>QDBusError</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QDBusError Class Reference</h1>
<!-- $$$QDBusError-brief -->
<p>The QDBusError class represents an error received from the D-Bus bus or from remote applications found in the bus. <a href="#details">More...</a></p>
<!-- @@@QDBusError -->
<pre class="cpp"> <span class="preprocessor">#include <QDBusError></span></pre><p>This class was introduced in Qt 4.2.</p>
<ul>
<li><a href="qdbuserror-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qdbuserror.html#ErrorType-enum">ErrorType</a></b> { NoError, Other, Failed, NoMemory, ..., UnknownObject }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qdbuserror.html#isValid">isValid</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qdbuserror.html#message">message</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qdbuserror.html#name">name</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> ErrorType </td><td class="memItemRight bottomAlign"><b><a href="qdbuserror.html#type">type</a></b> () const</td></tr>
</table>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qdbuserror.html#errorString">errorString</a></b> ( ErrorType <i>error</i> )</td></tr>
</table>
<a name="details"></a>
<!-- $$$QDBusError-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QDBusError class represents an error received from the D-Bus bus or from remote applications found in the bus.</p>
<p>When dealing with the D-Bus bus service or with remote applications over D-Bus, a number of error conditions can happen. This error conditions are sometimes signalled by a returned error value or by a QDBusError.</p>
<p>C++ and Java exceptions are a valid analogy for D-Bus errors: instead of returning normally with a return value, remote applications and the bus may decide to throw an error condition. However, the <a href="qtdbus.html">QtDBus</a> implementation does not use the C++ exception-throwing mechanism, so you will receive QDBusErrors in the return reply (see <a href="qdbusreply.html#error">QDBusReply::error</a>()).</p>
<p>QDBusError objects are used to inspect the error name and message as received from the bus and remote applications. You should not create such objects yourself to signal error conditions when called from D-Bus: instead, use <a href="qdbusmessage.html#createError">QDBusMessage::createError</a>() and <a href="qdbusconnection.html#send">QDBusConnection::send</a>().</p>
</div>
<p><b>See also </b><a href="qdbusconnection.html#send">QDBusConnection::send</a>(), <a href="qdbusmessage.html">QDBusMessage</a>, and <a href="qdbusreply.html">QDBusReply</a>.</p>
<!-- @@@QDBusError -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$ErrorType$$$NoError$$$Other$$$Failed$$$NoMemory$$$ServiceUnknown$$$NoReply$$$BadAddress$$$NotSupported$$$LimitsExceeded$$$AccessDenied$$$NoServer$$$Timeout$$$NoNetwork$$$AddressInUse$$$Disconnected$$$InvalidArgs$$$UnknownMethod$$$TimedOut$$$InvalidSignature$$$UnknownInterface$$$InternalError$$$UnknownObject$$$InvalidService$$$InvalidObjectPath$$$InvalidInterface$$$InvalidMember -->
<h3 class="fn"><a name="ErrorType-enum"></a>enum QDBusError::<span class="name">ErrorType</span></h3>
<p>In order to facilitate verification of the most common D-Bus errors generated by the D-Bus implementation and by the bus daemon itself, <a href="qdbuserror.html">QDBusError</a> can be compared to a set of pre-defined values:</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QDBusError::NoError</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign"><a href="qdbuserror.html">QDBusError</a> is invalid (i.e., the call succeeded)</td></tr>
<tr><td class="topAlign"><tt>QDBusError::Other</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign"><a href="qdbuserror.html">QDBusError</a> contains an error that is one of the well-known ones</td></tr>
<tr><td class="topAlign"><tt>QDBusError::Failed</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The call failed (<tt>org.freedesktop.DBus.Error.Failed</tt>)</td></tr>
<tr><td class="topAlign"><tt>QDBusError::NoMemory</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">Out of memory (<tt>org.freedesktop.DBus.Error.NoMemory</tt>)</td></tr>
<tr><td class="topAlign"><tt>QDBusError::ServiceUnknown</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">The called service is not known (<tt>org.freedesktop.DBus.Error.ServiceUnknown</tt>)</td></tr>
<tr><td class="topAlign"><tt>QDBusError::NoReply</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">The called method did not reply within the specified timeout (<tt>org.freedesktop.DBus.Error.NoReply</tt>)</td></tr>
<tr><td class="topAlign"><tt>QDBusError::BadAddress</tt></td><td class="topAlign"><tt>6</tt></td><td class="topAlign">The address given is not valid (<tt>org.freedesktop.DBus.Error.BadAddress</tt>)</td></tr>
<tr><td class="topAlign"><tt>QDBusError::NotSupported</tt></td><td class="topAlign"><tt>7</tt></td><td class="topAlign">The call/operation is not supported (<tt>org.freedesktop.DBus.Error.NotSupported</tt>)</td></tr>
<tr><td class="topAlign"><tt>QDBusError::LimitsExceeded</tt></td><td class="topAlign"><tt>8</tt></td><td class="topAlign">The limits allocated to this process/call/connection exceeded the pre-defined values (<tt>org.freedesktop.DBus.Error.LimitsExceeded</tt>)</td></tr>
<tr><td class="topAlign"><tt>QDBusError::AccessDenied</tt></td><td class="topAlign"><tt>9</tt></td><td class="topAlign">The call/operation tried to access a resource it isn't allowed to (<tt>org.freedesktop.DBus.Error.AccessDenied</tt>)</td></tr>
<tr><td class="topAlign"><tt>QDBusError::NoServer</tt></td><td class="topAlign"><tt>10</tt></td><td class="topAlign"><i>Documentation doesn't say what this is for</i> (<tt>org.freedesktop.DBus.Error.NoServer</tt>)</td></tr>
<tr><td class="topAlign"><tt>QDBusError::Timeout</tt></td><td class="topAlign"><tt>11</tt></td><td class="topAlign"><i>Documentation doesn't say what this is for or how it's used</i> (<tt>org.freedesktop.DBus.Error.Timeout</tt>)</td></tr>
<tr><td class="topAlign"><tt>QDBusError::NoNetwork</tt></td><td class="topAlign"><tt>12</tt></td><td class="topAlign"><i>Documentation doesn't say what this is for</i> (<tt>org.freedesktop.DBus.Error.NoNetwork</tt>)</td></tr>
<tr><td class="topAlign"><tt>QDBusError::AddressInUse</tt></td><td class="topAlign"><tt>13</tt></td><td class="topAlign">QDBusServer tried to bind to an address that is already in use (<tt>org.freedesktop.DBus.Error.AddressInUse</tt>)</td></tr>
<tr><td class="topAlign"><tt>QDBusError::Disconnected</tt></td><td class="topAlign"><tt>14</tt></td><td class="topAlign">The call/process/message was sent after <a href="qdbusconnection.html">QDBusConnection</a> disconnected (<tt>org.freedesktop.DBus.Error.Disconnected</tt>)</td></tr>
<tr><td class="topAlign"><tt>QDBusError::InvalidArgs</tt></td><td class="topAlign"><tt>15</tt></td><td class="topAlign">The arguments passed to this call/operation are not valid (<tt>org.freedesktop.DBus.Error.InvalidArgs</tt>)</td></tr>
<tr><td class="topAlign"><tt>QDBusError::UnknownMethod</tt></td><td class="topAlign"><tt>16</tt></td><td class="topAlign">The method called was not found in this object/interface with the given parameters (<tt>org.freedesktop.DBus.Error.UnknownMethod</tt>)</td></tr>
<tr><td class="topAlign"><tt>QDBusError::TimedOut</tt></td><td class="topAlign"><tt>17</tt></td><td class="topAlign"><i>Documentation doesn't say...</i> (<tt>org.freedesktop.DBus.Error.TimedOut</tt>)</td></tr>
<tr><td class="topAlign"><tt>QDBusError::InvalidSignature</tt></td><td class="topAlign"><tt>18</tt></td><td class="topAlign">The type signature is not valid or compatible (<tt>org.freedesktop.DBus.Error.InvalidSignature</tt>)</td></tr>
<tr><td class="topAlign"><tt>QDBusError::UnknownInterface</tt></td><td class="topAlign"><tt>19</tt></td><td class="topAlign">The interface is not known</td></tr>
<tr><td class="topAlign"><tt>QDBusError::InternalError</tt></td><td class="topAlign"><tt>20</tt></td><td class="topAlign">An internal error occurred (<tt>com.trolltech.QtDBus.Error.InternalError</tt>)</td></tr>
<tr><td class="topAlign"><tt>QDBusError::InvalidObjectPath</tt></td><td class="topAlign"><tt>23</tt></td><td class="topAlign">The object path provided is invalid.</td></tr>
<tr><td class="topAlign"><tt>QDBusError::InvalidService</tt></td><td class="topAlign"><tt>22</tt></td><td class="topAlign">The service requested is invalid.</td></tr>
<tr><td class="topAlign"><tt>QDBusError::InvalidMember</tt></td><td class="topAlign"><tt>25</tt></td><td class="topAlign">The member is invalid.</td></tr>
<tr><td class="topAlign"><tt>QDBusError::InvalidInterface</tt></td><td class="topAlign"><tt>24</tt></td><td class="topAlign">The interface is invalid.</td></tr>
<tr><td class="topAlign"><tt>QDBusError::UnknownObject</tt></td><td class="topAlign"><tt>21</tt></td><td class="topAlign">The remote object could not be found.</td></tr>
</table>
<!-- @@@ErrorType -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$errorString[overload1]$$$errorStringErrorType -->
<h3 class="fn"><a name="errorString"></a><span class="type"><a href="qstring.html">QString</a></span> QDBusError::<span class="name">errorString</span> ( <span class="type"><a href="qdbuserror.html#ErrorType-enum">ErrorType</a></span> <i>error</i> )<tt> [static]</tt></h3>
<p>Returns the error name associated with error condition <i>error</i>.</p>
<p>This function was introduced in Qt 4.3.</p>
<!-- @@@errorString -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn"><a name="isValid"></a><span class="type">bool</span> QDBusError::<span class="name">isValid</span> () const</h3>
<p>Returns true if this is a valid error condition (i.e., if there was an error), otherwise false.</p>
<!-- @@@isValid -->
<!-- $$$message[overload1]$$$message -->
<h3 class="fn"><a name="message"></a><span class="type"><a href="qstring.html">QString</a></span> QDBusError::<span class="name">message</span> () const</h3>
<p>Returns the message that the callee associated with this error. Error messages are implementation defined and usually contain a human-readable error code, though this does not mean it is suitable for your end-users.</p>
<!-- @@@message -->
<!-- $$$name[overload1]$$$name -->
<h3 class="fn"><a name="name"></a><span class="type"><a href="qstring.html">QString</a></span> QDBusError::<span class="name">name</span> () const</h3>
<p>Returns this error's name. Error names are similar to D-Bus Interface names, like <tt>org.freedesktop.DBus.InvalidArgs</tt>.</p>
<p><b>See also </b><a href="qdbuserror.html#type">type</a>().</p>
<!-- @@@name -->
<!-- $$$type[overload1]$$$type -->
<h3 class="fn"><a name="type"></a><span class="type"><a href="qdbuserror.html#ErrorType-enum">ErrorType</a></span> QDBusError::<span class="name">type</span> () const</h3>
<p>Returns this error's <a href="qdbuserror.html#ErrorType-enum">ErrorType</a>.</p>
<p><b>See also </b><a href="qdbuserror.html#ErrorType-enum">ErrorType</a>.</p>
<!-- @@@type -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Digia, Qt and their respective logos are trademarks of Digia Plc
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
