skip to main content
Interface Provider API : Reference : OAIP_connect (8-bit character version)
 

OAIP_connect (8-bit character version)

int OAIP_connect(
    DAM_HDBC dam_hdbc,
    IP_HENV henv,
    XM_Tree * pMemTree,
    char * sDataSourceName,
    char * sUserName,
    char * sPassword,
    char * sCurrentCatalog,
    char * sIPProperties,
    char * sIPCustomProperties,
    IP_HDBC * phdbc)
Table 2. Parameters for OAIP_connect (8-bit character)
Parameter
Type
Description
IN
dam_hdbc
DAM_HDBC
The connection handle.
henv
IP_HENV
The data structure allocated by the IP to keep its information.
pMemTree
XM_Tree *
The tree to use for allocating memory.
sDataSourceName
char *
The name of the data source to which the connection is being made.
sUserName
char *
The user name passed in by the client.
sPassword
char *
The password passed in by the client.
sCurrentCatalog
char *
Name of the catalog to use. The value can be specified by the client or in the DataSourceCurrentCatalog attribute.
sIPProperties
char *
Data source specific information that is set in the DataSourceIPProperties attribute.
sIPCustomProperties
char *
Custom properties passed in by the client. The keywords that can appear in this string are based on the setting of the DataSourceIPCustomProperties attribute.
OUT
phdbc
IP_HDBC *
A pointer to the data structure allocated by the IP to keep its connection information. This handle is passed in to the IP on subsequent IP calls. The OpenAccess SDK SQL engine does not look at information pointed to by this pointer. It is strictly for the IP's own use.
RETURN
int
DAM_SUCCESS - on success
DAM_FAILURE - on failure