X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=lib%2Fdoc%2Fsilcclient_using.html;h=2ad2981f9df83e2126404f6e6490722447dac062;hb=09bae6acdf9a519c6d9b4e7535e7f7e56b6c24c1;hp=84a41b250d236290b72d0991ef9dda3770c85eee;hpb=f93d80a4907e9ddd4bdc8b12a9f82cf2b279d07b;p=silc.git diff --git a/lib/doc/silcclient_using.html b/lib/doc/silcclient_using.html index 84a41b25..2ad2981f 100644 --- a/lib/doc/silcclient_using.html +++ b/lib/doc/silcclient_using.html @@ -13,14 +13,14 @@ common and core compomnent of SILC protocol from the lib/silccore, SKE from lib/silcske and general utility routines from lib/silcutil.
 
-The `silcapi.h' file defines the function prototypes that application +The `silcclient.h' file defines the function prototypes that application must implement in order to be able to create the user interface with the library. The idea is that the application can implement whatever user interface routines in the functions and display the data whatever way it wants. The library is entirely transparent to the user interface and it does not include any user interface specific issues such as window handling or item handling on the screen etc. These does not interest -the library. The `silcapi.h' also defines the client libary interface +the library. The `silcclient.h' also defines the client libary interface the application can call. The interface includes for example functions for sending channel and private messages, client and channel retrieval and other utility functions. @@ -35,19 +35,7 @@ get access all SILC Client Library routines:
 
#include "silcincludes.h"
-#include "clientlibincludes.h" -
- -
 
-If you are compiling with C++ compiler then you need to include the -headers as follows: - -
 
- -extern "C" {
-#include "silcincludes.h"
-#include "clientlibincludes.h"
-} +#include "silcclient.h"
@@ -66,7 +54,7 @@ The client object is SilcClient which is usually allocated in following manner:
 
-  SilcClient client = silc_client_alloc(&ops, params, context, version); +  SilcClient client = silc_client_alloc(&ops, params, context, silc_version_string);
 
`ops' is the static structure of client operations that library will call. @@ -76,6 +64,10 @@ SilcClient is always passed to the application thus the application specific context can be retrieved from the SilcClient object. See `client.h' file for detailed definition of SilcClient object. +
 
+The `silc_version_string' is the current protocol version string, and you +can get it by including `silcversion.h' header in your source code. +
 
`ops' can be defined for example as follows: @@ -301,7 +293,7 @@ the connections. The SilcClientOperations are expected to be implemented.
 
 #include "silcincludes.h"
-#include "silcapi.h"
+#include "silcclient.h"
 
 int main()
 {