wcDBOpen( )

Syntax . . Returns . . Tips . . Program Example . . Related Topics . . A-Z Index . . Home

Opens a managed connection to the database server for the current session.

Example

returnCode = wcDBOpen(cntrlHandle, "conn2", "clients@sirius",
                      "user76", "pass76");

Syntax

int wcDBOpen(void *controlHandle, 
             char *conName, 
             char *server,
             char *userID, 
             char *passwd)

controlHandle	The handle to the control structure.
conName	The name to associate with the connection. Must be only alphanumeric and underscore (_) characters, with a maximum of 18 characters. Use the connection name returned by wcAppPageConnName() to open a connection to the AppPages repository. If you want to use the connection in your AppPages, conName has to be the connection name you use in AppPages, plus the session ID appended at the end. See Tips section for more information.
server	The database name, server name, or both for the connection. Syntax is databaseName@serverName.
userID	The database user ID which is requred to log in to the database.
passwd	The password for the database user.

Returns

0	Success.
Error code	Failure or exception. For a list of possible error codes, see Error Messages.

Tips

One AppPages repository database connection and 5 user database connections can be opened at the same time. The connection name returned by wcAppPageConnName() is the connection name to the AppPages repository.
You can set up to 5 concurrent user database connections with different names. These connections will remain open until you call wcDBClose(), or you call wcDBOpen() again with the same connection name.
If you want to use wcDBOpen() to open a database connection and use the connection in you AppPages, you have to get the current session ID, and append the session ID to the connection name, and use the full name as the parameter to wcDBOpen(). See Program Example.

Program Example

The following code shows how wcDBOpen( ) is used in an application.

    wcGetVariable(wcp, "$SESSION_ID", &sessID);

    if (sessID!=NULL)
        sprintf(connName, "MYCONN%s", sessID);
    
    wcDBOpen(wcp, connName, dbname, dbuser, dbpass);