MACROMEDIA COLDFUSION MX 61-CFML, Reference

Page: 803 / 806

CF.http 803
Usage
You can write the
CF.http
function using named arguments or positional arguments. You can
invoke all supported arguments using the named argument style, as follows:
CF.http({method:"method", url:"URL", username:"username", password:"password",
resolveurl:"yes or no", params:arrayvar,
path:"path", file:"filename"});
Note: The named argument style uses curly braces {} to surround the function arguments.
Positional arguments let you use a shorthand coding style. However, not all arguments are
supported for the positional argument style. Use the following syntax to code the
CF.http
function using positional arguments:
CF.http(url);
CF.http(method, url);
CF.http(method, url, username, password);
CF.http(method, url, params, username, password);
Note: Do not use curly braces {} with positional arguments.
The following parameters can only be passed as an array of objects in the
params
argument in the
CF.http
function:
The CF.http function returns data as a set of object properties, as described in the following table:
path Optional The path to the directory in which to store files. When using the
path
argument, the
file
argument is required.
file Optional Name of the file that is accessed. For GET operations, defaults to the
name specified in the
url
argument. Enter path information in the
path
argument. This argument is required if using the
path
argument.
Parameter Description
name The variable name for data that is passed
type The transaction type:
•
URL
•
FormField
•
Cookie
•
CGI
•
File
value Value of URL, FormField, Cookie, File, or CGI variables that are passed
Property Description
Text A Boolean value that indicates whether the specified URL location contains text
data.
Charset The charset used by the document specified in the URL.
HTTP servers normally provide this information, or the charset is specified in the
charset parameter of the Content-Type header field of the HTTP protocol. For
example, the following HTTP header announces that the character encoding is
EUC-JP:
Content-Type: text/html; charset=EUC-JP
Arguments Req/Opt Description