API functions reference

For each function, this documentation includes a description of the function, including a prototype to show the order of the parameters, and any input and output parameters you must pass to the function. For some functions there is also an example of how you can use the function and a list of the conditions that may be returned.

Naming Convention

All API functions use this naming convention: BWIName

Where Name is the function name and is typically related to the operation of the function.

For C, you call a wrapper with the naming convention BWICName.

All parameter items use this naming convention: BWI_T_Name

Where:

is the type of item: H for handle, N for Next, P for Previous, R for runtime parameter, S for status, V for Value.

For country functions, this is G if the condition occurs for more than one country or the 2 letter country code, for example IE for the Republic of Ireland.

Name

is the name of the parameter item.

Use these symbolic names to make your application code easier to maintain. The example programs show the symbolic names using the correct syntax for the programming language.

Data types used by the API functions

The Bank Wizard API uses three data types:

Long integer - this is 4 bytes on most operating systems and 8 bytes on 64 bit operating systems
Char - string or character array (the terminology varies between languages)
Handle - parameter specifying where information is held. This is held as an unsigned long integer.

Parameters must be passed by reference. Instead of passing the parameter value, pass the address of the parameter to the function.