<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>WCSLIB 4.18: wcserr.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">WCSLIB 4.18
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.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="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_af99bb3c152a306abd27951285ad1127.html">C</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">wcserr.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="wcserr_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*============================================================================</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"></span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> WCSLIB 4.18 - an implementation of the FITS WCS standard.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (C) 1995-2013, Mark Calabretta</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> This file is part of WCSLIB.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"></span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> WCSLIB is free software: you can redistribute it and/or modify it under the</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> terms of the GNU Lesser General Public License as published by the Free</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> Software Foundation, either version 3 of the License, or (at your option)</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> any later version.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> WCSLIB is distributed in the hope that it will be useful, but WITHOUT ANY</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> more details.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public License</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> along with WCSLIB. If not, see http://www.gnu.org/licenses.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"></span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> Direct correspondence concerning WCSLIB to mark@calabretta.id.au</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> Author: Mark Calabretta, Australia Telescope National Facility, CSIRO.</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> Module author: Michael Droettboom</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> http://www.atnf.csiro.au/people/Mark.Calabretta</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> $Id: wcserr.h,v 4.18 2013/07/13 10:00:04 mcalabre Exp $</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">*=============================================================================</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">*</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">* Summary of the wcserr routines</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">* ------------------------------</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">* Most of the structs in WCSLIB contain a pointer to a wcserr struct as a</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">* member. Functions in WCSLIB that return an error status code can also</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">* allocate and set a detailed error message in this struct which also</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">* identifies the function, source file, and line number where the error</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">* occurred.</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">*</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">* For example:</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">*</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">= struct prjprm prj;</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">= wcserr_enable(1);</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">= if (prjini(&prj)) {</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">= // Print the error message to stderr.</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">= wcsprintf_set(stderr);</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">= wcserr_prt(prj.err, 0x0);</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">= }</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">*</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">* A number of utility functions used in managing the wcserr struct are for</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">* internal use only. They are documented here solely as an aid to</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">* understanding the code. They are not intended for external use - the API</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">* may change without notice!</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">*</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">*</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">* wcserr struct - Error message handling</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">* --------------------------------------</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">* The wcserr struct contains the numeric error code, a textual description of</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">* the error, and information about the function, source file, and line number</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">* where the error was generated.</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">*</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">* int status</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">* Numeric status code associated with the error, the meaning of which</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">* depends on the function that generated it. See the documentation for</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">* the particular function.</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">*</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">* int line_no</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">* Line number where the error occurred as given by the __LINE__</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">* preprocessor macro.</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">*</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">* const char *function</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">* Name of the function where the error occurred.</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">*</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">* const char *file</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment">* Name of the source file where the error occurred as given by the</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">* __FILE__ preprocessor macro.</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">*</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">* char msg[WCSERR_MSG_LENGTH]</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">* Informative error message.</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment">*</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">*</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">* wcserr_enable() - Enable/disable error messaging</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">* ------------------------------------------------</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment">* wcserr_enable() enables or disables wcserr error messaging. By default it</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">* is disabled.</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">*</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">* PLEASE NOTE: This function is not thread-safe.</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">*</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">* Given:</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">* enable int If true (non-zero), enable error messaging, else</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">* disable it.</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">*</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">* Function return value:</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">* int Status return value:</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment">* 0: Error messaging is disabled.</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">* 1: Error messaging is enabled.</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">*</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">*</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">* wcserr_prt() - Print a wcserr struct</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment">* ------------------------------------</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment">* wcserr_prt() prints the error message (if any) contained in a wcserr struct.</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment">* It uses the wcsprintf() functions.</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">*</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment">* Given:</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">* err const struct wcserr*</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment">* The error object. If NULL, nothing is printed.</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment">*</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment">* prefix const char *</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">* If non-NULL, each output line will be prefixed with</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment">* this string.</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment">*</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">* Function return value:</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment">* int Status return value:</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment">* 0: Success.</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment">* 2: Error messaging is not enabled.</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment">*</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">*</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment">* wcserr_clear() - Clear a wcserr struct</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment">* --------------------------------------</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment">* wcserr_clear() clears the error (if any) contained in a wcserr struct.</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment">*</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment">* Given and returned:</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment">* err struct wcserr**</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment">* The error object. If NULL, nothing is done. Set to</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment">* NULL on return.</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment">*</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment">* Function return value:</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment">* int Status return value:</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment">* 0: Success.</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment">*</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment">*</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment">* wcserr_set() - Fill in the contents of an error object</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment">* ------------------------------------------------------</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment">* INTERNAL USE ONLY.</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment">*</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment">* wcserr_set() fills a wcserr struct with information about an error.</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment">*</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment">* A convenience macro, WCSERR_SET, provides the source file and line number</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment">* information automatically.</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment">*</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment">* Given and returned:</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment">* err struct wcserr**</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment">* Error object.</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment">*</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment">* If err is NULL, returns the status code given without</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment">* setting an error message.</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment">*</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment">* If *err is NULL, allocates memory for a wcserr struct</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment">* (provided that status is non-zero).</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment">*</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment">* Given:</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment">* status int Numeric status code to set. If 0, then *err will be</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment">* deleted and *err will be returned as NULL.</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment">*</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment">* function const char *</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment">* Name of the function generating the error. This</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment">* must point to a constant string, i.e. in the</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment">* initialized read-only data section ("data") of the</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment">* executable.</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment">*</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment">* file const char *</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment">* Name of the source file generating the error. This</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment">* must point to a constant string, i.e. in the</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment">* initialized read-only data section ("data") of the</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment">* executable such as given by the __FILE__ preprocessor</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment">* macro.</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment">*</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment">* line_no int Line number in the source file generating the error</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment">* such as given by the __LINE__ preprocessor macro.</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment">*</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment">* format const char *</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment">* Format string of the error message. May contain</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment">* printf-style %-formatting codes.</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment">*</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment">* ... mixed The remaining variable arguments are applied (like</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment">* printf) to the format string to generate the error</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment">* message.</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment">*</span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment">* Function return value:</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment">* int The status return code passed in.</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment">*</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment">*</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment">* wcserr_copy() - Copy an error object</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment">* ------------------------------------</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment">* INTERNAL USE ONLY.</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment">*</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment">* wcserr_copy() copies one error object to another. Use of this function</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment">* should be avoided in general since the function, source file, and line</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment">* number information copied to the destination may lose its context.</span></div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment">*</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment">* Given:</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment">* src const struct wcserr*</span></div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment">* Source error object. If src is NULL, dst is cleared.</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment">*</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment">* Returned:</span></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment">* dst struct wcserr*</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment">* Destination error object. If NULL, no copy is made.</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment">*</span></div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment">* Function return value:</span></div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment">* int Numeric status code of the source error object.</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment">*</span></div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment">*</span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment">* WCSERR_SET() macro - Fill in the contents of an error object</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment">* ------------------------------------------------------------</span></div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment">* INTERNAL USE ONLY.</span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment">*</span></div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment">* WCSERR_SET() is a preprocessor macro that helps to fill in the argument list</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment">* of wcserr_set(). It takes status as an argument of its own and provides the</span></div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment">* name of the source file and the line number at the point where invoked. It</span></div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment">* assumes that the err and function arguments of wcserr_set() will be provided</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment">* by variables of the same names.</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment">*</span></div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment">*===========================================================================*/</span></div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="preprocessor">#ifndef WCSLIB_WCSERR</span></div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="preprocessor"></span><span class="preprocessor">#define WCSLIB_WCSERR</span></div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00219"></a><span class="lineno"><a class="code" href="wcserr_8h.html#ad53f2d5e6a70e53cb3decc6c7b42ad96"> 219</a></span> <span class="preprocessor">#define WCSERR_MSG_LENGTH 160</span></div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00221"></a><span class="lineno"><a class="code" href="structwcserr.html"> 221</a></span> <span class="keyword">struct </span><a class="code" href="structwcserr.html" title="Error message handling. ">wcserr</a> {</div>
<div class="line"><a name="l00222"></a><span class="lineno"><a class="code" href="structwcserr.html#a417d725c2e5615c3fb73cc210e0ccff2"> 222</a></span>  <span class="keywordtype">int</span> <a class="code" href="structwcserr.html#a417d725c2e5615c3fb73cc210e0ccff2">status</a>; <span class="comment">/* Status code for the error. */</span></div>
<div class="line"><a name="l00223"></a><span class="lineno"><a class="code" href="structwcserr.html#a210814c32ace19b9d09e4774e94a3c3c"> 223</a></span>  <span class="keywordtype">int</span> <a class="code" href="structwcserr.html#a210814c32ace19b9d09e4774e94a3c3c">line_no</a>; <span class="comment">/* Line number where the error occurred. */</span></div>
<div class="line"><a name="l00224"></a><span class="lineno"><a class="code" href="structwcserr.html#a311c9994c1d3793b2c98d706987bcd09"> 224</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keyword">function</span>; <span class="comment">/* Function name. */</span></div>
<div class="line"><a name="l00225"></a><span class="lineno"><a class="code" href="structwcserr.html#a278b3daecfc93a28c31750e6a6dc3718"> 225</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structwcserr.html#a278b3daecfc93a28c31750e6a6dc3718">file</a>; <span class="comment">/* Source file name. */</span></div>
<div class="line"><a name="l00226"></a><span class="lineno"><a class="code" href="structwcserr.html#acf8ea013ae1dc84ed25d5ace5a0a7000"> 226</a></span>  <span class="keywordtype">char</span> <a class="code" href="structwcserr.html#acf8ea013ae1dc84ed25d5ace5a0a7000">msg</a>[<a class="code" href="wcserr_8h.html#ad53f2d5e6a70e53cb3decc6c7b42ad96">WCSERR_MSG_LENGTH</a>]; <span class="comment">/* Informative error message. */</span></div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span> };</div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> </div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment">/* Size of the wcserr struct in int units, used by the Fortran wrappers. */</span></div>
<div class="line"><a name="l00230"></a><span class="lineno"><a class="code" href="wcserr_8h.html#a7b46d9cbaea3241d91e40d03a2725fd7"> 230</a></span> <span class="preprocessor">#define ERRLEN (sizeof(struct wcserr)/sizeof(int))</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="keywordtype">int</span> <a class="code" href="wcserr_8h.html#a1691b8bd184d40ca6fda255be078fa53" title="Enable/disable error messaging. ">wcserr_enable</a>(<span class="keywordtype">int</span> enable);</div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> </div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="keywordtype">int</span> <a class="code" href="wcserr_8h.html#a6585b9fc3a59b369e3336f3133dd1ca9" title="Print a wcserr struct. ">wcserr_prt</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structwcserr.html" title="Error message handling. ">wcserr</a> *err, <span class="keyword">const</span> <span class="keywordtype">char</span> *prefix);</div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> </div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="keywordtype">int</span> <a class="code" href="wcserr_8h.html#aa3843f24df9351294fa4847eaff672bc" title="Clear a wcserr struct. ">wcserr_clear</a>(<span class="keyword">struct</span> <a class="code" href="structwcserr.html" title="Error message handling. ">wcserr</a> **err);</div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> </div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> </div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment">/* INTERNAL USE ONLY -------------------------------------------------------*/</span></div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> </div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="keywordtype">int</span> <a class="code" href="wcserr_8h.html#ab0945d3588b604205b9c1b3d661a794f" title="Fill in the contents of an error object. ">wcserr_set</a>(<span class="keyword">struct</span> <a class="code" href="structwcserr.html" title="Error message handling. ">wcserr</a> **err, <span class="keywordtype">int</span> status, <span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keyword">function</span>,</div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *file, <span class="keywordtype">int</span> line_no, <span class="keyword">const</span> <span class="keywordtype">char</span> *format, ...);</div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> </div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="keywordtype">int</span> <a class="code" href="wcserr_8h.html#ad970e4ae584d3052b7bec2f1afb4689d" title="Copy an error object. ">wcserr_copy</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structwcserr.html" title="Error message handling. ">wcserr</a> *src, <span class="keyword">struct</span> <a class="code" href="structwcserr.html" title="Error message handling. ">wcserr</a> *dst);</div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span> </div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment">/* Convenience macro for invoking wcserr_set(). */</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"><a class="code" href="wcserr_8h.html#acfa8a447539633296d50e67c7ab466c2"> 247</a></span> <span class="preprocessor">#define WCSERR_SET(status) err, status, function, __FILE__, __LINE__</span></div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="preprocessor">#endif </span><span class="comment">/* WSCLIB_WCSERR */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jul 13 2013 20:00:26 for WCSLIB 4.18 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>
