wcDBClose( )

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

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

Example

returnCode = wcDBClose(cntrlHandle, "conn2");

Syntax

int wcDBClose(void *controlHandle, 
              char *conName)

controlHandle	The handle to the control structure.
conName	The name to associate with the connection. Must be the conName specified in the wcDBOpen( ) call that opened the connection. If you want to close the connection you opened in your AppPages, conName has to be the connection name you use in AppPages, plus the session ID appended at the end.

Returns

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

Tips

You might call wcDBClose( ) after the application receives an ERR_MSGSHUTDOWN message. This message is returned by wcConOpen( ) when the Web browser session has timed out. This message notifies the application so it can perform cleanup tasks and exit. If the application does not cleanup and exit in response to this error message, INFORMIX-Universal Web Connect will terminate the application process automatically with no cleanup.

Program Example

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

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

    if (sessID!=NULL)
        sprintf(connName, "MYCONN%s", sessID);
    
    wcDBClose(wcp, connName);