dbdefs.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

#include "mstypes.h"
#include <Mstn\MicroStation.r.h>
#include "dbdefs.r.h"

/*----------------------------------------------------------------------+
|                                                                       |
|   Linkage generation modes.                                           |
|                                                                       |
+----------------------------------------------------------------------*/
#define NOLINK              -1          /* null linkage mode */
#define NEWLINK              0          /* new linkage generation mode */
#define INFOLINK             1          /* informational linkage mode */
#define DUPLINK              2          /* duplicate linkage mode */

/*----------------------------------------------------------------------+
|                                                                       |
|   Linkage types recognized by MicroStation servers.                   |
|                                                                       |
+----------------------------------------------------------------------*/
// #define INFORMIX_LINKAGE     1
// #define DMRS_LINKAGE         2
// #define XBASE_LINKAGE        4
/* DBASE_LINKAGE only exists for backwards compatibility, in future use XBASE_LINKAGE */
// #define DBASE_LINKAGE        4
// #define ORACLE_LINKAGE       8
// #define RIS_LINKAGE         16
// #define INGRES_LINKAGE      32
// #define SYBASE_LINKAGE      64
// #define ODBC_LINKAGE        128
// #define OLEDB_LINKAGE       256
// #define BUDBC_LINKAGE       512

/*----------------------------------------------------------------------+
|                                                                       |
|   Signature words used for user data linkages.                        |
|                                                                       |
+----------------------------------------------------------------------*/
// #define INFORMIX_ID         0x3948      /* Informix user data signature */
// #define XBASE_ID            0x1971      /* Xbase(dBASE) user data signature */
// #define DBASE_ID            0x1971      /* exists for backwards compatibility to Xbase */
// #define RIS_ID              0x71fb      /* RIS user data signature */
// #define ORACLE_ID           0x6091      /* Oracle user data signature */
// #define INGRES_ID           0x3a77      /* INGRES user data signature (ING) */
// #define SYBASE_ID           0x4F58      /* Sybase user data signature (C.G)? */
// #define ODBC_ID             0x5e62      /* ODBC user data signature (ODB) */
// #define OLEDB_ID            0x5800      /* OLEDB user data signature */
// #define BUDBC_ID            0x5834      /* BUDBC user data signature */
// 
// #define PRIMARY_ID          0x6091      /* ID for Oracle linkage */
// #define SECONDARY_ID        0xf81       /* Secondary ID link (BSI radix 50) */

/*----------------------------------------------------------------------+
|                                                                       |
|   Masks for user attribute properties word.                           |
|                                                                       |
+----------------------------------------------------------------------*/
#define DB_PROP_INFO        0x8000
#define DB_PROP_REMOTE      0x4000
#define DB_PROP_MODIFIED    0x2000
#define DB_PROP_USER        0x1000
#define DB_PROPERTY_MASK    0xf000

#define USER_LINKAGE        0x1000      /* user data linkage */
#define INFO_LINKAGE        0x8000      /* informational linkage */

/*----------------------------------------------------------------------+
|                                                                       |
|   Miscellaneous constants - some of these are related to the          |
|       size of mscatalog columns.  They should be kept in synch.       |
|                                                                       |
+----------------------------------------------------------------------*/
// #define MAX_SCREEN_FORM             64
// #define MAX_FORM_TABLE              64
// #define MAX_FORM_TYPE               64
// #define MAX_REPORT_TABLE            64
// #define MAX_SQL_REVIEW             2048
// #define MAX_FENCE_FILTER           2048
// #define MAX_DAS_TABLE               32
// #define MAX_FORM_TYPE               64

/*----------------------------------------------------------------------+
|                                                                       |
|   Form Types.                                                         |
|                                                                       |
+----------------------------------------------------------------------*/
#define FORM_TYPE_REVIEW    1
#define FORM_TYPE_EDIT      2

/*----------------------------------------------------------------------+
|                                                                       |
|   Miscellaneous masks.                                                |
|                                                                       |
+----------------------------------------------------------------------*/
#define NULL_MASK           0x8000 /* null/not null in type descriptor */
#define TYPE_MASK           0x7fff /* mask type off type descriptor */

/*----------------------------------------------------------------------+
|                                                                       |
|   MicroStation message resource defines.                              |
|                                                                       |
+----------------------------------------------------------------------*/
//MsgList_MESSAGES
#define SERVER_INIT            353  /* database server initialized */
#define DBLOAD                 354  /* loading and initializing database */
#define SELECT_SOURCE_LINK     601  /* select element to provide linkage */

//MsgList_ERRORS 
#define DBSERVER_NOT_ACTIVE    143  /* server not active */
#define SERVER_INIT_ERROR      157  /* unable to initialize server */
#define MSG_SEND_ERROR         158  /* unable to send database request */
#define MSG_RCV_ERROR          159  /* unable to receive database response */
#define SERVER_STARTUP_ERROR   160  /* unable to startup database server */
#define DB_NOT_CONFIGURED      161  /* not configured with the database. */
#define MAX_ADATA              162  /* maximum user data size exceeded */
#define DB_NO_DATYPE           200  /* no display attribute type specified */
#define SERVER_DIED            254  /* database server died */

/*----------------------------------------------------------------------+
|                                                                       |
|   Server state change types                                           |
|                                                                       |
+----------------------------------------------------------------------*/

#define SERVER_STATE_LINKTYPE_DEFINED   1   /* MS_LINKTYPES was (re)defined */
#define SERVER_STATE_UNLOADED           2   /* server.ma was unloaded */
#define SERVER_STATE_PACKED_DATA        3   /* database server is returning packed data */
#define SERVER_STATE_SQLDA_DATA         4   /* database server is returning SQLDA structure */

/*----------------------------------------------------------------------+
|                                                                       |
|   Column data types.                                                  |
|                                                                       |
+----------------------------------------------------------------------*/
// #define DB_CHAR                 1
// #define DB_NUMBER               2
// #define DB_REAL                 2
// #define DB_DATE                 3
// #define DB_INTEGER              4
// #define DB_RAW                  5
// #define DB_BINARY               6
// #define DB_OBJECT               7
// #define DB_ARRAY                8
// #define DB_ROWID                9
// #define DB_UNDEFINED    99

/*----------------------------------------------------------------------+
|                                                                       |
|   Defines for mdlDB_fetchRow ().                                      |
|                                                                       |
+----------------------------------------------------------------------*/
#define QUERY_NOT_FINISHED  0   /* current query is not finished */
#define QUERY_FINISHED      1   /* currey query has finished */

/*----------------------------------------------------------------------+
|                                                                       |
|   Cursor typedef                                                      |
|                                                                       |
+----------------------------------------------------------------------*/
typedef long    CursorID;

/*----------------------------------------------------------------------+
|                                                                       |
|   Structure typedefs.                                                 |
|                                                                       |
+----------------------------------------------------------------------*/
struct User_Link
    {
#if defined (BITFIELDS_REVERSED)
    unsigned short info:1;      /* boolean: informational linkage */
    unsigned short remote:1;    /* boolean: remote linkage */
    unsigned short modified:1;  /* boolean: user linkage has been modified */
    unsigned short user:1;      /* boolean: user data linkage */
    unsigned short linkageClass:4; /* linkage family class */
    unsigned short words:8;     /* words to follow in linkage */
#else
    unsigned short words:8;     /* words to follow in linkage */
    unsigned short linkageClass:4; /* linkage family class */
    unsigned short user:1;      /* boolean: user data linkage */
    unsigned short modified:1;  /* boolean: user linkage has been modified */
    unsigned short remote:1;    /* boolean: remote linkage */
    unsigned short info:1;      /* boolean: informational linkage */
#endif
    UShort   id;            /* User ID number */
    };

struct LinkProps
    {
    UShort          information;    /* informational linkage */
    UShort          remote;         /* remote linkage */
    UShort          modified;       /* user linkage has been modified */
    UShort          user;           /* user data linkage */
    UShort          linkageClass;   /* linkage family class */
    };

struct DatabaseLink
    {
    UShort          linkSize;       /* total size (bytes) of linkage */
    UShort          linkType;       /* type (ORACLE, DMRS, XBASE...) */
    UShort          entity;         /* entity number */
    WChar           tablename[64];  /* database table */
    UInt32          mslink;         /* MSLINK key of linkage */
    LinkProps       props;          /* properties */
    UShort          dasType;        /* displayable attributes */
    };

struct ColumnDescr
    {
    WChar           name[MAX_COLUMN_LENGTH];   /* column name       */
    short           type;                      /* column type       */
    short           length;                    /* column length     */
    short           scale;                     /* numeric scale     */
    short           prec;                      /* numeric precision */
    short           null;                      /* nulls permitted   */
    };

struct LinkInfo
    {
    UShort          entity;
    UInt32          mslink;
    DgnModelRefP    modelRef;
    UInt32          filePos;
    UInt32          information;
    int             elemType;
    };