Matchcode client

Example Name: mcinter

Language: C

API type: Shared/static Library

API component filename: McClient.dll/libmcclient.so/libmcclient.a

Environment: Windows 2000, XP, Vista (Using Visual Studio 2005)/Unix

What does it do?

Demonstrates the use of communicating with the Capscan Pool Manager and searching.

Could be used as a starting point for:

Creating an interactive application to capture or verify an address using a postcode.

Where to find the example code:

After running the setup from the Matchcode CD to install the client APIs you will find this example installed (by default) in:

C:\Program Files\Capscan\SDK\Matchcode Client API\Static & DLL\Examples\

and

C:\Program Files\Capscan\SDK\Matchcode Client API\Static & DLL\Examples\ mcinter

If you have installed to another location you will need to change the path where necessary.

On Unix the C examples are installed in the examples directory under the base install path (so if you choose to install under ‘/opt/capscan/mcd5cs’, the files for building mcinter will be in ‘/opt/capscan/mcd5cs/examples’

What each file does:

File name                             What does it do?

Examples.dsw (Windows) The Visual Studio 6 workspace for building examples

mcinter.dsp (Windows) The Visual Studio 6 project file

Makefile (Unix/Linux) makefile for building examples

testmain.c The source for searching and displaying the results.

..\mcclient.h Client API header file.

C:\Windows\system32\spider.ini Capscan Client/Server configuration file.

Preparing to run the example:

Please make sure that you have installed the Capscan Pool Manager and that it is up and running.

 To build the examples on Windows, open the Examples.dsw file, set mcinter as the active project, and build. The mcinter binary will be in the Examples\release or \debug directory depending on which configuration was built.

To build on Unix, cd to the Examples directory, and type ‘make’

Running the example:

1. Make sure that the API library is in the search path.

2. Open a console window, and cd to the correct directory

3. Make sure that the correct host name is set in the local spider.ini file.

If you are not using the spider.ini file make sure that the correct host name is passed to the McSetParam() function.

4. Type mcinter (or mcinter –h HOST) to access a pool on a remote machine on the network

5. Follow the on screen prompts to select the required pool and search requests.

Trouble-shooting and hints:

1. If you are running on a LAN make sure that the Capscan Pool Manager is running correctly. To do this you can use the PoolMan Admin application that is installed along with the Capscan Pool Manager.

2. If you are using a firewall make sure that it is not blocking this example or the Capscan Pool Manager. By default the Capscan Client/Server uses port 27920 for sending and receiving data.

3. Try installing and running the Data Capture application to test that the Capscan Pool Manger is working correctly. The installation for this can be found on the CD under:

Api\mcd_cs\win32\client

4. For more hints and tips please see the SDK bookshelf documentation.