Annotation of win32/sql/oracle/include/oci/oci8dp.h, revision 1.1
1.1 ! parser 1: /*
! 2: * $Header: /var/lib/cvsroot/parser3/parser3/src/sql/oracle/oracle32/include/oci/oci8dp.h,v 1.1 2001/08/22 14:02:18 parser Exp $
! 3: */
! 4:
! 5: /* Copyright (c) Oracle Corporation 1998, 1999. All Rights Reserved. */
! 6:
! 7: /*
! 8: NAME
! 9: oci8dp.h - OCI: Direct Path API interface prototypes.
! 10:
! 11: DESCRIPTION
! 12: Public types, constants, and interfaces to the direct path API.
! 13:
! 14: RELATED DOCUMENTS
! 15:
! 16: NOTES
! 17: This file is not directly included by the application, this file
! 18: is included by "oci.h", which the application should include.
! 19:
! 20: MODIFIED (MM/DD/YY)
! 21: whe 09/01/99 - 976457:check __cplusplus for C++ code
! 22: abrumm 04/16/99 - dpapi: more attributes
! 23: abrumm 02/26/99 - add defines for DataSave action
! 24: abrumm 10/04/98 - clen must be a ub4
! 25: abrumm 05/27/98 - add column array flag values
! 26: abrumm 05/12/98 - direct path api support
! 27: abrumm 03/31/98 - OCI direct path interface support
! 28: abrumm 03/18/98 - Creation
! 29:
! 30: */
! 31:
! 32: #ifndef OCI8DP_ORACLE
! 33: # define OCI8DP_ORACLE
! 34:
! 35: #ifndef ORATYPES
! 36: #include <oratypes.h>
! 37: #endif
! 38:
! 39: #ifndef OCIDFN
! 40: #include <ocidfn.h>
! 41: #endif
! 42:
! 43: #ifndef OCI_ORACLE
! 44: #include <oci.h>
! 45: #endif
! 46:
! 47:
! 48: /*---------------------------------------------------------------------------
! 49: PUBLIC TYPES AND CONSTANTS
! 50: ---------------------------------------------------------------------------*/
! 51:
! 52: /*----- Handles and descriptors for direct path operations (OCIDirPath*) ----*/
! 53:
! 54: typedef struct OCIDirPathCtx OCIDirPathCtx; /* context */
! 55: typedef struct OCIDirPathColArray OCIDirPathColArray; /* column array */
! 56: typedef struct OCIDirPathStream OCIDirPathStream; /* stream */
! 57: typedef struct OCIDirPathDesc OCIDirPathDesc; /* direct path descriptor */
! 58:
! 59: /*----- Defines for Direct Path Options -----*/
! 60:
! 61: /* values for OCI_ATTR_DIRPATH_MODE attribute */
! 62: #define OCI_DIRPATH_LOAD 1 /* direct path load operation */
! 63: #define OCI_DIRPATH_UNLOAD 2 /* direct path unload operation */
! 64: #define OCI_DIRPATH_CONVERT 3 /* direct path convert only operation */
! 65:
! 66: /*----- values for OCI_ATTR_DIRPATH_INDEX_MAINT_METHOD attribute -----*/
! 67: #define OCI_DIRPATH_INDEX_MAINT_SINGLE_ROW 1
! 68: #define OCI_DIRPATH_INDEX_MAINT_SKIP_UNUSABLE 2
! 69: #define OCI_DIRPATH_INDEX_MAINT_SKIP_ALL 3
! 70:
! 71: /* values for OCI_ATTR_STATE attribute of OCIDirPathCtx */
! 72: #define OCI_DIRPATH_NORMAL 1 /* can accept rows, last row complete */
! 73: #define OCI_DIRPATH_PARTIAL 2 /* last row was partial */
! 74: #define OCI_DIRPATH_NOT_PREPARED 3 /* direct path context is not prepared */
! 75:
! 76: /*----- values for cflg argument to OCIDirpathColArrayEntrySet -----*/
! 77: #define OCI_DIRPATH_COL_COMPLETE 0 /* column data is complete */
! 78: #define OCI_DIRPATH_COL_NULL 1 /* column is null */
! 79: #define OCI_DIRPATH_COL_PARTIAL 2 /* column data is partial */
! 80:
! 81: /*----- values for action parameter to OCIDirPathDataSave -----*/
! 82: #define OCI_DIRPATH_DATASAVE_SAVEONLY 0 /* data save point only */
! 83: #define OCI_DIRPATH_DATASAVE_FINISH 1 /* execute finishing logic */
! 84:
! 85: /*---------------------------------------------------------------------------
! 86: PUBLIC FUNCTIONS
! 87: ---------------------------------------------------------------------------*/
! 88:
! 89: /*------------------------ OCIDirPathCtx Operations -------------------------*/
! 90:
! 91: /*
! 92: NAME
! 93: OCIDirPathAbort - OCI: Abort a direct path operation.
! 94:
! 95: DESCRIPTION
! 96: Aborts a direct path operation. Upon successful completion
! 97: the direct path context is no longer valid.
! 98:
! 99: RETURNS
! 100: An OCI error code, Oracle errors are returned via the error handle.
! 101: NOTES
! 102: */
! 103: sword
! 104: #if defined(__STDC__) || defined(__cplusplus)
! 105: OCIDirPathAbort(OCIDirPathCtx *dpctx, OCIError *errhp);
! 106: #else
! 107: OCIDirPathAbort(/*_ OCIDirPathCtx *dpctx, OCIError *errhp _*/);
! 108: #endif
! 109:
! 110: /*
! 111: NAME
! 112: OCIDirPathDataSave - OCI: Execute a data save point.
! 113:
! 114: DESCRIPTION
! 115: Successful return of this function indicates that a data save
! 116: point has been executed.
! 117:
! 118: RETURNS
! 119: An OCI error code, Oracle errors are returned via the error handle.
! 120: NOTES
! 121: */
! 122: sword
! 123: #if defined(__STDC__) || defined(__cplusplus)
! 124: OCIDirPathDataSave(OCIDirPathCtx *dpctx, OCIError *errhp, ub4 action);
! 125: #else
! 126: OCIDirPathDataSave(/*_ OCIDirPathCtx *dpctx, OCIError *errhp, ub4 action _*/);
! 127: #endif
! 128:
! 129: /*
! 130: NAME
! 131: OCIDirPathFinish - OCI: Finish a direct path operation.
! 132:
! 133: DESCRIPTION
! 134: Finishes a direct path operation.
! 135:
! 136: RETURNS
! 137: An OCI error code, Oracle errors are returned via the error handle.
! 138: NOTES
! 139: */
! 140: sword
! 141: #if defined(__STDC__) || defined(__cplusplus)
! 142: OCIDirPathFinish(OCIDirPathCtx *dpctx, OCIError *errhp);
! 143: #else
! 144: OCIDirPathFinish(/*_ OCIDirPathCtx *dpctx, OCIError *errhp _*/);
! 145: #endif
! 146:
! 147: /*
! 148: NAME
! 149: OCIDirPathFlushRow - OCI: Flush a partial row from the server.
! 150:
! 151: DESCRIPTION
! 152: Flushes a partially loaded row from the server.
! 153:
! 154: RETURNS
! 155: An OCI error code, Oracle errors are returned via the error handle.
! 156: NOTES
! 157: */
! 158: sword
! 159: #if defined(__STDC__) || defined(__cplusplus)
! 160: OCIDirPathFlushRow(OCIDirPathCtx *dpctx, OCIError *errhp);
! 161: #else
! 162: OCIDirPathFlushRow(/*_ OCIDirPathCtx *dpctx, OCIError *errhp _*/);
! 163: #endif
! 164:
! 165: /*
! 166: NAME
! 167: OCIDirPathPrepare - OCI: Prepare a direct path operation.
! 168:
! 169: DESCRIPTION
! 170: Prepares a table/partition for a direct path operation.
! 171:
! 172: RETURNS
! 173: An OCI error code, Oracle errors are returned via the error handle.
! 174: NOTES
! 175: */
! 176: sword
! 177: #if defined(__STDC__) || defined(__cplusplus)
! 178: OCIDirPathPrepare(OCIDirPathCtx *dpctx, OCISvcCtx *svchp, OCIError *errhp);
! 179: #else
! 180: OCIDirPathPrepare(/*_ OCIDirPathCtx *dpctx, OCISvcCtx *svchp,
! 181: OCIError *errhp _*/);
! 182: #endif
! 183:
! 184: /*
! 185: NAME
! 186: OCIDirPathLoadStream - OCI: Load a direct path stream.
! 187:
! 188: DESCRIPTION
! 189: Load a direct path stream to the object associated with
! 190: the direct path context.
! 191:
! 192: RETURNS
! 193: An OCI error code, Oracle errors are returned via the error handle.
! 194: NOTES
! 195: */
! 196: sword
! 197: #if defined(__STDC__) || defined(__cplusplus)
! 198: OCIDirPathLoadStream(OCIDirPathCtx *dpctx, OCIDirPathStream *dpstr,
! 199: OCIError *errhp);
! 200: #else
! 201: OCIDirPathLoadStream(/*_ OCIDirPathCtx *dpctx, OCIDirPathStream *dpstr,
! 202: OCIError *errhp _*/);
! 203: #endif
! 204:
! 205:
! 206: /*---------------------- OCIDirPathColArray Operations ----------------------*/
! 207:
! 208: /*
! 209: NAME
! 210: OCIDirPathColArrayEntryGet - OCI: Get column array entry.
! 211:
! 212: DESCRIPTION
! 213: Column array function which is used to get a specified entry in
! 214: a column array.
! 215:
! 216: RETURNS
! 217: An OCI error code, Oracle errors are returned via the error handle.
! 218: NOTES
! 219: */
! 220: sword
! 221: #if defined(__STDC__) || defined(__cplusplus)
! 222: OCIDirPathColArrayEntryGet(OCIDirPathColArray *dpca, OCIError *errhp,
! 223: ub4 rownum, ub2 colIdx, ub1 **cvalpp, ub4 *clenp,
! 224: ub1 *cflgp);
! 225: #else
! 226: OCIDirPathColArrayEntryGet(/*_ OCIDirPathColArray *dpca, OCIError *errhp,
! 227: ub4 rownum, ub2 colIdx, ub1 **cvalpp, ub4 *clenp,
! 228: ub1 *cflgp _*/);
! 229: #endif
! 230:
! 231: /*
! 232: NAME
! 233: OCIDirPathColArrayEntrySet - OCI: Set column array entry.
! 234:
! 235: DESCRIPTION
! 236: Column array function which is used to set a specified entry in
! 237: a column array.
! 238:
! 239: RETURNS
! 240: An OCI error code, Oracle errors are returned via the error handle.
! 241: NOTES
! 242: */
! 243: sword
! 244: #if defined(__STDC__) || defined(__cplusplus)
! 245: OCIDirPathColArrayEntrySet(OCIDirPathColArray *dpca, OCIError *errhp,
! 246: ub4 rownum, ub2 colIdx, ub1 *cvalp, ub4 clen,
! 247: ub1 cflg);
! 248: #else
! 249: OCIDirPathColArrayEntrySet(/*_ OCIDirPathColArray *dpca, OCIError *errhp,
! 250: ub4 rownum, ub2 colIdx, ub1 *cvalp, ub4 clen,
! 251: ub1 cflg _*/);
! 252: #endif
! 253:
! 254: /*
! 255: NAME
! 256: OCIDirPathColArrayRowGet - OCI: Get column array row pointers.
! 257:
! 258: DESCRIPTION
! 259: Column array function which is used to get the base row pointers
! 260: for a specified row in a column array.
! 261: To be used in lieu of OCIDirPathColArrayEntryGet() and
! 262: OCIDirPathColArrayEntrySet().
! 263:
! 264: RETURNS
! 265: An OCI error code, Oracle errors are returned via the error handle.
! 266: NOTES
! 267: */
! 268: sword
! 269: #if defined(__STDC__) || defined(__cplusplus)
! 270: OCIDirPathColArrayRowGet(OCIDirPathColArray *dpca, OCIError *errhp,
! 271: ub4 rownum, ub1 ***cvalppp, ub4 **clenpp,
! 272: ub1 **cflgpp);
! 273: #else
! 274: OCIDirPathColArrayRowGet(/*_ OCIDirPathColArray *dpca, OCIError *errhp,
! 275: ub4 rownum, ub1 ***cvalppp, ub4 **clenpp,
! 276: ub1 **cflgpp _*/);
! 277: #endif
! 278:
! 279: /*
! 280: NAME
! 281: OCIDirPathColArrayReset - OCI: Reset Column Array State
! 282:
! 283: DESCRIPTION
! 284: Function which resets the column array state.
! 285:
! 286: RETURNS
! 287: An OCI error code, Oracle errors are returned via the error handle.
! 288: NOTES
! 289: Resetting the column array state is necessary when piecing in a large
! 290: column and an error occurs in the middle of loading the column.
! 291: */
! 292: sword
! 293: #if defined(__STDC__) || defined(__cplusplus)
! 294: OCIDirPathColArrayReset(OCIDirPathColArray *dpca, OCIError *errhp);
! 295: #else
! 296: OCIDirPathColArrayReset(/*_ OCIDirPathColArray *dpca, OCIError *errhp _*/);
! 297: #endif
! 298:
! 299: /*
! 300: NAME
! 301: OCIDirPathColArrayToStream - OCI: Convert Column Array to Stream Format.
! 302:
! 303: DESCRIPTION
! 304: Convert from column array format to stream format which is suitable
! 305: for loading via OCIDirPathLoadStream().
! 306:
! 307: RETURNS
! 308: An OCI error code, Oracle errors are returned via the error handle.
! 309: NOTES
! 310: */
! 311: sword
! 312: #if defined(__STDC__) || defined(__cplusplus)
! 313: OCIDirPathColArrayToStream(OCIDirPathColArray *dpca, OCIDirPathCtx *dpctx,
! 314: OCIDirPathStream *dpstr, OCIError *errhp,
! 315: ub4 rowcnt, ub4 rowoff);
! 316: #else
! 317: OCIDirPathColArrayToStream(/*_ OCIDirPathColArray *dpca, OCIDirPathCtx *dpctx,
! 318: OCIDirPathStream *dpstr, OCIError *errhp,
! 319: ub4 rowcnt, ub4 rowoff _*/);
! 320: #endif
! 321:
! 322:
! 323:
! 324: /*----------------------- OCIDirPathStream Operations -----------------------*/
! 325:
! 326: /*
! 327: NAME
! 328: OCIDirPathStreamReset - OCI:
! 329:
! 330: DESCRIPTION
! 331:
! 332: RETURNS
! 333: An OCI error code, Oracle errors are returned via the error handle.
! 334: NOTES
! 335: */
! 336: sword
! 337: #if defined(__STDC__) || defined(__cplusplus)
! 338: OCIDirPathStreamReset(OCIDirPathStream *dpstr, OCIError *errhp);
! 339: #else
! 340: OCIDirPathStreamReset(/*_ OCIDirPathStream *dpstr, OCIError *errhp _*/);
! 341: #endif
! 342:
! 343: /*
! 344: NAME
! 345: OCIDirPathStreamToStream - OCI:
! 346:
! 347: DESCRIPTION
! 348:
! 349: RETURNS
! 350: An OCI error code, Oracle errors are returned via the error handle.
! 351: NOTES
! 352: */
! 353: sword
! 354: #if defined(__STDC__) || defined(__cplusplus)
! 355: OCIDirPathStreamToStream(OCIDirPathStream *istr, OCIDirPathStream *ostr,
! 356: OCIDirPathCtx *dpctx, OCIError *errhp,
! 357: ub4 isoff, ub4 osoff);
! 358: #else
! 359: OCIDirPathStreamToStream(/*_ OCIDirPathStream *istr, OCIDirPathStream *ostr,
! 360: OCIDirPathCtx *dpctx, OCIError *errhp,
! 361: ub4 isoff, ub4 osoff _*/);
! 362: #endif
! 363:
! 364: #endif /* OCI8DP_ORACLE */
E-mail:
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to oci8dp.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [parser3project] / win32 / sql / oracle / include / oci