<!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.7.4 -->
<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>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
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> </div>
<div class="ingroups"><a class="el" href="group__globus__generic__error__api.html">Globus Generic Error API</a></div></div>
<div class="contents">
<p>Get and set data in a Globus Generic Error object.
<a href="#details">More...</a></p>
<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,5,176,35"/></map>
</td></tr></table></center>
</div>
<h2><a name="member-group"></a>
Get Source</h2>
<ul>
<li>globus_module_descriptor_t * <a class="el" href="group__globus__generic__error__accessor.html#ga7177a61ceb9e221589d2b7c8afb91365">globus_error_get_source</a> (globus_object_t *error)
</ul>
<h2><a name="member-group"></a>
Set Source</h2>
<ul>
<li>void <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)
</ul>
<h2><a name="member-group"></a>
Get Cause</h2>
<ul>
<li>globus_object_t * <a class="el" href="group__globus__generic__error__accessor.html#ga535d97a0806fa466c8f086ef1c1bab9a">globus_error_get_cause</a> (globus_object_t *error)
</ul>
<h2><a name="member-group"></a>
Set Cause</h2>
<ul>
<li>void <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)
</ul>
<h2><a name="member-group"></a>
Get Type</h2>
<ul>
<li>int <a class="el" href="group__globus__generic__error__accessor.html#ga178a83a65eef9ba58a88e2a5fcf1c781">globus_error_get_type</a> (globus_object_t *error)
</ul>
<h2><a name="member-group"></a>
Set Type</h2>
<ul>
<li>void <a class="el" href="group__globus__generic__error__accessor.html#ga098cd7c084ca5cddcf9d5a63c309172f">globus_error_set_type</a> (globus_object_t *error, const int type)
</ul>
<h2><a name="member-group"></a>
Get Short Description</h2>
<ul>
<li>char * <a class="el" href="group__globus__generic__error__accessor.html#gae995aeed35844dd6539b85a31df31e66">globus_error_get_short_desc</a> (globus_object_t *error)
</ul>
<h2><a name="member-group"></a>
Set Short Description</h2>
<ul>
<li>void <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,...)
</ul>
<h2><a name="member-group"></a>
Get Long Description</h2>
<ul>
<li>char * <a class="el" href="group__globus__generic__error__accessor.html#ga262c03dd3d081f036ce39ac13ed82324">globus_error_get_long_desc</a> (globus_object_t *error)
</ul>
<h2><a name="member-group"></a>
Set Long Description</h2>
<ul>
<li>void <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,...)
</ul>
<hr/><a name="details" id="details"></a><h2>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>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga7177a61ceb9e221589d2b7c8afb91365"></a><!-- doxytag: member="globus_error_generic.c::globus_error_get_source" ref="ga7177a61ceb9e221589d2b7c8afb91365" args="(globus_object_t *error)" -->
<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><dt><b>Parameters:</b></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="return"><dt><b>Returns:</b></dt><dd>The originating module descriptor. </dd></dl>
</div>
</div>
<a class="anchor" id="ga233c6cfbeb5ac02a7c86f087a2d83762"></a><!-- doxytag: member="globus_error_generic.c::globus_error_set_source" ref="ga233c6cfbeb5ac02a7c86f087a2d83762" args="(globus_object_t *error, globus_module_descriptor_t *source_module)" -->
<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><dt><b>Parameters:</b></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="return"><dt><b>Returns:</b></dt><dd>void </dd></dl>
</div>
</div>
<a class="anchor" id="ga535d97a0806fa466c8f086ef1c1bab9a"></a><!-- doxytag: member="globus_error_generic.c::globus_error_get_cause" ref="ga535d97a0806fa466c8f086ef1c1bab9a" args="(globus_object_t *error)" -->
<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><dt><b>Parameters:</b></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="return"><dt><b>Returns:</b></dt><dd>The underlying error object if it exists, NULL if it doesn't. </dd></dl>
</div>
</div>
<a class="anchor" id="gaa128b1cc5518302f4e4292a987392976"></a><!-- doxytag: member="globus_error_generic.c::globus_error_set_cause" ref="gaa128b1cc5518302f4e4292a987392976" args="(globus_object_t *error, globus_object_t *causal_error)" -->
<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><dt><b>Parameters:</b></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="return"><dt><b>Returns:</b></dt><dd>void </dd></dl>
</div>
</div>
<a class="anchor" id="ga178a83a65eef9ba58a88e2a5fcf1c781"></a><!-- doxytag: member="globus_error_generic.c::globus_error_get_type" ref="ga178a83a65eef9ba58a88e2a5fcf1c781" args="(globus_object_t *error)" -->
<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><dt><b>Parameters:</b></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="return"><dt><b>Returns:</b></dt><dd>The error type of the object </dd></dl>
</div>
</div>
<a class="anchor" id="ga098cd7c084ca5cddcf9d5a63c309172f"></a><!-- doxytag: member="globus_error_generic.c::globus_error_set_type" ref="ga098cd7c084ca5cddcf9d5a63c309172f" args="(globus_object_t *error, const int type)" -->
<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><dt><b>Parameters:</b></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="return"><dt><b>Returns:</b></dt><dd>void </dd></dl>
</div>
</div>
<a class="anchor" id="gae995aeed35844dd6539b85a31df31e66"></a><!-- doxytag: member="globus_error_generic.c::globus_error_get_short_desc" ref="gae995aeed35844dd6539b85a31df31e66" args="(globus_object_t *error)" -->
<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><dt><b>Parameters:</b></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="return"><dt><b>Returns:</b></dt><dd>The short error description of the object </dd></dl>
</div>
</div>
<a class="anchor" id="ga0fa4eb98ddbba6c376bd16f512b8fe85"></a><!-- doxytag: member="globus_error_generic.c::globus_error_set_short_desc" ref="ga0fa4eb98ddbba6c376bd16f512b8fe85" args="(globus_object_t *error, const char *short_desc_format,...)" -->
<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><dt><b>Parameters:</b></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="return"><dt><b>Returns:</b></dt><dd>void </dd></dl>
</div>
</div>
<a class="anchor" id="ga262c03dd3d081f036ce39ac13ed82324"></a><!-- doxytag: member="globus_error_generic.c::globus_error_get_long_desc" ref="ga262c03dd3d081f036ce39ac13ed82324" args="(globus_object_t *error)" -->
<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><dt><b>Parameters:</b></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="return"><dt><b>Returns:</b></dt><dd>The long error description of the object </dd></dl>
</div>
</div>
<a class="anchor" id="gaef263d7eb8d7eb1304aaeff5e1003619"></a><!-- doxytag: member="globus_error_generic.c::globus_error_set_long_desc" ref="gaef263d7eb8d7eb1304aaeff5e1003619" args="(globus_object_t *error, const char *long_desc_format,...)" -->
<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><dt><b>Parameters:</b></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="return"><dt><b>Returns:</b></dt><dd>void </dd></dl>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<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>
