<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta name="robots" content="noindex"> <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <!-- THIS FILE IS AUTOMATICALLY GENERATED FROM THE GLOBUS SOURCE CODE DO NOT MODIFY. --> <title>Globus Reference Manual</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head> <body> <!-- Generated by Doxygen 1.8.3.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> </ul> </div> </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"> $(document).ready(function(){initNavTree('group__globus__generic__error__accessor.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">Error Data Accessors and Modifiers<div class="ingroups"><a class="el" href="group__globus__generic__error__api.html">Globus Generic Error API</a></div></div> </div> </div><!--header--> <div class="contents"> <div class="dynheader"> Collaboration diagram for Error Data Accessors and Modifiers:</div> <div class="dyncontent"> <center><table><tr><td><img src="group__globus__generic__error__accessor.png" border="0" alt="" usemap="#group____globus____generic____error____accessor"/> <map name="group____globus____generic____error____accessor" id="group____globus____generic____error____accessor"> <area shape="rect" id="node2" href="group__globus__generic__error__api.html" title="Globus Generic Error API" alt="" coords="5,12,176,39"/></map> </td></tr></table></center> </div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a> Get Source</h2></td></tr> <tr class="memitem:ga7177a61ceb9e221589d2b7c8afb91365"><td class="memItemLeft" align="right" valign="top">globus_module_descriptor_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__generic__error__accessor.html#ga7177a61ceb9e221589d2b7c8afb91365">globus_error_get_source</a> (globus_object_t *error)</td></tr> <tr class="separator:ga7177a61ceb9e221589d2b7c8afb91365"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a> Set Source</h2></td></tr> <tr class="memitem:ga233c6cfbeb5ac02a7c86f087a2d83762"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__generic__error__accessor.html#ga233c6cfbeb5ac02a7c86f087a2d83762">globus_error_set_source</a> (globus_object_t *error, globus_module_descriptor_t *source_module)</td></tr> <tr class="separator:ga233c6cfbeb5ac02a7c86f087a2d83762"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a> Get Cause</h2></td></tr> <tr class="memitem:ga535d97a0806fa466c8f086ef1c1bab9a"><td class="memItemLeft" align="right" valign="top">globus_object_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__generic__error__accessor.html#ga535d97a0806fa466c8f086ef1c1bab9a">globus_error_get_cause</a> (globus_object_t *error)</td></tr> <tr class="separator:ga535d97a0806fa466c8f086ef1c1bab9a"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a> Set Cause</h2></td></tr> <tr class="memitem:gaa128b1cc5518302f4e4292a987392976"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__generic__error__accessor.html#gaa128b1cc5518302f4e4292a987392976">globus_error_set_cause</a> (globus_object_t *error, globus_object_t *causal_error)</td></tr> <tr class="separator:gaa128b1cc5518302f4e4292a987392976"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a> Get Type</h2></td></tr> <tr class="memitem:ga178a83a65eef9ba58a88e2a5fcf1c781"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__generic__error__accessor.html#ga178a83a65eef9ba58a88e2a5fcf1c781">globus_error_get_type</a> (globus_object_t *error)</td></tr> <tr class="separator:ga178a83a65eef9ba58a88e2a5fcf1c781"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a> Set Type</h2></td></tr> <tr class="memitem:ga098cd7c084ca5cddcf9d5a63c309172f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__generic__error__accessor.html#ga098cd7c084ca5cddcf9d5a63c309172f">globus_error_set_type</a> (globus_object_t *error, const int type)</td></tr> <tr class="separator:ga098cd7c084ca5cddcf9d5a63c309172f"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a> Get Short Description</h2></td></tr> <tr class="memitem:gae995aeed35844dd6539b85a31df31e66"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__generic__error__accessor.html#gae995aeed35844dd6539b85a31df31e66">globus_error_get_short_desc</a> (globus_object_t *error)</td></tr> <tr class="separator:gae995aeed35844dd6539b85a31df31e66"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a> Set Short Description</h2></td></tr> <tr class="memitem:ga0fa4eb98ddbba6c376bd16f512b8fe85"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__generic__error__accessor.html#ga0fa4eb98ddbba6c376bd16f512b8fe85">globus_error_set_short_desc</a> (globus_object_t *error, const char *short_desc_format,...)</td></tr> <tr class="separator:ga0fa4eb98ddbba6c376bd16f512b8fe85"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a> Get Long Description</h2></td></tr> <tr class="memitem:ga262c03dd3d081f036ce39ac13ed82324"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__generic__error__accessor.html#ga262c03dd3d081f036ce39ac13ed82324">globus_error_get_long_desc</a> (globus_object_t *error)</td></tr> <tr class="separator:ga262c03dd3d081f036ce39ac13ed82324"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a> Set Long Description</h2></td></tr> <tr class="memitem:gaef263d7eb8d7eb1304aaeff5e1003619"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__generic__error__accessor.html#gaef263d7eb8d7eb1304aaeff5e1003619">globus_error_set_long_desc</a> (globus_object_t *error, const char *long_desc_format,...)</td></tr> <tr class="separator:gaef263d7eb8d7eb1304aaeff5e1003619"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>Get and set data in a Globus Generic Error object. </p> <p>This section defines operations for accessing and modifying data in a Globus Generic Error object. </p> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="ga7177a61ceb9e221589d2b7c8afb91365"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">globus_module_descriptor_t* globus_error_get_source </td> <td>(</td> <td class="paramtype">globus_object_t * </td> <td class="paramname"><em>error</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Retrieve the originating module descriptor from a error object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">error</td><td>The error from which to retrieve the module descriptor </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The originating module descriptor. </dd></dl> </div> </div> <a class="anchor" id="ga233c6cfbeb5ac02a7c86f087a2d83762"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void globus_error_set_source </td> <td>(</td> <td class="paramtype">globus_object_t * </td> <td class="paramname"><em>error</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">globus_module_descriptor_t * </td> <td class="paramname"><em>source_module</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set the originating module descriptor in a error object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">error</td><td>The error object for which to set the causative error </td></tr> <tr><td class="paramname">source_module</td><td>The originating module descriptor </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>void </dd></dl> </div> </div> <a class="anchor" id="ga535d97a0806fa466c8f086ef1c1bab9a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">globus_object_t* globus_error_get_cause </td> <td>(</td> <td class="paramtype">globus_object_t * </td> <td class="paramname"><em>error</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Retrieve the underlying error from a error object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">error</td><td>The error from which to retrieve the causative error. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The underlying error object if it exists, NULL if it doesn't. </dd></dl> </div> </div> <a class="anchor" id="gaa128b1cc5518302f4e4292a987392976"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void globus_error_set_cause </td> <td>(</td> <td class="paramtype">globus_object_t * </td> <td class="paramname"><em>error</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">globus_object_t * </td> <td class="paramname"><em>causal_error</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set the causative error in a error object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">error</td><td>The error object for which to set the causative error. </td></tr> <tr><td class="paramname">causal_error</td><td>The causative error. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>void </dd></dl> </div> </div> <a class="anchor" id="ga178a83a65eef9ba58a88e2a5fcf1c781"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int globus_error_get_type </td> <td>(</td> <td class="paramtype">globus_object_t * </td> <td class="paramname"><em>error</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Retrieve the error type from a generic globus error object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">error</td><td>The error from which to retrieve the error type </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The error type of the object </dd></dl> <p>References <a class="el" href="group__globus__generic__error__object.html#ga8fdc85772e479ba987fd496039516065">GLOBUS_ERROR_TYPE_GLOBUS</a>.</p> </div> </div> <a class="anchor" id="ga098cd7c084ca5cddcf9d5a63c309172f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void globus_error_set_type </td> <td>(</td> <td class="paramtype">globus_object_t * </td> <td class="paramname"><em>error</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const int </td> <td class="paramname"><em>type</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set the error type in a generic globus error object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">error</td><td>The error object for which to set the error type </td></tr> <tr><td class="paramname">type</td><td>The error type </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>void </dd></dl> <p>References <a class="el" href="group__globus__generic__error__object.html#ga8fdc85772e479ba987fd496039516065">GLOBUS_ERROR_TYPE_GLOBUS</a>.</p> </div> </div> <a class="anchor" id="gae995aeed35844dd6539b85a31df31e66"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char* globus_error_get_short_desc </td> <td>(</td> <td class="paramtype">globus_object_t * </td> <td class="paramname"><em>error</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Retrieve the short error description from a generic globus error object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">error</td><td>The error from which to retrieve the description </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The short error description of the object </dd></dl> <p>References <a class="el" href="group__globus__generic__error__object.html#ga8fdc85772e479ba987fd496039516065">GLOBUS_ERROR_TYPE_GLOBUS</a>.</p> </div> </div> <a class="anchor" id="ga0fa4eb98ddbba6c376bd16f512b8fe85"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void globus_error_set_short_desc </td> <td>(</td> <td class="paramtype">globus_object_t * </td> <td class="paramname"><em>error</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>short_desc_format</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname"><em>...</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set the short error description in a generic globus error object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">error</td><td>The error object for which to set the description </td></tr> <tr><td class="paramname">short_desc_format</td><td>Short format string giving a succinct description of the error. To be passed on to the user. </td></tr> <tr><td class="paramname">...</td><td>Arguments for the format string. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>void </dd></dl> <p>References <a class="el" href="group__globus__generic__error__object.html#ga8fdc85772e479ba987fd496039516065">GLOBUS_ERROR_TYPE_GLOBUS</a>.</p> </div> </div> <a class="anchor" id="ga262c03dd3d081f036ce39ac13ed82324"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char* globus_error_get_long_desc </td> <td>(</td> <td class="paramtype">globus_object_t * </td> <td class="paramname"><em>error</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Retrieve the long error description from a generic globus error object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">error</td><td>The error from which to retrieve the description </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The long error description of the object </dd></dl> <p>References <a class="el" href="group__globus__generic__error__object.html#ga8fdc85772e479ba987fd496039516065">GLOBUS_ERROR_TYPE_GLOBUS</a>.</p> </div> </div> <a class="anchor" id="gaef263d7eb8d7eb1304aaeff5e1003619"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void globus_error_set_long_desc </td> <td>(</td> <td class="paramtype">globus_object_t * </td> <td class="paramname"><em>error</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>long_desc_format</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname"><em>...</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set the long error description in a generic globus error object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">error</td><td>The error object for which to set the description </td></tr> <tr><td class="paramname">long_desc_format</td><td>Longer format string giving a more detailed explanation of the error. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>void </dd></dl> <p>References <a class="el" href="group__globus__generic__error__object.html#ga8fdc85772e479ba987fd496039516065">GLOBUS_ERROR_TYPE_GLOBUS</a>.</p> </div> </div> </div><!-- contents --> </div><!-- doc-content --> <hr> <p align="center"> <a href="http://www.globus.org/toolkit/about.html" target="_top">about globus</a> | <a href="http://www.globus.org/toolkit/" target="_top">globus toolkit</a> | <a href="https://dev.globus.org/wiki/Welcome/" target="_top">dev.globus</a> <br> <br> Comments? <a href="mailto:webmaster@globus.org">webmaster@globus.org</a> </body> </html>