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
+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.
+
\wxheading{Derived from}
None.
\end{twocollist}
Other constants defined elsewhere but used by wxFile functions are wxInvalidOffset which represents an
-invalid value of type {\it off\_t} and is returned by functions returning {\it off\_t} on error and the seek
+invalid value of type {\it wxFileOffset} and is returned by functions returning {\it wxFileOffset} on error and the seek
mode constants used with \helpref{Seek()}{wxfileseek}:
\twocolwidtha{7cm}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxFile::wxFile}\label{wxfileconstr}
+\membersection{wxFile::wxFile}\label{wxfilector}
\func{}{wxFile}{\void}
\docparam{fd}{An existing file descriptor (see \helpref{Attach()}{wxfileattach} for the list of predefined descriptors)}
-\membersection{wxFile::\destruct{wxFile}}
+\membersection{wxFile::\destruct{wxFile}}\label{wxfiledtor}
\func{}{\destruct{wxFile}}{\void}
\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 char*}{ 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
+Creates a file for writing. If the file already exists, setting {\bf overwrite} to true
will ensure it is overwritten.
\membersection{wxFile::Detach}\label{wxfiledetach}
\func{void}{Detach}{\void}
Get back a file descriptor from wxFile object - the caller is responsible for closing the file if this
-descriptor is opened. \helpref{IsOpened()}{wxfileisopened} will return FALSE after call to Detach().
+descriptor is opened. \helpref{IsOpened()}{wxfileisopened} will return false after call to Detach().
\membersection{wxFile::fd}\label{wxfilefd}
\constfunc{bool}{Eof}{\void}
-Returns TRUE if the end of the file has been reached.
+Returns true if the end of the file has been reached.
Note that the behaviour of the file pointer based class
\helpref{wxFFile}{wxffile} is different as \helpref{wxFFile::Eof}{wxffileeof}
-will return TRUE here only if an attempt has been made to read
-{\it past} the last byte of the file, while wxFile::Eof() will return TRUE
+will return true here only if an attempt has been made to read
+{\it past} the last byte of the file, while wxFile::Eof() will return true
even before such attempt is made if the file pointer is at the last position
in the file.
\func{static bool}{Exists}{\param{const char*}{ filename}}
-Returns TRUE if the given name specifies an existing regular file (not a
+Returns true if the given name specifies an existing regular file (not a
directory or a link)
\membersection{wxFile::Flush}\label{wxfileflush}
due to a missing fsync function, which reduces the usefulness of this function
(it can still be called but it will do nothing on unsupported compilers).
+\membersection{wxFile::GetKind}\label{wxfilegetfilekind}
+
+\constfunc{wxFileKind}{GetKind}{\void}
+
+Returns the type of the file. Possible return values are:
+
+\begin{verbatim}
+enum wxFileKind
+{
+ wxFILE_KIND_UNKNOWN,
+ wxFILE_KIND_DISK, // a file supporting seeking to arbitrary offsets
+ wxFILE_KIND_TERMINAL, // a tty
+ wxFILE_KIND_PIPE // a pipe
+};
+
+\end{verbatim}
+
\membersection{wxFile::IsOpened}\label{wxfileisopened}
\constfunc{bool}{IsOpened}{\void}
-Returns TRUE if the file has been opened.
+Returns true if the file has been opened.
\membersection{wxFile::Length}\label{wxfilelength}
-\constfunc{off\_t}{Length}{\void}
+\constfunc{wxFileOffset}{Length}{\void}
Returns the length of the file.
\func{bool}{Open}{\param{const char*}{ filename}, \param{wxFile::OpenMode}{ mode = wxFile::read}}
-Opens the file, returning TRUE if successful.
+Opens the file, returning true if successful.
\wxheading{Parameters}
\membersection{wxFile::Read}\label{wxfileread}
-\func{off\_t}{Read}{\param{void*}{ buffer}, \param{off\_t}{ count}}
+\func{size\_t}{Read}{\param{void*}{ buffer}, \param{size\_t}{ count}}
Reads the specified number of bytes into a buffer, returning the actual number read.
\membersection{wxFile::Seek}\label{wxfileseek}
-\func{off\_t}{Seek}{\param{off\_t }{ofs}, \param{wxSeekMode }{mode = wxFromStart}}
+\func{wxFileOffset}{Seek}{\param{wxFileOffset }{ofs}, \param{wxSeekMode }{mode = wxFromStart}}
Seeks to the specified position.
\membersection{wxFile::SeekEnd}\label{wxfileseekend}
-\func{off\_t}{SeekEnd}{\param{off\_t }{ofs = 0}}
+\func{wxFileOffset}{SeekEnd}{\param{wxFileOffset }{ofs = 0}}
Moves the file pointer to the specified number of bytes before the end of the file.
\membersection{wxFile::Tell}\label{wxfiletell}
-\constfunc{off\_t}{Tell}{\void}
+\constfunc{wxFileOffset}{Tell}{\void}
Returns the current position or wxInvalidOffset if file is not opened or if another
error occurred.
\membersection{wxFile::Write}\label{wxfilewrite}
-\func{size\_t}{Write}{\param{const void*}{ buffer}, \param{off\_t}{ count}}
+\func{size\_t}{Write}{\param{const void*}{ buffer}, \param{wxFileOffset}{ count}}
Writes the specified number of bytes from a buffer.
\membersection{wxFile::Write}\label{wxfilewrites}
-\func{bool}{Write}{\param{const wxString\& }{s}, \param{wxMBConv\&}{ conv = wxConvLibc}}
+\func{bool}{Write}{\param{const wxString\& }{s}, \param{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.
-The second argument is only meaningful in Unicode build of wxWindows when
+The second argument is only meaningful in Unicode build of wxWidgets when
{\it conv} is used to convert {\it s} to multibyte representation.
+Note that this method only works with {\tt NUL}-terminated strings, if you want
+to write data with embedded {\tt NUL}s to the file you should use the other
+\helpref{Write() overload}{wxfilewrite}.
+
projects / wxWidgets.git / blobdiff