Difference between revisions of "OpenDBX/C API/odbx init"
From Linuxnetworks
(→Description:) |
(→Parameters:) |
||
| Line 13: | Line 13: | ||
= Parameters: = | = Parameters: = | ||
| − | * handle: Pointer where the connection object | + | * handle: Pointer where the newly allocated connection object should be stored |
| − | * backend: Name of the | + | * backend: Name of the backend you want to use (mysql, pgsql, sqlite and sqlite3 - depends on the installed libraries) |
| − | * host: Host name or | + | * host: Host name or IP address of the database server or path to database file |
| − | * port: Port number the database server is listening | + | * port: Port number the database server is listening to |
| − | + | ||
= Return values: = | = Return values: = | ||
Revision as of 15:35, 5 June 2006
int odbx_init(
odbx_t** handle,
const char* backend,
const char* host,
const char* port )
Description:
Allocates and initializes the opaque object for connecting to the database server. The pointer to the newly created object is stored in handle and it can be used in all further OpenDBX functions not related to result processing.
Parameters:
- handle: Pointer where the newly allocated connection object should be stored
- backend: Name of the backend you want to use (mysql, pgsql, sqlite and sqlite3 - depends on the installed libraries)
- host: Host name or IP address of the database server or path to database file
- port: Port number the database server is listening to
Return values:
- Zero on success
- Non-zero if an error occured
Errors:
- -ODBX_ERR_PARAM: One of the parameters or its content is invalid
- -ODBX_ERR_NOMEM: Allocating new memory failed
- -ODBX_ERR_TOOLONG: The length of a string exceeded the buffer size
- -ODBX_ERR_NOEXIST: Backend library was not found
- -ODBX_ERR_NOOP: The function does not exist in the backend
- -1: Any error retured by the backend
Back to Overview
