Difference between revisions of "OpenDBX bind simple"

From Linuxnetworks
Redirect page
Jump to: navigation, search
(header)
(Redirecting to OpenDBX/API/odbx bind)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
__NOTOC__
+
#REDIRECT [[OpenDBX/API/odbx_bind]]
 
+
'''This function is deprecated in favor of [[OpenDBX_bind|odbx_bind()]]'''
+
 
+
'''#include <odbx.h>'''
+
+
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 [[OpenDBX_init|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 by [[OpenDBX_set_option|odbx_set_option()]], it must be done before calling this function.
+
 
+
Rebinding with other parameter and options can be performed by calling this function again after invoking [[OpenDBX_unbind|odbx_unbind()]] before.
+
 
+
= Parameters: =
+
 
+
* handle: Connection object created by [[OpenDBX_init|odbx_init()]]
+
* database: Name of the database
+
* username: User to connect to the database
+
* password: Password string for authentication
+
 
+
= Return values: =
+
 
+
* ODBX_ERR_SUCCESS on success
+
* Less than zero if an error occured
+
 
+
= Errors: =
+
 
+
* -ODBX_ERR_BACKEND: Any error occured in the backend
+
* -ODBX_ERR_PARAM: One of the parameters is NULL or handle is invalid
+
* -ODBX_ERR_NOMEM: Allocating new memory failed
+
* -ODBX_ERR_TOOLONG: The length of a string exceeded the buffer size
+
 
+
= See also: =
+
 
+
* [[OpenDBX_bind]]
+
 
+
 
+
----
+
Back to [[OpenDBX API|Overview]]
+

Latest revision as of 17:12, 17 May 2007