corrected SeekEnd() docs
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@36206 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
parent
9941146580
commit
69d313011b
@ -86,6 +86,7 @@ mode constants used with \helpref{Seek()}{wxfileseek}:
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxFile::wxFile}\label{wxfilector}
|
||||
|
||||
\func{}{wxFile}{\void}
|
||||
@ -111,6 +112,7 @@ Associates the file with the given file descriptor, which has already been opene
|
||||
|
||||
\docparam{fd}{An existing file descriptor (see \helpref{Attach()}{wxfileattach} for the list of predefined descriptors)}
|
||||
|
||||
|
||||
\membersection{wxFile::\destruct{wxFile}}\label{wxfiledtor}
|
||||
|
||||
\func{}{\destruct{wxFile}}{\void}
|
||||
@ -119,6 +121,7 @@ Destructor will close the file.
|
||||
|
||||
{\bf NB:} it is not virtual so you should not use wxFile polymorphically.
|
||||
|
||||
|
||||
\membersection{wxFile::Access}\label{wxfileaccess}
|
||||
|
||||
\func{static bool}{Access}{\param{const char *}{ name}, \param{OpenMode}{ mode}}
|
||||
@ -126,6 +129,7 @@ Destructor will close the file.
|
||||
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.
|
||||
|
||||
|
||||
\membersection{wxFile::Attach}\label{wxfileattach}
|
||||
|
||||
\func{void}{Attach}{\param{int}{ fd}}
|
||||
@ -137,12 +141,14 @@ have symbolic names of {\bf wxFile::fd\_stdin}, {\bf wxFile::fd\_stdout} and {\b
|
||||
The descriptor should be already opened and it will be closed by wxFile
|
||||
object.
|
||||
|
||||
|
||||
\membersection{wxFile::Close}\label{wxfileclose}
|
||||
|
||||
\func{void}{Close}{\void}
|
||||
|
||||
Closes the file.
|
||||
|
||||
|
||||
\membersection{wxFile::Create}\label{wxfilecreate}
|
||||
|
||||
\func{bool}{Create}{\param{const char*}{ filename}, \param{bool}{ overwrite = false}, \param{int }{access = wxS\_DEFAULT}}
|
||||
@ -150,6 +156,7 @@ Closes the file.
|
||||
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}
|
||||
@ -157,12 +164,14 @@ will ensure it is overwritten.
|
||||
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().
|
||||
|
||||
|
||||
\membersection{wxFile::fd}\label{wxfilefd}
|
||||
|
||||
\constfunc{int}{fd}{\void}
|
||||
|
||||
Returns the file descriptor associated with the file.
|
||||
|
||||
|
||||
\membersection{wxFile::Eof}\label{wxfileeof}
|
||||
|
||||
\constfunc{bool}{Eof}{\void}
|
||||
@ -183,6 +192,7 @@ file into memory, you should write a loop which uses
|
||||
\helpref{Read}{wxfileread} repeatedly and tests its return condition instead
|
||||
of using Eof() as this will not work for special files under Unix.
|
||||
|
||||
|
||||
\membersection{wxFile::Exists}\label{wxfileexists}
|
||||
|
||||
\func{static bool}{Exists}{\param{const char*}{ filename}}
|
||||
@ -190,6 +200,7 @@ of using Eof() as this will not work for special files under Unix.
|
||||
Returns true if the given name specifies an existing regular file (not a
|
||||
directory or a link)
|
||||
|
||||
|
||||
\membersection{wxFile::Flush}\label{wxfileflush}
|
||||
|
||||
\func{bool}{Flush}{\void}
|
||||
@ -200,6 +211,7 @@ Note that wxFile::Flush is not implemented on some Windows compilers
|
||||
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}
|
||||
@ -217,18 +229,21 @@ enum wxFileKind
|
||||
|
||||
\end{verbatim}
|
||||
|
||||
|
||||
\membersection{wxFile::IsOpened}\label{wxfileisopened}
|
||||
|
||||
\constfunc{bool}{IsOpened}{\void}
|
||||
|
||||
Returns true if the file has been opened.
|
||||
|
||||
|
||||
\membersection{wxFile::Length}\label{wxfilelength}
|
||||
|
||||
\constfunc{wxFileOffset}{Length}{\void}
|
||||
|
||||
Returns the length of the file.
|
||||
|
||||
|
||||
\membersection{wxFile::Open}\label{wxfileopen}
|
||||
|
||||
\func{bool}{Open}{\param{const char*}{ filename}, \param{wxFile::OpenMode}{ mode = wxFile::read}}
|
||||
@ -241,6 +256,7 @@ Opens the file, returning true if successful.
|
||||
|
||||
\docparam{mode}{The mode in which to open the file. May be one of {\bf wxFile::read}, {\bf wxFile::write} and {\bf wxFile::read\_write}.}
|
||||
|
||||
|
||||
\membersection{wxFile::Read}\label{wxfileread}
|
||||
|
||||
\func{size\_t}{Read}{\param{void*}{ buffer}, \param{size\_t}{ count}}
|
||||
@ -257,6 +273,7 @@ Reads the specified number of bytes into a buffer, returning the actual number r
|
||||
|
||||
The number of bytes read, or the symbol {\bf wxInvalidOffset} (-1) if there was an error.
|
||||
|
||||
|
||||
\membersection{wxFile::Seek}\label{wxfileseek}
|
||||
|
||||
\func{wxFileOffset}{Seek}{\param{wxFileOffset }{ofs}, \param{wxSeekMode }{mode = wxFromStart}}
|
||||
@ -273,11 +290,14 @@ Seeks to the specified position.
|
||||
|
||||
The actual offset position achieved, or wxInvalidOffset on failure.
|
||||
|
||||
|
||||
\membersection{wxFile::SeekEnd}\label{wxfileseekend}
|
||||
|
||||
\func{wxFileOffset}{SeekEnd}{\param{wxFileOffset }{ofs = 0}}
|
||||
|
||||
Moves the file pointer to the specified number of bytes before the end of the file.
|
||||
Moves the file pointer to the specified number of bytes relative to the end of
|
||||
the file. For example, \texttt{SeekEnd($-5$)} would position the pointer $5$
|
||||
bytes before the end.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
@ -287,6 +307,7 @@ Moves the file pointer to the specified number of bytes before the end of the fi
|
||||
|
||||
The actual offset position achieved, or wxInvalidOffset on failure.
|
||||
|
||||
|
||||
\membersection{wxFile::Tell}\label{wxfiletell}
|
||||
|
||||
\constfunc{wxFileOffset}{Tell}{\void}
|
||||
@ -294,6 +315,7 @@ The actual offset position achieved, or wxInvalidOffset on failure.
|
||||
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{wxFileOffset}{ count}}
|
||||
@ -310,6 +332,7 @@ Writes the specified number of bytes from a buffer.
|
||||
|
||||
the number of bytes actually written
|
||||
|
||||
|
||||
\membersection{wxFile::Write}\label{wxfilewrites}
|
||||
|
||||
\func{bool}{Write}{\param{const wxString\& }{s}, \param{wxMBConv\&}{ conv = wxConvUTF8}}
|
||||
|
Loading…
Reference in New Issue
Block a user