<!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__errno__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__errno__error__api.html">Globus Errno Error API</a></div></div> <div class="contents"> <p>Helper functions for dealing with Globus Errno 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__errno__error__utility.png" border="0" alt="" usemap="#group____globus____errno____error____utility"/> <map name="group____globus____errno____error____utility" id="group____globus____errno____error____utility"> <area shape="rect" id="node1" href="group__globus__errno__error__api.html" title="Globus Errno Error API" alt="" coords="7,5,161,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__errno__error__utility.html#ga3f891f35f34313d70ca88c86827fa390">globus_error_errno_match</a> (globus_object_t *error, globus_module_descriptor_t *module, int system_errno) </ul> <h2><a name="member-group"></a> Wrap Errno Error</h2> <ul> <li>globus_object_t * <a class="el" href="group__globus__errno__error__utility.html#gac98b9990387bcb26044193fe885b8ff8">globus_error_wrap_errno_error</a> (globus_module_descriptor_t *base_source, int system_errno, int type, const char *source_file, const char *source_func, int source_line, const char *short_desc_format,...) </ul> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <p>Helper functions for dealing with Globus Errno Error objects. </p> <p>This section defines utility functions for dealing with Globus Errno Error objects. </p> <hr/><h2>Function Documentation</h2> <a class="anchor" id="ga3f891f35f34313d70ca88c86827fa390"></a><!-- doxytag: member="globus_error_errno.c::globus_error_errno_match" ref="ga3f891f35f34313d70ca88c86827fa390" args="(globus_object_t *error, globus_module_descriptor_t *module, int system_errno)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">globus_bool_t globus_error_errno_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>system_errno</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 matches a specific errno. </p> <p>This function checks whether the error or any of it's causative errors originated from a specific module and contains a specific errno. If the module descriptor is left unspecified this function will check for any error of the specified errno 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">system_errno</td><td>The errno 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 errno GLOBUS_FALSE - the error failed to match the module and errno </dd></dl> </div> </div> <a class="anchor" id="gac98b9990387bcb26044193fe885b8ff8"></a><!-- doxytag: member="globus_error_errno.c::globus_error_wrap_errno_error" ref="gac98b9990387bcb26044193fe885b8ff8" args="(globus_module_descriptor_t *base_source, int system_errno, int type, const char *source_file, const char *source_func, int source_line, const char *short_desc_format,...)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">globus_object_t* globus_error_wrap_errno_error </td> <td>(</td> <td class="paramtype">globus_module_descriptor_t * </td> <td class="paramname"><em>base_source</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>system_errno</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 class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>source_file</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>source_func</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>source_line</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>Allocate and initialize an error of type GLOBUS_ERROR_TYPE_GLOBUS which contains a causal error of type GLOBUS_ERROR_TYPE_ERRNO. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">base_source</td><td>Pointer to the originating module. </td></tr> <tr><td class="paramname">system_errno</td><td>The errno to use when generating the causal error. </td></tr> <tr><td class="paramname">type</td><td>The error type. We may reserve part of this namespace for common errors. Errors not in this space are assumed to be local to the originating module. </td></tr> <tr><td class="paramname">source_file</td><td>Name of file. Use __FILE__ </td></tr> <tr><td class="paramname">source_func</td><td>Name of function. Use _globus_func_name and declare your func with GlobusFuncName(<name>) </td></tr> <tr><td class="paramname">source_line</td><td>Line number. Use __LINE__ </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>The resulting error object. It is the user's responsibility to eventually free this object using globus_object_free(). A globus_result_t may be obtained by calling globus_error_put() on this object. </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>