Nearcode

Example Name: NCDS

Language: C

API type: Shared Library

API component filename: mcclient.dll

Environment: Windows 2000, XP, Vista, (Using Visual Studio C++ 6.0)

What does it do?

Demonstrates the use of Nearcode client API. It connects to the Nearcode Pool Manager and queries the server via a user entered search string therefore allowing the user to familiarise themselves with the fields returned by the server. It specifically demonstrates the process of a nearestrecords lookup using search.

Could be used as a starting point for:

Learning about nearcode and as sample API code, specifically connecting to Nearcode Pool Manager and performing a search.

Where to find the example code:

After running the setup from the Nearcode CD to install the client APIs you will find these examples installed (by default) in:

C:\Program Files\Capscan\SDK\Nearcode Client API\DLL\Examples\c

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

What each file does:

File name                             What does it do?

Ncdcs.c The C example code. The example connects to a nearcode pool and allows the server to be queried.

NCDClient.dsp Microsoft Visual Studio C++ 6.0 project file.

NcClient.h Client API header file.

McClient.h Client API header file.

Preparing to run the example:

Please make sure that you have installed the Nearcode Server and that it is up and running. If you installed the Libraries example data during installation a LibrariesExample pool will have been created. Else you will need to configure a Nearcode server to run a Nearcode pool.

Running the example:

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

2. Open the NCDClient.dsp project file using Visual Studio 6.

3. Select Rebuild All from the Build menu to build the example.

4. Select Execute NCDClient.exe from the Build menu.

5. A command prompt window will open displaying a list of available pools and prompting for a pool name.

6. Enter LibrariesExample as the pool name or the relevant poolname if you configured your own nearcode pool and follow the onscreen prompts.

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. For more hints and tips please see the SDK bookshelf documentation.