OCI_olog

function

Library: Oracle Call Interface database support (OMOCI legacy)
Include: omoci.xin

Returns: OCI_SUCCESS if the function completes without error.

Declaration

define external integer function OCI_olog
   (  value OCI_Handle_type lda,
      value OCI_HostData_type hda,
      value string uid,
      value integer uidl,
      value string pswd,
      value integer pswdl,
      value string conn,
      value integer connl,
      value integer mode
   )

Purpose

This function establishes a connection between an OCI program and an Oracle database.

Input arguments:

lda -- Login data area descriptor.
hda -- The host data area.
uid -- The username, an optional password, and an optional host machine identifier. (Example: name/password@service_name)
uidl -- The length of the contents of uid, or OCI_NTS.
pswd -- The password, if not passed as part of uid.
pswdl -- The length of the contents of pswd, or OCI_NTS.
conn -- The SQL*Net V2 connect descriptor, if not passed as part of uid.
connl -- The length of the contents of conn or OCI_NTS.
mode -- The connection mode. The following values are allowed:
- OCI_LM_DEF -- Default login.
- OCI_LM_NBL -- Non-blocking login.

Example:

  set RetCode to OCI_olog
     (  ConnectionHandle,
        HostData,
        "my_account",
        OCI_NTS,
        "my_password",
        OCI_NTS,
        "my_server",
        OCI_NTS,
        OCI_LM_DEF
     )