Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve documentation of wxWebRequest storage methods

Browse Source 
Indicate which methods should be used with each storage type to process
the data later.
This commit is contained in:
Vadim Zeitlin
2021-01-12 03:07:11 +01:00
parent 591d02c979
commit 67ad831a31
1 changed files with 17 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
interface/wx/webrequest.h
View File

@@ -152,15 +152,29 @@ public:
*/ */
enum Storage enum Storage
{ {
/// All data is collected in memory until the request is complete /**
All data is collected in memory until the request is complete.
It can be later retrieved using wxWebResponse::AsString() or
wxWebResponse::GetStream().
*/
Storage_Memory, Storage_Memory,
/// The data is written to a file on disk /**
The data is written to a file on disk as it is received.
This file can be later read from using wxWebResponse::GetStream()
or otherwise processed using wxWebRequestEvent::GetResponseFileName().
*/
Storage_File, Storage_File,
/** /**
The data is not stored by the request and is only available The data is not stored by the request and is only available
via events. via events.
Data can be retrieved using wxWebRequestEvent::GetDataBuffer() and
wxWebRequestEvent::GetDataSize() methods from wxEVT_WEBREQUEST_DATA
handler.
*/ */
Storage_None Storage_None
}; };
@@ -694,7 +708,7 @@ public:
/** /**
Returns the full path of a temporary file containing the response data Returns the full path of a temporary file containing the response data
when the state is @c State_Completed and storage is @Storage_File. when the state is @c State_Completed and storage is @c Storage_File.
The file will be removed after the event handlers are called. You can The file will be removed after the event handlers are called. You can
move the file to a location of your choice if you want to process the move the file to a location of your choice if you want to process the