Visual Tools Object Model の作成 戻る 1 つ上のページに戻る 次へ
Visual Tools Object Model の作成



DeploymentManager オブジェクト

説明

DeploymentManager VTOM オブジェクトは、Allaire プロジェクト公開エンジンへの記述が可能なインタフェースです。DeploymentManager VTOM オブジェクトには、公開プロセスを制御するための、独自性の高い VTOM スクリプトを記述できるメソッドおよびプロパティのコレクションが用意されています。

プロパティ

CreateFolder (Wordbool、読み書き用)

ターゲット サーバ上に存在しないフォルダを作成するように公開エンジンに指示するブール型プロパティ

EncryptCFML (Wordbool、読み書き用)

すべての CFML ファイルを暗号化するように公開エンジンに指示するブール型プロパティ

FolderCount (Integer、読み取り専用)

現在開いているプロジェクトに関連付けられているフォルダの数を返します。

ForceLowerCase (Wordbool、読み書き用)

ファイル名を強制的に小文字にするように公開エンジンに指示するブール型プロパティ

IsLocalDeployment (Wordbool、読み書き用)

指定された公開サーバ リストより優先することによって、ローカル公開を実行することができます。指定された公開サーバ リストの代わりに、フォルダに割り当てられている実際の公開パス名を直接使います。

ServerCount (Integer、読み取り専用)

現在開いているプロジェクトに関連付けられている公開サーバの数を返します。この公開サーバの数には、AddServer メソッドによって一時的に追加された新しいサーバも含まれます。

UploadOnlyIfNewer (Wordbool、読み書き用)

ターゲット ファイルより新しいタイム スタンプのファイルのみをアップロードするように公開エンジンに指示するブール型プロパティ

メソッド

メモ サーバへのログインに失敗すると、公開の自動キャンセルとなります。

AddServer

procedure AddServer(const sServerName:WideString,ITServerType:Integer)

許されている ITServerType の値は次のとおりです。

1=FTP
2=RDS

公開サーバのリストにマシン レベルのサーバを一時的に追加します。このマシン レベル サーバは、プロジェクトの保存されている公開サーバ リストの一部となることはなく、独自の公開タスクの目的のために追加される一時的なサーバでしかありません。

CheckServerFolders

procedure CheckServerFolders(sServerName: WideString);

生成された VBScript/JScript 公開スクリプト内の適切な位置に挿入され、プロジェクトに割り当てられたすべての公開フォルダ全体を繰り返し処理して、ターゲット サーバ (sServerName) 上でその存在を確認します。フォルダがなければ、作成されます。

CheckServerFolders 呼び出しが含まれていない古いスクリプトは、まだ機能します。CreateFolder DeploymentManager プロパティは内部の CopyFileExtended 呼び出しに渡され、存在しないディレクトリを作成するように FileProxy に指示します。

ClearServerList

procedure ClearServerList()

プロジェクトに割り当てられているサーバの内部リストをクリアします。このメソッドを使うと、既定のプロジェクト公開サーバ リストを変更することができます。

CopyFile

function CopyFile(const SourceFile: WideString; const TargetFile: WideString): Integer

ソース ファイルをターゲット ファイルの場所にコピーします。

CopyFileExtended

function CopyFileExtended(const SourceFile: WideString; const TargetFile: WideString; CreateFolder: WordBool; UploadOnlyIfNewer: WordBool; EncryptCFML: WordBool): Integer

ソース ファイルをターゲットファイルの場所にコピーし、追加の引数を与えます。

CreateDir

function CreateDir(PathName: WideString): Integer

ディレクトリ作成プリミティブ関数。成功した場合は 0 を返し、失敗した場合は RDS エラー コードを返します。

FileExists

function FileExists(const sFileName: WideString): WordBool

ファイルが存在するかどうかをチェックします。

GetDeployServerName

function GetDeployServer(nServer:integer): WideString

インデックス nServer を基に、サーバ リストにあるサーバの名前を返します。内部サーバ リストの配列は 0 から始まります。

GetDeployServerStatus

function GetDeployServerStatus(nServer:integer):WideString

インデックス nServer を基に、サーバ リストにあるサーバのインデックスを返します。内部サーバ リストの配列は 0 から始まります。

GetDeployState

procedure GetDeployState(sServerName:WideString): WordBool

特定の公開サーバに、公開が使用可能であるかどうかを問い合わせます。GetDeployState には sServerName でサーバ名が渡され、WordBool で True または False を返します。

GetDeployTargetName

function GetDeployTargetName(const sServerName:Widestring, const sFolderName:Widestring, nFileIndex:Integer): WideString

渡されたサーバ名、フォルダ名、使用するフォルダ ファイルを表すIntegerを使って、対象となる公開ファイルの名前を計算します。このメソッドは主に、フォルダ内のすべての既存ファイルを反復処理するときに使います。このメソッドは、UploadFile メソッドに 2 番目の引数として渡される "Rds://localhost/D:/main/images/TestImage.jpg" などのサーバ ファイル ターゲット パスを計算します。

GetFolderDeployPath

function GetFolderDeployPath(const sFolderName:String): WideString

渡されたフォルダ名の公開パスを返します。このパスは、GetDeployServer および GetFolderName メソッドとともに使うことができます。

GetFolderFileCount

function GetFolderFileCount(const sFolderName:String):Integer

渡されたプロジェクト フォルダ名に追跡されるファイルの数を返します。

GetFolderFileExt

function GetFolderFileExt(const sFolderName: WideString; nIndex: Integer): WideString

渡されたフォルダ名を基に、フォルダ ファイルの拡張子を返します。詳細については「プロジェクト フォルダ名に関する特記事項」を参照してください。

GetFolderFileName

function GetFolderFileName(const sFolderName: WideString; nIndex: Integer): WideString

渡されたフォルダ名を基に、フォルダ ファイルの名前を返します。

GetFolderName

function GetFolderName(nFolder:Integer): WideString

位置インデックス nFolder によって表されるフォルダのプロジェクト フォルダ名を返します。プロジェクト フォルダには連番が付けられています。

GetLastErrorCode

function GetLastErrorCode(): Integer

最後のエラー コードを整数として返すことによって、UploadFile 呼び出しの結果をテストします。GetLastError の両方のメソッドを使うと、プログラムによってスクリプトを中止したり、基本的なエラー対処の他のフォームを提供したりすることができます。

GetLastErrorMessage

function GetLastErrorMessage(): WideString

最後に関連付けられた RDS エラー メッセージを返すことによって、UploadFile 呼び出しの結果をテストします。

IsFolderDeployable

function IsFolderDeployable(const sFolderName:WideString): WordBool

渡されたフォルダ名の公開ステータスを返します。このメソッドを使うと、「アップロードしない」と指定されているフォルダを無視することができます。

OpenProject

procedure OpenProject(const sProjectName: WideString)

渡された OleString で指定されているプロジェクトを開きます。プロジェクトは、既存のプロジェクト ファイルへの絶対パスで指定されている必要があります。

PathExists

function PathExists(const sFolderName: WideString): WordBool

パスが存在するかどうかをチェックします。

SetDeployState

procedure SetDeployState(sServerName:WideString,bServerStatus: WordBool)

公開時に sServerName によって指定された公開サーバを有効にしたり、無効にしたりします。サーバによっては、これによって公開プロセスの実行時に有効または無効にすることができます。

SetLogFileName(sLogFileName:String)

procedure SetLogFileName(sLogFileName: String)

生成された公開ログ ファイルの名前を変更します。既定名は "Deployment.log" で、その既定の場所は、ビジュアル ツールのメイン インストール ディレクトリです。絶対パスと完全ファイル名を指定してください。

SetLogging

procedure SetLogging(bDoLogging: WordBool)

ログ機能をオン/オフにします。このメソッドの有効性は、公開するプロジェクトを開いた後に失われます。

UploadFile

procedure UploadFile(const sFile:Widestring, sTargetFile: WideString)

サーバに個々のファイルをアップロードします。最初の OleString は、アップロードする個々のファイルの絶対パスを表します。2 番目の OleString は、rds://localhost/main/index.html などの完全なターゲット名を表します。

UploadProject

procedure UploadProject(const sProjectName: WideString)

OLE 文字列として渡された認識可能なプロジェクト名を基に、プロジェクト全体をアップロードします。これによって、プロジェクト (プロジェクトには各フォルダが保存されている) に割り当てられている各サーバを反復処理するループを処理する既定の公開エンジンを起動し、これらの各フォルダに含まれているすべてのファイルをアップロードします。「アップロードしない」と設定されているフォルダは、このプロセス時には無視されるので注意してください。

プロジェクト フォルダ名に関する特記事項

プロジェクト フォルダ名は、Project/Folder/Subfolder1[/SubFolder2... SubFolderN] というフォーマットで保存されています。この場合、

既存のフォルダ関連の DeploymentManager VTOM 呼び出しを使うには、プロジェクト名自体から始まる認識可能なフォルダ名を渡す必要があります。たとえば、Project1 というプロジェクトがあり、Images フォルダが含まれている Main フォルダがある場合、この Images フォルダ内のファイルの数を検索するときの正しい呼び出し方法は次のようになります。

ICount = GetFolderFileCount("MyProject/Main/Images"); // Image フォルダ内のファイルの数を返します。


Copyright © 2000, Allaire Corporation. All rights reserved. 戻る 1 つ上のページに戻る 次へ