Adobe 38040334 API Reference - Page 326

dreamweaver.setLiveDataError, API

Page 326 highlights

DREAMWEAVER CS3 321 API Reference 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 string • 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 value is equal to 200 (Status OK) and its httpReply.data value is equal to the empty string. For more information on the httpReply object, see "The HTTP API" on page 16. dreamweaver.setLiveDataError() Availability Dreamweaver UltraDev 1. Description Specifies the error message that appears if an error occurs while the liveDataTranslateMarkup() function executes in a translator. If the document that Dreamweaver passed to liveDataTranslate() contains errors, the server passes back an error message that is formatted using HTML. If the translator (the code that called liveDataTranslate()) determines that the server returned an error message, it calls setLiveDataError() to display the error message in Dreamweaver. This message appears after the liveDataTranslateMarkup() function finishes executing; Dreamweaver displays the description in an error dialog box. The setLiveDataError() function should be called only from the liveDataTranslateMarkup() function. Arguments source • The source argument is a string that contains source code, which is parsed and rendered in the error dialog box.

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250
  • 251
  • 252
  • 253
  • 254
  • 255
  • 256
  • 257
  • 258
  • 259
  • 260
  • 261
  • 262
  • 263
  • 264
  • 265
  • 266
  • 267
  • 268
  • 269
  • 270
  • 271
  • 272
  • 273
  • 274
  • 275
  • 276
  • 277
  • 278
  • 279
  • 280
  • 281
  • 282
  • 283
  • 284
  • 285
  • 286
  • 287
  • 288
  • 289
  • 290
  • 291
  • 292
  • 293
  • 294
  • 295
  • 296
  • 297
  • 298
  • 299
  • 300
  • 301
  • 302
  • 303
  • 304
  • 305
  • 306
  • 307
  • 308
  • 309
  • 310
  • 311
  • 312
  • 313
  • 314
  • 315
  • 316
  • 317
  • 318
  • 319
  • 320
  • 321
  • 322
  • 323
  • 324
  • 325
  • 326
  • 327
  • 328
  • 329
  • 330
  • 331
  • 332
  • 333
  • 334
  • 335
  • 336
  • 337
  • 338
  • 339
  • 340
  • 341
  • 342
  • 343
  • 344
  • 345
  • 346
  • 347
  • 348
  • 349
  • 350
  • 351
  • 352
  • 353
  • 354
  • 355
  • 356
  • 357
  • 358
  • 359
  • 360
  • 361
  • 362
  • 363
  • 364
  • 365
  • 366
  • 367
  • 368
  • 369
  • 370
  • 371
  • 372
  • 373
  • 374
  • 375
  • 376
  • 377
  • 378
  • 379
  • 380
  • 381
  • 382
  • 383
  • 384
  • 385
  • 386
  • 387
  • 388
  • 389
  • 390
  • 391
  • 392
  • 393
  • 394
  • 395
  • 396
  • 397
  • 398
  • 399
  • 400
  • 401
  • 402
  • 403
  • 404
  • 405
  • 406
  • 407
  • 408
  • 409
  • 410
  • 411
  • 412
  • 413
  • 414
  • 415
  • 416
  • 417
  • 418
  • 419
  • 420
  • 421
  • 422
  • 423
  • 424
  • 425
  • 426
  • 427
  • 428
  • 429
  • 430
  • 431
  • 432
  • 433
  • 434
  • 435
  • 436
  • 437
  • 438
  • 439
  • 440
  • 441
  • 442
  • 443
  • 444
  • 445
  • 446
  • 447
  • 448
  • 449
  • 450
  • 451
  • 452
  • 453
  • 454
  • 455
  • 456
  • 457
  • 458
  • 459
  • 460
  • 461
  • 462
  • 463
  • 464
  • 465
  • 466
  • 467
  • 468
  • 469
  • 470
  • 471
  • 472
  • 473
  • 474
  • 475
  • 476
  • 477
  • 478
  • 479
  • 480
  • 481
  • 482
  • 483
  • 484
  • 485
  • 486
  • 487
  • 488
  • 489
  • 490
  • 491
  • 492
  • 493
  • 494
  • 495
  • 496
  • 497

DREAMWEAVER CS3
API Reference
321
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
liveDataTrans-
lateMarkup()
function; if you try to call it at another time, an error occurs. The
dream-
weaver.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
string
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
value is equal to 200 (Status OK) and its
httpReply.data
value is equal to the empty string. For more information on the
httpReply
object, see “The HTTP
API” on page 16.
dreamweaver.setLiveDataError()
Availability
Dreamweaver UltraDev 1.
Description
Specifies the error message that appears if an error occurs while the
liveDataTranslateMarkup()
function
executes in a translator. If the document that Dreamweaver passed to
liveDataTranslate()
contains errors, the
server passes back an error message that is formatted using HTML. If the translator (the code that called
liveDataTranslate()
) determines that the server returned an error message, it calls
setLiveDataError()
to
display the error message in Dreamweaver. This message appears after the
liveDataTranslateMarkup()
function
finishes executing; Dreamweaver displays the description in an error dialog box. The
setLiveDataError()
function should be called only from the
liveDataTranslateMarkup()
function.
Arguments
source
The
source
argument is a string that contains source code, which is parsed and rendered in the error dialog box.