updates.
[website.git] / docs / toolkit / manual / silcstatus-SilcStatus.html
1
2 <html>
3 <head>
4  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-a" />
5  <meta http-equiv="Content-Language" content="en" />
6  <meta name="description" content="SILC Secure Internet Live Conferencing" />
7  <meta name="keywords" content="SILC, secure, chat, protocol, cipher, encrypt, SKE" />
8  <meta content="INDEX, FOLLOW" name="ROBOTS" />
9  <style type="text/css">
10   <!--
11   body { color: #000000; background: #f0f0f0; font-family: Helvetica, Arial, Sans-serif; }
12   a:link { text-decoration: none; color: #2f488f; }
13   a:visited { text-decoration: none;color: #2f488f; }
14   a:active { text-decoration: none; color: #2f488f; }
15   -->
16  </style>
17 </head>
18
19 <body topmargin="0" leftmargin="0" marginheight="0" marginwidth="0">
20
21 <table border="0" cellspacing="0" cellpadding="6" width="100%">
22  <tr valign="top" bgcolor="#dddddd">
23   <td><small>Copyright &copy; 2001 - 2007 SILC Project<br />
24     <a href="http://silcnet.org">SILC Project Website</a></small></td>
25   <td align="right"><small>
26    <a href="index.html">SILC Toolkit Reference Manual</a><br />
27    <a href="toolkit_index.html">Index</a></small></td>
28    </small></td>
29  </tr>
30 </table>
31 <table border="0" cellspacing="0" cellpadding="0" width="100%">
32 <tr bgcolor="#444444"><td><img src="space.gif" width="1" height="1"border="0" alt="" ></td></tr>
33 </table>
34
35 <table cellpadding="0" cellspacing="0" border="0">
36  <tr valign="top">
37
38   <td width="200" bgcolor="#f0f0f0">
39    <img src="space.gif" width="1" height="1" border="0" alt="">
40    <table width="100%" cellpadding="2" cellspacing="2" border="0">
41     <tr valign="top"><td>
42 <br />
43 <small>
44 <!-- Template file for the big index that appears in the Toolkit reference
45 manual on the left side.  With this file it is possible to add other than
46 automatically generated links to that list. -->
47
48 <a href="index.html"><img src="box.gif" border="0" alt="">SILC Toolkit Reference Manual</a><br />
49
50
51 <a href=silccryptlib.html><img src=box.gif border=0 alt=>SILC Crypto Library</a><br />
52 &nbsp;&nbsp;&nbsp; <a href=silcrng_intro.html><img src=box2.gif border=0 alt=>Introduction to SILC RNG</a><br />
53 &nbsp;&nbsp;&nbsp; <a href=silcrng.html><img src=box2.gif border=0 alt=>SILC RNG Interface</a><br />
54 &nbsp;&nbsp;&nbsp; <a href=silccipher.html><img src=box2.gif border=0 alt=>SILC Cipher API</a><br />
55 &nbsp;&nbsp;&nbsp; <a href=silcpkcs.html><img src=box2.gif border=0 alt=>SILC PKCS API</a><br />
56 &nbsp;&nbsp;&nbsp; <a href=silcpk.html><img src=box2.gif border=0 alt=>SILC Public Key API</a><br />
57 &nbsp;&nbsp;&nbsp; <a href=silcpkcs1.html><img src=box2.gif border=0 alt=>SILC PKCS #1 API</a><br />
58 &nbsp;&nbsp;&nbsp; <a href=silchash.html><img src=box2.gif border=0 alt=>SILC Hash Interface</a><br />
59 &nbsp;&nbsp;&nbsp; <a href=silchmac.html><img src=box2.gif border=0 alt=>SILC HMAC Interface</a><br />
60 <a href=silccorelib.html><img src=box.gif border=0 alt=>SILC Core Library</a><br />
61 &nbsp;&nbsp;&nbsp; <a href=silcauth.html><img src=box2.gif border=0 alt=>SILC Authentication Interface</a><br />
62 &nbsp;&nbsp;&nbsp; <a href=silcmessage.html><img src=box2.gif border=0 alt=>SILC Message Interface</a><br />
63 &nbsp;&nbsp;&nbsp; <a href=silcchannel.html><img src=box2.gif border=0 alt=>SILC Channel Interface</a><br />
64 &nbsp;&nbsp;&nbsp; <a href=silccommand.html><img src=box2.gif border=0 alt=>SILC Command Interface</a><br />
65 &nbsp;&nbsp;&nbsp; <a href=silcnotify.html><img src=box2.gif border=0 alt=>SILC Notify Interface</a><br />
66 &nbsp;&nbsp;&nbsp; <a href=silcstatus.html><img src=box2.gif border=0 alt=>SILC Status Types</a><br />
67 &nbsp;&nbsp;&nbsp; <a href=silcmode.html><img src=box2.gif border=0 alt=>SILC Modes</a><br />
68 &nbsp;&nbsp;&nbsp; <a href=silcid.html><img src=box2.gif border=0 alt=>SILC ID Interface</a><br />
69 &nbsp;&nbsp;&nbsp; <a href=silcargument.html><img src=box2.gif border=0 alt=>SILC Argument Interface</a><br />
70 &nbsp;&nbsp;&nbsp; <a href=silcattrs.html><img src=box2.gif border=0 alt=>SILC Attributes Interface</a><br />
71 &nbsp;&nbsp;&nbsp; <a href=silcpacket.html><img src=box2.gif border=0 alt=>Packet Engine Interface</a><br />
72 &nbsp;&nbsp;&nbsp; <a href=silcpubkey.html><img src=box2.gif border=0 alt=>SILC Public Key Payload Interface</a><br />
73 <a href=silcskelib.html><img src=box.gif border=0 alt=>SILC Key Exchange Library</a><br />
74 &nbsp;&nbsp;&nbsp; <a href=silcske.html><img src=box2.gif border=0 alt=>SILC SKE Interface</a><br />
75 &nbsp;&nbsp;&nbsp; <a href=silcconnauth.html><img src=box2.gif border=0 alt=>SILC Connection Authentication Interface</a><br />
76 <a href=silcvcardlib.html><img src=box.gif border=0 alt=>SILC VCard Library</a><br />
77 &nbsp;&nbsp;&nbsp; <a href=silcvcard.html><img src=box2.gif border=0 alt=>SILC VCard Interface</a><br />
78 <a href=silcmathlib.html><img src=box.gif border=0 alt=>SILC Math Library</a><br />
79 &nbsp;&nbsp;&nbsp; <a href=silcmp.html><img src=box2.gif border=0 alt=>SILC MP Interface</a><br />
80 &nbsp;&nbsp;&nbsp; <a href=silcmath.html><img src=box2.gif border=0 alt=>SILC Math Interface</a><br />
81 <a href=silcclientlib.html><img src=box.gif border=0 alt=>SILC Client Library</a><br />
82 &nbsp;&nbsp;&nbsp; <a href=silcclient_using.html><img src=box2.gif border=0 alt=>Using SILC Client Library Tutorial</a><br />
83 &nbsp;&nbsp;&nbsp; <a href=command_reply_args.html><img src=box2.gif border=0 alt=>Arguments for <b>command_reply</b> Client Operation</a><br />
84 &nbsp;&nbsp;&nbsp; <a href=silcstatus_args.html><img src=box2.gif border=0 alt=>SilcStatus Error Arguments in <b>command_reply</b> Client Operation</a><br />
85 &nbsp;&nbsp;&nbsp; <a href=notifyargs.html><img src=box2.gif border=0 alt=>Arguments for <b>notify</b> Client Operation</a><br />
86 &nbsp;&nbsp;&nbsp; <a href=silcclient_unicode.html><img src=box2.gif border=0 alt=>Unicode and UTF-8 Strings in Client Library</a><br />
87 &nbsp;&nbsp;&nbsp; <a href=silcclient.html><img src=box2.gif border=0 alt=>Client Library Interface Reference</a><br />
88 &nbsp;&nbsp;&nbsp; <a href=silcclient_entry.html><img src=box2.gif border=0 alt=>Client Entry Interface Reference</a><br />
89 <a href=silcasn1lib.html><img src=box.gif border=0 alt=>SILC ASN.1 Library</a><br />
90 &nbsp;&nbsp;&nbsp; <a href=silcasn1.html><img src=box2.gif border=0 alt=>SILC ASN.1 Interface</a><br />
91 &nbsp;&nbsp;&nbsp; <a href=silcber.html><img src=box2.gif border=0 alt=>SILC BER interface</a><br />
92 <a href=silchttplib.html><img src=box.gif border=0 alt=>SILC HTTP Library</a><br />
93 &nbsp;&nbsp;&nbsp; <a href=silchttpserver.html><img src=box2.gif border=0 alt=>SILC HTTP Server Interface</a><br />
94 &nbsp;&nbsp;&nbsp; <a href=silchttpphp.html><img src=box2.gif border=0 alt=>SILC HTTP PHP Translator</a><br />
95 <a href=silcutillib.html><img src=box.gif border=0 alt=>SILC Utility Library</a><br />
96 &nbsp;&nbsp;&nbsp; <a href=silctypes.html><img src=box2.gif border=0 alt=>Basic Types and Definitions</a><br />
97 &nbsp;&nbsp;&nbsp; <a href=silcbuffer.html><img src=box2.gif border=0 alt=>Data Buffer Interface</a><br />
98 &nbsp;&nbsp;&nbsp; <a href=silcbuffmt.html><img src=box2.gif border=0 alt=>Data Buffer Format Interface</a><br />
99 &nbsp;&nbsp;&nbsp; <a href=silchashtable.html><img src=box2.gif border=0 alt=>Hash Table Interface</a><br />
100 &nbsp;&nbsp;&nbsp; <a href=silcmemory.html><img src=box2.gif border=0 alt=>Memory Allocation Interface</a><br />
101 &nbsp;&nbsp;&nbsp; <a href=silcstack.html><img src=box2.gif border=0 alt=>Data Stack (memory pool) Interface</a><br />
102 &nbsp;&nbsp;&nbsp; <a href=silcfsm.html><img src=box2.gif border=0 alt=>Finite State Machine Interface</a><br />
103 &nbsp;&nbsp;&nbsp; <a href=silcthread.html><img src=box2.gif border=0 alt=>Thread Interface</a><br />
104 &nbsp;&nbsp;&nbsp; <a href=silcmutex.html><img src=box2.gif border=0 alt=>Mutual Exclusion Lock Interface</a><br />
105 &nbsp;&nbsp;&nbsp; <a href=silccond.html><img src=box2.gif border=0 alt=>Condition Variable Interface</a><br />
106 &nbsp;&nbsp;&nbsp; <a href=silcatomic.html><img src=box2.gif border=0 alt=>Atomic Operations Interface</a><br />
107 &nbsp;&nbsp;&nbsp; <a href=silcnet.html><img src=box2.gif border=0 alt=>Network (TCP and UDP) Interface</a><br />
108 &nbsp;&nbsp;&nbsp; <a href=silcschedule.html><img src=box2.gif border=0 alt=>Scheduler Interface</a><br />
109 &nbsp;&nbsp;&nbsp; <a href=silcasync.html><img src=box2.gif border=0 alt=>Asynchronous Operation Interface</a><br />
110 &nbsp;&nbsp;&nbsp; <a href=silcstream.html><img src=box2.gif border=0 alt=>Abstract Stream Interface</a><br />
111 &nbsp;&nbsp;&nbsp; <a href=silcsocketstream.html><img src=box2.gif border=0 alt=>Socket Stream Interface</a><br />
112 &nbsp;&nbsp;&nbsp; <a href=silcfdstream.html><img src=box2.gif border=0 alt=>File Descriptor Stream Interface</a><br />
113 &nbsp;&nbsp;&nbsp; <a href=silcfileutil.html><img src=box2.gif border=0 alt=>File Utility Functions</a><br />
114 &nbsp;&nbsp;&nbsp; <a href=silcstrutil.html><img src=box2.gif border=0 alt=>String Utility Interface</a><br />
115 &nbsp;&nbsp;&nbsp; <a href=silcsnprintf.html><img src=box2.gif border=0 alt=>Snprintf Interface</a><br />
116 &nbsp;&nbsp;&nbsp; <a href=silcutf8.html><img src=box2.gif border=0 alt=>UTF-8 String Interface</a><br />
117 &nbsp;&nbsp;&nbsp; <a href=silcstringprep.html><img src=box2.gif border=0 alt=>Stringprep Interface</a><br />
118 &nbsp;&nbsp;&nbsp; <a href=silcutil.html><img src=box2.gif border=0 alt=>Utility Functions</a><br />
119 &nbsp;&nbsp;&nbsp; <a href=silclist.html><img src=box2.gif border=0 alt=>List Interface</a><br />
120 &nbsp;&nbsp;&nbsp; <a href=silcdlist.html><img src=box2.gif border=0 alt=>Dynamic List Interface</a><br />
121 &nbsp;&nbsp;&nbsp; <a href=silcmime.html><img src=box2.gif border=0 alt=>MIME Interface</a><br />
122 &nbsp;&nbsp;&nbsp; <a href=silctime.html><img src=box2.gif border=0 alt=>Time Utility Functions</a><br />
123 &nbsp;&nbsp;&nbsp; <a href=silclog.html><img src=box2.gif border=0 alt=>Logging Interface</a><br />
124 &nbsp;&nbsp;&nbsp; <a href=silcconfig.html><img src=box2.gif border=0 alt=>Config File Interface</a><br />
125 <a href=silcskrlib.html><img src=box.gif border=0 alt=>SILC Key Repository Library</a><br />
126 &nbsp;&nbsp;&nbsp; <a href=silcskr.html><img src=box2.gif border=0 alt=>SILC SKR Interface</a><br />
127 <a href=silcaputillib.html><img src=box.gif border=0 alt=>SILC Application Utility Library</a><br />
128 &nbsp;&nbsp;&nbsp; <a href=silcapputil.html><img src=box2.gif border=0 alt=>SILC Application Utilities</a><br />
129 &nbsp;&nbsp;&nbsp; <a href=silcidcache.html><img src=box2.gif border=0 alt=>SILC ID Cache Interface</a><br />
130 <a href=silcsftplib.html><img src=box.gif border=0 alt=>SILC SFTP Library</a><br />
131 &nbsp;&nbsp;&nbsp; <a href=silcsftp.html><img src=box2.gif border=0 alt=>SILC SFTP Interface</a><br />
132 &nbsp;&nbsp;&nbsp; <a href=silcsftp_fs.html><img src=box2.gif border=0 alt=>SFTP Filesystems Interface</a><br />
133
134 <br />
135 <b>Resource Links</b>
136 <br />
137 <a href="http://silcnet.org"><img src="box.gif" border="0" alt="">SILC Project Website</a><br />
138 <a href="http://silcnet.org/support/documentation/"><img src="box.gif" border="0" alt="">SILC Protocol Documentation</a><br />
139 <a href="http://silcnet.org/support/documentation/wp/"><img src="box.gif" border="0" alt="">SILC White Paper</a><br />
140 <a href="http://silcnet.org/support/faq/"><img src="box.gif" border="0" alt="">SILC FAQs</a><br />
141
142 </small>
143 <br /><br /><br /><br />
144     </td></tr>
145    </table>
146   </td>
147
148   <td bgcolor="#cccccc" background="dot.gif">
149    <img src="space.gif" width="1" height="1" border="0" alt=""></td>
150
151   <td width="720" bgcolor="#ffffff">
152    <img src="space.gif" width="1" height="1" border="0" alt="">
153    <table cellpadding="2" cellspacing="6" width="100%">
154     <tr><td valign="top">
155 <br />
156
157 <FONT SIZE="+2" COLOR="#000055"><B><A NAME="SilcStatus">SilcStatus</A></FONT></B><BR><BR>
158
159 <FONT SIZE="+1"><B>
160 <FONT COLOR="#000055">NAME
161 </FONT></B></FONT>
162 <PRE><FONT FACE="courier" size="3">
163     typedef <A HREF="silctypes-SilcUInt8.html">SilcUInt8</A> <B>SilcStatus</B>
164
165 </FONT></PRE><FONT SIZE="+1"><B>
166 <FONT COLOR="#000055">DESCRIPTION
167 </FONT></B></FONT>
168 <PRE><FONT FACE="Helvetiva,Arial,Sans-serif">
169     The <B>SilcStatus</B> type definition and the status defines.  The
170     server returns a status in each Command Payload indicating
171     the status of the command.  The server can also return this
172     inside SILC_NOTIFY_TYPE_ERROR notify type.
173
174 </FONT></PRE><FONT SIZE="+1"><B>
175 <FONT COLOR="#000055">SOURCE
176 </FONT></B></FONT>
177 <PRE><FONT FACE="courier" size="3">    typedef <A HREF="silctypes-SilcUInt8.html">SilcUInt8</A> <B>SilcStatus</B>;
178     
179     /* Command Status messages */
180     #define SILC_STATUS_OK                      0
181     #define SILC_STATUS_LIST_START              1
182     #define SILC_STATUS_LIST_ITEM               2
183     #define SILC_STATUS_LIST_END                3
184     #define SILC_STATUS_ERR_NO_SUCH_NICK        10
185     #define SILC_STATUS_ERR_NO_SUCH_CHANNEL     11
186     #define SILC_STATUS_ERR_NO_SUCH_SERVER      12
187     #define SILC_STATUS_ERR_INCOMPLETE_INFORMATION    13
188     #define SILC_STATUS_ERR_NO_RECIPIENT        14
189     #define SILC_STATUS_ERR_UNKNOWN_COMMAND     15
190     #define SILC_STATUS_ERR_WILDCARDS           16
191     #define SILC_STATUS_ERR_NO_CLIENT_ID        17
192     #define SILC_STATUS_ERR_NO_CHANNEL_ID       18
193     #define SILC_STATUS_ERR_NO_SERVER_ID        19
194     #define SILC_STATUS_ERR_BAD_CLIENT_ID       20
195     #define SILC_STATUS_ERR_BAD_CHANNEL_ID      21
196     #define SILC_STATUS_ERR_NO_SUCH_CLIENT_ID   22
197     #define SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID  23
198     #define SILC_STATUS_ERR_NICKNAME_IN_USE     24
199     #define SILC_STATUS_ERR_NOT_ON_CHANNEL      25
200     #define SILC_STATUS_ERR_USER_NOT_ON_CHANNEL 26
201     #define SILC_STATUS_ERR_USER_ON_CHANNEL     27
202     #define SILC_STATUS_ERR_NOT_REGISTERED      28
203     #define SILC_STATUS_ERR_NOT_ENOUGH_PARAMS   29
204     #define SILC_STATUS_ERR_TOO_MANY_PARAMS     30
205     #define SILC_STATUS_ERR_PERM_DENIED         31
206     #define SILC_STATUS_ERR_BANNED_FROM_SERVER  32
207     #define SILC_STATUS_ERR_BAD_PASSWORD        33
208     #define SILC_STATUS_ERR_CHANNEL_IS_FULL     34
209     #define SILC_STATUS_ERR_NOT_INVITED         35
210     #define SILC_STATUS_ERR_BANNED_FROM_CHANNEL 36
211     #define SILC_STATUS_ERR_UNKNOWN_MODE        37
212     #define SILC_STATUS_ERR_NOT_YOU             38
213     #define SILC_STATUS_ERR_NO_CHANNEL_PRIV     39
214     #define SILC_STATUS_ERR_NO_CHANNEL_FOPRIV   40
215     #define SILC_STATUS_ERR_NO_SERVER_PRIV      41
216     #define SILC_STATUS_ERR_NO_ROUTER_PRIV      42
217     #define SILC_STATUS_ERR_BAD_NICKNAME        43
218     #define SILC_STATUS_ERR_BAD_CHANNEL         44
219     #define SILC_STATUS_ERR_AUTH_FAILED         45
220     #define SILC_STATUS_ERR_UNKNOWN_ALGORITHM   46
221     #define SILC_STATUS_ERR_NO_SUCH_SERVER_ID   47
222     #define SILC_STATUS_ERR_RESOURCE_LIMIT      48
223     #define SILC_STATUS_ERR_NO_SUCH_SERVICE     49
224     #define SILC_STATUS_ERR_NOT_AUTHENTICATED   50
225     #define SILC_STATUS_ERR_BAD_SERVER_ID       51
226     #define SILC_STATUS_ERR_KEY_EXCHANGE_FAILED 52
227     #define SILC_STATUS_ERR_BAD_VERSION         53
228     #define SILC_STATUS_ERR_TIMEDOUT            54
229     #define SILC_STATUS_ERR_UNSUPPORTED_PUBLIC_KEY    55
230     #define SILC_STATUS_ERR_OPERATION_ALLOWED   56
231     #define SILC_STATUS_ERR_BAD_SERVER          57
232     #define SILC_STATUS_ERR_BAD_USERNAME        58
233     #define SILC_STATUS_ERR_NO_SUCH_PUBLIC_KEY  59</FONT></PRE>
234 <br /><br /><br /><br />
235     </td></tr>
236    </table>
237   </td>
238
239   <td bgcolor="#cccccc" background="dot.gif">
240    <img src="space.gif" width="1" height="1" border="0" alt=""></td>
241
242   <td width="180" bgcolor="#f0f0f0">
243     <img src="space.gif" width="1" height="1" border="0" alt="">
244     <table width="100%" cellpadding="4" cellspacing="0">
245     <tr valign="top"><td>
246 <br />
247 <font face="Helvetica,Arial,Sans-serif" size="1">
248 <A HREF="silcstatus.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SILC Status Types</A><BR>
249 <A HREF="silcstatus-SilcStatus.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcStatus</A><BR>
250 <A HREF="silcstatus-silc_status_get_args.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_status_get_args</A><BR>
251 </font>
252
253 <br /><br /><br /><br />
254     </td></tr>
255     </table>
256   </td>
257 </tr>
258 </table>
259
260 <table border="0" cellspacing="0" cellpadding="0" width="100%">
261 <tr bgcolor="#444444"><td><img src="space.gif" width="1" height="1"border="0" alt="" ></td></tr>
262 </table>
263 <table border="0" cellspacing="0" cellpadding="6" width="100%">
264  <tr valign="top" bgcolor="#dddddd">
265   <td><small>Copyright &copy; 2001 - 2007 SILC Project<br />
266     <a href="http://silcnet.org">SILC Project Website</a></small></td>
267   <td align="right"><small>
268    <a href="index.html">SILC Toolkit Reference Manual</a><br />
269    <a href="toolkit_index.html">Index</a></small></td>
270    </small></td>
271  </tr>
272 </table>
273
274 </body>
275 </html>