mention that Wait() relocks the mutex before returning (patch 1482390)

[wxWidgets.git] / docs / latex / wx / recrdset.tex

diff --git a/docs/latex/wx/recrdset.tex b/docs/latex/wx/recrdset.tex
index 532bddfef177121fd8a38eba7a599b6173432e2b..7fedfe70acf4565c2eda1559c800c92a7d091978 100644 (file)
--- a/docs/latex/wx/recrdset.tex
+++ b/docs/latex/wx/recrdset.tex
@@ -4,10 +4,17 @@ Each wxRecordSet represents an ODBC database query. You can make multiple querie
 at a time by using multiple wxRecordSets with a wxDatabase or you can make
 your queries in sequential order using the same wxRecordSet.
 
-\wxheading{Derivation}
+Note: this class is considered obsolete, replaced by the Remstar 
+wxDB/wxDbTable classes
+
+\wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/odbc.h>
+
 \wxheading{See also}
 
 \helpref{wxRecordSet overview}{wxrecordsetoverview}, \helpref{wxDatabase overview}{wxdatabaseoverview}
@@ -263,7 +270,7 @@ obtained from the ODBC manager.}
 
 Copies the current data of the column at position {\it col} into the buffer
 \rtfsp{\it dataPtr}. To be sure to get the right type of data, the user has to pass the
-correct data type. The function returns FALSE if {\it col} does not
+correct data type. The function returns false if {\it col} does not
 exist or the wrong data type was given.
 
 \func{bool}{GetFieldData}{\param{const wxString\& }{name}, \param{int}{ dataType}, \param{void *}{dataPtr}}
@@ -449,14 +456,14 @@ has the number 0.
 
 \func{bool}{IsBOF}{\void}
 
-Returns TRUE if the user tried to move the cursor before the first record
+Returns true if the user tried to move the cursor before the first record
 in the set.
 
 \membersection{wxRecordSet::IsFieldDirty}
 
 \func{bool}{IsFieldDirty}{\param{int}{ field}}
 
-Returns TRUE if the given field has been changed but not saved yet.
+Returns true if the given field has been changed but not saved yet.
 
 \func{bool}{IsFieldDirty}{\param{const wxString\& }{name}}
 
@@ -466,7 +473,7 @@ Same as above, but uses the column name as the identifier.
 
 \func{bool}{IsFieldNull}{\param{int}{ field}}
 
-Returns TRUE if the given field has no data.
+Returns true if the given field has no data.
 
 \func{bool}{IsFieldNull}{\param{const wxString\& }{ name}}
 
@@ -476,7 +483,7 @@ Same as above, but uses the column name as the identifier.
 
 \func{bool}{IsColNullable}{\param{int}{ col}}
 
-Returns TRUE if the given column may contain no data.
+Returns true if the given column may contain no data.
 
 \func{bool}{IsColNullable}{\param{const wxString\& }{name}}
 
@@ -486,7 +493,7 @@ Same as above, but uses the column name as the identifier.
 
 \func{bool}{IsEOF}{\void}
 
-Returns TRUE if the user tried to move the cursor behind the last record
+Returns true if the user tried to move the cursor behind the last record
 in the set.
 
 \membersection{wxRecordSet::IsDeleted}
@@ -499,7 +506,7 @@ Not implemented.
 
 \func{bool}{IsOpen}{\void}
 
-Returns TRUE if the parent database is open.
+Returns true if the parent database is open.
 
 \membersection{wxRecordSet::Move}
 
@@ -552,11 +559,11 @@ Re-executes the last query. Not implemented.
 
 \membersection{wxRecordSet::SetFieldDirty}
 
-\func{void}{SetFieldDirty}{\param{int}{ field}, \param{bool}{ dirty = TRUE}}
+\func{void}{SetFieldDirty}{\param{int}{ field}, \param{bool}{ dirty = true}}
 
 Sets the dirty tag of the field field. Not implemented.
 
-\func{void}{SetFieldDirty}{\param{const wxString\& }{name}, \param{bool}{ dirty = TRUE}}
+\func{void}{SetFieldDirty}{\param{const wxString\& }{name}, \param{bool}{ dirty = true}}
 
 Same as above, but uses the column name as the identifier.
 
@@ -568,7 +575,7 @@ Not implemented.
 
 \membersection{wxRecordSet::SetFieldNull}
 
-\func{void}{SetFieldNull}{\param{void *}{p}, \param{bool }{isNull = TRUE}}
+\func{void}{SetFieldNull}{\param{void *}{p}, \param{bool }{isNull = true}}
 
 Not implemented.