ocikp.h

ORACLE访问接口

/*
 * $Header: ocikp.h 26-jun-2000.04:00:50 hmasaki Exp $
 */
/* Copyright (c) Oracle Corporation 1996, 2000. 
All Rights Reserved. */
 
/* NOTE:  See 'header_template.doc' in the 'doc' dve under the 'forms' 
      directory for the header file template that includes instructions. 
*/
 
/* 
   NAME 
     ocikp.h - Prototypes of V8 OCI functions in K&R style

   DESCRIPTION 
     defines the prototypes of V8 OCI functions in K&R style

   RELATED DOCUMENTS 
 
   INSPECTION STATUS 
     Inspection date: 
     Inspection status: 
     Estimated increasing cost defects per page: 
     Rule sets: 
 
   ACCEPTANCE REVIEW STATUS 
     Review date: 
     Review status: 
     Reviewers: 
 
   PUBLIC FUNCTION(S) 
     <list of external functions declared/defined - with one-line descriptions>

   PRIVATE FUNCTION(S) 
     <list of static functions defined in .c file - with one-line descriptions>
 
   EXAMPLES 
 
   NOTES 
     <other useful comments, qualifications, etc.> 

   MODIFIED   (MM/DD/YY)
   hmasaki     06/26/00 - fix 1230846: replace 0xa0 with 0x20
   skrishna    06/16/00 - [1120931]: fix lines wider than 80 chars
   bpalaval    04/07/00 - 892654 Added prototype for OCIServerRelease
   porangas    03/06/00 - Forward merge bug#974710 to 817
   slari       09/01/99 - remove OCIEnvCallback
   slari       08/23/99 - add OCIUcb in user callback functions
   whe         09/01/99 - 976457:check __cplusplus for C++ code
   dsaha       07/07/99 - Add OCIFEnvCreate for forms
  vyanaman    06/21/99 - Change OCI DateTime/Interval APIs.
   esoyleme    07/01/99 - expose MTS performance enhancements                  
   whe         06/14/99 - bug727872:add CONST to match definitions
   kkarun      02/23/99 - Fix OCIDateTime APIs
   jiyang      12/07/98 - Add comments for OCI_NLS_DUAL_CURRENCY
   aroy        12/01/98 - add OCIEnvCreate
   slari       11/23/98 - use ORASTDARG
   slari       11/22/98 - use arglist in OCIUserCallback
   slari       11/21/98 - replace ellipsis by arglist in OCIUserCallback
   thchang     10/20/98 - correct comment on OCILobCreateTemporary
   sgollapu    09/30/98 - Fix bug 725473
   slari       09/08/98 - allow envh to receive error info also in CallbackReg/
   lchidamb    07/07/98 - change comments
   aroy        08/04/98 - add OCITerminate calls                               
   sgollapu    06/30/98 - Add OCISubscription* prototypes
   nramakri    06/25/98 - remove CONST from some OCIPickler APIs
   jiyang      06/22/98 - Fix a lint error
   nmallava    06/08/98 - ociistemporary -> envhp
   jhasenbe    05/27/98 - Remove definitions for U-Calls (Unicode)
   nmallava    05/18/98 - correct comment
   sgollapu    05/19/98 - Change text to OraText
   aroy        04/20/98 - merge forward 8.0.5 -> 8.1.3
   nbhatt      05/14/98 - aq listen call
   vyanaman    04/19/98 - system timestamp
   kkarun      04/17/98 - Add more Interval functions
   vyanaman    04/16/98 - Add get/set TZ
   kkarun      04/13/98 - add datetime prototypes
   rkasamse    04/13/98 - change OCIEnv* to dvoid* for context/memory cart serv
   rkasamse    04/15/98 - chage pickler cart interface
   slari       03/20/98 - change proto of OCIUserCallback
   slari       02/17/98 - add OCIEnvCallback
   jiyang      04/02/98 - Accept both env and user handles for NLS
   nmallava    04/09/98 - OCILobLocatorAssign
   nmallava    04/07/98 - fix compiler warnings
   jhasenbe    04/06/98 - Add new interfaces for Unicode support
   skabraha    03/24/98 - fixing prototype mismatch
   tsaulys     03/20/98 - use environment or session handle
   rkasamse    03/20/98 - remove prototypes for OCIMemoryDuration* functions
   nmallava    03/17/98 - add interfaces
   nmallava    03/16/98 - add open/close apis
   nmallava    03/10/98 - add temporary lobs apis
   sgollapu    07/10/97 - Add OCIReset
   sgollapu    02/09/98 - OCI non-blocking
   nramakri    01/16/98 - remove #ifdef NEVER clause for OCIExtract
   rmurthy     01/08/98 - OCIContextGenerateKey: change ub1 to ub4
   ewaugh      01/02/98 - remove VAFP from OCIFormatString prototype
   ewaugh      12/18/97 - Turn type wrappers into functions.
   rtaranto    12/17/97 - Resolve merge conflicts
   jiyang      11/13/97 - Add NLS service for cartridge
   rhwu        12/02/97 - add OCI Thread
   nramakri    12/15/97 - move to core4
   nramakri    12/11/97 - modify OCIExtract prototype
   ewaugh      12/10/97 - add OCIFormat prototypes
   skabraha    12/02/97 - adding OCIFile functions
   nramakri    11/12/97 - add OCIExtract prototypes
   rkasamse    11/21/97 - add prototypes for memory cartridge services and cont
   rkasamse    11/03/97 - Add pickler cartridge service interfaces
   tanguyen    08/19/97 -
   schandra    06/25/97 - AQ OCI interface
   bnainani    07/21/97 - add prototypes for Oracle XA extensions
   rtaranto    05/20/97 - remove OCILobLocatorSize (again)
   esoyleme    05/13/97 - move failover callback prototype
   skmishra    05/06/97 - stdc compiler fixes
   skmishra    04/23/97 - Provide C++ compatibility
   skotsovo    04/21/97 - make lob parameter names consistent
   rwhitman    04/16/97 - Fix LOB prototypes - Olint OCI 8.0.3
   ramkrish    04/15/97 - Add free flag to OCILobFlushBuffer
   cxcheng     04/09/97 - change objnamp from CONST text* to dvoid*
   cxcheng     04/08/97 - fix prototype for OCIDescribeAny
   skotsovo    03/31/97 - remove OCILobLocatorSize
   skotsovo    03/27/97 - add OCILobLoadFromFile
   sgollapu    03/26/97 - Change OCIDescribeAny prototype
   skotsovo    03/26/97 - add svchp to ocienablebuffering
   skotsovo    03/26/97 - change OCILobFlushBuffers to OCILobFlushBuffer
   skotsovo    03/18/97 - add interface for lob buffering.
   dchatter    01/13/97 - fix comments on LOB calls
   aroy        01/10/97 - remove ocilobfilecreate delete
   sgollapu    12/27/96 - Correct OCILogon prototype
   dchatter    01/04/97 - comments to describe the functions
   sgollapu    11/25/96 - Change OCILobFileIsExistent
   schandra    11/18/96 - Remove xa.h include
   sgollapu    11/09/96 - Change prototype of OCIDescribeAny
   dchatter    11/01/96 - lint error
   dchatter    10/31/96 - delete CONST from lob write cb fn
   dchatter    10/30/96 - more changes
   dchatter    10/26/96 - lob/file long name corrections
   slari       10/16/96 - delete unused calls
   rwessman    10/29/96 - Fixed OCISecurityGetIdentity prototype
   sgollapu    10/22/96 - Add OCILogon and OCILogoff prototypes
   rwessman    10/16/96 - Added cryptographic and digital signature functions
   rxgovind    10/07/96 - add oci file calls
   skotsovo    09/20/96 - in OCILobGetLength(), remove the 'isnull' parameter.
   skotsovo    10/01/96 - move orl lob fnts to oci
   skotsovo    09/20/96 - in OCILobGetLength(), remove the 'isnull' parameter.
   aroy        08/29/96 - change prototype for Nchar Lob support
   dchatter    08/21/96 - OCIResultSetToStmt prototype change
   sthakur     08/14/96 - add OCIParamSet
   schandra    06/17/96 - Convert XA to use new OCI
   aroy        07/17/96 - terminology change: OCILobLocator => OCILobLocator
   dchatter    07/01/96 - drop prototypes not in beta1
   dchatter    06/29/96 - OCIParamGet prototype change
   dchatter    06/19/96 - add OCISvcCtxBreak, OCILdaToSvcCtx
   slari       06/12/96 - inlcude oratypes.h instead of s.h
   schandra    05/31/96 - remove client DBID parameters from OCITransStart
   asurpur     06/05/96 - Changing the prototype for OCIPasswordChange
   dchatter    05/30/96 - change OCIStmtGetBind prototype
   schandra    05/29/96 - Add timeout parameter to OCITransDetach
   slari       05/30/96 - add OCIBindDynamic/OCIDefineDynamic
   slari       05/28/96 - fix gpi/spi protos
   slari       05/28/96 - change proto for OCIParamGet
   jbellemo    05/23/96 - remove ociisc
   schandra    05/15/96 - Remove ocitgti type
   schandra    04/18/96 - OCITransCommitt -> OCITransCommit
   schandra    03/27/96 - V8OCI - add transaction related calls
   dchatter    04/01/96 - change return types to sword to be compatible with oo
   dchatter    03/21/96 - add oci2lda conversion routines
   aroy        03/12/96 - change parameter order for lob functions
   dchatter    03/08/96 - minor parameter renaming for lob calls
   slari       03/14/96 - change proto of OCITransRollback
   slari       03/12/96 - remove ocidqry
   slari       03/01/96 - change proto for OCIInitialize
   slari       02/07/96 - update prototypes
   slari       02/06/96 - add OCITransCommit()
   slari       02/02/96 - ociisc: rm dblink info
   dchatter    01/08/96 - V8 OCI K&R prototype file
   dchatter    01/08/96 - Creation

*/
 
#ifndef OCIKP_ORACLE
# define OCIKP_ORACLE
 
# ifndef ORATYPES 
#  include <oratypes.h> 
# endif 
 
#ifndef ORASTDARG
#include <stdarg.h>
#define ORASTDARG
#endif
 
#ifndef OCIDFN
#include <ocidfn.h>
#endif

#ifndef NZT_ORACLE
#include <nzt.h>
#endif /* NZT_ORACLE */

#ifndef OCI_ORACLE
#include <oci.h>
#endif

#ifndef ORT_ORACLE
#include <ort.h>
#endif 

/*--------------------------------------------------------------------------- 
                     PUBLIC TYPES AND CONSTANTS 
  ---------------------------------------------------------------------------*/

/*--------------------------------------------------------------------------- 
                     PRIVATE TYPES AND CONSTANTS 
  ---------------------------------------------------------------------------*/
 
 
/*--------------------------------------------------------------------------- 
                           PUBLIC FUNCTIONS 
  ---------------------------------------------------------------------------*/

/*------------------Oracle Version 8 Call Interface--------------------------*/


/*****************************************************************************
                              DESCRIPTION
******************************************************************************
Note: the descriptions of the functions are alphabetically arranged. Please 
maintain the arrangement when adding a new function description. The actual 
prototypes are below this comment section and donot follow any alphabetical 
ordering. 


--------------------------------OCIAttrGet------------------------------------

OCIAttrGet()
Name
OCI Attribute Get
Purpose
This call is used to get a particular attribute of a handle. 
Syntax
sword OCIAttrGet ( CONST dvoid    *trgthndlp,
                 ub4            trghndltyp,
                 dvoid          *attributep,
                 ub4            *sizep,
                 ub4            attrtype,
                 OCIError       *errhp );
Comments
This call is used to get a particular attribute of a handle.
See Appendix B,  "Handle Attributes",  for a list of handle types and their 
readable attributes.
Parameters
trgthndlp (IN) - is the pointer to a handle type. 
trghndltyp (IN) - is the handle type. 
attributep (OUT) - is a pointer to the storage for an attribute value. The 
attribute value is filled in. 
sizep (OUT) - is the size of the attribute value. 
This can be passed in as NULL for most parameters as the size is well known. 
For OraText* parameters, a pointer to a ub4 must be passed in to get the 
length of the string. 
attrtype (IN) - is the type of attribute.
errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for 
diagnostic information in the event of an error.
Related Functions
OCIAttrSet()

--------------------------------OCIAttrSet------------------------------------


OCIAttrSet()
Name