invalid size is (size_t)-1, not 0xffffffff; stream returned by GetInputstream() must be destroyed while wxHTTP object is still alive; some English corrections

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@40536 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2006-08-09 21:23:56 +00:00
parent 49638afa16
commit 034ad06337

View File

@@ -29,26 +29,23 @@ Returns the HTTP response code returned by the server. Please refer to
\func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}} \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}}
Creates a new input stream on the specified path. You can use all except the seek Creates a new input stream on the specified path. Notice that this stream is
functionality of wxStream. Seek isn't available on all streams. For example, unseekable, i.e. SeekI() and TellI() methods shouldn't be used.
HTTP or FTP streams don't deal with it. Other functions like Tell and SeekI
aren't available for the moment for this sort of stream.
You will be notified when the EOF is reached by an error.
\wxheading{Note} Note that you can still know the size of the file you are getting using
\helpref{wxStreamBase::GetSize()}{wxstreambasegetsize}. However there is a
You can know the size of the file you are getting using \helpref{wxStreamBase::GetSize()}{wxstreambasegetsize}. limitation: in HTTP protocol, the size is not always specified so sometimes
But there is a limitation: as HTTP servers aren't obliged to pass the size of \texttt{(size\_t)-1} can returned ot indicate that the size is unknown. In such
the file, in some case, you will be returned 0xfffffff by GetSize(). In these case, you may want to use \helpref{wxInputStream::LastRead()}{wxinputstreamlastread}
cases, you should use the value returned by \helpref{wxInputStream::LastRead()}{wxinputstreamlastread}: method in a loop to get the total size.
this value will be 0 when the stream is finished.
\wxheading{Return value} \wxheading{Return value}
Returns the initialized stream. You will have to delete it yourself once you Returns the initialized stream. You must delete it yourself once you
don't use it anymore. The destructor closes the network connection. don't use it anymore and this must be done before the wxHTTP object itself is
The next time you will try to get a file the network connection will have destroyed. The destructor closes the network connection. The next time you will
to be reestablished: but you don't have to take care of this since wxHTTP reestablishes it automatically. try to get a file the network connection will have to be reestablished, but you
don't have to take care of this since wxHTTP reestablishes it automatically.
\wxheading{See also} \wxheading{See also}