DWC_GetGHTTPDataEx

Syntax

#include <dwc.h>

int DWC_GetGHTTPDataEx(
            const char* url,
            int bufferlen,
            BOOL buffer_clear,
            DWCGHTTPProgressCallback progressCallback,
            DWCGHTTPCompletedCallback completedCallback,
            void* param );

Description

Downloads data from the URL specified with url.

When post has been specified as NULL, this function behaves identically to DWC_GetGHTTPDataEx2.

If the DWC_ProcessGHTTP function is called repeatedly after calling this function, the communication process will proceed and the completion callback will be called when the process completes.

To find the communication status during processing, call the DWC_GetGHTTPState function using the request identifier of the return value.

Arguments

url The URL from which to download. NULL-terminated string.
bufferlen Size of the reception buffer.
buffer_clear Indicates whether to deallocate the reception buffer after data is received.
(TRUE: deallocate; FALSE: do not deallocate.)
progressCallback The pointer to the callback function called during communication.
completedCallback Pointer to the callback function called when the download is complete.
param Callback parameter.

Return Values

0 or higher Request identifier.
DWC_GHTTP_IN_ERROR An error is being generated.
DWC_GHTTP_FAILED_TO_OPEN_FILE File open failed.
DWC_GHTTP_INVALID_POST Invalid transmission.
DWC_GHTTP_INSUFFICIENT_MEMORY Insufficient memory.
DWC_GHTTP_INVALID_FILE_NAME Invalid file name.
DWC_GHTTP_INVALID_BUFFER_SIZE Invalid buffer size.
DWC_GHTTP_INVALID_URL Invalid URL.
DWC_GHTTP_UNSPECIFIED_ERROR Unspecified error.

See Also

DWC_GetGHTTPDataEx2
DWC_ProcessGHTTP
DWCGHTTPProgressCallback
DWCGHTTPCompletedCallback
DWC_GetGHTTPState

Revision History

2007/10/15 To the description of the url argument, added text about the NULL terminator.
2006/12/27 Made revisions to reflect the addition of the DWC_GetGHTTPDataEx2 function.
2006/01/18 Added DWC_GHTTP_IN_ERROR to the return values.
2005/10/27 Initial version.


CONFIDENTIAL