added null pointer check and assert

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

diff --git a/docs/latex/wx/file.tex b/docs/latex/wx/file.tex
index 17eacd3042959cf9a3bc064df3c0cc8b1100fc0a..316ecf7efc53409213da4defb488bb614af7caf3 100644 (file)
--- a/docs/latex/wx/file.tex
+++ b/docs/latex/wx/file.tex
@@ -20,8 +20,8 @@ wxFile is a wrapper around {\tt file descriptor.} - see also
 \helpref{wxFFile}{wxffile} for a wrapper around {\tt FILE} structure.
 
 {\tt wxFileOffset} is used by the wxFile functions which require offsets as 
 \helpref{wxFFile}{wxffile} for a wrapper around {\tt FILE} structure.
 
 {\tt wxFileOffset} is used by the wxFile functions which require offsets as 

-parameter or return them. If the platform supports it, wxFileOffset if a typedef
-for a native 64 bit integer, else a 32 bit integer is used for wxFileOffset.
+parameter or return them. If the platform supports it, wxFileOffset is a typedef
+for a native 64 bit integer, otherwise a 32 bit integer is used for wxFileOffset.

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 


@@ -31,6 +31,10 @@ None.
 
 <wx/file.h>
 
 
 <wx/file.h>
 

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

 \wxheading{Constants}
 
 wx/file.h defines the following constants:
 \wxheading{Constants}
 
 wx/file.h defines the following constants:


@@ -93,7 +97,7 @@ mode constants used with \helpref{Seek()}{wxfileseek}:
 
 Default constructor.
 
 
 Default constructor.
 

-\func{}{wxFile}{\param{const char*}{ filename}, \param{wxFile::OpenMode}{ mode = wxFile::read}}
+\func{}{wxFile}{\param{const wxString\&}{ filename}, \param{wxFile::OpenMode}{ mode = wxFile::read}}

 
 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


@@ -124,7 +128,7 @@ Destructor will close the file.
 
 \membersection{wxFile::Access}\label{wxfileaccess}
 
 
 \membersection{wxFile::Access}\label{wxfileaccess}
 

-\func{static bool}{Access}{\param{const char *}{ name}, \param{OpenMode}{ mode}}
+\func{static bool}{Access}{\param{const wxString\&}{ name}, \param{OpenMode}{ mode}}

 
 This function verifies if we may access the given file in specified mode. Only
 values of wxFile::read or wxFile::write really make sense here.
 
 This function verifies if we may access the given file in specified mode. Only
 values of wxFile::read or wxFile::write really make sense here.


@@ -151,7 +155,7 @@ Closes the file.
 
 \membersection{wxFile::Create}\label{wxfilecreate}
 
 
 \membersection{wxFile::Create}\label{wxfilecreate}
 

-\func{bool}{Create}{\param{const char*}{ filename}, \param{bool}{ overwrite = false}, \param{int }{access = wxS\_DEFAULT}}
+\func{bool}{Create}{\param{const wxString\&}{ filename}, \param{bool}{ overwrite = false}, \param{int }{access = wxS\_DEFAULT}}

 
 Creates a file for writing. If the file already exists, setting {\bf overwrite} to true
 will ensure it is overwritten.
 
 Creates a file for writing. If the file already exists, setting {\bf overwrite} to true
 will ensure it is overwritten.


@@ -195,7 +199,7 @@ of using Eof() as this will not work for special files under Unix.
 
 \membersection{wxFile::Exists}\label{wxfileexists}
 
 
 \membersection{wxFile::Exists}\label{wxfileexists}
 

-\func{static bool}{Exists}{\param{const char*}{ filename}}
+\func{static bool}{Exists}{\param{const wxString\&}{ filename}}

 
 Returns true if the given name specifies an existing regular file (not a
 directory or a link)
 
 Returns true if the given name specifies an existing regular file (not a
 directory or a link)


@@ -246,7 +250,7 @@ Returns the length of the file.
 
 \membersection{wxFile::Open}\label{wxfileopen}
 
 
 \membersection{wxFile::Open}\label{wxfileopen}
 

-\func{bool}{Open}{\param{const char*}{ filename}, \param{wxFile::OpenMode}{ mode = wxFile::read}}
+\func{bool}{Open}{\param{const wxString\&}{ filename}, \param{wxFile::OpenMode}{ mode = wxFile::read}}

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


@@ -318,7 +322,7 @@ error occurred.
 
 \membersection{wxFile::Write}\label{wxfilewrite}
 
 
 \membersection{wxFile::Write}\label{wxfilewrite}
 

-\func{size\_t}{Write}{\param{const void*}{ buffer}, \param{wxFileOffset}{ count}}
+\func{size\_t}{Write}{\param{const void*}{ buffer}, \param{size\_t}{ count}}

 
 Writes the specified number of bytes from a buffer.
 
 
 Writes the specified number of bytes from a buffer.
 


@@ -335,7 +339,7 @@ the number of bytes actually written
 
 \membersection{wxFile::Write}\label{wxfilewrites}
 
 
 \membersection{wxFile::Write}\label{wxfilewrites}
 

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

 
 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.