ghttpGet

GameSpy SDK

ghttpGet

Make a HTTP GET request and save the response to memory.

GHTTPRequest ghttpGet(
const gsi_char * URL,
GHTTPBool blocking,
ghttpCompletedCallback completedCallback,
void * param );
RoutineRequired HeaderDistribution
ghttpGet<ghttp.h>SDKZIP

Return Value

If less than 0, the request failed and this is a GHTTPRequestError value. Otherwise it identifies the request.

Parameters

URL
[in] URL
blocking
[in] If true, this call doesn't return until the file has been received.
completedCallback
[in] Called when the file has been received.
param
[in] Optional free-format user data for use by the callback

Remarks

This function is used to download the contents of a web page to memory. The application can provide the memory by supplying a buffer to this function, or the SDK can be allocate the memory internally.
Use ghttpGetEx for extra optionional parameters.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
ghttpGetghttpGetAghttpGetW

ghttpGetW and ghttpGetA are UNICODE and ANSI mapped versions of ghttpGet. The arguments of ghttpGetA are ANSI strings; those of ghttpGetW are wide-character strings.