Show TOC

Function documentationImage Loader

 

This action is used to load an image from a URL or from a file reference. Some URL requests require authentication, so there are optional properties that pass user name and password credentials to a request.

The EncodedImage property stores the image as a string and allows interaction with the Image Saver and Send Mail actions.

Features

The properties for this action are listed in the following table:

Property

Data Type

Access

Use

SourceURL

String

In and out

Controls the URL that is used to load the image. It can be a Web URL such as http://www.server.com/MyPhoto.gif or a file-based URL such as C:\Reports\MyImage.gif. We recommend that you use Web-based requests, which increases application portability and simplifies administration. Use forward slashes (/) in Web URLs. A backslash (\) represents an escape character.

EncodedImage

PNG or JPEG

Out

Contains the content of the loaded image. If the load attempt is unsuccessful, this property remains empty. You can use this property to link the output of this action to another action. For example, you can map the EncodedImage property to the AttachmentContent property of the Send Mail action to email the image.

The following properties also apply to this action.

  • Timeout

  • LoginName

  • LoginPassword

  • Success

For more information, see HTML Loader.