replaced wxStream::GetSize() with GetLength() (still keep the former but it will be deprecated) (second part of patch 1063498)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@30428 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -27,27 +27,31 @@ None
|
||||
% ctor & dtor
|
||||
% -----------
|
||||
|
||||
|
||||
\membersection{wxStreamBase::wxStreamBase}\label{wxstreambasector}
|
||||
|
||||
\func{}{wxStreamBase}{\void}
|
||||
|
||||
Creates a dummy stream object. It doesn't do anything.
|
||||
|
||||
|
||||
\membersection{wxStreamBase::\destruct{wxStreamBase}}\label{wxstreambasedtor}
|
||||
|
||||
\func{}{\destruct{wxStreamBase}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxStreamBase::IsOk}\label{wxstreambaseisok}
|
||||
|
||||
\constfunc{wxStreamError}{IsOk}{\void}
|
||||
\membersection{wxStreamBase::GetLength}\label{wxstreambasegetlength}
|
||||
|
||||
Returns true if no error occurred on the stream.
|
||||
\constfunc{wxFileOffset}{GetLength}{\void}
|
||||
|
||||
\wxheading{See also}
|
||||
Returns the length of the stream in bytes. If the length cannot be determined
|
||||
(this is always the case for socket streams for example), returns
|
||||
\texttt{wxInvalidOffset}.
|
||||
|
||||
\newsince{2.5.4}
|
||||
|
||||
\helpref{GetLastError}{wxstreambasegetlasterror}
|
||||
|
||||
\membersection{wxStreamBase::GetLastError}\label{wxstreambasegetlasterror}
|
||||
|
||||
@@ -63,6 +67,33 @@ This function returns the last error.
|
||||
\twocolitem{{\bf wxSTREAM\_READ\_ERROR}}{A generic error occurred on the last read call.}
|
||||
\end{twocollist}
|
||||
|
||||
|
||||
\membersection{wxStreamBase::GetSize}\label{wxstreambasegetsize}
|
||||
|
||||
\constfunc{size\_t}{GetSize}{\void}
|
||||
|
||||
\deprecated{\helpref{GetLength}{wxstreambasegetlength}}
|
||||
|
||||
This function returns the size of the stream. For example, for a file it is the
|
||||
size of the file.
|
||||
|
||||
\wxheading{Warning}
|
||||
|
||||
There are streams which do not have size by definition, such as socket streams.
|
||||
In that cases, GetSize returns $0$ so you should always test its return value.
|
||||
|
||||
|
||||
\membersection{wxStreamBase::IsOk}\label{wxstreambaseisok}
|
||||
|
||||
\constfunc{wxStreamError}{IsOk}{\void}
|
||||
|
||||
Returns true if no error occurred on the stream.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{GetLastError}{wxstreambasegetlasterror}
|
||||
|
||||
|
||||
\membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread}
|
||||
|
||||
\func{size\_t}{OnSysRead}{\param{void*}{ buffer}, \param{size\_t}{ bufsize}}
|
||||
@@ -70,6 +101,7 @@ This function returns the last error.
|
||||
Internal function. It is called when the stream wants to read data of the
|
||||
specified size. It should return the size that was actually read.
|
||||
|
||||
|
||||
\membersection{wxStreamBase::OnSysSeek}\label{wxstreambaseonsysseek}
|
||||
|
||||
\func{off\_t}{OnSysSeek}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}}
|
||||
@@ -77,6 +109,7 @@ specified size. It should return the size that was actually read.
|
||||
Internal function. It is called when the stream needs to change the
|
||||
current position.
|
||||
|
||||
|
||||
\membersection{wxStreamBase::OnSysTell}\label{wxstreambaseonsystell}
|
||||
|
||||
\constfunc{off\_t}{OnSysTell}{\void}
|
||||
@@ -84,21 +117,11 @@ current position.
|
||||
Internal function. Is is called when the stream needs to know the
|
||||
real position.
|
||||
|
||||
|
||||
\membersection{wxStreamBase::OnSysWrite}\label{wxstreambaseonsyswrite}
|
||||
|
||||
\func{size\_t}{OnSysWrite}{\param{void *}{buffer}, \param{size\_t}{ bufsize}}
|
||||
|
||||
See \helpref{OnSysRead}{wxstreambaseonsysread}.
|
||||
|
||||
\membersection{wxStreamBase::GetSize}\label{wxstreambasegetsize}
|
||||
|
||||
\constfunc{size\_t}{GetSize}{\void}
|
||||
|
||||
This function returns the size of the stream. For example, for a file it is the size of
|
||||
the file.
|
||||
|
||||
\wxheading{Warning}
|
||||
|
||||
There are streams which do not have size by definition, such as socket streams.
|
||||
In that cases, GetSize returns $0$ so you should always test its return value.
|
||||
|
||||
|
Reference in New Issue
Block a user