Annotation of win32/sql/oracle/include/oci/oci1.h, revision 1.1.1.1

1.1       parser      1: /*
                      2:  * $Header: /var/lib/cvsroot/parser3/parser3/src/sql/oracle/oracle32/include/oci/oci1.h,v 1.1 2001/08/22 14:02:18 parser Exp $
                      3:  */
                      4: 
                      5: /* Copyright (c) Oracle Corporation 1997, 1998. All Rights Reserved. */ 
                      6:  
                      7: /* NOTE:  See 'header_template.doc' in the 'doc' dve under the 'forms' 
                      8:       directory for the header file template that includes instructions. 
                      9: */
                     10:  
                     11: /* 
                     12:    NAME 
                     13:      oci1.h - Cartridge Service definitions
                     14: 
                     15:    DESCRIPTION 
                     16:      <short description of component this file declares/defines> 
                     17: 
                     18:    RELATED DOCUMENTS 
                     19:  
                     20:    INSPECTION STATUS 
                     21:      Inspection date: 
                     22:      Inspection status: 
                     23:      Estimated increasing cost defects per page: 
                     24:      Rule sets: 
                     25:  
                     26:    ACCEPTANCE REVIEW STATUS 
                     27:      Review date: 
                     28:      Review status: 
                     29:      Reviewers: 
                     30:  
                     31:    PUBLIC FUNCTION(S) 
                     32:      <list of external functions declared/defined - with one-line descriptions>
                     33: 
                     34:    PRIVATE FUNCTION(S)
                     35:      <list of static functions defined in .c file - with one-line descriptions>
                     36: 
                     37:    EXAMPLES
                     38: 
                     39:    NOTES
                     40:      <other useful comments, qualifications, etc.>
                     41: 
                     42:    MODIFIED   (MM/DD/YY)
                     43:    nramakri    01/16/98 - remove #ifdef NEVER clause
                     44:    ewaugh      12/18/97 - Turn type wrappers into functions.
                     45:    skabraha    12/02/97 - Adding data structures & constants for OCIFile
                     46:    rhwu        12/02/97 - OCI Thread
                     47:    nramakri    12/15/97 - move to core4
                     48:    ewaugh      12/11/97 - add OCIFormat package constants
                     49:    ssamu       12/10/97 - do not include s.h
                     50:    nramakri    11/19/97 - add OCIExtract definitions
                     51:    ssamu       11/14/97 - creation
                     52: 
                     53: */
                     54: 
                     55: 
                     56: #ifndef OCI1_ORACLE
                     57: # define OCI1_ORACLE
                     58: 
                     59: # ifndef ORATYPES
                     60: #  include <oratypes.h>
                     61: # endif
                     62: 
                     63: 
                     64: /*---------------------------------------------------------------------------
                     65:                      PUBLIC TYPES AND CONSTANTS
                     66:   ---------------------------------------------------------------------------*/
                     67: 
                     68: /* Constants required by the OCIFormat package. */
                     69: 
                     70: #define OCIFormatUb1(variable)      OCIFormatTUb1(),      &(variable)
                     71: #define OCIFormatUb2(variable)      OCIFormatTUb2(),      &(variable)
                     72: #define OCIFormatUb4(variable)      OCIFormatTUb4(),      &(variable)
                     73: #define OCIFormatUword(variable)    OCIFormatTUword(),    &(variable)
                     74: #define OCIFormatUbig_ora(variable) OCIFormatTUbig_ora(), &(variable)
                     75: #define OCIFormatSb1(variable)      OCIFormatTSb1(),      &(variable)
                     76: #define OCIFormatSb2(variable)      OCIFormatTSb2(),      &(variable)
                     77: #define OCIFormatSb4(variable)      OCIFormatTSb4(),      &(variable)
                     78: #define OCIFormatSword(variable)    OCIFormatTSword(),    &(variable)
                     79: #define OCIFormatSbig_ora(variable) OCIFormatTSbig_ora(), &(variable)
                     80: #define OCIFormatEb1(variable)      OCIFormatTEb1(),      &(variable)
                     81: #define OCIFormatEb2(variable)      OCIFormatTEb2(),      &(variable)
                     82: #define OCIFormatEb4(variable)      OCIFormatTEb4(),      &(variable)
                     83: #define OCIFormatEword(variable)    OCIFormatTEword(),    &(variable)
                     84: #define OCIFormatChar(variable)     OCIFormatTChar(),     &(variable)
                     85: #define OCIFormatText(variable)     OCIFormatTText(),      (variable)
                     86: #define OCIFormatDouble(variable)   OCIFormatTDouble(),   &(variable)
                     87: #define OCIFormatDvoid(variable)    OCIFormatTDvoid(),     (variable)
                     88: #define OCIFormatEnd                OCIFormatTEnd()
                     89: 
                     90: #define OCIFormatDP 6
                     91: 
                     92: 
                     93: /*----------------- Public Constants for OCIFile -------------------------*/
                     94: 
                     95: /* flags for open.*/
                     96: /* flags for mode */
                     97: #define OCI_FILE_READ_ONLY         1   /* open for read only */
                     98: #define OCI_FILE_WRITE_ONLY        2   /* open for write only */
                     99: #define OCI_FILE_READ_WRITE        3   /* open for read & write */
                    100: /* flags for create */
                    101: #define OCI_FILE_EXIST             0   /* the file should exist */
                    102: #define OCI_FILE_CREATE            1   /* create if the file doesn't exist */
                    103: #define OCI_FILE_EXCL              2   /* the file should not exist */
                    104: #define OCI_FILE_TRUNCATE          4   /* create if the file doesn't exist, 
                    105:                                           else truncate file the file to 0 */
                    106: #define OCI_FILE_APPEND            8   /* open the file in append mode */
                    107: 
                    108: /* flags for seek */
                    109: #define OCI_FILE_SEEK_BEGINNING    1  /* seek from the beginning of the file */
                    110: #define OCI_FILE_SEEK_CURRENT      2  /* seek from the current position */
                    111: #define OCI_FILE_SEEK_END          3  /* seek from the end of the file */
                    112: 
                    113: #define OCI_FILE_FORWARD     1     /* seek forward             */
                    114: #define OCI_FILE_BACKWARD    2     /* seek backward            */
                    115: 
                    116: /* file type */
                    117: #define   OCI_FILE_BIN      0    /* binary file */
                    118: #define   OCI_FILE_TEXT     1    /* text file */
                    119: #define   OCI_FILE_STDIN    2    /* standard i/p */
                    120: #define   OCI_FILE_STDOUT   3    /* standard o/p */
                    121: #define   OCI_FILE_STDERR   4    /* standard error */
                    122: 
                    123: /* Represents an open file */
                    124: typedef struct OCIFileObject OCIFileObject;
                    125: 
                    126: 
                    127: /*--------------------- OCI Thread Object Definitions------------------------*/
                    128: 
                    129: /* OCIThread Context */
                    130: typedef struct OCIThreadContext OCIThreadContext;
                    131: 
                    132: /* OCIThread Mutual Exclusion Lock */
                    133: typedef struct OCIThreadMutex   OCIThreadMutex; 
                    134: 
                    135: /* OCIThread Key for Thread-Specific Data */
                    136: typedef struct OCIThreadKey     OCIThreadKey;  
                    137: 
                    138: /* OCIThread Thread ID */
                    139: typedef struct OCIThreadId      OCIThreadId;  
                    140: 
                    141: /* OCIThread Thread Handle */
                    142: typedef struct OCIThreadHandle  OCIThreadHandle;  
                    143: 
                    144: 
                    145: /*-------------------- OCI Thread Callback Function Pointers ----------------*/
                    146: 
                    147: /* OCIThread Key Destructor Function Type */
                    148: typedef void (*OCIThreadKeyDestFunc)(/*_ dvoid * _*/);
                    149: 
                    150: 
                    151: /* Flags passed into OCIExtractFromXXX routines to direct processing         */
                    152: #define OCI_EXTRACT_CASE_SENSITIVE     0x1 /* matching is case sensitive     */
                    153: #define OCI_EXTRACT_UNIQUE_ABBREVS     0x2 /* unique abbreviations for keys
                    154:                                               are allowed                    */
                    155: #define OCI_EXTRACT_APPEND_VALUES      0x4 /* if multiple values for a key
                    156:                                               exist, this determines if the 
                    157:                                               new value should be appended 
                    158:                                               to (or replace) the current 
                    159:                                               list of values                 */
                    160: 
                    161: /* Constants passed into OCIExtractSetKey routine */
                    162: #define OCI_EXTRACT_MULTIPLE           0x8 /* key can accept multiple values */
                    163: #define OCI_EXTRACT_TYPE_BOOLEAN         1 /* key type is boolean            */
                    164: #define OCI_EXTRACT_TYPE_STRING          2 /* key type is string             */
                    165: #define OCI_EXTRACT_TYPE_INTEGER         3 /* key type is integer            */
                    166: #define OCI_EXTRACT_TYPE_OCINUM          4 /* key type is ocinum             */
                    167: 
                    168: /*---------------------------------------------------------------------------
                    169:                      PRIVATE TYPES AND CONSTANTS
                    170:   ---------------------------------------------------------------------------*/
                    171: 
                    172: 
                    173: /*---------------------------------------------------------------------------
                    174:                            PUBLIC FUNCTIONS
                    175:   ---------------------------------------------------------------------------*/
                    176: 
                    177: 
                    178: /*---------------------------------------------------------------------------
                    179:                           PRIVATE FUNCTIONS
                    180:   ---------------------------------------------------------------------------*/
                    181: 
                    182: 
                    183: #endif                                              /* OCI1_ORACLE */

E-mail: