Installation and using

---

To install Bopup IM Client SDK:

1. Launch bopupsdk.exe or bopupsdk.msi setup file (*).
2. Follow all instructions in the Setup Wizard.
3. After installation you can launch this help file's shortcut from "Start Menu -> Programs -> Bopup IM Client SDK" folder.

(*) — The filename may have a different name depending on custom installation package or supported platform.

Bopup IM Client SDK contents

Installation folder of the SDK contains the following folders under the root folder:

• \ — At the root level, the license agreement (license.txt), information file (readme.txt), contact information (contacts.txt) and this help documentation file (BopupSDK.chm).
• \com — Includes COM components and manifest files to build client applications. Files from this folder must be also redistributed with applications that use the SDK.
• \include — Includes C++ header files that contain interface and structure definitions. Must be included into C++ client application's source code that use Bopup IM Client SDK. This folder also includes CSClient4.bas file that provides constants and type definitions for VBA support. That file must be included to VBA projects (macros) to use the SDK in Microsoft Office applications.
• \samples\VB — Tutorial code and sample projects built on Microsoft Visual Basic (VB) .NET.
• \samples\VBA — Tutorial code and sample projects built for VBA (Visual Basic for Applications) environment.
• \samples\VC++ — Sample and tutorial C++ source code and Microsoft Visual C++ 6.0 build projects.

Redistributable components

Bopup IM Client SDK includes COM redistributable and manifest files that are required to run applications built using this SDK. The COM components and manifest files are located in the \com folder and must be distributed and registered with the client application software on a target computer. The components include:

• CSClient.dll — A core module which implements the IServerClient, IServerClientVB and IServerClientVBA interfaces that are used to communicate with the IM server.
• SecPrvdr.dll — An encryption module that is used by the IServerClient and IServerClientVB interfaces for generating encryption session key with the IM server and for encoding/decoding instant messages. This component is used by the interfaces internally.
• Transfer.dll — A file transfer module that is used by the IServerClient interface to send and receive files to/from users on the IM network. This component is used by the interface internally.
• CSClient.X.manifest — A manifest file for CSClient.dll module which adds a support for deployment of this COM component to a machine without the need to register it.
• SecPrvdr.X.manifest — A manifest file for SecPrvdr.dll module which adds a support for deployment of this COM component to a machine without the need to register it.
• Transfer.X.manifest — A manifest file for Transfer.dll module which adds a support for deployment of this COM component to a machine without the need to register it.

Registration of the COM components can be done via stardard COM registration with the help of built-in regsvr32.exe Windows tool. Here is a sample of registration of the CSClient.dll and SecPrvdr.dll modules from a command line:

regsvr32 csclient.dll

regsvr32 secprvdr.dll

regsvr32 transfer.dll

For more information on the regsvr32 registration tool run it with the /? command line parameter.

The COM components can be used without registration by enabling the Registration-Free COM model. In that way the CSClient.X.manifest, SecPrvdr.X.manifest and Transfer.X.manifest files must be also distributed with the client application. These files should be copied into the same directory that contains the application's executable and CSClient.dll, SecPrvdr.dll and Transfer.dll components. Please note that it is required to create a manifest file for application's executable too and the Registration-Free COM mechanism is available in Windows XP/2003 and later versions of Windows.

For more information on Registration-Free COM model please refer documentation available on Microsoft's website at Registration-Free Activation of COM Components: A Walkthrough.