<!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__error__api.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> </div>
<div class="headertitle">
<div class="title">Globus Error API</div> </div>
</div>
<div class="contents">
<p>Intended use:
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Globus Error API:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__globus__error__api.png" border="0" alt="" usemap="#group____globus____error____api"/>
<map name="group____globus____error____api" id="group____globus____error____api">
<area shape="rect" id="node1" href="group__globus__errno__error__api.html" title="Globus Errno Error API" alt="" coords="184,5,339,35"/><area shape="rect" id="node3" href="group__globus__generic__error__api.html" title="Globus Generic Error API" alt="" coords="176,59,347,88"/></map>
</td></tr></table></center>
</div>
<h2><a name="groups"></a>
Modules</h2>
<ul>
<li><a class="el" href="group__globus__errno__error__api.html">Globus Errno Error API</a>
<li><a class="el" href="group__globus__generic__error__api.html">Globus Generic Error API</a>
</ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Intended use: </p>
<p>If a function needs to return an error it should do the following:</p>
<ul>
<li>External errors, such as error returns from system calls and GSSAPI errors, should be wrapped using the appropriate error type.</li>
<li>The wrapped external error should then be passed as the cause of a globus error.</li>
<li>External error types are expected to provide a utility function to combine the above two steps.</li>
<li>The globus error should then be returned from the function.</li>
</ul>
<p>Notes on how to generate globus errors:</p>
<ul>
<li>Module specific error types should be greater or equal to 1024 (to leave some space for global error types).</li>
<li>You may wish to generate a mapping from error types to format strings for use in short descriptions.</li>
<li>You may also wish to generate a common prefix for all of the above fromat strings. The suggested prefix is "Function: %s Line:
%s ". </li>
</ul>
</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>
