Nearcode

Example Name: NCDWeb

Language: VB

API type: .Net

API component filename: Capclasm.dll

Environment: Windows 2000, XP, Vista, (Using Visual Studio 2008, .Net Framework 3.5)

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 psearch.

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\dotnet\Examples\VB

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?

NCDWeb.aspc.VB The main form for searching and displaying the results.

NcdWeb.sln Visual Studio 2008 solutions 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 install 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. Open the NCDWeb.sln solution file using Visual Studio 2008.

2. In the solution Explorer, under References, make sure that there is a valid entry for the CAPCLASM.DLL.

3. Make sure that the Solution Configuration is set to Debug.

4. In the Solution Explorer under References check that the solution is pointing to a valid CAPCLASM.DLL.

5. In the Solution Explorer right click on NCDWeb.aspx and select “Set as Start Page”.

6. In the code make sure that the Hostname and Poolname are set to the required values.

7. Save any changes.

8. Press F5 to run the example.

9. Enter a postcode and click the Search button.

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.