Skip to content

BE_HTTP_GETFile.md

Latest commit

 

History

History
50 lines (31 loc) · 2.17 KB

BE_HTTP_GETFile.md

File metadata and controls

50 lines (31 loc) · 2.17 KB
Raw

BE_HTTP_GETFile

BE_HTTP_GETFile ( url ; { path ; username ; password } )

Description

Does a http, https, ftp, ftps, or sftp GET / download and saves the result to path. This uses the same curl library as the built in Insert From URL.

Parameters

  • url : The url to retrieve.
  • path ( optional ) : The path to save the file to.
  • username ( optional ) : The username if the url requires authentication.
  • password ( optional ) : The password if the url requires authentication.

Keywords

HTTP GET Curl FTP

Version History

  • 1.2.0 : First Release
  • 3.3.0 : Renamed to BE_HTTP_GET_File from BE_SaveURLToFile

Notes

Headers can be set beforehand with BE_HTTP_SetCustomHeader. Authentication types and other options can be set beforehand with the BE_CurlSetOption function.

Not all servers respond with data when doing curl operations so use BE_GetLastError after the function call to tell if the call was able to be made, and then BE_HTTP_ResponseCode to check for the appropriate response code, and BE_HTTP_ResponseHeaders to get the response headers to diagnose any issues.

Error codes that you get from the BE_GetLastError function after this function call comes from the curl library itself and not the plugin. To find a specific error code use this documentation :

http://curl.haxx.se/libcurl/c/libcurl-errors.html

Also use the BE_CurlTrace function to see the transcript of the connection to diagnose any other issues that may have come up and can't be determined from the error value alone.

Compatibility

Platform Compatibility
Status Active
Mac FMP Yes
Win FMP Yes
FMS Yes
iOS Yes
Linux Yes

This function has been superseded by the Insert From URL script step, and may be deprecated in a future release. However the BE functions allow for a larger number of curl options, have a better response mechanism with the separate BE_HTTP_ResponseCode function, and have the advantage of not being a single script step. Whether or not to deprecate the BE functions depends on end user needs.

Example Code