MACROMEDIA DREAMWEAVER 8-DREAMWEAVER API, Reference

Page: 405 / 628

Live data functions 405
dreamweaver.liveDataTranslate()
Availability
Dreamweaver UltraDev 1.
Description
Sends an entire HTML document to an application server, asks the server to execute the
scripts in the document, and returns the resulting HTML document. This function can be
called only from a translator’s
liveDataTranslateMarkup()
function; if you try to call it at
another time, an error occurs. The
dreamweaver.liveDataTranslate()
function performs
the following operations:
■
Makes the animated image (that appears near the right edge of the Live Data window)
play.
■
Listens for user input. If the Stop icon is clicked, the function returns immediately.
■
Accepts a single string argument from the caller. (This string is typically the entire source
code of the user’s document. It is the same string that is used in the next operation.)
■
Saves the HTML string from the user’s document as a temporary file on the live data
server.
■
Sends an HTTP request to the live-data server, using the parameters specified in the Live
Data Settings dialog box.
■
Receives the HTML response from the live data server.
■
Removes the temporary file from the live data server.
■
Makes the animated image stop playing.
■
Returns the HTML response to the caller.
Arguments
■
A single string, which typically is the entire source code of the user’s current document.
Returns
An
httpReply
object. This object is the same as the value that the
MMHttp.getText()
function returns. If the user clicks the Stop icon, the return value’s
httpReply.statusCode
is
equal to 200 (Status OK) and its
httpReply.data
is equal to the empty string. For more
information on the
httpReply
object, see Chapter 2, “The HTTP API,” on page 29 .
000_DW_API_Print.book Page 405 Wednesday, July 20, 2005 11:58 AM