<!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__utility.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">Error Handling Helpers</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>Helper functions for dealing with Globus Generic Error objects.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Error Handling Helpers:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__globus__generic__error__utility.png" border="0" alt="" usemap="#group____globus____generic____error____utility"/>
<map name="group____globus____generic____error____utility" id="group____globus____generic____error____utility">
<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>
Error Match</h2>
<ul>
<li>globus_bool_t <a class="el" href="group__globus__generic__error__utility.html#gabc9e30ff28f507d8297900808e4e0714">globus_error_match</a> (globus_object_t *error, globus_module_descriptor_t *module, int type)
</ul>
<h2><a name="member-group"></a>
Print Error Chain</h2>
<ul>
<li>char * <a class="el" href="group__globus__generic__error__utility.html#ga0c90e5ebed8b504645b53ae62e4c457f">globus_error_print_chain</a> (globus_object_t *error)
</ul>
<h2><a name="member-group"></a>
Print User Friendly Error Message</h2>
<ul>
<li>char * <a class="el" href="group__globus__generic__error__utility.html#ga5114e24fdb91268e276f12fafe2b9bee">globus_error_print_friendly</a> (globus_object_t *error)
</ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Helper functions for dealing with Globus Generic Error objects. </p>
<p>This section defines utility functions for dealing with Globus Generic Error objects. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gabc9e30ff28f507d8297900808e4e0714"></a><!-- doxytag: member="globus_error_generic.c::globus_error_match" ref="gabc9e30ff28f507d8297900808e4e0714" args="(globus_object_t *error, globus_module_descriptor_t *module, int type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_bool_t globus_error_match </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>module</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">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>Check whether the error originated from a specific module and is of a specific type. </p>
<p>This function checks whether the error or any of it's causative errors originated from a specific module and is of a specific type. If the module descriptor is left unspecified this function will check for any error of the specified type and vice versa.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">error</td><td>The error object for which to perform the check </td></tr>
<tr><td class="paramname">module</td><td>The module descriptor to check for </td></tr>
<tr><td class="paramname">type</td><td>The type to check for </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>GLOBUS_TRUE - the error matched the module and type GLOBUS_FALSE - the error failed to match the module and type </dd></dl>
</div>
</div>
<a class="anchor" id="ga0c90e5ebed8b504645b53ae62e4c457f"></a><!-- doxytag: member="globus_error_generic.c::globus_error_print_chain" ref="ga0c90e5ebed8b504645b53ae62e4c457f" args="(globus_object_t *error)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* globus_error_print_chain </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>Return a string containing all printable errors found in a error object and it's causative error chain. </p>
<p>If the GLOBUS_ERROR_VERBOSE env is set, file, line and function info will also be printed (where available). Otherwise, only the module name will be printed.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">error</td><td>The error to print </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A string containing all printable errors. This string needs to be freed by the user of this function. </dd></dl>
</div>
</div>
<a class="anchor" id="ga5114e24fdb91268e276f12fafe2b9bee"></a><!-- doxytag: member="globus_error_generic.c::globus_error_print_friendly" ref="ga5114e24fdb91268e276f12fafe2b9bee" args="(globus_object_t *error)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* globus_error_print_friendly </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>Return a string containing error messages from the top 1 and bottom 3 objects, and, if found, show a friendly error message. </p>
<p>The error chain will be searched from top to bottom until a friendly handler is found and a friendly message is created.</p>
<p>If the GLOBUS_ERROR_VERBOSE env is set, then the result from <a class="el" href="group__globus__generic__error__utility.html#ga0c90e5ebed8b504645b53ae62e4c457f" title="Return a string containing all printable errors found in a error object and it's causative error chai...">globus_error_print_chain()</a> will be used.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">error</td><td>The error to print </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A string containing a friendly error message. This string needs to be freed by the user of this function. </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>
