demos/dbbrowse/help.std/getcol.htm

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
   2 <HTML><HEAD><TITLE>DBBrowser Help : Remstar ODBC Classes</TITLE></HEAD>
   3 <BODY BGCOLOR=#C6DFC6><CENTER><IMG SRC="../help.png/logo.png"></CENTER><BR><CENTER><B>DBBrowser<BR>Mark Johnson, Berlin Germany<BR>mj10777@gmx.net</B><HR></CENTER>
   4 <!----------------------------------------------------------------------------------------------------------->
   5  <TABLE border=1><B><TBODY><TR bgcolor=#CCFFFF>
   6   <TH><B><H3><IMG SRC="../help.png/remstar.png"><BR>Remstar ODBC Classes :<BR>The new wxDB::GetColumns() Function<BR>Description</H3><BR>(English)</B></FONT></TH>
   7  </TABLE></TBODY></TR><P>
   8  <B>Stand: 2000-01-23.01-mj10777</B><HR>
   9 <!-------------------------------------------------------------->
  10  <TABLE border=1><B><TBODY>
  11   <TR><TH bgcolor=#CCFFFF><B>There are 2 new wxDB Functions : </B></TH></TR>
  12  </TBODY></TABLE>
  13 <!-------------------------------->
  14  <A NAME="GETCOLUMNS">
  15  <TABLE border=1><B><TBODY><TR>
  16   <TR><TH bgcolor=#FFFFAA><B><A HREF="#GETCOLUMNS">wxColInf *wxDB::GetColumns(char *tableName, int *numCols, const char *userID)</A></B></FONT></TH></TR>
  17  </TBODY></TABLE>
  18  <TABLE border=1><B><TBODY><TR>
  19   <TR><TH bgcolor=#FFFFE0><B>This Function stores all (<I><FONT color=#FF0000>int numCols</FONT>) information from the Table (<I><FONT color=#FF0000>char *tableName</FONT></I>).<BR>It returns the result in a <A HREF="#WXCOLINF">wxColInf</A> Stucture (Class)</B></FONT></TH></TR>
  20  </TBODY></TABLE>
  21 <!-------------------------------->
  22  <A NAME="GETKEYFIELDS"><P>
  23  <TABLE border=1><B><TBODY><TR>
  24   <TR><TH bgcolor=#FFFFAA><B><A HREF="#GETKEYFIELDS">int wxDB::GetKeyFields(char *tableName, wxColInf* colInf,int noCols)</A></B></FONT></TH></TR>
  25  </TBODY></TABLE>
  26  <TABLE border=1><B><TBODY><TR>
  27   <TR><TH bgcolor=#FFFFE0><B>Tries to find out if any (<I><FONT color=#FF0000>int noCols</FONT></I>) of the columns (<I><FONT color=#FF0000>wxColInf* colInf</FONT></I>)<BR> in the Table (<I><FONT color=#FF0000>char *tableName</FONT></I>) are <IMG SRC="../help.png/key.png">&nbsp;Primary or <IMG SRC="../help.png/keyf.png">&nbsp;Foreign Keys.<HR>This Function is only called from GetColumns().</B></FONT></TH></TR>
  28  </TBODY></TABLE><HR>
  29 <!----------------------------------------------------------------------------------------------------------->
  30  <TABLE border=1><B><TBODY>
  31   <TR><TH bgcolor=#CCFFFF><B>There are 4 new wxDB Classes (Structures) : </B></TH></TR>
  32  </TBODY></TABLE>
  33 <!-------------------------------->
  34  <A NAME="WXDBINF"><P>
  35  <TABLE border=1><B><TBODY><TR>
  36   <TR><TH bgcolor=#FFFFAA><B><A HREF="#WXDBINF">wxDbInf</A></B></FONT></TH></TR>
  37  </TBODY></TABLE>
  38  <TABLE border=1><B><TBODY><TR>
  39   <TR><TH bgcolor=#FFFFE0>
  40       <B>This Class stores all ODBC-Information for a Database :<HR>
  41          Catalog Entry (<I><FONT color=#FF0000>char catalog[128+1]</I></FONT>),<BR>
  42          Schema (<I><FONT color=#FF0000>char schema[128+1]</I></FONT>)<BR>
  43          the number of Tables found(<I><FONT color=#FF0000>int numTables</I></FONT>)<BR>
  44          and a Pointer (<I><A HREF="#WXTABLEINF">wxTableInf*</A><FONT color=#FF0000> pTableInf</FONT></I>) Structure is stored.
  45       </B></FONT></TH></TR>
  46  </TBODY></TABLE>
  47 <!-------------------------------->
  48  <A NAME="WXTABLEINF"><P>
  49  <TABLE border=1><B><TBODY><TR>
  50   <TR><TH bgcolor=#FFFFAA><B><A HREF="#WXTABLEINF">wxTableInf</A></B></FONT></TH></TR>
  51  </TBODY></TABLE>
  52  <TABLE border=1><B><TBODY><TR>
  53   <TR><TH bgcolor=#FFFFE0>
  54       <B>This Class stores all ODBC-Information about a Table :<HR>
  55          Table-Name (<I><FONT color=#FF0000>char tableName[DB_MAX_TABLE_NAME_LEN+1]</I></FONT>),<BR>
  56          Table-Type (<I><FONT color=#FF0000>char tableType[254+1]</I></FONT>) - "TABLE", "SYSTEM TABLE" etc. ,<BR>
  57          Table-Remarks (<I><FONT color=#FF0000>char tableRemarks[254+1]</I></FONT>),<BR>
  58          the number of Columns found(<I><FONT color=#FF0000>int numCols</I></FONT>)<BR>
  59          and a Pointer (<I><A HREF="#WXCOLINF">wxColInf*</A><FONT color=#FF0000> pColInf</FONT></I>) Structure is stored.
  60       </B></FONT></TH></TR>
  61  </TBODY></TABLE>
  62 <!-------------------------------->
  63  <A NAME="WXCOLINF"><P>
  64  <TABLE border=1><B><TBODY><TR>
  65   <TR><TH bgcolor=#FFFFAA><B><A HREF="#WXCOLINF">wxColInf</A></B></FONT></TH></TR>
  66  </TBODY></TABLE>
  67  <TABLE border=1><B><TBODY><TR>
  68   <TR><TH bgcolor=#FFFFE0>
  69       <B>This Class stores all ODBC-Information about a Column :<HR>
  70          Catalog Entry (<I><FONT color=#FF0000>char catalog[128+1]</I></FONT>),<BR>
  71          Schema (<I><FONT color=#FF0000>char schema[128+1]</I></FONT>)<BR>
  72          Table-Name (<I><FONT color=#FF0000>char tableName[DB_MAX_TABLE_NAME_LEN+1]</I></FONT>),<BR>
  73          Column-Name (<I><FONT color=#FF0000>char colName[DB_MAX_COLUMN_NAME_LEN+1]</I></FONT>),<BR>
  74          Datatype (from SQL) (<I><FONT color=#FF0000>SWORD sqlDataType</I></FONT>),<BR>
  75          Data-Name(from SQL) (<I><FONT color=#FF0000>char typeName[128+1]</I></FONT>),<BR>
  76          Column size(from SQL) (<I><FONT color=#FF0000>SWORD columnSize</I></FONT>),<BR>
  77          Buffer length(from SQL) (<I><FONT color=#FF0000>SWORD bufferLength</I></FONT>),<BR>
  78          Decimal digits(from SQL) (<I><FONT color=#FF0000>short decimalDigits</I></FONT>),<BR>
  79          numPrecRadix (from SQL) (<I><FONT color=#FF0000>short numPrecRadix</I></FONT>),<BR>
  80          Nullable (from SQL) (<I><FONT color=#FF0000>short nullable</I></FONT>),<BR>
  81          Remarks (<I><FONT color=#FF0000>char remarks[254+1]</I></FONT>),<BR>
  82          Datatype (from wxDB) (<I><FONT color=#FF0000>int dbDataType</I></FONT>),<BR>
  83          Primary-Key (<I><FONT color=#FF0000>int PkCol</I></FONT>) 0=No; 1= First Key, 2 = Second Key etc.,<BR>
  84          Tables that use this Key as a Foreign Key(<I><FONT color=#FF0000>char PkTableName[DB_MAX_TABLE_NAME_LEN+1]</I></FONT>),<BR>
  85          Foreign-Key (<I><FONT color=#FF0000>int FkCol</I></FONT>) 0=No; 1= First Key, 2 = Second Key etc.,<BR>
  86          Table-Name where this Foreign-Key is Primary Key(<I><FONT color=#FF0000>char FkTableName[DB_MAX_TABLE_NAME_LEN+1]</I></FONT>),<BR>
  87          and a Pointer (<I><A HREF="#WXCOLFOR">wxColFor*</A><FONT color=#FF0000> pColFor</FONT></I>) Structure is stored.
  88       </B></FONT></TH></TR>
  89  </TBODY></TABLE>
  90 <!-------------------------------->
  91  <A NAME="WXCOLFOR"><P>
  92  <TABLE border=1><B><TBODY><TR>
  93   <TR><TH bgcolor=#FFFFAA><B><A HREF="#WXCOLFOR">wxColFor</A></B></FONT></TH></TR>
  94  </TBODY></TABLE>
  95  <TABLE border=1><B><TBODY><TR>
  96   <TR><TH bgcolor=#FFFFE0>
  97       <B>This Class stores how this Column should be formated in a String : <HR>
  98          Output String (<I><FONT color=#FF0000>wxString s_Field</I></FONT>),<BR>
  99          Formatted Objects (TIMESTAMP needs 7) (<I><FONT color=#FF0000>wxString s_Format[7]</I></FONT>),<BR>
 100          Formatted Objects  (<I><FONT color=#FF0000>wxString s_Menge[7]</I></FONT>),<BR>
 101          Formatted Objects (TT MM YYYY HH MM SS m) (<I><FONT color=#FF0000>int i_Menge[7]</I></FONT>),<BR>
 102          National (0=timestamp,1=EU,2=UK,3=International,4=US)<I><FONT color=#FF0000>int i_Nation</I></FONT>),<BR>
 103          Datatype (from wxDB) (<I><FONT color=#FF0000>int I_dbDataType</I></FONT>),<BR>
 104          Datatype (from SQL) (<I><FONT color=#FF0000>SWORD i_sqlDataType</I></FONT>),<HR>
 105          int Format(int Nation, int dbDataType,SWORD sqlDataType,short columnSize,short decimalDigits);<BR>
 106          The Formatted Objects receive Standard Values and Format() is called.<BR>
 107          The Programmers can, if they want something special , change these Values and call Format() again
 108       </B></FONT></TH></TR>
 109  </TBODY></TABLE>
 110  <TABLE border=1><B><TBODY>
 111   <TR><TH bgcolor=#FFBBBB><B>This class is most definitely very much underdeveloped !<BR>It was made so that the DBGrid could be realised.<BR>Changes here are probable. (Suggestions welcomed)</A></B></TH></TR>
 112  </TBODY></TABLE><P>
 113 <!----------------------------------------------------------------------------------------------------------->
 114  <TABLE border=1><B><TBODY><TR>
 115   <TR><TH bgcolor=#FFF777><B>Well now, <A HREF="getcolsh.htm">that makes everything clear</A> does't it?</B></FONT></TH></TR>
 116  </TBODY></TABLE><HR>
 117 <!----------------------------------------------------------------------------------------------------------->
 118 </BODY></HTML>