> ## Documentation Index
> Fetch the complete documentation index at: https://docs.loqate.com/llms.txt
> Use this file to discover all available pages before exploring further.

# lqtServer

## Static Public Member Functions

| Method                                    | Description                                                              |
| ----------------------------------------- | ------------------------------------------------------------------------ |
| `static lqtServer* create()`              | Returns a pointer to a newly created `lqtServer` instance.               |
| `static void destroy(lqtServer* pServer)` | Destroys all resources associated with the supplied `lqtServer` pointer. |

## Public Member Functions

| Method                                                                                                                | Description                                                                                                                    |
| --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `void init(const char* path)`                                                                                         | Initializes a server instance using the `loqate.ini` configuration file located at the supplied path.                          |
| `void shutdown()`                                                                                                     | Shuts down the current server instance.                                                                                        |
| `int open()`                                                                                                          | Creates a new session and returns the session ID.                                                                              |
| `void close(int ID)`                                                                                                  | Closes the session referenced by the supplied session ID.                                                                      |
| `serverStatus getStatus()`                                                                                            | Returns a `serverStatus` enumeration value giving the current server status.                                                   |
| `const char* getLastError()`                                                                                          | Returns a string containing textual detail of the outcome of the most recent member function call.                             |
| `const char* getOption(const char* option)`                                                                           | Returns the string value associated with the supplied option name.                                                             |
| `void setOption(const char* option, const char* value)`                                                               | Sets the supplied option name with the supplied option value.                                                                  |
| `void log(const char* msg)`                                                                                           | Logs the supplied string to the Loqate log.                                                                                    |
| `void process(const lqtInputRecord* inputRecord, const lqtProcessList* processList, lqtProcessResult* processResult)` | Performs the supplied `lqtProcessList` on the supplied `lqtInputRecord`, returning results in the supplied `lqtProcessResult`. |
| `const char* getVersion()`                                                                                            | Returns the version number of the Loqate server.                                                                               |
| `const char* readRegistry(const char* tableName, const char* key)`                                                    | Returns the value of the key from the given Loqate table.                                                                      |