cspublic.h

SQLAPI C/C++ 连接Oracle 数据库！

*****************************************************************************/

/*
** The following is the list of all valid options:
*/
#define CS_OPT_DATEFIRST        (CS_INT)5001    /* Set first day of week */
#define CS_OPT_TEXTSIZE         (CS_INT)5002    /* Text size */
#define CS_OPT_STATS_TIME       (CS_INT)5003    /* Server time statistics */
#define CS_OPT_STATS_IO         (CS_INT)5004    /* Server I/O statistics */
#define CS_OPT_ROWCOUNT         (CS_INT)5005    /* Maximum row count */
#define CS_OPT_NATLANG          (CS_INT)5006    /* National Language */
#define CS_OPT_DATEFORMAT       (CS_INT)5007    /* Date format */
#define CS_OPT_ISOLATION        (CS_INT)5008    /* Transaction isolation
                                                ** level */
#define CS_OPT_AUTHON           (CS_INT)5009    /* Set authority level on */
#define CS_OPT_CHARSET          (CS_INT)5010    /* Character set */
#define CS_OPT_SHOWPLAN         (CS_INT)5013    /* show execution plan    */
 
#define CS_OPT_NOEXEC           (CS_INT)5014    /* don't execute query */
#define CS_OPT_ARITHIGNORE      (CS_INT)5015    /* ignore arithmetic
                                                ** exceptions */
#define CS_OPT_TRUNCIGNORE      (CS_INT)5016    /* support ANSI null values */
#define CS_OPT_ARITHABORT       (CS_INT)5017    /* abort on arithmetic
                                                ** exceptions */
#define CS_OPT_PARSEONLY        (CS_INT)5018    /* parse only, return error
                                                ** msgs */
#define CS_OPT_GETDATA          (CS_INT)5020    /* return trigger data */
#define CS_OPT_NOCOUNT          (CS_INT)5021    /* don't print done count */
#define CS_OPT_FORCEPLAN        (CS_INT)5023    /* force variable substitute
                                                ** order */
#define CS_OPT_FORMATONLY       (CS_INT)5024    /* send format w/o row */
#define CS_OPT_CHAINXACTS       (CS_INT)5025    /* chained transaction mode */
#define CS_OPT_CURCLOSEONXACT   (CS_INT)5026    /* close cursor on end trans */
#define CS_OPT_FIPSFLAG         (CS_INT)5027    /* FIPS flag */
#define CS_OPT_RESTREES         (CS_INT)5028    /* return resolution trees */
#define CS_OPT_IDENTITYON       (CS_INT)5029    /* turn on explicit identity */
#define CS_OPT_CURREAD       	(CS_INT)5030    /* Set session label
						** @@ curread */
#define CS_OPT_CURWRITE       	(CS_INT)5031    /* Set session label 
						** @@curwrite */
#define CS_OPT_IDENTITYOFF      (CS_INT)5032    /* turn off explicit identity */
#define CS_OPT_AUTHOFF      	(CS_INT)5033    /* Set authority level off */
#define CS_OPT_ANSINULL      	(CS_INT)5034    /* ANSI NULLS behavior */
#define CS_OPT_QUOTED_IDENT    	(CS_INT)5035    /* Quoted identifiers */
#define CS_OPT_ANSIPERM    	(CS_INT)5036    /* ANSI permission checking */
#define CS_OPT_STR_RTRUNC    	(CS_INT)5037    /* ANSI right truncation */
#define CS_OPT_SORTMERGE	(CS_INT)5038	/* Sort merge join status */
#define CS_OPT_IDENTITYUPD_ON	(CS_INT)5039	/* turn on identity update */
#define CS_OPT_IDENTITYUPD_OFF	(CS_INT)5040	/* turn off identity update */

#define CS_OPT_SHOW_FI		(CS_INT)5047	/* Show Functional Indexes */
#define CS_OPT_HIDE_VCC		(CS_INT)5048	/* Hide Virtual Computed Columns */
 
#define CS_MIN_OPTION           CS_OPT_DATEFIRST
#define CS_MAX_OPTION           CS_OPT_HIDE_VCC

/*
** The supported options are summarized below with their defined values
** for `ArgSize' and `OptionArg'. ArgSize specifies the domain of valid
** values that are allowed.
** 
** Option			ArgSize		OptionArg
** ---------------		---------	---------
** CS_OPT_DATEFIRST 		1 byte		Defines below
** CS_OPT_TEXTSIZE 		4 bytes		Size in bytes 
** CS_OPT_ROWCOUNT  		4 bytes		Number of rows 
** CS_OPT_NATLANG 		OptionArg Len	National Lang (string)
** CS_OPT_DATEFORMAT 		1 byte		Defines below
** CS_OPT_ISOLATION 		1 byte		Defines below		
** CS_OPT_AUTHON 		OptionArg Len	Table Name (string)
** CS_OPT_CHARSET 		OptionArg Len	Character set (string)
** CS_OPT_IDENTITYON 		OptionArg Len	Table Name (string)
** CS_OPT_CURREAD 		OptionArg Len	Read Label(string)
** CS_OPT_CURWRITE 		OptionArg Len	Write Label(string)
** CS_OPT_IDENTITYOFF 		OptionArg Len	Table Name (string)
** CS_OPT_AUTHOFF 		OptionArg Len	Table Name (string)
** CS_OPT_IDENTITYUPD_ON 	OptionArg Len	Table Name (string)
** CS_OPT_IDENTITYUPD_OFF 	OptionArg Len	Table Name (string)
** (All remaining options)	1 byte		Boolean value
** 
** All string values must be sent in 7 bit ASCII.
**
*/ 


/* CS_OPT_DATEFIRST */
#define CS_OPT_MONDAY		(CS_INT)1
#define CS_OPT_TUESDAY		(CS_INT)2
#define CS_OPT_WEDNESDAY	(CS_INT)3
#define CS_OPT_THURSDAY		(CS_INT)4
#define CS_OPT_FRIDAY		(CS_INT)5
#define CS_OPT_SATURDAY		(CS_INT)6
#define CS_OPT_SUNDAY		(CS_INT)7

/* CS_OPT_DATEFORMAT */
#define CS_OPT_FMTMDY		(CS_INT)1
#define CS_OPT_FMTDMY		(CS_INT)2
#define CS_OPT_FMTYMD		(CS_INT)3
#define CS_OPT_FMTYDM		(CS_INT)4
#define CS_OPT_FMTMYD		(CS_INT)5
#define CS_OPT_FMTDYM		(CS_INT)6

/* CS_OPT_ISOLATION */
#define CS_OPT_LEVEL0		(CS_INT)0
#define CS_OPT_LEVEL1		(CS_INT)1
#define CS_OPT_LEVEL2		(CS_INT)2
#define CS_OPT_LEVEL3		(CS_INT)3

/*****************************************************************************
**
** Open Client/Server capabilities.
**
*****************************************************************************/

/*
** Capability types.
*/
#define CS_CAP_REQUEST		(CS_INT)1
#define CS_CAP_RESPONSE		(CS_INT)2

/*
** Special capability value to set/get all capability values at once.
*/
#define CS_ALL_CAPS		(CS_INT)2700

/*
** Capability request values.
*/
#define CS_REQ_LANG		(CS_INT)1
#define CS_REQ_RPC		(CS_INT)2
#define CS_REQ_NOTIF		(CS_INT)3
#define CS_REQ_MSTMT		(CS_INT)4
#define CS_REQ_BCP		(CS_INT)5
#define CS_REQ_CURSOR		(CS_INT)6
#define CS_REQ_DYN		(CS_INT)7
#define CS_REQ_MSG		(CS_INT)8
#define CS_REQ_PARAM		(CS_INT)9
#define CS_DATA_INT1		(CS_INT)10
#define CS_DATA_INT2		(CS_INT)11
#define CS_DATA_INT4		(CS_INT)12
#define CS_DATA_BIT		(CS_INT)13
#define CS_DATA_CHAR		(CS_INT)14
#define CS_DATA_VCHAR		(CS_INT)15
#define CS_DATA_BIN		(CS_INT)16
#define CS_DATA_VBIN		(CS_INT)17
#define CS_DATA_MNY8		(CS_INT)18
#define CS_DATA_MNY4		(CS_INT)19
#define CS_DATA_DATE8		(CS_INT)20
#define CS_DATA_DATE4		(CS_INT)21
#define CS_DATA_FLT4		(CS_INT)22
#define CS_DATA_FLT8		(CS_INT)23
#define CS_DATA_NUM		(CS_INT)24
#define CS_DATA_TEXT		(CS_INT)25
#define CS_DATA_IMAGE		(CS_INT)26
#define CS_DATA_DEC		(CS_INT)27
#define CS_DATA_LCHAR		(CS_INT)28
#define CS_DATA_LBIN		(CS_INT)29
#define CS_DATA_INTN		(CS_INT)30
#define CS_DATA_DATETIMEN	(CS_INT)31
#define CS_DATA_MONEYN		(CS_INT)32
#define CS_CSR_PREV		(CS_INT)33
#define CS_CSR_FIRST		(CS_INT)34
#define CS_CSR_LAST		(CS_INT)35
#define CS_CSR_ABS		(CS_INT)36
#define CS_CSR_REL		(CS_INT)37
#define CS_CSR_MULTI		(CS_INT)38
#define CS_CON_OOB		(CS_INT)39
#define CS_CON_INBAND		(CS_INT)40
#define CS_CON_LOGICAL		(CS_INT)41
#define CS_PROTO_TEXT		(CS_INT)42
#define CS_PROTO_BULK		(CS_INT)43
#define CS_REQ_URGNOTIF		(CS_INT)44
#define CS_DATA_SENSITIVITY	(CS_INT)45
#define CS_DATA_BOUNDARY	(CS_INT)46
#define CS_PROTO_DYNAMIC	(CS_INT)47
#define CS_PROTO_DYNPROC	(CS_INT)48
#define CS_DATA_FLTN		(CS_INT)49
#define CS_DATA_BITN		(CS_INT)50
#define CS_OPTION_GET		(CS_INT)51
#define CS_DATA_INT8		(CS_INT)52
#define CS_DATA_VOID		(CS_INT)53	
#define CS_DOL_BULK		(CS_INT)54
#define CS_OBJECT_JAVA1		(CS_INT)55
#define CS_OBJECT_CHAR		(CS_INT)56
#define CS_DATA_COLUMNSTATUS	(CS_INT)57
#define CS_OBJECT_BINARY	(CS_INT)58
#define CS_REQ_RESERVED1	(CS_INT)59
#define CS_WIDETABLES		(CS_INT)60
#define CS_REQ_RESERVED2	(CS_INT)61
#define CS_DATA_UINT2		(CS_INT)62
#define CS_DATA_UINT4		(CS_INT)63
#define CS_DATA_UINT8		(CS_INT)64
#define CS_DATA_UINTN		(CS_INT)65
#define CS_CUR_IMPLICIT		(CS_INT)66
#define CS_DATA_UCHAR		(CS_INT)67
#define CS_IMAGE_NCHAR		(CS_INT)68
#define CS_BLOB_NCHAR_16	(CS_INT)69
#define CS_BLOB_NCHAR_8		(CS_INT)70
#define CS_BLOB_NCHAR_SCSU	(CS_INT)71
#define CS_DATA_DATE		(CS_INT)72
#define CS_DATA_TIME		(CS_INT)73
#define CS_DATA_INTERVAL	(CS_INT)74
#define CS_CSR_SCROLL		(CS_INT)75
#define CS_CSR_SENSITIVE	(CS_INT)76
#define CS_CSR_INSENSITIVE	(CS_INT)77
#define CS_CSR_SEMISENSITIVE	(CS_INT)78
#define CS_CSR_KEYSETDRIVEN	(CS_INT)79
#define CS_REQ_SRVPKTSIZE	(CS_INT)80
#define CS_DATA_UNITEXT		(CS_INT)81
#define CS_CAP_EXTENDEDFAILOVER	(CS_INT)82
#define CS_DATA_SINT1		(CS_INT)83
#define CS_REQ_LARGEIDENT	(CS_INT)84
#define CS_REQ_BLOB_NCHAR_16	(CS_INT)85
#define CS_DATA_XML		(CS_INT)86
#define CS_REQ_CURINFO3		(CS_INT)87

/*
** Minimum and maximum request capability values.
*/
#define CS_MIN_REQ_CAP		CS_REQ_LANG
#define CS_MAX_REQ_CAP		CS_REQ_CURINFO3

/*
** Capability response values.
*/
#define CS_RES_NOMSG		(CS_INT)1
#define CS_RES_NOEED		(CS_INT)2
#define CS_RES_NOPARAM		(CS_INT)3
#define CS_DATA_NOINT1		(CS_INT)4
#define CS_DATA_NOINT2		(CS_INT)5
#define CS_DATA_NOINT4		(CS_INT)6
#define CS_DATA_NOBIT		(CS_INT)7
#define CS_DATA_NOCHAR		(CS_INT)8
#define CS_DATA_NOVCHAR		(CS_INT)9
#define CS_DATA_NOBIN		(CS_INT)10
#define CS_DATA_NOVBIN		(CS_INT)11
#define CS_DATA_NOMNY8		(CS_INT)12
#define CS_DATA_NOMNY4		(CS_INT)13
#define CS_DATA_NODATE8		(CS_INT)14
#define CS_DATA_NODATE4		(CS_INT)15
#define CS_DATA_NOFLT4		(CS_INT)16
#define CS_DATA_NOFLT8		(CS_INT)17
#define CS_DATA_NONUM		(CS_INT)18
#define CS_DATA_NOTEXT		(CS_INT)19
#define CS_DATA_NOIMAGE		(CS_INT)20
#define CS_DATA_NODEC		(CS_INT)21
#define CS_DATA_NOLCHAR		(CS_INT)22
#define CS_DATA_NOLBIN		(CS_INT)23
#define CS_DATA_NOINTN		(CS_INT)24
#define CS_DATA_NODATETIMEN	(CS_INT)25
#define CS_DATA_NOMONEYN	(CS_INT)26
#define CS_CON_NOOOB		(CS_INT)27
#define CS_CON_NOINBAND		(CS_INT)28
#define CS_PROTO_NOTEXT		(CS_INT)29
#define CS_PROTO_NOBULK		(CS_INT)30
#define CS_DATA_NOSENSITIVITY	(CS_INT)31
#define CS_DATA_NOBOUNDARY	(CS_INT)32
#define CS_RES_NOTDSDEBUG	(CS_INT)33
#define CS_RES_NOSTRIPBLANKS	(CS_INT)34
#define CS_DATA_NOINT8		(CS_INT)35
#define CS_OBJECT_NOJAVA1	(CS_INT)36
#define CS_OBJECT_NOCHAR	(CS_INT)37
#define CS_DATA_NOZEROLEN	(CS_INT)38
#define CS_OBJECT_NOBINARY	(CS_INT)39
#define CS_RES_RESERVED		(CS_INT)40
#define CS_DATA_NOUINT2		(CS_INT)41
#define CS_DATA_NOUINT4		(CS_INT)42
#define CS_DATA_NOUINT8		(CS_INT)43
#define CS_DATA_NOUINTN		(CS_INT)44
#define CS_NOWIDETABLES		(CS_INT)45
#define CS_DATA_NOUCHAR		(CS_INT)46
#define CS_IMAGE_NONCHAR	(CS_INT)47
#define CS_BLOB_NONCHAR_16	(CS_INT)48
#define CS_BLOB_NONCHAR_8	(CS_INT)49
#define CS_BLOB_NONCHAR_SCSU	(CS_INT)50
#define CS_DATA_NODATE		(CS_INT)51
#define CS_DATA_NOTIME		(CS_INT)52
#define CS_DATA_NOINTERVAL	(CS_INT)53
#define CS_DATA_NOUNITEXT	(CS_INT)54
#define CS_DATA_NOSINT1		(CS_INT)55
#define CS_NO_LARGEIDENT	(CS_INT)56
#define CS_NO_BLOB_NCHAR_16	(CS_INT)57
#define CS_NO_SRVPKTSIZE	(CS_INT)58
#define CS_DATA_NOXML		(CS_INT)59
#define CS_NONINT_RETURN_VALUE	(CS_INT)60
#define CS_RES_NOCURINFO2	(CS_INT)61

/*
** Minimum and maximum response capability values.
*/
#define CS_MIN_RES_CAP		CS_RES_NOMSG
#define CS_MAX_RES_CAP		CS_RES_NOCURINFO2

/*
** Minimum and maximum of all capabilities defined above.
*/
#define CS_MIN_CAPVALUE		CS_REQ_LANG
#define CS_MAX_CAPVALUE		CS_DATA_UNITEXT

/*
** Size of area to store capabilities. The array len must be greater
** than CS_CAP_ARRAYLEN additional capabilities to be added.
*/
#define CS_CAP_ARRAYLEN		16

/*
** Maximum OID length (bytes)
*/
#define CS_MAX_OIDLEN		255

/*
** Index used by access macros so that the first byte in the array will
** contain the high order bit.
*/
#define CS_CAP_IDX(B)		((CS_CAP_ARRAYLEN - (B)/ CS_BITS_PER_BYTE) - 1)

/*
** Data structure defining storage for capabilities.
*/
typedef	struct _cs_cap_type
{
	CS_BYTE		mask[CS_CAP_ARRAYLEN];
} CS_CAP_TYPE;

/*
** Access macros for CS_CAP_TYPE structure.
*/
#define	CS_SET_CAPMASK(M, B)	((M)->mask[CS_CAP_IDX(B)] |= \
					(1 << ((B) % CS_BITS_PER_BYTE)))
#define	CS_CLR_CAPMASK(M, B)	((M)->mask[CS_CAP_IDX(B)] &= \
					~(1 << ((B) % CS_BITS_PER_BYTE)))
#define	CS_TST_CAPMASK(M, B)	((M)->mask[CS_CAP_IDX(B)] & \
					(1 << ((B) % CS_BITS_PER_BYTE)))

/*****************************************************************************
**
** Defines used in Open Client/Server structures.
**
*****************************************************************************/

/*
** Define I/O types in the CS_IODESC structure.
*/
#define CS_IODATA		(CS_INT)1600

/*
** Define status values for the status field of the CS_SERVERMSG and
** CS_CLIENTMSG structures.
*/
#define CS_HASEED		(CS_INT)0x1
#define CS_FIRST_CHUNK		(CS_INT)0x2
#define CS_LAST_CHUNK		(CS_INT)0x4
#define	CS_EEDINFO		(CS_INT)0x8

/*****************************************************************************
**
** Hidden information structures.
**
*****************************************************************************/

#ifndef CS__INTERNAL_STRUCTS

/*
** If passing code through lint, define the hidden structures as void.
*/
#ifdef lint

#ifndef CS_LOGINFO
#define CS_LOGINFO	CS_VOID
#endif /* CS_LOGINFO */

#ifndef CS_BLKDESC
#define CS_BLKDESC      CS_VOID
#endif /* CS_BLKDESC */

#ifndef CS_BLK_ROW
#define CS_BLK_ROW	CS_VOID
#endif /* CS_BLK_ROW */

#else /* lint */

/*
** Use anonymous structure tags to define the hidden structures.
*/
typedef struct _csloginfo	CS_LOGINFO;
typedef struct _cs_blkdesc	CS_BLKDESC;
typedef	struct _bulkrow		CS_BLK_ROW; 

#endif /* lint */

#endif /* CS__INTERNAL_STRUCTS */

/*****************************************************************************
**
** User-accessible information structures.
**
*****************************************************************************/

/*
** Define the I/O descriptor structure used by Open Client/Server.
**
** iotype		Indicates the type of I/O to perform. For text
**			and image operations, iotype always has the
**			value CS_IODATA.
**
** datatype		The datatype of the data object. The only legal
**			values for datatype are CS_TEXT_TYPE and
**			CS_IMAGE_TYPE and CS_XML_TYPE.
**
** *locale		A pointer to a CS_LOCALE structure containing
**		 	localization information for the text or image
**			value. Set locale to NULL if localization
**			information is not required.
**
** usertype		The SQL Server user-defined datatype of the data
**			object, if any.
**
** total_txtlen		The total length, in bytes, of the text or image
**			value.
**
** offset		Reserved for future use.
**
** log_on_update	Whether the update for this text object should
**			be logged or not.
**
** name			The name of the text or image column. name is a
**			string of the form table.column.
**
** namelen		The actual length of name
**
** timestamp	 	The text timestamp of the column. A text
**			timestamp marks the time of a text or image
**			column's last modification.