Connect, authorize, and initialize functions

OCIEnvCreate

Description : You can call this function to create and initialize an environment handle.

Function syntax :

sword OCIEnvCreate ( OCIEnv **envhpp,
ub4 mode,
CONST dvoid *ctxp,
CONST dvoid (malocfp)
(dvoid *ctxp,
size_t size),
CONST dvoid (ralocfp)
(dvoid *ctxp,
dvoid *memptr,
size_t newsize),
CONST void (*mfreefp)
(dvoid *ctxp,
dvoid *memptr))
size_t xtramemsz,
dvoid **usrmempp );

Parameters :

Return value : OCI_SUCCESS if succeeded, OCI_ERROR if failed, and OCI_INVALID_HANDLE in the event of an invalid handle.

OCIEnvNlsCreate

Description : You can call this function to create and initialize an environment handle for OCI functions to work under. It is an enhanced version of the OCIEnvCreate() function.

Function prototype :

sword OCIEnvNlsCreate ( OCIEnv **envhpp,ub4 mode,void *ctxp,void *(*malocfp)(void  *ctxp, size_t size),void *(*ralocfp)(void  *ctxp, void  *memptr, size_t newsize),void (*mfreefp)(void  *ctxp, void  *memptr),size_t xtramemsz,void **usrmempp,ub2  charset,ub2  ncharset );

Parameters :

Return value : OCI_SUCCESS if succeeded, or OCI_ERROR if failed.

OCIEnvInit

Description : You can call this function to allocate and initialize an environment handle.

Function prototype :

sword OCIEnvInit ( OCIEnv **envhpp,
    ub4 mode,
    size_t xtramemsz,
    dvoid **usrmempp );

Parameters:

Return value : OCI_SUCCESS if succeeded, or OCI_ERROR if failed.

OCIInitialize

Description : You can call this function to initialize the OCI application environment. In this function, OCI initializes internal global variables and loads some configuration information.

Function prototype :

sword OCIInitialize ( ub4 mode,
    const void *ctxp,
    const void *(*malocfp)
    ( void *ctxp,
    size_t size ),
    const void *(*ralocfp)
    ( void *ctxp,
    void *memptr,
    size_t newsize ),
    const void (*mfreefp)
    ( void *ctxp,
    void *memptr ));

Parameters :

Return value : OCI_SUCCESS if succeeded, or OCI_ERROR if failed.

OCILogoff

Description : You can call this function to disconnect a server session created by calling the OCILogon() function.

Function prototype :

sword OCILogoff ( 
    OCISvcCtx *svchp
    OCIError *errhp );

Parameters :

Return value : OCI_SUCCESS if succeeded, or OCI_ERROR if failed.

OCILogon

Description : You can call this function to log on to a specified database service with your username and password and initialize the related context handles.

Function prototype :

sword OCILogon ( OCIEnv *envhp,
    OCIError *errhp,
    OCISvcCtx **svchp,
    CONST OraText *username,
    ub4 uname_len,
    CONST OraText *password,
    ub4 passwd_len,
    CONST OraText *dbname,
    ub4 dbname_len );

Parameters :

Return value : OCI_SUCCESS if succeeded, or OCI_ERROR if failed.

OCIServerAttach

Description : You can call this function to attach a database server to a specified connection handle.

Function prototype :

sword OCIServerAttach ( OCIServer *srvhp,
    OCIError *errhp,
    CONST text *dblink,
    sb4 dblink_len,
    ub4 mode );

Parameters :

Return value : OCI_SUCCESS if succeeded, or OCI_ERROR if failed.

OCIServerDetach

Description : You can call this function to disassociate a connection handle from a database server.

Function prototype :

sword OCIServerDetach ( OCIServer *srvhp,
    OCIError *errhp,
    ub4 mode );

Parameters :

Return value : OCI_SUCCESS if succeeded, or OCI_ERROR if failed.

OCISessionBegin

Description : You can call this function on the specified service context handle to create a session for the specified database server with your logon credentials.

Function prototype :

sword OCISessionBegin ( OCISvcCtx *svchp,
    OCIError *errhp,
    OCISession *usrhp,
    ub4 credt,
    ub4 mode );

Parameters :

Return value : OCI_SUCCESS if succeeded, or OCI_ERROR if failed.

OCISessionEnd

Description : You can call this function to disconnect the session with the database server that you created by calling the OCISessionBegin() function on the specified service context handle.

Function prototype :

sword OCISessionEnd ( OCISvcCtx *svchp,
    OCIError *errhp,
    OCISession *usrhp,
    ub4 mode );

Parameters :

Return value : OCI_SUCCESS if succeeded, or OCI_ERROR if failed.

OCIPing

Description : You can call this function to verify that a session and service are active. It succeeds only when the service is active and the session exists.

Function prototype :

sword OCIPing (
OCISvcCtx* svchp,
OCIError* errhp,
ub4 mode)

Parameters :

Return value : OCI_SUCCESS if succeeded, or OCI_ERROR if failed.