ewdb_api_Init()

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

ewdb_api_Set_Debug()

Prototype: |
void ewdb_api_Set_Debug( | int IN_iDebug);
Description: | Set the debug level for the API (and supporting) functions.
RETURN CODE INFO
Return Type: | void
PARAMETER INFO
Parameter | Type | Description
IN_iDebug | int | Flag indicating the level of debug information that the caller wishes the API to log. See EWDB_DEBUG_DB_BASE_NONE for information on the various debug level constants. Constants can be bitwise OR'd together to form the proper debug level.
Group: | EWDB_API_LIB
Sub Group: | UTILITY
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_Shutdown()

Prototype: |
int ewdb_api_Shutdown( | void);
Description: | Shutdown the API environment and free any related memory and handles.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | The API environment was successfully de-initialized.
EWDB_RETURN_FAILURE | The API environment failed to de-initialize. Please see stderr or a logfile for details of the failure.
EWDB_RETURN_WARNING | The API environment had not been initialized using ewdb_api_Init.
PARAMETER INFO
Group: | EWDB_API_LIB
Sub Group: | UTILITY
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h