| <!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.8.20"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Qpid Proton C API: Error</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="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.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> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function() { init_search(); }); |
| /* @license-end */ |
| </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">Qpid Proton C API |
|  <span id="projectnumber">0.32.0</span> |
| </div> |
| </td> |
| <td> <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.svg" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a> |
| </span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.20 --> |
| <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'); |
| /* @license-end */ |
| </script> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('group__error.html',''); initResizable(); }); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- 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 class="header"> |
| <div class="summary"> |
| <a href="#define-members">Macros</a> | |
| <a href="#typedef-members">Typedefs</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">Error<div class="ingroups"><a class="el" href="group__core.html">Core</a></div></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A Proton API error. |
| <a href="#details">More...</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> |
| Macros</h2></td></tr> |
| <tr class="memitem:gac73fbd2363c5f562f85dde459e631394"><td class="memItemLeft" align="right" valign="top"><a id="gac73fbd2363c5f562f85dde459e631394"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#gac73fbd2363c5f562f85dde459e631394">PN_OK</a></td></tr> |
| <tr class="memdesc:gac73fbd2363c5f562f85dde459e631394"><td class="mdescLeft"> </td><td class="mdescRight">No error. <br /></td></tr> |
| <tr class="separator:gac73fbd2363c5f562f85dde459e631394"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga9e0f51b097f94293cdbbdeb5422a27a3"><td class="memItemLeft" align="right" valign="top"><a id="ga9e0f51b097f94293cdbbdeb5422a27a3"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#ga9e0f51b097f94293cdbbdeb5422a27a3">PN_EOS</a></td></tr> |
| <tr class="memdesc:ga9e0f51b097f94293cdbbdeb5422a27a3"><td class="mdescLeft"> </td><td class="mdescRight">End of stream. <br /></td></tr> |
| <tr class="separator:ga9e0f51b097f94293cdbbdeb5422a27a3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga664f7bdd616c30b72bd50bcc17839c81"><td class="memItemLeft" align="right" valign="top"><a id="ga664f7bdd616c30b72bd50bcc17839c81"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#ga664f7bdd616c30b72bd50bcc17839c81">PN_ERR</a></td></tr> |
| <tr class="memdesc:ga664f7bdd616c30b72bd50bcc17839c81"><td class="mdescLeft"> </td><td class="mdescRight">General error. <br /></td></tr> |
| <tr class="separator:ga664f7bdd616c30b72bd50bcc17839c81"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaaeef136648e1fd51c2b56c0265fa86f7"><td class="memItemLeft" align="right" valign="top"><a id="gaaeef136648e1fd51c2b56c0265fa86f7"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#gaaeef136648e1fd51c2b56c0265fa86f7">PN_OVERFLOW</a></td></tr> |
| <tr class="memdesc:gaaeef136648e1fd51c2b56c0265fa86f7"><td class="mdescLeft"> </td><td class="mdescRight">Overflow error. <br /></td></tr> |
| <tr class="separator:gaaeef136648e1fd51c2b56c0265fa86f7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga3317339fb405435df42fa93d62f0e14c"><td class="memItemLeft" align="right" valign="top"><a id="ga3317339fb405435df42fa93d62f0e14c"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#ga3317339fb405435df42fa93d62f0e14c">PN_UNDERFLOW</a></td></tr> |
| <tr class="memdesc:ga3317339fb405435df42fa93d62f0e14c"><td class="mdescLeft"> </td><td class="mdescRight">Underflow error. <br /></td></tr> |
| <tr class="separator:ga3317339fb405435df42fa93d62f0e14c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga5efbe6093556326613d2ccd3864a00aa"><td class="memItemLeft" align="right" valign="top"><a id="ga5efbe6093556326613d2ccd3864a00aa"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#ga5efbe6093556326613d2ccd3864a00aa">PN_STATE_ERR</a></td></tr> |
| <tr class="memdesc:ga5efbe6093556326613d2ccd3864a00aa"><td class="mdescLeft"> </td><td class="mdescRight">State error. <br /></td></tr> |
| <tr class="separator:ga5efbe6093556326613d2ccd3864a00aa"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga5551b7172de89dc540bd7c2beedd325a"><td class="memItemLeft" align="right" valign="top"><a id="ga5551b7172de89dc540bd7c2beedd325a"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#ga5551b7172de89dc540bd7c2beedd325a">PN_ARG_ERR</a></td></tr> |
| <tr class="memdesc:ga5551b7172de89dc540bd7c2beedd325a"><td class="mdescLeft"> </td><td class="mdescRight">Argument error. <br /></td></tr> |
| <tr class="separator:ga5551b7172de89dc540bd7c2beedd325a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga8bcf4aa6de1a6530713839bcae97d4a2"><td class="memItemLeft" align="right" valign="top"><a id="ga8bcf4aa6de1a6530713839bcae97d4a2"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#ga8bcf4aa6de1a6530713839bcae97d4a2">PN_TIMEOUT</a></td></tr> |
| <tr class="memdesc:ga8bcf4aa6de1a6530713839bcae97d4a2"><td class="mdescLeft"> </td><td class="mdescRight">Timeout. <br /></td></tr> |
| <tr class="separator:ga8bcf4aa6de1a6530713839bcae97d4a2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga53284958be0c328f90ca3a4a0793d965"><td class="memItemLeft" align="right" valign="top"><a id="ga53284958be0c328f90ca3a4a0793d965"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#ga53284958be0c328f90ca3a4a0793d965">PN_INTR</a></td></tr> |
| <tr class="memdesc:ga53284958be0c328f90ca3a4a0793d965"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt. <br /></td></tr> |
| <tr class="separator:ga53284958be0c328f90ca3a4a0793d965"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gafbb090366e9dbf9a5bb0735df1e23d33"><td class="memItemLeft" align="right" valign="top"><a id="gafbb090366e9dbf9a5bb0735df1e23d33"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#gafbb090366e9dbf9a5bb0735df1e23d33">PN_INPROGRESS</a></td></tr> |
| <tr class="memdesc:gafbb090366e9dbf9a5bb0735df1e23d33"><td class="mdescLeft"> </td><td class="mdescRight">In-progress. <br /></td></tr> |
| <tr class="separator:gafbb090366e9dbf9a5bb0735df1e23d33"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gab1f773ca03b0953de6ce3caf4c795b8d"><td class="memItemLeft" align="right" valign="top"><a id="gab1f773ca03b0953de6ce3caf4c795b8d"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#gab1f773ca03b0953de6ce3caf4c795b8d">PN_OUT_OF_MEMORY</a></td></tr> |
| <tr class="memdesc:gab1f773ca03b0953de6ce3caf4c795b8d"><td class="mdescLeft"> </td><td class="mdescRight">Out-of-memory error. <br /></td></tr> |
| <tr class="separator:gab1f773ca03b0953de6ce3caf4c795b8d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga82db456291c2627e31becc44b733a7f0"><td class="memItemLeft" align="right" valign="top"><a id="ga82db456291c2627e31becc44b733a7f0"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#ga82db456291c2627e31becc44b733a7f0">PN_ABORTED</a></td></tr> |
| <tr class="memdesc:ga82db456291c2627e31becc44b733a7f0"><td class="mdescLeft"> </td><td class="mdescRight">Delivery aborted error. <br /></td></tr> |
| <tr class="separator:ga82db456291c2627e31becc44b733a7f0"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> |
| Typedefs</h2></td></tr> |
| <tr class="memitem:ga24a289d5b32c9bd8a775600a5af83d52"><td class="memItemLeft" align="right" valign="top"><a id="ga24a289d5b32c9bd8a775600a5af83d52"></a> |
| typedef struct <a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a></td></tr> |
| <tr class="memdesc:ga24a289d5b32c9bd8a775600a5af83d52"><td class="mdescLeft"> </td><td class="mdescRight">An int error <code>code</code> and some string <code>text</code> to describe the error. <br /></td></tr> |
| <tr class="separator:ga24a289d5b32c9bd8a775600a5af83d52"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:gac6b84f09fac8e82bd41a62212d4d8f64"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#gac6b84f09fac8e82bd41a62212d4d8f64">pn_code</a> (int code)</td></tr> |
| <tr class="memdesc:gac6b84f09fac8e82bd41a62212d4d8f64"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the error code. <a href="group__error.html#gac6b84f09fac8e82bd41a62212d4d8f64">More...</a><br /></td></tr> |
| <tr class="separator:gac6b84f09fac8e82bd41a62212d4d8f64"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga0992aa0df5290a2ae639246b0c2f5481"><td class="memItemLeft" align="right" valign="top"><a id="ga0992aa0df5290a2ae639246b0c2f5481"></a> |
| <a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#ga0992aa0df5290a2ae639246b0c2f5481">pn_error</a> (void)</td></tr> |
| <tr class="memdesc:ga0992aa0df5290a2ae639246b0c2f5481"><td class="mdescLeft"> </td><td class="mdescRight">Create an error object. <br /></td></tr> |
| <tr class="separator:ga0992aa0df5290a2ae639246b0c2f5481"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga5e57528759aedb00e68aafd0d025d06c"><td class="memItemLeft" align="right" valign="top"><a id="ga5e57528759aedb00e68aafd0d025d06c"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#ga5e57528759aedb00e68aafd0d025d06c">pn_error_free</a> (<a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *error)</td></tr> |
| <tr class="memdesc:ga5e57528759aedb00e68aafd0d025d06c"><td class="mdescLeft"> </td><td class="mdescRight">Free an error object. <br /></td></tr> |
| <tr class="separator:ga5e57528759aedb00e68aafd0d025d06c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga15440ed9515967950fa4504a53fc0b64"><td class="memItemLeft" align="right" valign="top"><a id="ga15440ed9515967950fa4504a53fc0b64"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#ga15440ed9515967950fa4504a53fc0b64">pn_error_clear</a> (<a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *error)</td></tr> |
| <tr class="memdesc:ga15440ed9515967950fa4504a53fc0b64"><td class="mdescLeft"> </td><td class="mdescRight">Reset the error to a "no error" state with code == 0. <br /></td></tr> |
| <tr class="separator:ga15440ed9515967950fa4504a53fc0b64"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gac5b68c9e6a637810a55c0b0e6f66c90d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#gac5b68c9e6a637810a55c0b0e6f66c90d">pn_error_set</a> (<a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *error, int code, const char *text)</td></tr> |
| <tr class="memdesc:gac5b68c9e6a637810a55c0b0e6f66c90d"><td class="mdescLeft"> </td><td class="mdescRight">Set the error code and text. <a href="group__error.html#gac5b68c9e6a637810a55c0b0e6f66c90d">More...</a><br /></td></tr> |
| <tr class="separator:gac5b68c9e6a637810a55c0b0e6f66c90d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga59db2b3acdca714819c6450d2d5440a1"><td class="memItemLeft" align="right" valign="top"><a id="ga59db2b3acdca714819c6450d2d5440a1"></a> |
| int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#ga59db2b3acdca714819c6450d2d5440a1">pn_error_vformat</a> (<a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *error, int code, const char *fmt, va_list ap)</td></tr> |
| <tr class="memdesc:ga59db2b3acdca714819c6450d2d5440a1"><td class="mdescLeft"> </td><td class="mdescRight">Set the code and set the text using a printf-style formatted string. <br /></td></tr> |
| <tr class="separator:ga59db2b3acdca714819c6450d2d5440a1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga806d0788eeb97fd52d645cb8b75f8bf2"><td class="memItemLeft" align="right" valign="top"><a id="ga806d0788eeb97fd52d645cb8b75f8bf2"></a> |
| int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#ga806d0788eeb97fd52d645cb8b75f8bf2">pn_error_format</a> (<a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *error, int code, const char *fmt,...)</td></tr> |
| <tr class="memdesc:ga806d0788eeb97fd52d645cb8b75f8bf2"><td class="mdescLeft"> </td><td class="mdescRight">Set the code and set the text using a printf-style formatted string. <br /></td></tr> |
| <tr class="separator:ga806d0788eeb97fd52d645cb8b75f8bf2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga00e179c24bc0954e1f01c64aa832ee2c"><td class="memItemLeft" align="right" valign="top"><a id="ga00e179c24bc0954e1f01c64aa832ee2c"></a> |
| int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#ga00e179c24bc0954e1f01c64aa832ee2c">pn_error_code</a> (<a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *error)</td></tr> |
| <tr class="memdesc:ga00e179c24bc0954e1f01c64aa832ee2c"><td class="mdescLeft"> </td><td class="mdescRight">Get the the error code. <br /></td></tr> |
| <tr class="separator:ga00e179c24bc0954e1f01c64aa832ee2c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga67cbe6ebb143370e0604f5b84d716c56"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#ga67cbe6ebb143370e0604f5b84d716c56">pn_error_text</a> (<a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *error)</td></tr> |
| <tr class="memdesc:ga67cbe6ebb143370e0604f5b84d716c56"><td class="mdescLeft"> </td><td class="mdescRight">Get the error text. <a href="group__error.html#ga67cbe6ebb143370e0604f5b84d716c56">More...</a><br /></td></tr> |
| <tr class="separator:ga67cbe6ebb143370e0604f5b84d716c56"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga96ccb65768c64ee0a1b71b83e08489d3"><td class="memItemLeft" align="right" valign="top"><a id="ga96ccb65768c64ee0a1b71b83e08489d3"></a> |
| int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#ga96ccb65768c64ee0a1b71b83e08489d3">pn_error_copy</a> (<a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *error, <a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *src)</td></tr> |
| <tr class="memdesc:ga96ccb65768c64ee0a1b71b83e08489d3"><td class="mdescLeft"> </td><td class="mdescRight">Copy the src error. <br /></td></tr> |
| <tr class="separator:ga96ccb65768c64ee0a1b71b83e08489d3"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <p>A Proton API error. </p> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a id="gac6b84f09fac8e82bd41a62212d4d8f64"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gac6b84f09fac8e82bd41a62212d4d8f64">◆ </a></span>pn_code()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const char* pn_code </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>code</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the name of the error code. </p> |
| <p>Returned pointer is to a static constant, do not delete. </p> |
| <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="broker_8c-example.html#a72">broker.c</a>, <a class="el" href="direct_8c-example.html#a40">direct.c</a>, and <a class="el" href="receive_8c-example.html#a14">receive.c</a>.</dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="gac5b68c9e6a637810a55c0b0e6f66c90d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gac5b68c9e6a637810a55c0b0e6f66c90d">◆ </a></span>pn_error_set()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_error_set </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> * </td> |
| <td class="paramname"><em>error</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>code</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>text</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the error code and text. </p> |
| <p>Makes a copy of text. </p> |
| |
| </div> |
| </div> |
| <a id="ga67cbe6ebb143370e0604f5b84d716c56"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga67cbe6ebb143370e0604f5b84d716c56">◆ </a></span>pn_error_text()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const char* pn_error_text </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> * </td> |
| <td class="paramname"><em>error</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the error text. </p> |
| <p>The returned pointer is owned by the pn_error_t. </p> |
| <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="direct_8c-example.html#a19">direct.c</a>, and <a class="el" href="send_8c-example.html#a18">send.c</a>.</dd> |
| </dl> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
