libcURL.cURLClient.Get - charonn0/RB-libcURL GitHub Wiki
libcURL.cURLClient.Get
Method Signatures
Function Get(URL As String, WriteTo As Writeable = Nil) As Boolean
Function Get(URL As libcURL.URLParser, WriteTo As Writeable = Nil) As Boolean
Sub Get(URL As String, WriteTo As Writeable = Nil)
Sub Get(URL As libcURL.URLParser, WriteTo As Writeable = Nil)
Parameters
| Name | Type | Comment |
|---|---|---|
| URL | String or URLParser |
The RFC 3986 URI to get. In libcurl 7.62.0 and newer, you may also pass an instance of URLParser. |
| WriteTo | Writeable |
Optional. Downloaded data (if any) will be written to this object. If this parameter is Nil then use GetDownloadedData. |
Return value
The synchronous version of this method returns True on success. Check cURLClient.LastError if this method returns False.
Remarks
Performs a download using protocol-appropriate semantics (http GET, ftp RETR, etc.)
The protocol is inferred by libcURL; explicitly specify the protocol in the URL to avoid bad guesses.
You may optionally pass a Writeable object to receive downloaded data. If no object is passed then downloaded data can be retrieved with GetDownloadedData.
If the URL parameter is empty ("") then the previous URL is reused; if there is no previous URL then the transfer will fail with error code CURLE_URL_MALFORMAT(3). If the previous transfer involved any sort of redirection then the "previous URL" is the URL enclosed in the final redirect.