Lasso Soft Inc. > Home

[Include_URL]

[Include_URL] includes a Web page from a remote server and displays it in the current format file.

The URL parameter is required. It should be a valid URL and may contain GET parameters. The remote page will be fetched and the response will be returned as the result of the tag.

All other parameters are optional and change the information that is sent to and received from the remote server.

-NoData sends the URL to the remote server, but ignores the reply. The tag returns nothing.

-Username and -Password allow authentication information to be sent along with the URL. The authentication information will be sent to the remote server just as if they had been typed into the authentication dialog of a Web browser.

-GETParams and -POSTParams allow an array of name/value pairs to be passed along with the URL to the remote server. GET parameters are appended to the end of the URL itself. POST parameters are submitted as if they were form elements.

-ExtraMIMEHeaders allows an array of extra HTTP request headers to be passed along with the URL to the remote server.

-SendMIMEHeaders allows an array of MIME headers sent back from the remote server in the HTTP response to be inspected. The -SendMIMEHeaders parameter requires the name of a variable in which the array of headers will be stored.

  • Syntax
  • Parameters
[Include_URL: 'http://www.example.com']

[Include_URL: 'http://www.example.com', -NoData]

[Include_URL: 'http://www.example.com',  
  -POSTParams=(Array: 'Name'='Value')]

[Include_URL: 'http://www.example.com',  
  -GETParams=(Array: 'Name'='Value')]

[Include_URL: 'http://www.example.com',  
  -Username='Username', 
  -Password='Password']

[Include_URL: 'http://www.example.com',  
  -SendMIMEHeaders=(Array: 'Name'='Value')]

[Include_URL: 'http://www.example.com',  
  -RetrieveMIMEHeaders='Variable Name']
Required Parameters
URL The URL which is to be included.
Optional Parameters
-POSTParams An optional array of pairs which will be passed as the POST parameters with the URL request.
-GETParams An optional array of pairs which will be passed as the GET parameters with the URL request.
-SendMIMEHeaders An optional array of pairs which will be sent as additonal MIME headers along with the URL request.
-RetrieveMIMEHeaders The optional name of a variable in which to store retrieved MIME headers.
-Username An optional username with which to authenticate the URL request.
-Password An optional password with which to authenticate the URL request.
-NoData If specified then the URL request is sent, but no results are returned.
Encoding Keyword Specifies the encoding for the tag's return value. Tags are encoded using -EncodeHTML by default if their value is output in a format file. No encoding is applied to nested tags unless an explicity encoding keyword is specified. One of -EncodeBreak, -EncodeHTML, -EncodeNone, -EncodeRaw, -EncodeSmart, -EncodeStrictURL, -EncodeURL, -EncodeXML.
Examples

To create a proxy for Web requests:

Pass an [Action_Param] to the [Include_URL] tag and return the results of that tag in place of the current format file. The following example simply returns the URL specified in a URL parameter to the format file.

[Include_URL: (Action_Param: 'URL')]
Tag Link [Include_URL] Category Include
Type Substitution Data Source Any
Support Preferred Version 3.0
Output Type String Security Tag
Implementation Sets Lasso 5.0,LDML3x

Please note that periodically LassoSoft will go through the notes and may incorporate information from them into the documentation. Any submission here gives LassoSoft a non-exclusive license and will be made available in various formats to the Lasso community.

LassoSoft Inc. > Home

 

 

©LassoSoft Inc 2015 | Web Development by Treefrog Inc | PrivacyLegal terms and Shipping | Contact LassoSoft