added null pointer check and assert

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

diff --git a/docs/latex/wx/ffile.tex b/docs/latex/wx/ffile.tex
index 569fa17f0aefa5216c63d5049402336b21f51204..611569f1f972323abfc0d1d2c7da6512e2fae0b7 100644 (file)
--- a/docs/latex/wx/ffile.tex
+++ b/docs/latex/wx/ffile.tex
@@ -6,7 +6,7 @@
 %% Created:     14.01.02 (extracted from file.tex)
 %% RCS-ID:      $Id$
 %% Copyright:   (c) Vadim Zeitlin
 %% Created:     14.01.02 (extracted from file.tex)
 %% RCS-ID:      $Id$
 %% Copyright:   (c) Vadim Zeitlin

-%% License:     wxWidgets license
+%% License:     wxWindows license

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxFFile}}\label{wxffile}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxFFile}}\label{wxffile}


@@ -25,6 +25,10 @@ None.
 
 <wx/ffile.h>
 
 
 <wx/ffile.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt%
 \twocolitem{{\bf wxFromStart}}{Count offset from the start of the file}
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt%
 \twocolitem{{\bf wxFromStart}}{Count offset from the start of the file}


@@ -41,7 +45,7 @@ None.
 
 Default constructor.
 
 
 Default constructor.
 

-\func{}{wxFFile}{\param{const char*}{ filename}, \param{const char*}{ mode = "r"}}
+\func{}{wxFFile}{\param{const wxString\&}{ filename}, \param{const wxString\&}{ mode = "r"}}

 
 Opens a file with the given mode. As there is no way to return whether the
 operation was successful or not from the constructor you should test the
 
 Opens a file with the given mode. As there is no way to return whether the
 operation was successful or not from the constructor you should test the


@@ -127,7 +131,7 @@ the file is not opened.
 
 \membersection{wxFFile::Error}\label{wxffileerror}
 
 
 \membersection{wxFFile::Error}\label{wxffileerror}
 

-Returns \true if an error has occured on this file, similar to the standard
+Returns \true if an error has occurred on this file, similar to the standard

 \texttt{ferror()} function.
 
 Please note that this method may only be called for opened files and may crash
 \texttt{ferror()} function.
 
 Please note that this method may only be called for opened files and may crash


@@ -180,7 +184,7 @@ Returns the length of the file.
 
 \membersection{wxFFile::Open}\label{wxffileopen}
 
 
 \membersection{wxFFile::Open}\label{wxffileopen}
 

-\func{bool}{Open}{\param{const char*}{ filename}, \param{const char*}{ mode = "r"}}
+\func{bool}{Open}{\param{const wxString\&}{ filename}, \param{const wxString\&}{ mode = "r"}}

 
 Opens the file, returning \true if successful.
 
 
 Opens the file, returning \true if successful.
 


@@ -210,7 +214,7 @@ The number of bytes read.
 
 \membersection{wxFFile::ReadAll}\label{wxffilereadall}
 
 
 \membersection{wxFFile::ReadAll}\label{wxffilereadall}
 

-\func{bool}{ReadAll}{\param{wxString *}{ str}, \param{wxMBConv\&}{ conv = wxConvUTF8}}
+\func{bool}{ReadAll}{\param{wxString *}{ str}, \param{const wxMBConv\&}{ conv = wxConvAuto()}}

 
 Reads the entire contents of the file into a string.
 
 
 Reads the entire contents of the file into a string.
 


@@ -277,7 +281,7 @@ Number of bytes written.
 
 \membersection{wxFFile::Write}\label{wxffilewrites}
 
 
 \membersection{wxFFile::Write}\label{wxffilewrites}
 

-\func{bool}{Write}{\param{const wxString\& }{s}, \param{wxMBConv\&}{ conv = wxConvUTF8}}
+\func{bool}{Write}{\param{const wxString\& }{s}, \param{const wxMBConv\&}{ conv = wxConvAuto()}}

 
 Writes the contents of the string to the file, returns \true on success.
 
 
 Writes the contents of the string to the file, returns \true on success.