cstypes.h

通用的数据库中间库

/*
**	Sybase Open Client/Server 
**	Confidential Property of Sybase, Inc.
**	Copyright  Sybase, Inc. 1992, 1996
**	All rights reserved
*/

#ifndef __CSTYPES_H__

#define __CSTYPES_H__

/*
** This file defines basic error codes and data types used in all Open
** Client/Server System 10 Products.
*/

/*
** Include the configuration header file. This file contains the defines and
** type definitions that are platform/compiler specific.
*/
#include	"csconfig.h"

/*****************************************************************************
**
** Return code defines used in client/server applications.
**
*****************************************************************************/

/*
** See the csconfig.h header file for the definition of CS_RETCODE.
*/

/*
** Define the core return codes.
*/
#define CS_SUCCEED		(CS_RETCODE)1
#define CS_FAIL			(CS_RETCODE)0
#define CS_MEM_ERROR		(CS_RETCODE)-1
#define	CS_PENDING		(CS_RETCODE)-2
#define	CS_QUIET		(CS_RETCODE)-3
#define	CS_BUSY			(CS_RETCODE)-4
#define	CS_INTERRUPT		(CS_RETCODE)-5
#define CS_BLK_HAS_TEXT		(CS_RETCODE)-6
#define CS_CONTINUE		(CS_RETCODE)-7
#define CS_FATAL		(CS_RETCODE)-8

/*
** Define error offsets. All other CS_RETCODE error codes should be
** based off of these values to avoid define conflicts.
*/
#define CS_CONV_ERR		(CS_RETCODE)(-100)
#define CS_EXTERNAL_ERR		(CS_RETCODE)(-200)
#define CS_INTERNAL_ERR		(CS_RETCODE)(-300)

/* common library errors */
#define CS_COMN_ERR		(CS_RETCODE)(-400)

/*
** Return code for a routine which was cancelled via ct_cancel().
*/
#define CS_CANCELED		(CS_RETCODE)(CS_EXTERNAL_ERR - 2)

/*
** Special returns for ct_fetch().
*/
#define CS_ROW_FAIL		(CS_RETCODE)(CS_EXTERNAL_ERR - 3)
#define CS_END_DATA		(CS_RETCODE)(CS_EXTERNAL_ERR - 4)

/*
** Special return for ct_results().
*/
#define CS_END_RESULTS		(CS_RETCODE)(CS_EXTERNAL_ERR - 5)

/*
** Special return for ct_get_data().
*/
#define CS_END_ITEM		(CS_RETCODE)(CS_EXTERNAL_ERR - 6)

/*
** Special return for ct_diag().
*/
#define CS_NOMSG		(CS_RETCODE)(CS_EXTERNAL_ERR - 7)

/*
** Special return for ct_poll().
*/
#define CS_TIMED_OUT		(CS_RETCODE)(CS_EXTERNAL_ERR - 8)

/*
** Special returns for passthru().
*/
#define CS_PASSTHRU_EOM		(CS_RETCODE)(CS_EXTERNAL_ERR - 10)
#define CS_PASSTHRU_MORE	(CS_RETCODE)(CS_EXTERNAL_ERR - 11)

/*
** Special return for ct_cancel().
*/
#define	CS_TRYING		(CS_RETCODE)(CS_EXTERNAL_ERR - 13)

/*
** Errors caused by external events (i.e. bad params supplied by user).
*/
#define CS_EBADPARAM		(CS_RETCODE)(CS_EXTERNAL_ERR - 14)
#define CS_EBADLEN		(CS_RETCODE)(CS_EXTERNAL_ERR - 15)
#define CS_ENOCNVRT		(CS_RETCODE)(CS_EXTERNAL_ERR - 16)

/*
** Return codes for conversion errors. These should be used in any user-
** defined conversion routines that are install via cs_set_convert().
*/
#define CS_EOVERFLOW		(CS_RETCODE)(CS_CONV_ERR - 1)
#define CS_EUNDERFLOW		(CS_RETCODE)(CS_CONV_ERR - 2)
#define CS_EPRECISION		(CS_RETCODE)(CS_CONV_ERR - 3)
#define CS_ESCALE		(CS_RETCODE)(CS_CONV_ERR - 4)
#define CS_ESYNTAX		(CS_RETCODE)(CS_CONV_ERR - 5)
#define CS_EFORMAT		(CS_RETCODE)(CS_CONV_ERR - 6)
#define CS_EDOMAIN		(CS_RETCODE)(CS_CONV_ERR - 7)
#define CS_EDIVZERO		(CS_RETCODE)(CS_CONV_ERR - 8)
#define CS_ERESOURCE		(CS_RETCODE)(CS_CONV_ERR - 9)
#define CS_ENULLNOIND		(CS_RETCODE)(CS_CONV_ERR - 10)
#define CS_ETRUNCNOIND		(CS_RETCODE)(CS_CONV_ERR - 11)
#define CS_ENOBIND		(CS_RETCODE)(CS_CONV_ERR - 12)
#define CS_TRUNCATED		(CS_RETCODE)(CS_CONV_ERR - 13)
#define CS_ESTYLE		(CS_RETCODE)(CS_CONV_ERR - 14)
#define CS_EBADXLT      	(CS_RETCODE)(CS_CONV_ERR - 15)
#define CS_ENOXLT       	(CS_RETCODE)(CS_CONV_ERR - 16)
#define CS_USEREP		(CS_RETCODE)(CS_CONV_ERR - 17)

/*
** Error Severities. 
*/
#define CS_SV_INFORM		(CS_INT)0
#define CS_SV_API_FAIL		(CS_INT)1
#define CS_SV_RETRY_FAIL	(CS_INT)2
#define CS_SV_RESOURCE_FAIL	(CS_INT)3
#define CS_SV_CONFIG_FAIL	(CS_INT)4
#define CS_SV_COMM_FAIL		(CS_INT)5
#define CS_SV_INTERNAL_FAIL	(CS_INT)6
#define CS_SV_FATAL		(CS_INT)7


/*****************************************************************************
**
** Error numbers, and macros for extracting information from a 
** Client-Library error number.
**
** Error numbers are broken down into four components:
**
**	Layer		- Represents which layer is reporting the error.
**	Origin		- Indicates where the error manifested itself. 
**	Severity	- How bad is the error?
**	Number		- The actual layer specific error number being
**			  reported.
**
*****************************************************************************/

/*
** The error message number.
*/
#if defined (SYB_LP64) || defined (_AIX)
typedef unsigned int CS_MSGNUM;
#else
typedef long CS_MSGNUM;
#endif

/*
** The following macros are used to extract the components from a composite
** error number.
*/
#define CS_LAYER(L)	(CS_MSGNUM) (((L) >> 24) & 0xff)
#define CS_ORIGIN(O)	(CS_MSGNUM) (((O) >> 16) & 0xff)
#define CS_SEVERITY(S)	(CS_MSGNUM) (((S) >> 8) & 0xff)
#define CS_NUMBER(N)	(CS_MSGNUM) ((N) & 0xff)

/*
** The following are the possible values for cs_status field of
** CHAR_ATTRIB structure defined in intl_nls.h
*/

# define        CS_STAT_DEFAULT           0x0000
# define        CS_STAT_MULTIBYTE         0x0001
# define        CS_STAT_SPACELAST         0x0002
# define        CS_STAT_NONASCIISP        0x0004

/*****************************************************************************
**
** Defines used in client/server applications.
**
*****************************************************************************/

/*
** The maximum localization name allowed. A four byte value is added (instead
** of 1 byte) to provide space for null termination and remain on a modulo 4
** byte boundary.
*/
#define	CS_MAX_LOCALE		(CS_INT)(64 + 4)

/*
** The maximum column name allowed.
*/
#define	CS_MAX_NAME		(CS_INT)(128 + 4)

/*
** The maximum password length allowed.
*/
#define CS_MAX_PASS		(CS_INT)(30)

/*
** The maximum number of characters in arrays. Please note that this define
** does not correspond to any server definition of lengths (particularly
** the length of the character data type, which is 255 bytes for the Sybase
** server).
*/
#define CS_MAX_CHAR		(CS_INT)256

/*
** Maximum string in Directory Services
*/
#define	CS_MAX_DS_STRING	(CS_INT)512

/*
** Maximum data length of numeric/decimal datatypes.
*/
#define	CS_MAX_NUMLEN		(CS_INT)33

/*
** To be true or not true.
*/
#define CS_TRUE			(CS_BOOL)1
#define CS_FALSE		(CS_BOOL)0

/*
** Define basic default types.
*/
#define CS_NULLTERM		(CS_INT)(-9)
#define CS_WILDCARD		(CS_INT)(-99)
#define CS_NO_LIMIT		(CS_INT)(-9999)
#define CS_UNUSED		(CS_INT)(-99999)

/*
** timeout values
**
**	CS_NO_LIMIT		Resource will never expire.
**	CS_UNEXPIRED		Resource did not expire.
*/
#define CS_UNEXPIRED		(CS_INT)(-999999)

/*
** Enumerate what datatypes we support.
*/
#define CS_ILLEGAL_TYPE		(CS_INT)(-1)
#define CS_CHAR_TYPE		(CS_INT)0
#define CS_BINARY_TYPE		(CS_INT)1
#define CS_LONGCHAR_TYPE	(CS_INT)2
#define CS_LONGBINARY_TYPE	(CS_INT)3
#define CS_TEXT_TYPE		(CS_INT)4
#define CS_IMAGE_TYPE		(CS_INT)5
#define CS_TINYINT_TYPE		(CS_INT)6
#define CS_SMALLINT_TYPE	(CS_INT)7
#define CS_INT_TYPE		(CS_INT)8
#define CS_REAL_TYPE		(CS_INT)9
#define CS_FLOAT_TYPE		(CS_INT)10
#define CS_BIT_TYPE		(CS_INT)11
#define CS_DATETIME_TYPE	(CS_INT)12
#define CS_DATETIME4_TYPE	(CS_INT)13
#define CS_MONEY_TYPE		(CS_INT)14
#define CS_MONEY4_TYPE		(CS_INT)15
#define CS_NUMERIC_TYPE		(CS_INT)16
#define CS_DECIMAL_TYPE		(CS_INT)17
#define CS_VARCHAR_TYPE		(CS_INT)18
#define CS_VARBINARY_TYPE	(CS_INT)19
#define CS_LONG_TYPE		(CS_INT)20
#define CS_SENSITIVITY_TYPE	(CS_INT)21
#define CS_BOUNDARY_TYPE	(CS_INT)22
#define CS_VOID_TYPE		(CS_INT)23
#define CS_USHORT_TYPE		(CS_INT)24

/*
** Define the minimum and maximum datatype values.
*/
#define CS_MIN_SYBTYPE		CS_CHAR_TYPE
#define CS_MAX_SYBTYPE		CS_VOID_TYPE

/*
** Define the number of datatypes that are supported by Sybase.
*/
#define CS_MAXSYB_TYPE		(CS_MAX_SYBTYPE + 1)

/*
** The minumum user-defined data type.
*/
#define CS_USER_TYPE		(CS_INT)100

/*
** Define the bit values used in the format element of the CS_DATAFMT
** structure. The CS_FMT_JUSTIFY_RT flag exists for future use only.
*/
#define CS_FMT_UNUSED		(CS_INT)0x0
#define CS_FMT_NULLTERM		(CS_INT)0x1
#define CS_FMT_PADNULL		(CS_INT)0x2
#define CS_FMT_PADBLANK		(CS_INT)0x4
#define CS_FMT_JUSTIFY_RT	(CS_INT)0x8
#define CS_FMT_STRIPBLANKS	(CS_INT)0x10
#define CS_FMT_SAFESTR		(CS_INT)0x20

/*
** The following are bit values for the status field in the CS_DATAFMT
** structure.
** 
** CS_HIDDEN		Set if this column would normally be hidden
**			from the user.
**
** CS_KEY		Set if the column is a key column.
**
** CS_VERSION_KEY	Set if the column is part of the version key for
**			the row.
**
** CS_NODATA		Not currently used in Open Client/Server.
**
** CS_UPDATABLE		Set if the column is an updatable cursor column.
**
** CS_CANBENULL		Set if the column can contain NULL values.
**
** CS_DESCIN		
** CS_DESCOUT		Open Server-specific values for dynamic SQL.
**
** CS_INPUTVALUE	Set if the parameter is an input parameter value
**			for a Client-Library command.
**
** CS_UPDATECOL		Set if the parameter is the name of a column in
**			the update clause of a cursor declare command.
**
** CS_RETURN		Set if the parameter is a return parameter to
**			an RPC command.
**
** CS_TIMESTAMP		Set if the column is a timestamp column.
**
** CS_NODEFAULT		Open Server-specific status values for RPC parameters.
**
** CS_IDENTITY		Set if the column is an identity column.
**
*/
#define CS_HIDDEN		(CS_INT)0x1
#define CS_KEY			(CS_INT)0x2
#define CS_VERSION_KEY		(CS_INT)0x4
#define CS_NODATA		(CS_INT)0x8
#define CS_UPDATABLE		(CS_INT)0x10
#define CS_CANBENULL		(CS_INT)0x20
#define CS_DESCIN		(CS_INT)0x40
#define CS_DESCOUT		(CS_INT)0x80
#define CS_INPUTVALUE		(CS_INT)0x100
#define CS_UPDATECOL		(CS_INT)0x200
#define CS_RETURN 		(CS_INT)0x400
#define CS_TIMESTAMP		(CS_INT)0x2000
#define CS_NODEFAULT		(CS_INT)0x4000
#define CS_IDENTITY		(CS_INT)0x8000

/*
** The following are bit values for the status field in the CS_BROWSEDESC
** structure.
** 
** CS_EXPRESSION	Set when the column is the result of an expression.
**
** CS_RENAMED		Set when that the column's heading is not the 
**			original name of the column. 
*/
#define CS_EXPRESSION		(CS_INT)0x800
#define CS_RENAMED		(CS_INT)0x1000

/*
** Define special precision/scale value for using the precision/scale of the
** source element when doing a conversion from a numeric/decimal datatype to a
** numeric/decimal datatype.
*/
#define CS_SRC_VALUE		(CS_INT)-2562

/*
** Minimum/maximum/default precision and scale values for numeric/decimal
** datatypes.
*/
#define CS_MIN_PREC		(CS_INT)1
#define CS_MAX_PREC		(CS_INT)77
#define CS_DEF_PREC		(CS_INT)18

#define CS_MIN_SCALE		(CS_INT)0
#define CS_MAX_SCALE		(CS_INT)77
#define CS_DEF_SCALE		(CS_INT)0

/*
** The datetime format for converting datetime to char.
*/
#define CS_DATES_SHORT		(CS_INT)0	/* default	*/
#define CS_DATES_MDY1		(CS_INT)1	/* mm/dd/yy	*/
#define CS_DATES_YMD1		(CS_INT)2	/* yy.mm.dd	*/
#define CS_DATES_DMY1		(CS_INT)3	/* dd/mm/yy	*/
#define CS_DATES_DMY2		(CS_INT)4	/* dd.mm.yy	*/
#define CS_DATES_DMY3		(CS_INT)5	/* dd-mm-yy	*/
#define CS_DATES_DMY4		(CS_INT)6	/* dd mon yy	*/
#define CS_DATES_MDY2		(CS_INT)7	/* mon dd, yy	*/
#define CS_DATES_HMS		(CS_INT)8	/* hh:mm:ss	*/
#define CS_DATES_LONG		(CS_INT)9	/* default with micro secs */
#define CS_DATES_MDY3		(CS_INT)10	/* mm-dd-yy	*/
#define CS_DATES_YMD2		(CS_INT)11	/* yy/mm/dd	*/
#define CS_DATES_YMD3		(CS_INT)12	/* yymmdd	*/
#define CS_DATES_YDM1		(CS_INT)13	/* yy/dd/mm	*/
#define CS_DATES_MYD1		(CS_INT)14	/* mm/yy/dd	*/
#define CS_DATES_DYM1		(CS_INT)15	/* dd/yy/mm	*/
#define CS_DATES_SHORT_ALT	(CS_INT)100	/* default	*/
#define CS_DATES_MDY1_YYYY	(CS_INT)101	/* mm/dd/yyyy	*/
#define CS_DATES_YMD1_YYYY	(CS_INT)102	/* yyyy.mm.dd	*/
#define CS_DATES_DMY1_YYYY	(CS_INT)103	/* dd/mm/yyyy	*/
#define CS_DATES_DMY2_YYYY	(CS_INT)104	/* dd.mm.yyyy	*/
#define CS_DATES_DMY3_YYYY	(CS_INT)105	/* dd-mm-yyyy	*/
#define CS_DATES_DMY4_YYYY	(CS_INT)106	/* dd mon yyyy	*/
#define CS_DATES_MDY2_YYYY	(CS_INT)107	/* mon dd, yyyy	*/
#define CS_DATES_HMS_ALT	(CS_INT)108	/* hh:mm:ss	*/
#define CS_DATES_LONG_ALT	(CS_INT)109	/* default with micro secs */
#define CS_DATES_MDY3_YYYY	(CS_INT)110	/* mm-dd-yyyy	*/
#define CS_DATES_YMD2_YYYY	(CS_INT)111	/* yyyy/mm/dd	*/
#define CS_DATES_YMD3_YYYY	(CS_INT)112	/* yyyymmdd	*/


/*
** sizeof macro which forces a CS_INT cast for portability.
*/
#define CS_SIZEOF		(CS_INT)sizeof

/*
** Locale type information. CS_LC_MONETARY and CS_LC_NUMERIC are defined
** for future use.
*/
#define CS_LC_COLLATE           (CS_INT)1
#define CS_LC_CTYPE             (CS_INT)2
#define CS_LC_MESSAGE           (CS_INT)3
#define CS_LC_MONETARY          (CS_INT)4
#define CS_LC_NUMERIC           (CS_INT)5
#define CS_LC_TIME              (CS_INT)6
#define CS_LC_ALL               (CS_INT)7
#define CS_SYB_LANG		(CS_INT)8
#define CS_SYB_CHARSET		(CS_INT)9
#define CS_SYB_SORTORDER	(CS_INT)10
#define CS_SYB_COLLATE		CS_SYB_SORTORDER
#define CS_SYB_LANG_CHARSET	(CS_INT)11
#define CS_SYB_TIME		(CS_INT)12
#define CS_SYB_MONETARY		(CS_INT)13
#define CS_SYB_NUMERIC		(CS_INT)14

/*
** Object type information for the cs_objects() API.
*/
#define CS_CONNECTNAME		(CS_INT)1
#define CS_CURSORNAME		(CS_INT)2
#define CS_STATEMENTNAME	(CS_INT)3
#define CS_CURRENT_CONNECTION	(CS_INT)4
#define CS_MIN_USERDATA		(CS_INT)100

/*
** Info type information for the ct_ds_objinfo() API.
*/
#define CS_DS_CLASSOID		(CS_INT)1
#define CS_DS_DIST_NAME		(CS_INT)2
#define CS_DS_NUMATTR		(CS_INT)3
#define CS_DS_ATTRIBUTE		(CS_INT)4
#define CS_DS_ATTRVALS		(CS_INT)5

/*****************************************************************************
**
** Common datatype typedefs and structures used in client/server applications.
**
*****************************************************************************/

/*
** Define client/server datatypes.
** 
** CS_FLOAT is defined in csconfig.h
*/
typedef unsigned char   CS_TINYINT;	/* 1 byte integer */
typedef short           CS_SMALLINT;	/* 2 byte integer */
typedef char		CS_CHAR;	/* char type */
typedef unsigned char   CS_BINARY;	/* binary type */
typedef unsigned char   CS_BIT;		/* bit type */
typedef float		CS_REAL;	/* 4 byte float type */
typedef unsigned char	CS_BYTE;	/* 1 byte byte */
typedef unsigned char	CS_TEXT;	/* text data */
typedef unsigned char	CS_IMAGE;	/* image data */
typedef unsigned char	CS_LONGCHAR;	/* long char type */
typedef unsigned char	CS_LONGBINARY;	/* long binary type */
typedef long 		CS_LONG;	/* long integer type */
typedef CS_INT		CS_VOIDDATA;	/* void data */

typedef   struct  cs_ctx_globs	CS_CTX_GLOBS;
typedef   struct  cs_ctx_locglobs	CS_CTX_LOCGLOBS;

/*
** The following typedefs are platform specific.
**
**	CS_VOID 	(compiler void differences)
**	CS_THRDRES	(compiler void differences)
**	CS_INT		(need to force it to 4 bytes)
**
** Please see the csconfig.h file for the actual definitions.
*/