dbserver.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once
#ifndef __dbserverH__
#define __dbserverH__

/*----------------------------------------------------------------------+
|                                                                       |
|   Required include files.                                             |
|                                                                       |
+----------------------------------------------------------------------*/
#include "dbdefs.h"
#include "dberrs.h"
#include "mselems.h"

#include "database.h"

/*----------------------------------------------------------------------+
|                                                                       |
|   SQL statement types.                                                |
|                                                                       |
+----------------------------------------------------------------------*/
#define MALFORMED_STMT        1
#define UNKNOWN_STMT          2
#define SELECT_STMT           3
#define UPDATE_STMT           4
#define CONNECT_STMT          5
#define DISCONNECT_STMT       6
#define SQLFORMS_STMT         7
#define RELOAD_STMT           8
#define INSERT_STMT           9
#define COMMIT_STMT           10
#define ROLLBACK_STMT         11
#define HANDLES_STMT          12
#define DELETE_STMT           13

/*----------------------------------------------------------------------+
|                                                                       |
|   Database forms modes.                                               |
|                                                                       |
+----------------------------------------------------------------------*/
#define FORMS_NONE      0x0000
#define FORMS_DIALOG    0x0101
#define FORMS_TEXT      0x0001

/*----------------------------------------------------------------------+
|                                                                       |
|   Miscellaneous defines.                                              |
|                                                                       |
+----------------------------------------------------------------------*/
#define MAX_MB_CHAR_LEN      10     /* MB character maximum */
#define APPEND_LINK           0     /* add linkage to existing links */
#define REPLACE_LINK          1     /* replace linkages with current link */
#define ACTIVATE_FILTER       1     /* turn on fence  filter */
#define DEACTIVATE_FILTER     2     /* turn off fence filter */
#define MAX_DB_APPS         126     /* maximum number of application tasks */
#define DB_MSG_CHAR_DATA      1     /* set type of data in msg to chars */
#define DB_MSG_SHORT_DATA     2     /* set type of data in msg to shorts */
#define DB_BUFFER_SIZE     2048     /* size (bytes) of request buffer */
#define DA_DATA_SIZE       (DB_BUFFER_SIZE - sizeof (long))
                                    /* size of displayable attribute buffer */
#define DB_VERSION_5          1     /* indicates Version 5 of MS */
#define MAX_UCM_FIELDS       32     /* max columns for DBREAD/DBWRITE */
#define MAX_LINES         65535     /* DA; maximum lines */
#define MAX_CHARS          2048     /* DA; maximum chars */
#define NEWLINE              10     /* ASCII newline */
#define CARRIAGERETURN       13     /* ASCII carriage return */
#define MAX_STATEMENT      2048     /* maximum SQL statement size */
#define DB_MAX_ERROR_DISPLAY MAX_ERROR_LENGTH

/* Next mode defines */
#define NEXT_MODE_MAX         1     /* Locks Table to add Max mslink */
/*#define NEXT_MODE_OCC       2     RIS - use occurence column !!!OBSOLETE!!! */
#define NEXT_MODE_LARGEST     3     /* Don't use locking to add the mslink */
#define DB_MAX_ATTEMPTS      10     /* Default maximum number of Attempts to update mslink */


/*----------------------------------------------------------------------+
|                                                                       |
|   MicroStation command numbers.                                       |
|                                                                       |
+----------------------------------------------------------------------*/
#define ATTACH_AE           239
#define DELETE_LINK         240
#define REVIEW_SINGLE       241
#define FENCE_REPORT        243
#define DEFINE_AE           246
#define DEFINE_DB           247
#define EDIT_AE             248
#define LOCATE_AE           249
#define SHOW_AE             250
#define FENCE_ATTACH        255
#define FENCE_DETACH        256
#define CREATE_ENTITY       257
#define ATTACH_DA           399
#define LOAD_DA             400
#define FENCE_LOAD          401
#define GENERATE_DA         402

/*----------------------------------------------------------------------+
|                                                                       |
|   Server message types.                                               |
|                                                                       |
+----------------------------------------------------------------------*/
#define FIRST_MESSAGE   0       /* request for 1st message on queue */
#define DB_USTN_MSG     1       /* MicroStation request for services */
#define DB_USTN_ACK     2       /* server response to DB_USTN_MSG */
#define DB_APP_MSG     16       /* application request for services */
#define DB_APP_ACK     17       /* server response to DB_APP_MSG */

/*----------------------------------------------------------------------+
|                                                                       |
|   MicroStation command window defines.                                |
|                                                                       |
+----------------------------------------------------------------------*/
#define NO_MESSAGE      0
#define NO_FIELD        0
#define STATUS_FIELD    1
#define MESSAGE_FIELD   2
#define COMMAND_FIELD   3
#define PROMPT_FIELD    4
#define KEYIN_FIELD     5
#define ERROR_FIELD     6

/*----------------------------------------------------------------------+
|                                                                       |
|   Database server requests.                                           |
|                                                                       |
|   These are the possible database server requests.  These are requests|
|   for database services which originate within MicroStation and are   |
|   passed to the database server through a message queue.  The server  |
|   fills the request and then replies with a message through the same  |
|   message queue.                                                      |
+----------------------------------------------------------------------*/
#define DB_STARTUP             1   /* start up and initialize database */
#define DB_TERMINATE           2   /* terminate database server */
#define DB_ATTACH_AE          10   /* attach the AE to an element */
#define DB_OPEN_REPORT        11   /* inititialize a database fence report */
#define DB_CLOSE_REPORT       12   /* close a database fence report */
#define DB_ELEMENT_REPORT     13   /* process element for fence report */
#define DB_REVIEW_ATTRIBUTES  14   /* review attributes of an element */
#define DB_DETACH_LINK        15   /* remove database linkages from element */
#define DB_SELECT_AE          16   /* select the active entity graphically */
#define DB_DELETE_ELEMENT     18   /* process linkages for deleted element */
#define DB_ELEMENT_FILTER     19   /* filter function for single element op */
#define DB_FENCE_FILTER       20   /* database fence filter function */
#define DB_UCM_READ           21   /* process user command DBREAD operator */
#define DB_UCM_WRITE          22   /* process user command DBWRITE operator */
#define DB_INITIALIZE_TCB     24   /* set up TCB during drawing init */
#define DB_DEFINE_APPL_ELM    25   /* define application element for scan */
#define DB_PROCESS_APPL_ELM   26   /* process application element */
#define DB_SHUTDOWN           28   /* shut down and close the database */
#define DB_COPY_ELEMENT       30   /* copy element */
#define DB_LOGIN              41   /* MicroStation log on message */
#define DB_UCM_ADD            46   /* process user command DBADD operator */
#define DB_UCM_DELETE         47   /* process user command DBDELETE operator*/
#define DB_ATTACH_DA          48   /* attach linkage to existing text node */
#define DB_LOAD_DA            49   /* load linkage text to text node */
#define DB_GENERATE_DA        50   /* create new textnodes with linkage text*/

/*----------------------------------------------------------------------+
|                                                                       |
|   Server keyin requests.                                              |
|                                                                       |
+----------------------------------------------------------------------*/
#define DB_PROCESS_KEYIN       3   /* process a direct database keyin */
#define DB_OPTIONS             4   /* database setup tutorial */
#define DB_DEFINE              5   /* process a DB= keyin */
#define DB_FIND_ENTITY         6   /* locate a record and setup as AE */
#define DB_EDIT_AE             7   /* edit the active entity */
#define DB_CREATE_ENTITY       8   /* add a record to the database */
#define DB_SHOW_AE             9   /* AE=$, display the active entity */
#define DB_DEFINE_SEARCH      17   /* process a DS= fence search keyin */
#define DB_LINKAGE_MODE       23   /* process an ACTIVE LINK <> keyin */
#define DB_DELETE_MODE        27   /* process SET DELETE <> keyin */
#define DB_REVIEW_TABLE       29   /* process RA= keyin */
#define DB_REPORT_SPEC        31   /* process RS= keyin */
#define DB_FORM_COMMAND       59   /* process FORM keyin */
#define DB_FORM_DISPLAY       60   /* display form */
#define DB_CONFIRM_MODE       65   /* confirmation mode */
#define DB_INSERT_AE          66   /* AE = keyin */
#define DB_AUTOCOMMIT         67   /* auto commit SQL transactions */
#define DB_RELEASE            68   /* release resources on disconnect */
#define DB_MDLDIALOGS         69   /* use MDL dialogs for query */
#define DB_DEBUG              71   /* server debug mode */

/*----------------------------------------------------------------------+
|                                                                       |
|   Server application requests.                                        |
|                                                                       |
+----------------------------------------------------------------------*/
#define DB_NULREC             32   /* create a null record and set up as AE */
#define DB_GETREC             33   /* retrieves a record and sets up as AE */
#define DB_GETFLD             34   /* extracts a field from the AE */
#define DB_EDTFLD             35   /* edits a field of the AE */
#define DB_NEWREC             36   /* writes the AE as a new record */
#define DB_UPDREC             37   /* updates a given record with the AE */
#define DB_SCNENT             38   /* scans for a record */
#define DB_DELREC             39   /* deletes a record from the database */
#define DB_QUEUE              40   /* creates/removes message queues */
#define DB_GETFMT             42   /* retrieve type and length of column */
#define DB_GETMAX             43   /* retrieve number of columns and rows */
#define DB_FLDNAME            44   /* retrieve column names of a table */
#define DB_JNDCOL             45   /* codelist lookup */

/*----------------------------------------------------------------------+
|                                                                       |
|   Server MDL requests.                                                |
|                                                                       |
+----------------------------------------------------------------------*/
#define DB_DECODE_LINK        51   /* decode user data linkage */
#define DB_READ_COLUMN        52   /* read column from table */
#define DB_WRITE_COLUMN       53   /* write column from table */
#define DB_LARGEST_MSLINK     54   /* largest MSLINK key in table */
#define DB_BUILD_LINK         55   /* construct linkage */
#define DB_DELETE_ROW         56   /* delete row from table */
#define DB_ADD_ROW            57   /* add a new row to a table */
#define DB_QUERY              58   /* query the database */
#define DB_DESCRIBE_TABLE     61   /* describe a database table */
#define DB_OPEN_CURSOR        62   /* open cursor for query by mdl */
#define DB_FETCH_ROW          63   /* fetch row from a table */
#define DB_CLOSE_CURSOR       64   /* close cursor used by mdl */
#define DB_ERRORTEXT          70   /* retrieve error text */
#define DB_BUILD_DA_LINK      72   /* build DA linkage */
#define DB_AE_FROM_LINK       73   /* setup AE from linkage */
#define DB_ENCODE_LINK        74   /* convert linkage to external format */
#define DB_CREATE_ENT_ROW     75   /* create new entity row with new mslink */
#define DB_REGISTER_QUERY     76   /* load UCM registers with query */
#define DB_COPY_ROW           77   /* copy existing row and generate MSLINK */
#define DB_GENERIC            78   /* a general request that developers can define */

/*----------------------------------------------------------------------+
|                                                                       |
|   Scan comparison codes.                                              |
|                                                                       |
+----------------------------------------------------------------------*/
#define CC_EQ   1
#define CC_LT   2
#define CC_GT   3
#define CC_NE   4
#define CC_LE   5
#define CC_GE   6

/*----------------------------------------------------------------------+
|                                                                       |
|   Cursor Request Types                                                |
|                                                                       |
+----------------------------------------------------------------------*/
#define REQUEST_WITHOUT_CURSORID    0
#define REQUEST_WITH_CURSORID       1

/*----------------------------------------------------------------------+
|                                                                       |
|   Structure typedefs.                                                 |
|                                                                       |
+----------------------------------------------------------------------*/
/* RIS server still uses old external program methods */
struct DBClient
    {
#if defined (RIS)
    WChar           name[60];       /* client program's name */
    int             pid;            /* process id of client */
    int             active;         /* client task active */
    int             messagekey;     /* key for the message path to/from the process */
    int             msqid;          /* message queue id */
#else
    int             active;         /* client task active               */
    void            *extProgDescrP; /* descriptor for the client        */
#endif
    };

// Persistent data structure stored in the DGN file
struct DatabaseApplicationElement
    {
    DgnPlatform::Elm_hdr     ehdr;      /* element header */
    char            schema[80];         /* control file name */         // CHAR_OK
    char            udlPath[256];       /* full path and file name */   // CHAR_OK
    short           extrawords[16];     /* a little extra */
    };

struct UCMArg
    {
    WChar           *field;         /* field name */
    WChar           *value;         /* field value (DBWRITE only */
#if defined (DBASE)
    short           fieldnum;       /* index of field in database structure */
    short           fieldoffset;    /* offset of field in record */
#endif
    };

struct RequestStatus
    {
    long            code;           /* return code status of request */
    long            msg_fld;        /* message field to output message text */
    WChar           msg[DB_MAX_ERROR_DISPLAY];   /* message text; valid if msg_fld non-zero */
    };

struct RequestHeader
    {
    long            type;       /* type of message */
    size_t          length;     /* number of bytes in message */
    ProcessID       sendpid;    /* sending task's PID */
    long            request;    /* database request type */
    RequestStatus   status;     /* return status */
    bool            isCallocd;     /* whether or not data buffer was callocd */
    size_t          callocdLength;  /* if isCallocd, this is the callocd length */
    long            databaseID; /* id of target database (FUTURE EXPANSION) */
    };

struct DBMessage
    {
    RequestHeader hdr;      /* message header */
    union                   /* message data */
        {
        WChar       *chardata;
        short       *shortdata;
        } u;
    WChar           buffer[DB_BUFFER_SIZE];
    };

struct Ver4RequestHeader
    {
    long            type;       /* type of message */
    long            request;    /* database request type */
    long            length;     /* number of bytes in message */
    long            sendpid;    /* sending task's PID */
    RequestStatus   status;     /* return status */
    };

struct Ver4DBMessage
    {
    Ver4RequestHeader hdr;      /* message header */
    union                       /* message data */
        {
        WChar       chardata[DB_BUFFER_SIZE];
        short       shortdata[DB_BUFFER_SIZE / 2];
        } u;
    };

struct Ver42RequestHeader
    {
    long            type;       /* type of message */
    long            length;     /* number of bytes in message */
    ProcessID       sendpid;    /* sending task's PID */
    long            request;    /* database request type */
    RequestStatus   status;     /* return status */
    };

struct Ver42DBMessage
    {
    Ver42RequestHeader hdr;     /* message header */
    union                       /* message data */
        {
        WChar       chardata[DB_BUFFER_SIZE];
        short       shortdata[DB_BUFFER_SIZE / 2];
        } u;
    };

struct DBServerInformation
    {
    bool            connectedToDB;  /* if a user is connected to the database */
    bool            active;         /* if the database server is up */
    };

struct TableDescr
    {
    struct TableDescr   *next;               /* next table in the list */
    WChar                name[MAX_TABLE_LENGTH+1];           /* table name */
    UShort               entity;             /* entity number */
    WChar                screenform[MAX_SCREEN_FORM+1];     /* screen form */
    WChar                reporttable[MAX_REPORT_TABLE+1];    /* output report table */
    WChar                sqlreview[MAX_SQL_REVIEW+1];    /* SQL SELECT for review */
    WChar                fencefilter[MAX_FENCE_FILTER+1];   /* SQL SELECT for fence filter */
    WChar                dastable[MAX_DAS_TABLE+1];      /* table with DAS info */
    WChar                aeTable[MAX_TABLE_LENGTH + 1];
    };

struct SQLStatedata
    {
    struct
        {
        int          valid;         /* currently attached database is valid */
        WChar        filename[MAXFILELENGTH]; /* database file specification */
        TableDescr  *table;         /* pointer to linked list of tables */
        int          nextMode;      /* RIS only - mode for max mslink */
        int          serverType;    /* brand of database server */
        int          useTempTables; /* use temp AE tables */
        int          randomMsforms; /* using randomly-generated msforms table name */
        int          xbaseExclusive;/* XBASE only - exclusive mode - no locking */
        int          maxAttempts;   /* Max insert/update attempts for new mslink */
        }  db;
    struct
        {
        short       type;               /* SQL statement type */
        long        tuples;             /* tuples returned from last query */
        short       active;             /* is there a query currently active? */
        } query;
    long rowsProcessed;             /* rows processed for any sql statement */
    struct
        {
        int (*queryInitialize)();  /* prepare for query */
        int (*queryCleanUp)();     /* clean up after query */
        int (*executeSQL)();       /* execute SQL statement (non SELECT) */
        int (*processRow)();       /* process returned row from query */
        } statefunc;
    };

typedef short FormToggle;

struct DescrMessageHdr
   {
   short   columns;
   short   rows;
   short   items;
   };

struct DescriptorMessage
    {
    DescrMessageHdr hdr;
    WChar           data[1];
    };

struct Ver4DescrMessageHdr
   {
   short            columns;
   short            rows;
   short            items;
   short            continued;
   };

struct Ver4DescriptorMessage
    {
    Ver4DescrMessageHdr hdr;
    WChar           data[DB_BUFFER_SIZE - sizeof(Ver4DescrMessageHdr)];
    };

struct PCVer4DescriptorMessage
    {
    short           columns;
    short           rows;
    WChar           data[DB_BUFFER_SIZE - (sizeof(short) * 2)];
    };

struct DBLogin
    {
    WChar           taskname[132];          /* process name */
    ProcessID       pid;                    /* process ID */
    };

/* MicroCSL request/acknowledge messages */
struct DeleteTableRowRequest
    {
    UShort          entity;         /* entity number of table */
    UInt32          mslink;         /* MSLINK key of row to delete */
    };

struct NullRowRequest
    {
    UShort          entity;          /* entity number of table */
    };

struct GetRowRequest
    {
    UShort          entity;         /* entity number of table */
    UInt32          mslink;         /* MSLINK key of row to establish as AE */
    };

struct GetColumnRequest
    {
    UShort          entity;         /* entity number of table */
    UInt32          mslink;         /* MSLINK key of record to read */
    UShort          fieldno;        /* field number to read */
    };

struct GetColumnAck
    {
    WChar           value[1];              /* value of field requested */
    };

struct EditColumnRequest
    {
    UShort          entity;      /* entity number of table */
    UInt32          mslink;      /* MSLINK key of record to write */
    UShort          fieldno;     /* field number to write */
    WChar           value[1];               /* value of field to write */
    };

struct NewRowRequest
    {
    UInt32          mslink;       /* MSLINK key of row added to database */
    };

struct UpdateRowRequest
    {
    UInt32          mslink;       /* MSLINK key of row to update with AE */
    };

struct ScanColumn
    {
    short           fieldno;              /* field number to compare */
    short           compcode;             /* comparison code */
    union {
        WChar       *value;            /* pointer to field value */
        long        offset;            /* offset of field value in buffer */
        } u;
    } ;

struct ScanEntityRequest
    {
    UShort          entity;        /* entity number to scan */
    UInt32          startrec;      /* starting MSLINK key to begin scan */
    short           numfields;     /* number of fields to compare */
    ScanColumn      scanlist[1];   /* list of field criteria */
    };

struct ScanEntityAck
    {
    UInt32          mslink;           /* MSLINK key of record located */
    };

struct GetFormatRequest
    {
    UShort          entity;          /* entity number of table */
    UShort          column;          /* column number to retrieve */
    };              

struct GetFormatAck
    {
    UShort          type;            /* data type of column */
    UShort          length;          /* length of column in bytes */
    };

struct GetMaxRequest
    {
    UShort          entity;          /* entity number of table */
    };

struct GetMaxAck
    {
    UShort          columns;         /* number of columns in the table */
    UInt32          rows;            /* number of rows in the table  */
    };

struct FieldNameRequest
    {
    UShort          entity;          /* entity number of table */
    UShort          width;           /* max width of column names */
    UShort          number;          /* max number of columns to be returned */
    };

struct FieldNameAck
    {
    UShort          number;          /* number of column names in buffer */
    WChar           names[1];                  /* column names in table */
    };

struct JoinColumnRequest
    {
    UShort          entity;          /* entity number of table */
    UShort          column;          /* column number of codelist value */
    UInt32          mslink;          /* MSLINK column of row */
    };

struct JoinColumnAck
    {
    WChar           value[1];                  /* codelist value */
    };

struct DABuffer
    {
    long            numlines;
    WChar           textdata[DA_DATA_SIZE];
    };

/* MDL request/acknowledge messages */
struct ColumnReadRequest
    {
    WChar           tableName[64];      /* table name */
    WChar           columnName[64];     /* column name to read */
    UInt32          mslinkKey;          /* MSLINK key of column to read */
    };

struct ColumnReadAck
    {
    WChar           value[256];                  /* column value */
    };

struct ColumnWriteRequest
    {
    WChar           tableName[64];      /* table name */
    WChar           columnName[64];     /* column name to write */
    UInt32          mslinkKey;          /* MSLINK key of column to write */
    WChar           columnValue[256];   /* column name to write */
    };

struct DeleteRowRequest
    {
    WChar           tableName[64];      /* table name */
    UInt32          mslinkKey;          /* MSLINK key of column to delete */
    };

struct BuildLinkRequest
    {
    short           linkType;           /* linkage type (ORACLE, IX) */
    LinkProps       props;              /* properties of the linkage */
    WChar           tableName[64];      /* table name */
    UInt32          mslinkKey;          /* MSLINK key of column */
    short           dasType;            /* displayable attribute type */
    };

struct AttributeMod
    {
    short           *attributes;        /* new attributes */
    size_t          length;             /* length (bytes) of the attribute block */
    int             mode;               /* APPEND or REPLACE */
    };

struct CreateEntityAck
    {
    UInt32          mslink;
    UShort          entity;
    };

struct OpenCursorMessage
    {
    CursorID        cursorID;
    long            descriptionLength;
    WChar           description[1];
    };

/* This structure is used for version 4 compatibility ONLY */
struct DBServer
    {
    WChar           dummy[8];
    int             active;
    };

/*----------------------------------------------------------------------+
|                                                                       |
|   General linkage formats.                                            |
|                                                                       |
+----------------------------------------------------------------------*/
#if !defined (GENERICLINK)
typedef struct
    {
#if defined (BITFIELDS_REVERSED)
    UShort info:1;          /* boolean: informational linkage */
    UShort remote:1;        /* boolean: remote linkage */
    UShort modified:1;      /* boolean: user linkage has been modified */
    UShort user:1;          /* boolean: user data linkage */
    UShort linkageClass:4;  /* linkage family class */
    UShort words:8;         /* words to follow in linkage */
#else
    UShort words:8;         /* words to follow in linkage */
    UShort linkageClass:4;  /* linkage family class */
    UShort user:1;          /* boolean: user data linkage */
    UShort modified:1;      /* boolean: user linkage has been modified */
    UShort remote:1;        /* boolean: remote linkage */
    UShort info:1;          /* boolean: informational linkage */
#endif
    UShort  primary_id;     /* User ID number */
    UShort  secondary_id;    /* Secondary ID number */

    UShort  entity;         /* entity number */
    UInt32  mslink;         /* MSLINK field value */
    byte    dastype;        /* displayable attribute type */
    byte    pad[3];                 /* user linkages are a multiple of 4 */
    } Generic_link, GenericLink;
#define GENERICLINK
#endif

/*----------------------------------------------------------------------+
|                                                                       |
|   DMRS linkage format                                                 |
|                                                                       |
+----------------------------------------------------------------------*/
#if !defined (DMRSLINK)
typedef struct
    {
#if defined (BITFIELDS_REVERSED)
    UShort info:1;              /* boolean: informational linkage */
    UShort remote:1;            /* boolean: remote linkage */
    UShort modified:1;          /* boolean: user linkage has been modified */
    UShort user:1;              /* boolean: user data linkage */
    UShort linkageClass:4;      /* linkage family class */
    UShort type:8;              /* displayable attribute type */
#else
    UShort type:8;              /* displayable attribute type */
    UShort linkageClass:4;      /* linkage family class */
    UShort user:1;              /* boolean: user data linkage */
    UShort modified:1;          /* boolean: user linkage has been modified */
    UShort remote:1;            /* boolean: remote linkage */
    UShort info:1;              /* boolean: informational linkage */
#endif
    UShort          entity;      /* entity number */
    UShort          occ_low;     /* low word of the 24 bit occurence number */
    byte            occ_high;    /* high byte of the occurence number */
    byte            reuse;       /* reuse counter */
    } DMRS_link, DMRSLink;
#define DMRSLINK
#endif

/*----------------------------------------------------------------------+
|                                                                       |
|   Informix linkage format.                                            |
|                                                                       |
+----------------------------------------------------------------------*/
#if !defined (IXLINKAGE)
typedef Generic_link IX_link, IXLink;
#define IXLINKAGE
#endif

/*----------------------------------------------------------------------+
|                                                                       |
|   dBASE linkage format.                                               |
|                                                                       |
+----------------------------------------------------------------------*/
#if !defined (DBLINKAGE)
typedef Generic_link dB_link, dBASELink;
#define DBLINKAGE
#endif

/*----------------------------------------------------------------------+
|                                                                       |
|   Oracle linkage format.                                              |
|                                                                       |
+----------------------------------------------------------------------*/
#if !defined (ORACLELINKAGE)
typedef Generic_link Oracle_link, OracleLink;
#define ORACLELINKAGE
#endif

/*----------------------------------------------------------------------+
|                                                                       |
|   MDL call back message structure.                                    |
|                                                                       |
| Changes from 256 to 640 3/24/94 to handle larger callbacks from DOS   |
| Oracle server. Duplicate definition, see ipdfpi.h!                    |
|                                                                       |
+----------------------------------------------------------------------*/
#if !defined (MDLCALLBACK_BUFFER)
#define     MDLCALLBACK_BUFFER      640
struct MDLCallBack
    {
    short    status;
    short    dataLength;
    WChar    data[MDLCALLBACK_BUFFER];
    };
#endif

/*----------------------------------------------------------------------+
|                                                                       |
|   MicroCSL to MDL callback defines.                                   |
|                                                                       |
+----------------------------------------------------------------------*/
#define CALLBACK_DisplayDebugMsg    1
#define CALLBACK_DisplayInfoBox     2

struct DBMDLCallback
    {
    short    requestType;
    WChar   data[MDLCALLBACK_BUFFER - sizeof(int)];
    };

/*----------------------------------------------------------------------+
|                                                                       |
|   Defines for multi-message fetches.                                  |
|                                                                       |
+----------------------------------------------------------------------*/
/* State definitions */
#define PACK_FINISHED       1
#define PACK_COL_NAMES      2
#define PACK_COL_TYPES      3
#define PACK_COL_LENGTHS    4
#define PACK_COL_DATA       5

#define PACK_ABORT          1

/* state information for fetches and describes (MDL side) */
struct UnpackState
    {
    short           descrAllocated;
    short           state;
    int             processedCols;
    };

/* state information for fetches and describes (server side) */
struct MDLOperationState
    {
    short           active;
    short           rowActive;
    short           state;
    short           processedForState;
    };

/*----------------------------------------------------------------------+
|                                                                       |
|   cursor structures (MS -> Server.ma)                                 |
|                                                                       |
+----------------------------------------------------------------------*/
struct CursorRequest
    {
    short           type;
    CursorID        cursorID;
    size_t          queryLength;    /* server.ma -> MS this is length of open cursor describe */
    WChar           query[1];       /*  and this is the result from the describe */
    };

struct CursorDescriptor
    {
    bool            isActive;
    size_t          length;
    WChar           *description;
    };

#endif /* __dbserverH__ */