<!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__object.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> </div>
<div class="headertitle">
<div class="title">Error Construction</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>Create and initialize a Globus Generic Error object.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Error Construction:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__globus__generic__error__object.png" border="0" alt="" usemap="#group____globus____generic____error____object"/>
<map name="group____globus____generic____error____object" id="group____globus____generic____error____object">
<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="define-members"></a>
Defines</h2>
<ul>
<li>#define <a class="el" href="group__globus__generic__error__object.html#ga8fdc85772e479ba987fd496039516065">GLOBUS_ERROR_TYPE_GLOBUS</a>
</ul>
<h2><a name="member-group"></a>
Construct Error</h2>
<ul>
<li>globus_object_t * <a class="el" href="group__globus__generic__error__object.html#ga2e4aa651000f003991af6a766f6120e5">globus_error_construct_error</a> (globus_module_descriptor_t *base_source, globus_object_t *base_cause, int type, const char *source_file, const char *source_func, int source_line, const char *short_desc_format,...)
<li>globus_object_t * <a class="el" href="group__globus__generic__error__object.html#gac86c29289d7428fc695273f8ba51511d">globus_error_v_construct_error</a> (globus_module_descriptor_t *base_source, globus_object_t *base_cause, const int type, const char *source_file, const char *source_func, int source_line, const char *short_desc_format, va_list ap)
</ul>
<h2><a name="member-group"></a>
Initialize Error</h2>
<ul>
<li>globus_object_t * <a class="el" href="group__globus__generic__error__object.html#ga5915386c64811d78f50bfb01a16783c7">globus_error_initialize_error</a> (globus_object_t *error, globus_module_descriptor_t *base_source, globus_object_t *base_cause, int type, const char *source_file, const char *source_func, int source_line, const char *short_desc_format, va_list ap)
</ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Create and initialize a Globus Generic Error object. </p>
<p>This section defines operations to create and initialize Globus Generic Error objects. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga8fdc85772e479ba987fd496039516065"></a><!-- doxytag: member="globus_error_generic.h::GLOBUS_ERROR_TYPE_GLOBUS" ref="ga8fdc85772e479ba987fd496039516065" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GLOBUS_ERROR_TYPE_GLOBUS</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Error type definition. </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga2e4aa651000f003991af6a766f6120e5"></a><!-- doxytag: member="globus_error_generic.c::globus_error_construct_error" ref="ga2e4aa651000f003991af6a766f6120e5" args="(globus_module_descriptor_t *base_source, globus_object_t *base_cause, 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_construct_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">globus_object_t * </td>
<td class="paramname"><em>base_cause</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. </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">base_cause</td><td>The error object causing the error. If this is the original error this paramater may be NULL. </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>
<a class="anchor" id="gac86c29289d7428fc695273f8ba51511d"></a><!-- doxytag: member="globus_error_generic.c::globus_error_v_construct_error" ref="gac86c29289d7428fc695273f8ba51511d" args="(globus_module_descriptor_t *base_source, globus_object_t *base_cause, const int type, const char *source_file, const char *source_func, int source_line, const char *short_desc_format, va_list ap)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_object_t* globus_error_v_construct_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">globus_object_t * </td>
<td class="paramname"><em>base_cause</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 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">va_list </td>
<td class="paramname"><em>ap</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. </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">base_cause</td><td>The error object causing the error. If this is the original error this paramater may be NULL. </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">ap</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>
<a class="anchor" id="ga5915386c64811d78f50bfb01a16783c7"></a><!-- doxytag: member="globus_error_generic.c::globus_error_initialize_error" ref="ga5915386c64811d78f50bfb01a16783c7" args="(globus_object_t *error, globus_module_descriptor_t *base_source, globus_object_t *base_cause, int type, const char *source_file, const char *source_func, int source_line, const char *short_desc_format, va_list ap)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_object_t* globus_error_initialize_error </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>base_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_object_t * </td>
<td class="paramname"><em>base_cause</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">va_list </td>
<td class="paramname"><em>ap</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize a previously allocated error of type GLOBUS_ERROR_TYPE_GLOBUS. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">error</td><td>The previously allocated error object. </td></tr>
<tr><td class="paramname">base_source</td><td>Pointer to the originating module. </td></tr>
<tr><td class="paramname">base_cause</td><td>The error object causing the error. If this is the original error this paramater may be NULL. </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">ap</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. You may have to call globus_error_put() on this object before passing it on. </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>
