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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libircclient: Obtaining error values and descriptions.</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.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Obtaining error values and descriptions.</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__errors.html#g3a18336093ee74751244d996bc32247d">irc_errno</a> (<a class="el" href="libircclient_8h.html#0030a976ab3e6a247d57e30fd5979cd5">irc_session_t</a> *session)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the last error code. <a href="#g3a18336093ee74751244d996bc32247d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__errors.html#gfdc70ca04626818d2fd9a55da0b90e5f">irc_strerror</a> (int ircerrno)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the text error message associated with this error code. <a href="#gfdc70ca04626818d2fd9a55da0b90e5f"></a><br></td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g3a18336093ee74751244d996bc32247d"></a><!-- doxytag: member="libircclient.h::irc_errno" ref="g3a18336093ee74751244d996bc32247d" args="(irc_session_t *session)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int irc_errno </td>
<td>(</td>
<td class="paramtype"><a class="el" href="libircclient_8h.html#0030a976ab3e6a247d57e30fd5979cd5">irc_session_t</a> * </td>
<td class="paramname"> <em>session</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the last error code.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>session</em> </td><td>An initiated session.</td></tr>
</table>
</dl>
This function returns the last error code associated with last operation of this IRC session. Possible error codes are defined in <a class="el" href="libirc__errors_8h.html" title="This file defines error codes generated by libircclient.">libirc_errors.h</a><p>
As usual, next errno rules apply:<ul>
<li><a class="el" href="group__errors.html#g3a18336093ee74751244d996bc32247d" title="Returns the last error code.">irc_errno()</a> should be called ONLY if the called function fails;</li><li><a class="el" href="group__errors.html#g3a18336093ee74751244d996bc32247d" title="Returns the last error code.">irc_errno()</a> doesn't return 0 if function succeed; actually, the return value will be undefined.</li><li>you should call <a class="el" href="group__errors.html#g3a18336093ee74751244d996bc32247d" title="Returns the last error code.">irc_errno()</a> IMMEDIATELY after function fails, before calling any other libircclient function.</li></ul>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__errors.html#gfdc70ca04626818d2fd9a55da0b90e5f" title="Returns the text error message associated with this error code.">irc_strerror</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="gfdc70ca04626818d2fd9a55da0b90e5f"></a><!-- doxytag: member="libircclient.h::irc_strerror" ref="gfdc70ca04626818d2fd9a55da0b90e5f" args="(int ircerrno)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * irc_strerror </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>ircerrno</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the text error message associated with this error code.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ircerrno</em> </td><td>A numeric error code returned by <a class="el" href="group__errors.html#g3a18336093ee74751244d996bc32247d" title="Returns the last error code.">irc_errno()</a></td></tr>
</table>
</dl>
This function returns the text representation of the given error code.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__errors.html#g3a18336093ee74751244d996bc32247d" title="Returns the last error code.">irc_errno()</a> </dd></dl>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sat Jan 3 15:01:06 2009 for libircclient by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
|
