← Back to branch summary

~ubuntu-branches/ubuntu/quantal/libircclient/quantal

« back to all changes in this revision

Viewing changes to doc/html/pagefaq.html

  • Committer: Bazaar Package Importer
  • Author(s): Bradley Smith
  • Date: 2009-01-05 22:46:15 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20090105224615-j4djww5j1gkoy9y8
Tags: 1.3+dfsg1-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/pagefaq.html
1
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3
3
<title>libircclient: Frequently Asked Questions</title>
4
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
5
<link href="tabs.css" rel="stylesheet" type="text/css">
6
6
</head><body>
7
 
<!-- Generated by Doxygen 1.4.6 -->
8
 
<div class="tabs">
9
 
  <ul>
10
 
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11
 
    <li><a href="modules.html"><span>Modules</span></a></li>
12
 
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13
 
    <li><a href="files.html"><span>Files</span></a></li>
14
 
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
15
 
  </ul></div>
16
 
<h1><a class="anchor" name="pagefaq">Frequently Asked Questions</a></h1><h2><a class="anchor" name="faq">
 
7
<!-- Generated by Doxygen 1.5.6 -->
 
8
<div class="navigation" id="top">
 
9
  <div class="tabs">
 
10
    <ul>
 
11
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
 
12
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
 
13
      <li><a href="modules.html"><span>Modules</span></a></li>
 
14
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
 
15
      <li><a href="files.html"><span>Files</span></a></li>
 
16
    </ul>
 
17
  </div>
 
18
</div>
 
19
<div class="contents">
 
20
<h1><a class="anchor" name="pagefaq">Frequently Asked Questions </a></h1><h2><a class="anchor" name="faq">
17
21
FAQ</a></h2>
18
22
<h3><a class="anchor" name="faq1">
19
23
Why the IRC server generates all these event_numeric events, and what is their meaning?</a></h3>
23
27
Why the irc_cmd_... functions does not return an error if the IRC server reports it? For example, why irc_cmd_join() returns success when I attempt to join a password-protected channel, and then the IRC server sends an error?</a></h3>
24
28
The irc_cmd_... functions return success when the command is sent to the IRC server. The asynchronous nature of IRC makes it impossible to obtain the command result immediately. Please read <a class="el" href="pagefaq.html#faq1">Why the IRC server generates all these event_numeric events, and what is their meaning?</a>.<h3><a class="anchor" name="faq3">
25
29
How to register/auth with NICKSERV?</a></h3>
26
 
There is no 'standard' way. However, knowing that all NICKSERV messages are sent via <a class="el" href="structirc__callbacks__t.html#92a5b22ba900f06fa04ea9e79462ffc6">irc_callbacks_t::event_notice</a>, you can use following algorithm: <div class="fragment"><pre class="fragment"><span class="keyword">static</span> <span class="keywordtype">void</span> event_notice (<a class="code" href="libircclient_8h.html#0030a976ab3e6a247d57e30fd5979cd5">irc_session_t</a> * session, <span class="keyword">const</span> <span class="keywordtype">char</span> * event, 
 
30
There is no 'standard' way. However, knowing that all NICKSERV messages are sent via <a class="el" href="structirc__callbacks__t.html#92a5b22ba900f06fa04ea9e79462ffc6">irc_callbacks_t::event_notice</a>, you can use following algorithm: <div class="fragment"><pre class="fragment"><span class="keyword">static</span> <span class="keywordtype">void</span> event_notice (<a class="code" href="libircclient_8h.html#0030a976ab3e6a247d57e30fd5979cd5" title="A libircclient IRC session.">irc_session_t</a> * session, <span class="keyword">const</span> <span class="keywordtype">char</span> * event, 
27
31
             <span class="keyword">const</span> <span class="keywordtype">char</span> * origin, <span class="keyword">const</span> <span class="keywordtype">char</span> ** params, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> count)
28
32
{
29
33
    <span class="keywordtype">char</span> buf[256];
37
41
    <span class="keywordflow">if</span> ( strstr (params[1], <span class="stringliteral">"This nick is not registered"</span>) == params[1] )
38
42
    {
39
43
        sprintf (buf, <span class="stringliteral">"REGISTER %s NOMAIL"</span>, gCfg.irc_nickserv_password);
40
 
        <a class="code" href="group__ircmd__msg.html#g8c2ec03f1a9ce7c739e11b64fd088ae5">irc_cmd_msg</a> (session, <span class="stringliteral">"nickserv"</span>, buf);
 
44
        <a class="code" href="group__ircmd__msg.html#g8c2ec03f1a9ce7c739e11b64fd088ae5" title="Sends the message to the nick or to the channel.">irc_cmd_msg</a> (session, <span class="stringliteral">"nickserv"</span>, buf);
41
45
    }
42
46
    <span class="keywordflow">else</span> <span class="keywordflow">if</span> ( strstr (params[1], <span class="stringliteral">"This nickname is registered and protected"</span>) 
43
47
      == params[1] )
44
48
    {
45
49
        sprintf (buf, <span class="stringliteral">"IDENTIFY %s"</span>, gCfg.irc_nickserv_password);
46
 
        <a class="code" href="group__ircmd__msg.html#g8c2ec03f1a9ce7c739e11b64fd088ae5">irc_cmd_msg</a> (session, <span class="stringliteral">"nickserv"</span>, buf);
 
50
        <a class="code" href="group__ircmd__msg.html#g8c2ec03f1a9ce7c739e11b64fd088ae5" title="Sends the message to the nick or to the channel.">irc_cmd_msg</a> (session, <span class="stringliteral">"nickserv"</span>, buf);
47
51
    }
48
52
    <span class="keywordflow">else</span> <span class="keywordflow">if</span> ( strstr (params[1], <span class="stringliteral">"Password accepted - you are now recognized"</span>) 
49
53
      == params[1] )
64
68
    <span class="comment">// report an error</span>
65
69
 
66
70
<span class="comment">// And now we can use libircclient</span>
67
 
</pre></div> <hr size="1"><address style="align: right;"><small>Generated on Tue Aug 29 21:52:31 2006 for libircclient by&nbsp;
 
71
</pre></div> </div>
 
72
<hr size="1"><address style="text-align: right;"><small>Generated on Sat Jan 3 15:01:06 2009 for libircclient by&nbsp;
68
73
<a href="http://www.doxygen.org/index.html">
69
 
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
 
74
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
70
75
</body>
71
76
</html>