Error logging can be used to help diagnose any problems preventing normal operation of the Pro API. Problems such as failure to start up the API can be solved from observing the output to the log file.

Logging can be activated by modifying configuration settings in the [QADefault] section of the qaworld.ini file.

If you are running the Pro API in Client/Server mode, these settings will only activate error logging on the client.

Format:

LogFile={filename}

Default:

qaerrors.log

Purpose:

LogFile enables you to specify a log file to which any errors that occur when you call API function are written. These errors are only written if you set <a href="/address-validation/pro-api/7.98/configuration-settings/error-logging/#log-errors" target="_self" title="">LogErrors</a> to be YES as well as specifying the name of the file you want to write to with LogFile.

It is recommended that you create a log file when integrating the API.

Example:

LogFile=error.log

This creates a log file called error.log in the same directory as the program files.

If you change the default log file location, it is recommended that you specify the full path of the file to write logging to:

c:\temp\error.log

Format:

LogErrors={boolean}

Default:

NO

Purpose:

This keyword specifies whether or not error logging is enabled. If LogErrors is set to YES, the <a href="/address-validation/pro-api/7.98/configuration-settings/error-logging/#log-file" target="_self" title="">LogFile</a> keyword must contain a valid file path and name.

Example:

LogErrors= NO

This means that no errors are logged, even if a file name has been specified with LogFile.

Pro API

Configuration settings


    Related Resources