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
|
<!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: Managing libircclient options.</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>Managing libircclient options.</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__options.html#geba7a9cf7f7808a61f945a58c6d780f8">LIBIRC_OPTION_DEBUG</a> (1 << 1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__options.html#g0dd67b0a5373a108d86d911fa5741e72">LIBIRC_OPTION_STRIPNICKS</a> (1 << 2)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">allows to strip origins automatically. <a href="#g0dd67b0a5373a108d86d911fa5741e72"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__options.html#gc5d81f651f1441690f3f59c3ddccaa48">irc_option_set</a> (<a class="el" href="libircclient_8h.html#0030a976ab3e6a247d57e30fd5979cd5">irc_session_t</a> *session, unsigned int option)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the libircclient option. <a href="#gc5d81f651f1441690f3f59c3ddccaa48"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__options.html#gf56687ccad2045204ae23f70d2f54860">irc_option_reset</a> (<a class="el" href="libircclient_8h.html#0030a976ab3e6a247d57e30fd5979cd5">irc_session_t</a> *session, unsigned int option)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resets the libircclient option. <a href="#gf56687ccad2045204ae23f70d2f54860"></a><br></td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="geba7a9cf7f7808a61f945a58c6d780f8"></a><!-- doxytag: member="libirc_options.h::LIBIRC_OPTION_DEBUG" ref="geba7a9cf7f7808a61f945a58c6d780f8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LIBIRC_OPTION_DEBUG (1 << 1) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
enables additional debug output
</div>
</div><p>
<a class="anchor" name="g0dd67b0a5373a108d86d911fa5741e72"></a><!-- doxytag: member="libirc_options.h::LIBIRC_OPTION_STRIPNICKS" ref="g0dd67b0a5373a108d86d911fa5741e72" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LIBIRC_OPTION_STRIPNICKS (1 << 2) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
allows to strip origins automatically.
<p>
For every IRC server event, the event origin is sent in standard form: nick!host@ircserver, i.e. like tim!home@irc.krasnogorsk.ru. Such origins can not be used in IRC commands, and need to be stripped (i.e. host and server part should be cut off) before using. This can be done either explicitly, by calling <a class="el" href="group__nnparse.html#g217df7c7c7dc5e60678dd14e24e41f03" title="Gets the nick part from the target.">irc_target_get_nick()</a>, or implicitly for all the events - by setting this option with <a class="el" href="group__options.html#gc5d81f651f1441690f3f59c3ddccaa48" title="Sets the libircclient option.">irc_option_set()</a>.
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gf56687ccad2045204ae23f70d2f54860"></a><!-- doxytag: member="libircclient.h::irc_option_reset" ref="gf56687ccad2045204ae23f70d2f54860" args="(irc_session_t *session, unsigned int option)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void irc_option_reset </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>option</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Resets the libircclient option.
<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>
<tr><td valign="top"></td><td valign="top"><em>option</em> </td><td>An option from <a class="el" href="libirc__options_8h.html" title="This file defines the options used in irc_session_options().">libirc_options.h</a></td></tr>
</table>
</dl>
This function removes the previously set libircclient option, changing libircclient behavior. See the option list for the meaning for every option.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__options.html#gc5d81f651f1441690f3f59c3ddccaa48" title="Sets the libircclient option.">irc_option_set</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="gc5d81f651f1441690f3f59c3ddccaa48"></a><!-- doxytag: member="libircclient.h::irc_option_set" ref="gc5d81f651f1441690f3f59c3ddccaa48" args="(irc_session_t *session, unsigned int option)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void irc_option_set </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>option</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the libircclient option.
<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>
<tr><td valign="top"></td><td valign="top"><em>option</em> </td><td>An option from <a class="el" href="libirc__options_8h.html" title="This file defines the options used in irc_session_options().">libirc_options.h</a></td></tr>
</table>
</dl>
This function sets the libircclient option, changing libircclient behavior. See the option list for the meaning for every option.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__options.html#gf56687ccad2045204ae23f70d2f54860" title="Resets the libircclient option.">irc_option_reset</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>
|
