| Prototype: |
| int ewdb_api_Init( |
char * DBuser, char * DBpassword, char * DBservice); |
|
| Description: |
Initialization function for the API. This function should be called prior to any other API calls. It initializes the API environment and validates the database connection parameters (DBuser, DBpassword, DBservice). |
RETURN CODE INFO |
| Return Type: |
int |
| Return Value |
Description |
| EWDB_RETURN_SUCCESS |
The API environment was successfully initialized. |
| EWDB_RETURN_FAILURE |
The API environment failed to initialize. Please see stderr or a logfile for details of the failure. |
| EWDB_RETURN_WARNING |
The API environment was already initialized. If the client needs to reinitialize the API environment with different parameters, they must first call ewdb_api_Shutdown to uninitialize the existing environment. |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| DBuser |
char * |
The database user that the program should run as. |
| DBpassword |
char * |
The password for user DBuser. |
| DBservice |
char * |
The network serviceID of the database to connect to. In Oracle environments, the serviceID is usually defined in either a tnsnames.ora file or by an Oracle Names server. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
UTILITY |
| Language: |
C |
| Location: |
./src/oracle/schema-working/src/include/ewdb_ora_api.h |