OCILogon2()

Purpose

This function is used to create a logon session in connection pooling mode.

Syntax

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

Parameters

envhp (IN)

The OCI environment handle.

errhp (IN/OUT)

An error handle you can pass to OCIErrorGet() for diagnostic information in the event of an error.

svchp (IN/OUT)

The address of a service context pointer. This will be returned with the service context handle, attached to the pool.

username (IN)

The username. Must be in UTF-16 encoding in OCI_UTF16 environment mode.

uname_len (IN)

The length of username, in number of bytes, regardless of the encoding.

password (IN)

The user's password. If it is null and mode is OCI_SPOOL, OCI, OCILogon2() assumes that the logon is for a proxy user. It implicitly creates a proxy connection in such a case, using the pool user to authenticate the proxy user. Must be in UTF-16 encoding in OCI_UTF16 environment mode.

passwd_len (IN)

The length of password, in number of bytes, regardless of the encoding.

dbname (IN)

The name of the database to connect to when mode=OCI_DEFAULT. Must be in UTF-16 encoding in OCI_UTF16 environment mode.

The name of the connection pool to connect to when mode=OCI_CPOOL. This must be the same as the poolName parameter of the connection pool created by OCIConnectionPoolCreate(). Must be in UTF-16 encoding in OCI_UTF16 environment mode.

dbname_len (IN)

The length of dbname when mode=OCI_DEFAULT, in number of bytes, regardless of the encoding.

The length of poolName, in number of bytes, regardless of the encoding, when mode=OCI_CPOOL.

mode (IN)

The values accepted are:

• OCI_CPOOL - use connection pooling,

• OCI_DEFAULT - no connection pooling, equivalent to calling OCILogon().

Comments

This call allocates the error and service context handles which are passed to it. This call also implicitly allocates server and authentication handles associated with the session. These handles can be retrieved by calling OCIAttrGet() on the service context handle.

This call assumes that OCIConnectionPoolCreate() has already been called, giving poolName, when connection pooling is in effect.

Related Functions

OCILogon()