How to run QAS Pro V4's C/Visual Basic API sample code
Associated product(s): Product name: Pro
Views: 1326 | Created: 2 years ago | Last updated: 2 years ago
This documents illustrates the steps involved in setting-up and running the Visual Basic and C sample code shipped with QAS Pro V4 on Microsoft Windows or Unix. Also included is a list of the various files and their descriptions that make up each type of sample code.
Use the guide below to select the appropriate document section to read.
How to run C sample code for Pro API on UNIX
How to run C sample code for Pro API on Windows
How to run VB sample code for Pro API on Windows
How to run C sample code for Pro API on UNIX
What everything is:
Sample code
/sample/c/qs_sl.c - Primary API sample code
(single line searching)
/sample/c/qs_sl_io.c - Primary API functions performing user input and output (single line searching)
/sample/c/qs_sl.h - Primary API header file (single line searching)
This sample code can be compiled into the qs_sl test harness by running the make file (e.g make install)
/apps/qs_sl - Compiled test harness
The code used to compile this test harness is in /sample/c
It is based on the Ideal Integration Document.
Program files
/lib/qaupicd.a - Primary API Static library
/lib/libqaupicd.so - Primary API Shared Object library
Details of the function calls and their parameters can be found in the Pro API guide.
/lib/qaupicd.h - Primary API header file
/apps/qalicn.ini - V4 licensing file.
This file should contain all the licence keys you have to use with the data. The licence keys unlock the data for use with the Pro API.
Consult the QuickAddress Pro API guide for further details.
/apps/qaworld.ini - Client-side configuration side.
If run in client-server mode, this should contain the server’s communication settings. Error logging can be set up in this file.
/apps/qawserve.ini - Server-side configuration file.
Data file locations and country configurations are stored in this file.
/apps/* .044 - English (UK) language files.
These are the default language files for Pro. Each set of language files are suffixed with the country code.
/apps/qalcl.dat - Locale file
Contains details on countries, ISO codes and language codes.
If you have downloaded the QuickAddress API sample code, you will need to have a licensed copy of the software on order to use the program files. If you already have a licensed copy of the product, the product image includes a compiled, working version of the test harness (/apps/qs_sl). The source code for this is in /sample/c/
Included in this directory is a make file with a compilation script. This script can be run to compile the sample code.
How to run C sample code for Pro API on Windows
What everything is:
Sample code
qs_ui.c - User interface API sample code
qs_sl.c - Primary API sample code (single line searching)
qs_sl_io.c - Primary API functions performing user input and output (single line searching)
qs_sl.h - Primary API header file (single line searching)
Program files
QAUWVED.DLL - UI Pro DLL containing function calls.
qauwved.h - Header file for associated DLL
qauwved.lib - Stub library containing static entry points to DLL
QAUPIED.DLL - Primary DLL containing function calls
qaupied.h - Header file for associated DLL
qaupied.lib - Stub library containing static entry points to DLL
Details of the function calls and their parameters can be found in the Pro API guide.
QALICN.ini - V4 licensing file.
This file should contain all the licence keys you have to use with the data. The licence keys unlock the data for use with the Pro API.
See the QuickAddress Pro API guide for further details
QAWORLD.ini - Client-side configuration side.
If run in client-server mode, this should contain the server’s communication settings. Error logging can be set up in this file.
QAWSERVE.ini - Server-side configuration file.
Data file locations and country configurations are stored in this file.
* .044 - English (UK) language files.
These are the default language files for Pro. Each set of language files are suffixed with the country code.
QACFGWN.EXE - Configuration editor
Used to activate countries, enter licence keys and configure country layouts.
See Country Information Guide for country-specific layouts and address elements.
qalcl.dat - Locale file
Contains details on countries, ISO codes and language codes.
If you have downloaded the sample code, you will need to have a licensed copy of the software on order to use the program files.
How to run VB sample code for Pro API on Windows
What everything is:
Sample code
VB_UI\*.* - User interface API sample code
VB_Pri\*.* - Primary API sample code
This sample code has been written for Visual Basic and can be run as a Visual Basic project. It is based on the Ideal Implementation Document.
Program files
QAUWVED.DLL - UI Pro DLL containing function calls.
QAUPIED.DLL - Primary API DLL containing function calls
Details of the function calls and their parameters can be found in the Pro API guide.
QALICN.ini - V4 licensing file.
This file should contain all the licence keys you have to use with the data. The licence keys unlock the data for use with the Pro API.
See the Pro API guide for further details
QAWORLD.ini - Client-side configuration side.
If run in client-server mode, this should contain the server’s communication settings. Error logging can be set up in this file.
QAWSERVE.ini - Server-side configuration file.
Data file locations and country configurations are stored in this file.
* .044 - English (UK) language files.
These are the default language files for Pro. Each set of language files are suffixed with the country code.
QACFGWN.EXE - Configuration editor
Used to activate countries, enter licence keys and configure country layouts.
See Country Information Guide for country-specific layouts and address elements.
qalcl.dat - Locale file
Contains details on countries, ISO codes and language codes.
If you have downloaded the sample code, you will need to have a licensed copy of the software on order to use the program files.
