GetURLImageEx

Purpose

New in version 2.1.103.0 or later.

This function returns a web page image file and saves it in the file specified.  This is useful for retrieving pages like weather satellite maps, and then displaying the maps in a HomeSeer device.

Parameters

Parameter: host
Type: string
Description: This is the name or IP address of host to connect to, such as "HomeSeer.com".

Parameter: page
Type: string
Description: This is the image to retrieve from the server, such as "/logo.gif".  It should be fully qualified as referenced from the host parameter above, such as "\images\something\other\logo.gif" if necessary.

Parameter: filename
Type: string
Description: This is the file that you would like the downloaded image to be stored in.  If the filename is not fully qualified, then the HomeSeer path will be prepended to the string provided.

Optional Parameter: port (Default=80)
Type: integer
Description: This is the port number on the server to connect with (80 = standard web server).

Returns

Return value: result
Type: string
Description: This is the result of the operation - if empty, the operation was successful.  If the return value is not empty, then it will be an error message.