|
Nearcode |
|
Example Name: NCD Language: C# API type: .Net API component filename: Capclasm.dll
Environment: Windows 2000, XP, |
|
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\CS 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? AmbiguityForm.cs Form used to
present and resolve ambiguous results. ConnectionForm.cs
Form used to select the
server running the Capscan Pool Manager and to select the
required pool. InfoForm.cs Form used to display the pool
information and available fields. NearcodeForm.cs The
main form for searching and displaying the results. Ncd.sln Visual
Studio 2008 solutions file. Program.cs The main entry point for the
application.
|
|
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 NCD.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.
Press F5 to run the example. 5.
From the Connection window select the host
server name and pool and click OK. 6.
From the main window 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.
|