Difference between revisions of "OpenDBX bind simple"

From Linuxnetworks
Jump to: navigation, search
Line 13: Line 13:
 
= Parameters: =
 
= Parameters: =
  
handle: Connection object created by odbx_init()
+
* handle: Connection object created by odbx_init()
database: Name of the database
+
* database: Name of the database
username: User to connect to the database
+
* username: User to connect to the database
password: Password string for authentication
+
* password: Password string for authentication
  
 
= Return values: =
 
= Return values: =
  
Zero on success
+
* Zero on success
Non-zero if an error occured
+
* Non-zero if an error occured
  
 
= Errors: =
 
= Errors: =
  
-ODBX_ERR_PARAM: One of the parameters is invalid
+
* -ODBX_ERR_PARAM: One of the parameters is invalid
-ODBX_ERR_NOMEM: Allocating new memory failed
+
* -ODBX_ERR_NOMEM: Allocating new memory failed
-ODBX_ERR_TOOLONG: The length of a string exceeded the buffer size
+
* -ODBX_ERR_TOOLONG: The length of a string exceeded the buffer size
-1: Any error retured by the backend
+
* -1: Any error retured by the backend
  
  
 
----
 
----
 
Back to [[OpenDBX API|Overview]]
 
Back to [[OpenDBX API|Overview]]

Revision as of 18:34, 1 October 2005


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 username and password. 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
  • Non-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 Overview