| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.9.1"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Proton DotNet: Apache.Qpid.Proton.Client.IErrorCondition Interface Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Proton DotNet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.1 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceApache.html">Apache</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid.html">Qpid</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton.html">Proton</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html">Client</a></li><li class="navelem"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html">IErrorCondition</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Client.IErrorCondition Interface Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>An immutable error condition that carries information that aids in determining the factors that lead to the error. |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Client.IErrorCondition:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.png" usemap="#Apache.Qpid.Proton.Client.IErrorCondition_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Client.IErrorCondition_map" name="Apache.Qpid.Proton.Client.IErrorCondition_map"> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientErrorCondition.html" title="Client error condition implementation which serves as a layer over the proton based version allowing ..." alt="Apache.Qpid.Proton.Client.Implementation.ClientErrorCondition" shape="rect" coords="0,56,369,80"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:ae1491cf1b2623be8898a6c73b9b1886f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html">IErrorCondition</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html#ae1491cf1b2623be8898a6c73b9b1886f">Create</a> (string condition, string description, IDictionary< string, object > info=null)</td></tr> |
| <tr class="memdesc:ae1491cf1b2623be8898a6c73b9b1886f"><td class="mdescLeft"> </td><td class="mdescRight">Create an error condition object using the supplied values. The condition string cannot be null however the other attribute can. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html#ae1491cf1b2623be8898a6c73b9b1886f">More...</a><br /></td></tr> |
| <tr class="separator:ae1491cf1b2623be8898a6c73b9b1886f"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:ae7a42a43a98e0930c0c2164b8839f5bb"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html#ae7a42a43a98e0930c0c2164b8839f5bb">Condition</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ae7a42a43a98e0930c0c2164b8839f5bb"><td class="mdescLeft"> </td><td class="mdescRight">Indicates the type of error that this condition conveys <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html#ae7a42a43a98e0930c0c2164b8839f5bb">More...</a><br /></td></tr> |
| <tr class="separator:ae7a42a43a98e0930c0c2164b8839f5bb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae3394e64097b231b8c1685881410e125"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html#ae3394e64097b231b8c1685881410e125">Description</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ae3394e64097b231b8c1685881410e125"><td class="mdescLeft"> </td><td class="mdescRight">A description of the condition that resulted in this error. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html#ae3394e64097b231b8c1685881410e125">More...</a><br /></td></tr> |
| <tr class="separator:ae3394e64097b231b8c1685881410e125"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af61ebb02a10d9d8f6fca5696285752e0"><td class="memItemLeft" align="right" valign="top">IReadOnlyDictionary< string, object > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html#af61ebb02a10d9d8f6fca5696285752e0">Info</a><code> [get]</code></td></tr> |
| <tr class="memdesc:af61ebb02a10d9d8f6fca5696285752e0"><td class="mdescLeft"> </td><td class="mdescRight">Optional supplementary information that aids in processing this error. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html#af61ebb02a10d9d8f6fca5696285752e0">More...</a><br /></td></tr> |
| <tr class="separator:af61ebb02a10d9d8f6fca5696285752e0"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>An immutable error condition that carries information that aids in determining the factors that lead to the error. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ae1491cf1b2623be8898a6c73b9b1886f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae1491cf1b2623be8898a6c73b9b1886f">◆ </a></span>Create()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html">IErrorCondition</a> Apache.Qpid.Proton.Client.IErrorCondition.Create </td> |
| <td>(</td> |
| <td class="paramtype">string </td> |
| <td class="paramname"><em>condition</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">string </td> |
| <td class="paramname"><em>description</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">IDictionary< string, object > </td> |
| <td class="paramname"><em>info</em> = <code>null</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create an error condition object using the supplied values. The condition string cannot be null however the other attribute can. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">condition</td><td>The string error condition symbolic name</td></tr> |
| <tr><td class="paramname">description</td><td>Description of the error</td></tr> |
| <tr><td class="paramname">info</td><td>Optional dictionary containing addition error information</info> <dl class="section return"><dt>Returns</dt><dd></dd></dl> |
| </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="ae7a42a43a98e0930c0c2164b8839f5bb"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae7a42a43a98e0930c0c2164b8839f5bb">◆ </a></span>Condition</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string Apache.Qpid.Proton.Client.IErrorCondition.Condition</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Indicates the type of error that this condition conveys </p> |
| |
| </div> |
| </div> |
| <a id="ae3394e64097b231b8c1685881410e125"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae3394e64097b231b8c1685881410e125">◆ </a></span>Description</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string Apache.Qpid.Proton.Client.IErrorCondition.Description</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>A description of the condition that resulted in this error. </p> |
| |
| </div> |
| </div> |
| <a id="af61ebb02a10d9d8f6fca5696285752e0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af61ebb02a10d9d8f6fca5696285752e0">◆ </a></span>Info</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">IReadOnlyDictionary<string, object> Apache.Qpid.Proton.Client.IErrorCondition.Info</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Optional supplementary information that aids in processing this error. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this interface was generated from the following file:<ul> |
| <li>src/Proton.Client/Client/IErrorCondition.cs</li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 |
| </small></address> |
| </body> |
| </html> |
