/usr/share/doc/libglobus-gsi-openssl-error-dev/html/group__globus__openssl__error__utility.html is in libglobus-gsi-openssl-error-doc 2.1-1.
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 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 | <!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.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</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__openssl__error__utility.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">Error Helper Functions</div> </div>
<div class="ingroups"><a class="el" href="group__globus__openssl__error__api.html">Globus OPENSSL Error API</a></div></div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for Error Helper Functions:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__globus__openssl__error__utility.png" border="0" alt="" usemap="#group____globus____openssl____error____utility"/>
<map name="group____globus____openssl____error____utility" id="group____globus____openssl____error____utility">
<area shape="rect" id="node1" href="group__globus__openssl__error__api.html" title="Globus OPENSSL Error API" alt="" coords="7,5,193,35"/></map>
</td></tr></table></center>
</div>
<h2><a name="member-group"></a>
OpenSSL Error Match</h2>
<ul>
<li>globus_bool_t <a class="el" href="group__globus__openssl__error__utility.html#ga944c2c110759c9d3857561beb2a33bc6">globus_error_match_openssl_error</a> (globus_object_t *error, unsigned long library, unsigned long function, unsigned long reason)
</ul>
<h2><a name="member-group"></a>
Wrap OpenSSL Error</h2>
<ul>
<li>globus_object_t * <a class="el" href="group__globus__openssl__error__utility.html#ga106c894da18b56f40b841b356d7c0ae5">globus_error_wrap_openssl_error</a> (globus_module_descriptor_t *base_source, int error_type, const char *source_file, const char *source_func, int source_line, const char *format,...)
</ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Utility functions that deal with Globus OpenSSL Error objects. </p>
<p>This section defines utility function for Globus OpenSSL Error objects. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga944c2c110759c9d3857561beb2a33bc6"></a><!-- doxytag: member="globus_error_openssl.c::globus_error_match_openssl_error" ref="ga944c2c110759c9d3857561beb2a33bc6" args="(globus_object_t *error, unsigned long library, unsigned long function, unsigned long reason)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_bool_t <a class="el" href="group__globus__openssl__error__utility.html#ga944c2c110759c9d3857561beb2a33bc6">globus_error_match_openssl_error</a> </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">unsigned long </td>
<td class="paramname"><em>library</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>function</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>reason</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 library, from a specific function 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 library, specific function and is of a specific type.</p>
<dl class="params"><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">library</td><td>The library to check for </td></tr>
<tr><td class="paramname">function</td><td>The function to check for </td></tr>
<tr><td class="paramname">reason</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 GLOBUS_FALSE - the error failed to match </dd></dl>
</div>
</div>
<a class="anchor" id="ga106c894da18b56f40b841b356d7c0ae5"></a><!-- doxytag: member="globus_error_openssl.c::globus_error_wrap_openssl_error" ref="ga106c894da18b56f40b841b356d7c0ae5" args="(globus_module_descriptor_t *base_source, int error_type, const char *source_file, const char *source_func, int source_line, const char *format,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_object_t* <a class="el" href="group__globus__openssl__error__utility.html#ga106c894da18b56f40b841b356d7c0ae5">globus_error_wrap_openssl_error</a> </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>error_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>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>Wrap the OpenSSL error and create a wrapped globus error object from the error. </p>
<p>This function gets all the openssl errors from the error list, and chains them using the globus error string object. The resulting globus error object is a wrapper to the openssl error at the end of the chain.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">base_source</td><td>The module that the error was generated from </td></tr>
<tr><td class="paramname">error_type</td><td>The type of error encapsulating the openssl error </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">format</td><td>format string for the description of the error entry point where the openssl error occurred, should be followed by parameters to fill the format string (like in printf). </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The globus error object. A globus_result_t object can be created using the globus_error_put function</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>globus_error_put() </dd></dl>
</div>
</div>
</div><!-- contents -->
</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>
|