libglobus-common-doc 14.10-2 / usr / share / doc / libglobus-common-dev / html / group__globus__generic__error__utility.html

This file is indexed.

/usr/share/doc/libglobus-common-dev/html/group__globus__generic__error__utility.html is in libglobus-common-doc 14.10-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
<!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.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){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 class="ingroups"><a class="el" href="group__globus__generic__error__api.html">Globus Generic Error API</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<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,32"/></map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Error Match</h2></td></tr>
<tr class="memitem:gabc9e30ff28f507d8297900808e4e0714"><td class="memItemLeft" align="right" valign="top">globus_bool_t&#160;</td><td class="memItemRight" valign="bottom"><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)</td></tr>
<tr class="separator:gabc9e30ff28f507d8297900808e4e0714"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Print Error Chain</h2></td></tr>
<tr class="memitem:ga0c90e5ebed8b504645b53ae62e4c457f"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__generic__error__utility.html#ga0c90e5ebed8b504645b53ae62e4c457f">globus_error_print_chain</a> (globus_object_t *error)</td></tr>
<tr class="separator:ga0c90e5ebed8b504645b53ae62e4c457f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Print User Friendly Error Message</h2></td></tr>
<tr class="memitem:ga5114e24fdb91268e276f12fafe2b9bee"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__generic__error__utility.html#ga5114e24fdb91268e276f12fafe2b9bee">globus_error_print_friendly</a> (globus_object_t *error)</td></tr>
<tr class="separator:ga5114e24fdb91268e276f12fafe2b9bee"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">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>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gabc9e30ff28f507d8297900808e4e0714"></a>
<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 *&#160;</td>
          <td class="paramname"><em>error</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">globus_module_descriptor_t *&#160;</td>
          <td class="paramname"><em>module</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>type</em>&#160;</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 class="params"><dt>Parameters</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="section return"><dt>Returns</dt><dd>GLOBUS_TRUE - the error matched the module and type GLOBUS_FALSE - the error failed to match the module and type </dd></dl>

<p>References <a class="el" href="group__globus__generic__error__accessor.html#ga535d97a0806fa466c8f086ef1c1bab9a">globus_error_get_cause()</a>, <a class="el" href="group__globus__generic__error__accessor.html#ga7177a61ceb9e221589d2b7c8afb91365">globus_error_get_source()</a>, <a class="el" href="group__globus__generic__error__accessor.html#ga178a83a65eef9ba58a88e2a5fcf1c781">globus_error_get_type()</a>, and <a class="el" href="group__globus__generic__error__object.html#ga8fdc85772e479ba987fd496039516065">GLOBUS_ERROR_TYPE_GLOBUS</a>.</p>

</div>
</div>
<a class="anchor" id="ga0c90e5ebed8b504645b53ae62e4c457f"></a>
<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 *&#160;</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 class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">error</td><td>The error to print </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string containing all printable errors. This string needs to be freed by the user of this function. </dd></dl>

<p>References <a class="el" href="group__globus__generic__error__accessor.html#ga535d97a0806fa466c8f086ef1c1bab9a">globus_error_get_cause()</a>.</p>

</div>
</div>
<a class="anchor" id="ga5114e24fdb91268e276f12fafe2b9bee"></a>
<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 *&#160;</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&#39;s causative error chai...">globus_error_print_chain()</a> will be used.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">error</td><td>The error to print </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string containing a friendly error message. This string needs to be freed by the user of this function. </dd></dl>

<p>References <a class="el" href="group__globus__generic__error__accessor.html#ga535d97a0806fa466c8f086ef1c1bab9a">globus_error_get_cause()</a>, <a class="el" href="group__globus__generic__error__accessor.html#ga7177a61ceb9e221589d2b7c8afb91365">globus_error_get_source()</a>, <a class="el" href="group__globus__generic__error__utility.html#ga0c90e5ebed8b504645b53ae62e4c457f">globus_error_print_chain()</a>, <a class="el" href="group__globus__thread__key.html#ga54b93ce20069e0616e5b05e2be49d240">globus_thread_getspecific()</a>, and <a class="el" href="group__globus__thread__key.html#ga576439a7030a7e1dc81da6c36d05655f">globus_thread_setspecific()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<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>

APT Browse - Built by Thomas Orozco.