Dreamweaver API リファレンス

Dreamweaver3の頃は、日本語訳がなく、英語版のみ提供されていたので、勝手に翻訳して公開しています。現在のDreamweaverでは日本語訳が付いているので、今となっては役に立たないコンテンツです。ただ、共通ライブラリについては元からヘルプがないので、その部分は役に立つと思います。/Commonと/Classは/Configurations/Shared/MM/Scriptsフォルダ内にあるフォルダです。

  clearTemp ()
説明

Dreamweaver をインストールしたフォルダ内にある Configuration/Temp フォルダに入っているすべてのファイルを削除します。

引数

なし。

戻り値

なし。

ダイアログを表示して、「OK」ボタンを押すと、TMP フォルダ内のファイルを削除します。
if( confirm( "削除しますか?" ) )
MMHttp.clearTemp();


  getFile ()
説明

サーバー上にあるファイルをダウンロードし、ローカルのハードディスクに保存します。

引数

URL, prompt, saveURL, titleBarLabel
URL
ダウンロードするサーバー上のファイルを URL 形式で指定します。URL の http:// の部分は省略することが出来ます。
prompt
ダウンロードしたファイルの保存先を指定する保存ダイアログを表示するかどうか設定します。ダイアログを表示するには true、表示しない場合は false を指定します。引数 saveURL が、Dreamweaver をインストールしたフォルダ内にある Configuration/Temp 以外のフォルダを指定している場合は、必ずダイアログが表示されるので、この引数は無効になります。この引数を指定しない場合は、ダイアログは表示されません。

saveURL
ダウンロードしたファイルの保存先を URL 形式で指定します。このフォルダが、Configuration/Temp 以外のフォルダの場合は、ファイルの保存ダイアログが表示されます。この引数を指定しない場合は、ファイルは Configuration/Temp に保存されます。
titleBarLabel
ファイルの保存ダイアログに表示するラベルを指定します。 この引数を指定しない場合は、OS の初期設定のラベルが表示されます。

戻り値

ファイルの保存先とサーバーからのステータスコードを格納したオブジェクトを返します。ダウンロードに失敗した場合は、サーバーからのステータスコードに以下のエラーコードのいずれかが設定されます。
1: 未指定のエラーです。
2: ファイルが見つかりません。
3: 無効なパスです。
4: 開けるファイル数の限界に達しました。
5: アクセスが拒否されました。
6: 無効なファイルハンドルです。
7: 現在の作業ディレクトリを削除できません。
8: この他にディレクトリのエントリはありません。
9: ファイルポインタの設定エラーです。
10: ハードウェアエラーです。
11: 共有違反です。
12: ロック違反です。
13: ディスク領域がいっぱいです
14: ファイルの最後に達しました。

サーバーからファイルをダウンロードし、保存先とサーバーからのステータスコードを表示します。
var result = MMHttp.getFile( "http://www.yahoo.co.jp/" );
if( result.statusCode < 15 )
alert( "ファイルのダウンロードに失敗しました - " + result.statusCode );
else
{
alert( "サーバーからのステータスコード" + result.statusCode );
alert( "ファイルの保存先" + result.data );
}


  getFileCallback ()
説明

サーバー上にあるファイルをダウンロードし、ローカルのハードディスクに保存します。getFile() 関数と機能が似ていますが、getFile() 関数はダウンロードが完了するまで処理をブロックしますが、この関数を使えば、処理がブロックされるのを防ぐことが出来ます。getFileCallback() 関数は、ファイルのダウンロードを開始するだけで、ダウンロードの確認は別に定義した関数が処理を行い、ダウンロードの処理は非同期に行われます。

引数

callbackFunction, URL, {prompt}, {saveURL}, {titleBarLabel}
callbackFunction
ファイルのダウンロードが完了したときに呼び出す関数名を文字列で指定します。
URL
ダウンロードするサーバー上のファイルを URL 形式で指定します。URL の http:// の部分は省略することが出来ます。
prompt
ダウンロードしたファイルの保存先を指定する保存ダイアログを表示するかどうか設定します。ダイアログを表示するには true、表示しない場合は false を指定します。引数 saveURL が、Configuration/Temp 以外のフォルダを指定している場合は、必ずダイアログが表示されるので、この引数は無効になります。この引数を指定しない場合は、ダイアログは表示されません。

saveURL
ダウンロードしたファイルの保存先を URL 形式で指定します。このフォルダが、Configuration/Temp 以外のフォルダの場合は、ファイルの保存ダイアログが表示されます。この引数を指定しない場合は、ファイルは Configuration/Temp に保存されます。
titleBarLabel
ファイルの保存ダイアログに表示するラベルを指定します。 この引数を指定しない場合は、OS の初期設定のラベルが表示されます。

戻り値

識別 ID を返します。このID を使って、ダウンロード終了後の内容を識別します。

getFileCallback() 関数でファイルのダウンロードを開始し、getFiles() 関数でダウンロード後の結果を表示します。getFiles() 関数には、識別 ID と処理結果が引数として渡されます。処理結果は、getFile() 関数の戻り値と同じように、ファイルの保存先とサーバーからのステータスコードを格納したオブジェクトが返されます。
var id;
function GoCommand()
{
id = MMHttp.getFileCallback( "getFiles", "http://www.yahoo.co.jp/" );
}
function getFiles( requestID, result )
{
if( requestID == id )
{
if( result.statusCode < 15 )
alert( "ファイルのダウンロードに失敗しました - " + result.statusCode );
else
{
alert( "サーバーからのステータスコード" + result.statusCode );
alert( "ファイルの保存先" + result.data );
}
}
}


  getText ()
説明

サーバー上にあるファイルをダウンロードし、ファイルの内容を取得します。

引数

URL
ダウンロードするサーバー上のファイルを URL 形式で指定します。URL の http:// の部分は省略することが出来ます。

戻り値

ダウンロードしたファイルの内容とサーバーからのステータスコードを格納したオブジェクトを返します。ダウンロードに失敗した場合は、サーバーからのステータスコードにエラーコードが設定されます。エラーコードについては、getFile() 関数を参照して下さい。

サーバーからファイルをダウンロードし、ダウンロードした内容を新規ドキュメントに設定します。
var result = MMHttp.getText( "http://www.yahoo.co.jp/" );
if( result.statusCode < 15 )
alert( "ファイルのダウンロードに失敗しました - " + result.statusCode );
else
{
var theDOM = dw.createDocument();
theDOM.documentElement.outerHTML = result.data;
}


  getTextCallback ()
説明

サーバー上にあるファイルをダウンロードし、ファイルの内容を取得します。getText() 関数と機能が似ていますが、getText() 関数はダウンロードが完了するまで処理をブロックしますが、この関数を使えば、処理がブロックされるのを防ぐことが出来ます。getTextCallback() 関数は、ファイルのダウンロードを開始するだけで、ダウンロードの確認は別に定義した関数が処理を行い、ダウンロードの処理は非同期に行われます。

引数

callbackFunction, URL
callbackFunction
ファイルのダウンロードが完了したときに呼び出す関数名を文字列で指定します。
URL
ダウンロードするサーバー上のファイルを URL 形式で指定します。URL の http:// の部分は省略することが出来ます。

戻り値

識別 ID を返します。このID を使って、ダウンロード終了後の内容を識別します。

getTextCallback() 関数でファイルのダウンロードを開始し、getTextData() 関数でダウンロードした内容を表示します。getTextData() 関数には、識別 ID と処理結果が引数として渡されます。処理結果は、getText() 関数の戻り値と同じように、ファイルの内容とサーバーからのステータスコードを格納したオブジェクトが返されます。
var id;
function GoCommand()
{
id = MMHttp.getFileCallback( "getTextData", "http://www.yahoo.co.jp/" );
}
function getTextData( requestID, result )
{
if( requestID == id )
{
if( result.statusCode < 15 )
alert( "ファイルのダウンロードに失敗しました - " + result.statusCode );
else
{
alert( result.data );
}
}
}


  postText ()
説明

サーバー上のファイルにデータをポストし、結果を取得します。ポストするデータは、フォームエンコードされている必要がありますが、サーバー側で受信可能であれば、どのようなデータでもポストすることが出来ます。

引数

URL, dataToPost, contentType
URL
データをポストするサーバー上のファイルを URL 形式で指定します。URL の http:// の部分は省略することが出来ます。
dataToPost
ポストするデータを指定します。ポストするデータは、引数 contentType の内容によっては、フォームエンコードする必要があります。
contentType
ポストするデータのタイプを指定します。この引数を指定しない場合は、"application/x-www-form-urlencoded" に初期設定されます。

戻り値

ポストした結果とサーバーからのステータスコードを格納したオブジェクトを返します。データのポストに失敗した場合は、サーバーからのステータスコードにエラーコードが設定されます。エラーコードについては、getFile() 関数を参照して下さい。

サーバーにある CGI に対してデータをポストし、結果を新規ドキュメントに設定します。
var name = "ともひろ";
var message = "こんにちは";
var postdata = "name=" + escape( name ) + "&msg=" + escape( message );
var result = MMHttp.postText( "http://www.game3rd.com/dreamweaver/chat/chat.cgi", postdata );
if( result.statusCode < 15 )
alert( "データのポストに失敗しました - " + result.statusCode );
else
{
var theDOM = dw.createDocument();
theDOM.documentElement.outerHTML = result.data;
}


  postTextCallback ()
説明

サーバー上のファイルにデータをポストし、結果を取得します。ポストするデータは、フォームエンコードされている必要がありますが、サーバー側で受信可能であれば、どのようなデータでもポストすることが出来ます。postText() 関数と機能が似ていますが、postText() 関数は結果を受け取るまで処理をブロックしますが、この関数を使えば、処理がブロックされるのを防ぐことが出来ます。postTextCallback() 関数は、サーバーに対してデータをポストし、結果を取得した後の処理は別に定義した関数が処理を行い、結果の取得は非同期に行われます。

引数

callbackFunction, URL, dataToPost, {contentType}
callbackFunction
ポスとした結果を取得したときに、呼び出す関数名を文字列で指定します。
URL
データをポストするサーバー上のファイルを URL 形式で指定します。URL の http:// の部分は省略することが出来ます。
dataToPost
ポストするデータを指定します。ポストするデータは、引数 contentType の内容によっては、フォームエンコードする必要があります。
contentType
ポストするデータのタイプを指定します。この引数を指定しない場合は、"application/x-www-form-urlencoded" に初期設定されます。

戻り値

識別 ID を返します。このID を使って、ポスとした結果の内容を識別します。

postTextCallback() 関数でデータをポストし、postTextData() 関数でポストした結果を表示します。postTextData() 関数には、識別 ID と処理結果が引数として渡されます。処理結果は、postText() 関数の戻り値と同じように、ポストした結果とサーバーからのステータスコードを格納したオブジェクトが返されます。
var id;
function GoCommand()
{
var name = "ともひろ";
var message = "こんにちは";
var postdata = "name=" + escape( name ) + "&msg=" + escape( message );
id = MMHttp.postTextCallback( postTextData, "http://www.game3rd.com/dreamweaver/chat/chat.cgi", postdata );
}
function postTextData( requestID, result )
{
if( requestID == id )
{
if( result.statusCode < 15 )
alert( "データのポストに失敗しました - " + result.statusCode );
else
{
alert( result.data );
}
}
}



TOP > Dreamweaver徹底活用 >