Programming interfaces and example code for xmlsq

xmlsq provides interfaces for programming languages including C#, VB.NET, C, C++, VBA, VB6 and Python.

All programming interfaces provide a GetText, FullQuery and Count function or method. These behave in a similar way to the equivalent command-line commands. There are also some general diagnostic functions that provide details about the installed core DLL.

The core native DLL diXmlsq.dll must be installed on your system for all of these programming interfaces.

Some example test code for each language is provided below. The tests are simple and perhaps a bit silly, but demonstrate the basics. We hope you can use these examples to carry out your more exciting tasks using xmlsq. See Documentation for the manuals for the various programming languages.

C Programming

The "raw" C interface calls the core functions in the native DLL directly. You may find one of the other interfaces easier to use. Include diXmlsq.h in your source code and link to diXmlsq.lib. These two files should be found in C:\Program Files (x86)\xmlsq\C\.

C++ (STL) Programming

The C++ (STL) interface provides a more convenient interface using STL std::string and std::vector. Include xmlsq.cpp, xmlsq.hpp and diXmlsq.h in your project and link to diXmlsq.lib. The two C++ files should be found in C:\Program Files (x86)\xmlsq\Cpp\.

.NET Programming

In your .NET application, add a reference to the library diXmlsqNet.dll. This file should be found in C:\Program Files (x86)\xmlsq\DotNet\. Alternatively, include the C# source code diXmlsqNet.cs directly in your project.

VBA/VB6 Programming

Include the file basXmlsq.bas in your project. This file should be found in C:\Program Files (x86)\xmlsq\VBA\.

Python Programming

The Python interface to xmlsq is available separately from the Python Package Index (PyPi).

To install:

pip install xmlsq

or, if already installed,

pip install --upgrade xmlsq

To check if correctly installed, type in the Python REPL:

>>> import xmlsq
>>> xmlsq.Gen.version()
10000

Note there are no changes to the Python interface between versions 0.9.0 and 1.0.0 of the main library.