Difference between revisions of "OpenDBX bind simple"

From Linuxnetworks
Redirect page
Jump to: navigation, search
(Return values:)
(Redirecting to OpenDBX/API/odbx bind)
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
__NOTOC__
+
#REDIRECT [[OpenDBX/API/odbx_bind]]
 
+
int odbx_bind_simple(
+
    odbx_t* handle,
+
    const char* database,
+
    const char* username,
+
    const char* password )
+
 
+
= Description: =
+
 
+
Opens the database located on the database server specified in odbx_init(). The authentication is done by using the given username and password which may be NULL if they are not used by the backend. If any options should be set, it must be done before calling this function.
+
 
+
= Parameters: =
+
 
+
* handle: Connection object created by odbx_init()
+
* database: Name of the database
+
* username: User to connect to the database
+
* password: Password string for authentication
+
 
+
= Return values: =
+
 
+
* Zero on success
+
* Less than zero if an error occured
+
 
+
= Errors: =
+
 
+
* -ODBX_ERR_PARAM: One of the parameters is invalid
+
* -ODBX_ERR_NOMEM: Allocating new memory failed
+
* -ODBX_ERR_TOOLONG: The length of a string exceeded the buffer size
+
* -1: Any error retured by the backend
+
 
+
 
+
----
+
Back to [[OpenDBX API|Overview]]
+

Latest revision as of 17:12, 17 May 2007