Connector/ODBC 5 commit: r323 - trunk/MYSQLPlus/MYSQLPlusLib

[pharvey]

Modified:
   trunk/MYSQLPlus/MYSQLPlusLib/MResult.cpp
   trunk/MYSQLPlus/MYSQLPlusLib/MResult.h
Log:
some doc

Modified: trunk/MYSQLPlus/MYSQLPlusLib/MResult.cpp
===================================================================
--- trunk/MYSQLPlus/MYSQLPlusLib/MResult.cpp	2006-06-07 05:44:48 UTC (rev 322)
+++ trunk/MYSQLPlus/MYSQLPlusLib/MResult.cpp	2006-06-07 06:30:48 UTC (rev 323)
@@ -303,7 +303,7 @@
         case SQL_WCHAR:
         case SQL_WVARCHAR:
         case SQL_WLONGVARCHAR:
-            MYODBCDbgReturn( fromCharacterSQL() );
+            MYODBCDbgReturn( fromCharacterSQL( &resultGetData ) );
 
         case SQL_DECIMAL:
         case SQL_NUMERIC:
@@ -314,32 +314,32 @@
         case SQL_REAL:
         case SQL_FLOAT:
         case SQL_DOUBLE:
-            MYODBCDbgReturn( fromNumericSQL() );
+            MYODBCDbgReturn( fromNumericSQL( &resultGetData ) );
 
         case SQL_BIT:
-            MYODBCDbgReturn( fromBitSQL() );
+            MYODBCDbgReturn( fromBitSQL( &resultGetData ) );
 
         case SQL_BINARY:
         case SQL_VARBINARY:
         case SQL_LONGVARBINARY:
-            MYODBCDbgReturn( fromBinarySQL() );
+            MYODBCDbgReturn( fromBinarySQL( &resultGetData ) );
 
         case SQL_TYPE_DATE:
-            MYODBCDbgReturn( fromDateSQL() );
+            MYODBCDbgReturn( fromDateSQL( &resultGetData ) );
 
         case SQL_GUID:
-            MYODBCDbgReturn( fromGuidSQL() );
+            MYODBCDbgReturn( fromGuidSQL( &resultGetData ) );
 
         case SQL_TYPE_TIME:
-            MYODBCDbgReturn( fromTimeSQL() );
+            MYODBCDbgReturn( fromTimeSQL( &resultGetData ) );
 
         case SQL_TYPE_TIMESTAMP:
-            MYODBCDbgReturn( fromTimeStampSQL() );
+            MYODBCDbgReturn( fromTimeStampSQL( &resultGetData ) );
 
         case SQL_INTERVAL_YEAR:
         case SQL_INTERVAL_MONTH:
         case SQL_INTERVAL_YEAR_TO_MONTH:
-            MYODBCDbgReturn( fromIntervalYearMonthSQL() );
+            MYODBCDbgReturn( fromIntervalYearMonthSQL( &resultGetData ) );
 
         case SQL_INTERVAL_DAY:
         case SQL_INTERVAL_HOUR:
@@ -351,7 +351,7 @@
         case SQL_INTERVAL_HOUR_TO_MINUTE:
         case SQL_INTERVAL_HOUR_TO_SECOND:
         case SQL_INTERVAL_MINUTE_TO_SECOND:
-            MYODBCDbgReturn( fromIntervalDayTimeSQL() );
+            MYODBCDbgReturn( fromIntervalDayTimeSQL( &resultGetData ) );
 
         default:
             MYODBCDbgReturn( getDiagnostic()->doAppend( MDiagnostic::DIA_HY003 ) );
@@ -738,14 +738,19 @@
 }
 
 /*!
-    \brief      Get character column data from current row. 
+    \brief  Get character cell data. 
 
-                This enforces the rules from the ODBC specification in a section name
"SQL to C: Character"
-                while attempting to get the column data.
+            This enforces the rules from the ODBC specification in a section name "SQL to
C: Character"
+            while attempting to get the column data.
 
-                Converts type as required.
+            Converts type as required.
 
-    \sa         "SQL to C: Character"
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/odbc/htm/odbcconverting_data_from_sql_to_c_data_types.asp
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa     getData()
+            "SQL to C: Character"
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/odbc/htm/odbcconverting_data_from_sql_to_c_data_types.asp
 */
 SQLRETURN MResult::fromCharacterSQL( MResultGetData *pResultGetData )
 {
@@ -829,6 +834,21 @@
     MYODBCDbgReturn( getDiagnostic()->doAppend( MDiagnostic::DIA_07006 ) );
 }
 
+/*!
+    \brief  Get numeric cell data. 
+
+            This enforces the rules from the ODBC specification in a section name "SQL to
C: Numeric"
+            while attempting to get the column data.
+
+            Converts type as required.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa     getData()
+            "SQL to C: Numeric"
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/odbc/htm/odbcconverting_data_from_sql_to_c_data_types.asp
+*/
 SQLRETURN MResult::fromNumericSQL( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -908,6 +928,21 @@
     MYODBCDbgReturn( getDiagnostic()->doAppend( MDiagnostic::DIA_07006 ) );
 }
 
+/*!
+    \brief  Get bit cell data. 
+
+            This enforces the rules from the ODBC specification in a section name "SQL to
C: Bit"
+            while attempting to get the column data.
+
+            Converts type as required.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa     getData()
+            "SQL to C: Bit"
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/odbc/htm/odbcconverting_data_from_sql_to_c_data_types.asp
+*/
 SQLRETURN MResult::fromBitSQL( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -957,6 +992,21 @@
     MYODBCDbgReturn( getDiagnostic()->doAppend( MDiagnostic::DIA_07006 ) );
 }
 
+/*!
+    \brief  Get binary cell data. 
+
+            This enforces the rules from the ODBC specification in a section name "SQL to
C: Binary"
+            while attempting to get the column data.
+
+            Converts type as required.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa     getData()
+            "SQL to C: Binary"
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/odbc/htm/odbcconverting_data_from_sql_to_c_data_types.asp
+*/
 SQLRETURN MResult::fromBinarySQL( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -979,6 +1029,21 @@
     MYODBCDbgReturn( getDiagnostic()->doAppend( MDiagnostic::DIA_07006 ) );
 }
 
+/*!
+    \brief  Get date cell data. 
+
+            This enforces the rules from the ODBC specification in a section name "SQL to
C: Date"
+            while attempting to get the column data.
+
+            Converts type as required.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa     getData()
+            "SQL to C: Date"
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/odbc/htm/odbcconverting_data_from_sql_to_c_data_types.asp
+*/
 SQLRETURN MResult::fromDateSQL( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1005,6 +1070,21 @@
     MYODBCDbgReturn( getDiagnostic()->doAppend( MDiagnostic::DIA_07006 ) );
 }
 
+/*!
+    \brief  Get guid cell data (in case we support it in future). 
+
+            This enforces the rules from the ODBC specification in a section name "SQL to
C: GUID"
+            while attempting to get the column data.
+
+            Converts type as required.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa     getData()
+            "SQL to C: GUID"
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/odbc/htm/odbcconverting_data_from_sql_to_c_data_types.asp
+*/
 SQLRETURN MResult::fromGuidSQL( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1031,6 +1111,21 @@
     MYODBCDbgReturn( getDiagnostic()->doAppend( MDiagnostic::DIA_07006 ) );
 }
 
+/*!
+    \brief  Get time cell data. 
+
+            This enforces the rules from the ODBC specification in a section name "SQL to
C: Time"
+            while attempting to get the column data.
+
+            Converts type as required.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa     getData()
+            "SQL to C: Time"
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/odbc/htm/odbcconverting_data_from_sql_to_c_data_types.asp
+*/
 SQLRETURN MResult::fromTimeSQL( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1057,6 +1152,21 @@
     MYODBCDbgReturn( getDiagnostic()->doAppend( MDiagnostic::DIA_07006 ) );
 }
 
+/*!
+    \brief  Get timestamp cell data. 
+
+            This enforces the rules from the ODBC specification in a section name "SQL to
C: Timestamp"
+            while attempting to get the column data.
+
+            Converts type as required.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa     getData()
+            "SQL to C: Timestamp"
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/odbc/htm/odbcconverting_data_from_sql_to_c_data_types.asp
+*/
 SQLRETURN MResult::fromTimeStampSQL( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1085,6 +1195,21 @@
     MYODBCDbgReturn( getDiagnostic()->doAppend( MDiagnostic::DIA_07006 ) );
 }
 
+/*!
+    \brief  Get Year-Month Intervals cell data. 
+
+            This enforces the rules from the ODBC specification in a section name "SQL to
C: Year-Month Intervals"
+            while attempting to get the column data.
+
+            Converts type as required.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa     getData()
+            "SQL to C: Year-Month Intervals"
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/odbc/htm/odbcconverting_data_from_sql_to_c_data_types.asp
+*/
 SQLRETURN MResult::fromIntervalYearMonthSQL( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1122,6 +1247,21 @@
     MYODBCDbgReturn( getDiagnostic()->doAppend( MDiagnostic::DIA_07006 ) );
 }
 
+/*!
+    \brief  Get Day-Time Intervals cell data. 
+
+            This enforces the rules from the ODBC specification in a section name "SQL to
C: Day-Time Intervals"
+            while attempting to get the column data.
+
+            Converts type as required.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa     getData()
+            "SQL to C: Day-Time Intervals"
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/odbc/htm/odbcconverting_data_from_sql_to_c_data_types.asp
+*/
 SQLRETURN MResult::fromIntervalDayTimeSQL( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1168,6 +1308,18 @@
     MYODBCDbgReturn( getDiagnostic()->doAppend( MDiagnostic::DIA_07006 ) );
 }
 
+/*!
+    \brief  Converts data to SQL_C_CHAR.
+
+            This method uses information provided in MResultGetData to fill a target
buffer with the 
+            specified cell data - converted as needed.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa getData()
+*/
 SQLRETURN MResult::toCharC( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1218,6 +1370,18 @@
     MYODBCDbgReturn( SQL_SUCCESS );
 }
 
+/*!
+    \brief  Converts data to SQL_C_WCHAR.
+
+            This method uses information provided in MResultGetData to fill a target
buffer with the 
+            specified cell data - converted as needed.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa getData()
+*/
 SQLRETURN MResult::toWCharC( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1268,6 +1432,18 @@
     MYODBCDbgReturn( SQL_SUCCESS );
 }
 
+/*!
+    \brief  Converts data to SQL_C_SSHORT.
+
+            This method uses information provided in MResultGetData to fill a target
buffer with the 
+            specified cell data - converted as needed.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa getData()
+*/
 SQLRETURN MResult::toSShortC( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1305,6 +1481,18 @@
     MYODBCDbgReturn( SQL_SUCCESS );
 }
 
+/*!
+    \brief  Converts data to SQL_C_USHORT.
+
+            This method uses information provided in MResultGetData to fill a target
buffer with the 
+            specified cell data - converted as needed.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa getData()
+*/
 SQLRETURN MResult::toUShortC( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1332,6 +1520,18 @@
     MYODBCDbgReturn( SQL_SUCCESS );
 }
 
+/*!
+    \brief  Converts data to SQL_C_SLONG.
+
+            This method uses information provided in MResultGetData to fill a target
buffer with the 
+            specified cell data - converted as needed.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa getData()
+*/
 SQLRETURN MResult::toSLongC( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1359,6 +1559,18 @@
     MYODBCDbgReturn( SQL_SUCCESS );
 }
 
+/*!
+    \brief  Converts data to SQL_C_ULONG.
+
+            This method uses information provided in MResultGetData to fill a target
buffer with the 
+            specified cell data - converted as needed.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa getData()
+*/
 SQLRETURN MResult::toULongC( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1386,6 +1598,18 @@
     MYODBCDbgReturn( SQL_SUCCESS );
 }
 
+/*!
+    \brief  Converts data to SQL_C_FLOAT.
+
+            This method uses information provided in MResultGetData to fill a target
buffer with the 
+            specified cell data - converted as needed.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa getData()
+*/
 SQLRETURN MResult::toFloatC( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1413,6 +1637,18 @@
     MYODBCDbgReturn( SQL_SUCCESS );
 }
 
+/*!
+    \brief  Converts data to SQL_C_DOUBLE.
+
+            This method uses information provided in MResultGetData to fill a target
buffer with the 
+            specified cell data - converted as needed.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa getData()
+*/
 SQLRETURN MResult::toDoubleC( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1440,6 +1676,18 @@
     MYODBCDbgReturn( SQL_SUCCESS );
 }
 
+/*!
+    \brief  Converts data to SQL_C_BIT.
+
+            This method uses information provided in MResultGetData to fill a target
buffer with the 
+            specified cell data - converted as needed.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa getData()
+*/
 SQLRETURN MResult::toBitC( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1467,6 +1715,18 @@
     MYODBCDbgReturn( SQL_SUCCESS );
 }
 
+/*!
+    \brief  Converts data to SQL_C_STINYINT.
+
+            This method uses information provided in MResultGetData to fill a target
buffer with the 
+            specified cell data - converted as needed.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa getData()
+*/
 SQLRETURN MResult::toSTinyIntC( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1494,6 +1754,18 @@
     MYODBCDbgReturn( SQL_SUCCESS );
 }
 
+/*!
+    \brief  Converts data to SQL_C_UTINYINT.
+
+            This method uses information provided in MResultGetData to fill a target
buffer with the 
+            specified cell data - converted as needed.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa getData()
+*/
 SQLRETURN MResult::toUTinyIntC( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1521,6 +1793,18 @@
     MYODBCDbgReturn( SQL_SUCCESS );
 }
 
+/*!
+    \brief  Converts data to SQL_C_SBIGINT.
+
+            This method uses information provided in MResultGetData to fill a target
buffer with the 
+            specified cell data - converted as needed.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa getData()
+*/
 SQLRETURN MResult::toSBigIntC( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1548,6 +1832,18 @@
     MYODBCDbgReturn( SQL_SUCCESS );
 }
 
+/*!
+    \brief  Converts data to SQL_C_UBIGINT.
+
+            This method uses information provided in MResultGetData to fill a target
buffer with the 
+            specified cell data - converted as needed.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa getData()
+*/
 SQLRETURN MResult::toUBigIntC( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1575,6 +1871,18 @@
     MYODBCDbgReturn( SQL_SUCCESS );
 }
 
+/*!
+    \brief  Converts data to SQL_C_BINARY.
+
+            This method uses information provided in MResultGetData to fill a target
buffer with the 
+            specified cell data - converted as needed.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa getData()
+*/
 SQLRETURN MResult::toBinaryC( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1608,6 +1916,18 @@
     MYODBCDbgReturn( SQL_SUCCESS );
 }
 
+/*!
+    \brief  Converts data to SQL_C_XML.
+
+            This method uses information provided in MResultGetData to fill a target
buffer with the 
+            specified cell data - converted as needed.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa getData()
+*/
 SQLRETURN MResult::toXmlC( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1641,18 +1961,26 @@
     MYODBCDbgReturn( SQL_SUCCESS );
 }
 
+/*!
+    \brief  Converts data to SQL_C_VARBOOKMARK.
+
+            This method uses information provided in MResultGetData to fill a target
buffer with the 
+            specified cell data - converted as needed.
+
+    \note   We may never really use this as bookmark requests will likely get intercepted
higher up
+            the 'food chain'. But doing this allows us to put a bookmark into the result
set and 
+            subsequently in our data conversion 'hub' - the Variant cell value.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa getData()
+*/
 SQLRETURN MResult::toVarBookmarkC( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
 
-    /*!
-        \internal
-        \note
-
-        We may never really use this as bookmark requests will likely get intercepted
higher up
-        the 'food chain'. But doing this allows us to put a bookmark into the result set
and 
-        subsequently in our data conversion 'hub' - the Variant cell value.
-    */
     if ( !pResultGetData->variantData.canConvert<QByteArray>() )
         MYODBCDbgReturn( getDiagnostic()->doAppend( MDiagnostic::DIA_07006 ) );
 
@@ -1682,6 +2010,18 @@
     MYODBCDbgReturn( SQL_SUCCESS );
 }
 
+/*!
+    \brief  Converts data to SQL_C_TYPE_DATE.
+
+            This method uses information provided in MResultGetData to fill a target
buffer with the 
+            specified cell data - converted as needed.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa getData()
+*/
 SQLRETURN MResult::toTypeDateC( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1714,6 +2054,18 @@
     MYODBCDbgReturn( SQL_SUCCESS );
 }
 
+/*!
+    \brief  Converts data to SQL_C_TYPE_TIME.
+
+            This method uses information provided in MResultGetData to fill a target
buffer with the 
+            specified cell data - converted as needed.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa getData()
+*/
 SQLRETURN MResult::toTypeTimeC( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1746,6 +2098,18 @@
     MYODBCDbgReturn( SQL_SUCCESS );
 }
 
+/*!
+    \brief  Converts data to SQL_C_TYPE_TIMESTAMP.
+
+            This method uses information provided in MResultGetData to fill a target
buffer with the 
+            specified cell data - converted as needed.
+
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
+    \return SQLRETURN
+
+    \sa getData()
+*/
 SQLRETURN MResult::toTypeTimestampC( MResultGetData *pResultGetData )
 {
     MYODBCDbgEnter();
@@ -1783,17 +2147,19 @@
 }
 
 /*!
-    \brief          Attempts to get the data in a SQL_NUMERIC_STRUCT.
+    \brief          Attempts to get the data into a SQL_NUMERIC_STRUCT.
 
                     The precision and scale fields of SQL_NUMERIC_STRUCT are for output
only. In other
                     words the app can not set them and expect it to mean anything. This
is according to
                     the ODBC specification. But we are an internal method used to support
higher-level
                     versions of getData() and as such we expect precision and scale
fields to hold viable
-                    values as per ODBC rules.
+                    values as per (other) ODBC rules.
 
     \note           Not all source data can be converted to a SQL_NUMERIC_STRUCT. There
are ODBC rules
                     which govern this - most of which may have been applied before
getting here.
 
+    \param  pResultGetData  Reference to a MResultGetData. This should be initialized
with cell data etc.
+
     \return SQLRETURN
 
     \sa getData()
@@ -2015,10 +2381,11 @@
     \brief  Appends an IRD record describing the given field.
 
             This is all about mapping our MySQL field description (MYSQL_FIELD) to our
ODBC
-            column description (IRD).
+            row descriptor (IRD).
 
-    \param  nField
-    \param  pField
+    \param  nField          The field/column we are working with. 
+    \param  pField          Reference to a viable MYSQL_FIELD. This is how MySQL describe
a field/column. This is our source. 
+    \param  pDescriptor     Reference to the IRD for the resultset. This is our target.
We will append a record here.
 
     \return SQLRETURN
     

Modified: trunk/MYSQLPlus/MYSQLPlusLib/MResult.h
===================================================================
--- trunk/MYSQLPlus/MYSQLPlusLib/MResult.h	2006-06-07 05:44:48 UTC (rev 322)
+++ trunk/MYSQLPlus/MYSQLPlusLib/MResult.h	2006-06-07 06:30:48 UTC (rev 323)
@@ -210,7 +210,7 @@
     SQLRETURN       toVarBookmarkC( MResultGetData  *pResultGetData );                 
/*!< SQL_C_VARBOOKMARK 	    SQLCHAR * 	            unsigned char *     */
     SQLRETURN       toTypeDateC( MResultGetData  *pResultGetData );                    
/*!< SQL_C_TYPE_DATE 	    SQL_DATE_STRUCT         DATE_STRUCT         */
     SQLRETURN       toTypeTimeC( MResultGetData  *pResultGetData );                    
/*!< SQL_C_TYPE_TIME 	    SQL_TIME_STRUCT         TIME_STRUCT         */
-    SQLRETURN       toTypeTimeStampC( MResultGetData  *pResultGetData );               
/*!< SQL_C_TYPE_TIMESTAMP 	SQL_TIMESTAMP_STRUCT    TIMESTAMP_STRUCT    */
+    SQLRETURN       toTypeTimestampC( MResultGetData  *pResultGetData );               
/*!< SQL_C_TYPE_TIMESTAMP 	SQL_TIMESTAMP_STRUCT    TIMESTAMP_STRUCT    */
     SQLRETURN       toNumericC( MResultGetData  *pResultGetData );                     
/*!< SQL_C_NUMERIC 	        SQL_NUMERIC_STRUCT      SQL_NUMERIC_STRUCT  */
     SQLRETURN       toGuidC( MResultGetData  *pResultGetData );                        
/*!< SQL_C_GUID 	        SQLGUID                 SQLGUID             */
     SQLRETURN       toIntervalMonthC( MResultGetData  *pResultGetData );               
/*!< interval type          SQL_INTERVAL_STRUCT     SQL_INTERVAL_STRUCT */