httpget
httpget |
Purpose
Synopsis
function httpget(url:string|text, result:string):integer
function httpget(url:string|text, result:string, xhdr:string|text):integer
Arguments
|
url
|
URL to process
|
|
result
|
File to store the result of the request
|
|
xhdr
|
Additional headers to add to the request
|
Return value
HTTP status of the request (
e.g. 200 for success, see Section
Constants for a list of predefined status code constants; value 999 indicates that an I/O error occurred during the operation) or the request number (≥1000) if asynchronous mode is active
Example
Retrieve the default entry page of the FICO website in French and store it in the file
"fico.html":
status:=httpget('http://www.fico.com/fr/Pages/default.aspx', 'fico.html')
Further information
1. The function returns after the request has been processed when synchronous mode is active (see
http_async). Otherwise, using asynchronous mode, the function returns immediately after having sent the request and the model is notified about the completion of the operation by an event of class
EVENT_HTTPEND. In this mode the result file
result must be a physical file (although drivers
"tmp:" and
"null:" can still be used).
2. When building a query it is important to encode data to be sent using
urlencode
3. By default the header
"Accept-Encoding: gzip" is inserted into the request and the result data is automatically decompressed if the server supports compression. This behaviour is disabled if this optional header is already specified (
e.g. the parameter
xhdr includes
"Accept-Encoding: identity").
4. When cookie management is enabled (see
http_cookies) an additional header
"Cookie:" is inserted into the request if the cookie store contains compatible cookies. This behaviour is disabled if this optional header is already specified via the parameter
xhdr.
Related topics
Module