Mmhttp.getfile() – Adobe Dreamweaver API Reference CS5 User Manual
Page 21
16
DREAMWEAVER API REFERENCE
The HTTP API
Last updated 8/27/2013
MMHttp.getFile()
Description
This function gets the file at the specified URL and saves it in the Configuration/Temp folder, which is located in the
Dreamweaver application folder. Dreamweaver automatically creates subfolders that mimic the folder structure of the
server; for example, if the specified file is at www.dreamcentral.com/people/index.html, Dreamweaver stores the
index.html file in the People folder inside the www.dreamcentral.com folder.
Arguments
URL, {prompt}, {saveURL}, {titleBarLabel}
•
The URL argument is an absolute URL on a web server; if http:// is omitted from the URL, Dreamweaver assumes
HTTP protocol.
•
The prompt argument, which is optional, is a Boolean value that specifies whether to prompt the user to save the
file. If saveURL is outside the Configuration/Temp folder, a prompt value of
false
is ignored for security reasons.
•
The saveURL argument, which is optional, is the location on the user’s hard disk where the file should be saved,
which is expressed as a file:// URL. If prompt is a
true
value or saveURL is outside the Configuration/Temp folder,
the user can override saveURL in the Save dialog box.
•
The titleBarLabel argument, which is optional, is the label that should appear in the title bar of the Save dialog box.
Returns
An object that represents the reply from the server. The
data
property of this object is a string that contains the
location where the file is saved, which is expressed as a file:// URL. Normally, the
statusCode
property of the object
contains the status code that is received from the server. However, if a disk error occurs while Dreamweaver is saving
the file on the local drive, the
statusCode
property contains an integer that represents one of the following error codes
if the operation is not successful:
•
1: Unspecified error
•
2: File not found
•
3: Invalid path
•
4: Number of open files limit reached
•
5: Access denied
•
6: Invalid file handle
•
7: Cannot remove current working folder
•
8: No more folder entries
•
9: Error setting file pointer
•
10: Hardware error
•
11: Sharing violation