home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
DOS/V Power Report 2002 July
/
VPR0207A.ISO
/
OLS
/
IRVINE0_4_1A
/
irvine0_4_1a.lzh
/
doc
/
api.txt
< prev
next >
Wrap
Text File
|
2002-04-21
|
21KB
|
859 lines
IrvineのActiveXオートメーション(ver 0.3.30)
・もっとも簡単に使用する方法は VBScriptか JScriptを使う方法です。
例A: 以下のテキストをsample.vbsとして保存後エクスプローラから実行してください。
set irvine = CreateObject("Irvine.Api")
MsgBox("Irvineのバージョンは " & irvine.Version & " です。")
for i = 0 to irvine.Current.ItemCount - 1
item = irvine.Current.Items(i)
MsgBox item.Url
next
例B: 以下のテキストをsample.jsとして保存後エクスプローラから実行してください。
irvine = new ActiveXObject("Irvine.Api");
irvine.Download("http://127.0.0.1/",1);
○Irvine.Api
○Irvine.Item
○Irvine.Folder
○Irvine.UrlManager
○Irvine.Api
・プロパティ
Version
戻り値: BSTR
説明: バージョン情報を返します。読み取り専用。
HInstance
戻り値: long
説明: インスタンスハンドルを返します。読み取り専用。
WindowHandle
戻り値: long
説明: メインフォームのハンドルを返します。読み取り専用。
ApplicationPath
戻り値: BSTR
説明: 実行ファイルのPathを返します。読み取り専用。
PluginsPath
戻り値: BSTR
説明: プラグインフォルダのPathを返します。読み取り専用。
ImportPath
戻り値: BSTR
説明: インポートフォルダ(ここにURLリスト等を入れると自動でインポート)
のPathを返します。読み取り専用。
TotalBytes
戻り値: double
説明: 総ダウンロードバイトを返します。読み取り専用。
TotalFiles
戻り値: double
説明: 総ダウンロードファイル数を返します。読み取り専用。
IniFilename
戻り値: BSTR
説明: INIファイル名を返します。読み取り専用。
ScriptsPath
戻り値: BSTR
説明: スクリプトフォルダのPathを返します。読み取り専用。
ItemCount
戻り値: long
説明: カレントキューのアイテム数を返します。読み取り専用。
CurrentQueueFolder
戻り値: BSTR
説明: カレントキューフォルダ名。書込み可能。
SelectedItemCount
戻り値: long
説明: 選択アイテム数。読み取り専用。
StatusBarText
戻り値: BSTR
説明: ステータスバーのテキスト。書込み可能。
ActiveDownloadCount
戻り値: long
説明: 実行アイテム数。読み取り専用。
ActiveQueueCount
戻り値: long
説明: 実行待ちアイテム数。読み取り専用。
Items[long Index]
戻り値:BSTR
説明: アイテムデータ。GetItemData SetItemDataと同じ。
ItemSelected[long Index]
戻り値: VARIANT_BOOL
説明: アイテムの選択。書き込み可能。GetItemSelected,SetItemSelectedメソッドと同じもの。
OptionData[BSTR Section,BSTR Ident]
戻り値: BSTR
説明: オプションデータ。書き込み可能。GetOptionData,SetOptionDataメソッドと同じもの。独自のデータを永続的に保存可能です。
FolderData[BSTR Section,BSTR Ident]
戻り値: BSTR
説明: フォルダデータ。書き込み可能。GetFolderData,SetFolderDataメソッドと同じもの。独自のデータを永続的に保存可能です。
Filtering
戻り値: VARIANT_BOOL
説明: URLの振り分け。書き込み可能。
Default
戻り値:Irvine.Folder
説明:デフォルトフォルダ。
Trash
戻り値:Irvine.Folder
説明:ごみ箱。
Root
戻り値:Irvine.Folder
説明:すべての親フォルダ。これは特殊フォルダなので表示されていません。デフォルトとごみ箱はFoldersには含まれていません。
Current
戻り値:Irvine.Folder
説明:カレントフォルダ。書き込み可能。
ImportLinksDepth
戻り値:long
説明:リンクのインポートの階層数。書き込み可能。
ImportLinksThreadCount
戻り値:long
説明:リンクのインポートのスレッド数。書き込み可能。
ActiveFolderCount
戻り値:long
説明:実行中のフォルダ数。
OptionValues[BSTR Ident]
戻り値: BSTR
説明: Section不要のオプションデータ。書き込み可能。GetOptionValue,SetOptionValueメソッドと同じもの。
FolderValues[BSTR Ident]
戻り値: BSTR
説明: Section不要のフォルダデータ。書き込み可能。GetFolderValue,SetFolderValueメソッドと同じもの。
・メソッド
AddUrl(BSTR Urls,long Flag)
引数:Urls…URLリスト Flag…[0:通常 1:選択 2:展開]
説明:Urlリストを追加する。
Import(BSTR Filename)
引数: Filename…ファイル名
説明: リストを自動識別でインポート
Save()
説明: 保存します。
Quit()
説明: 終了します。
Download(BSTR Url, long Flag)
引数:Flag…[0: 通常 1: ダイアログ 2: フォルダダイアログ 3:すぐにダウンロード 4:すぐにダイアログ 5:すぐにキューフォルダ]
説明:URLをダウンロードします。
Clear()
説明:カレントキューのアイテムをクリアします。
ForegroundWindow()
説明:ウィンドウを最前列へ表示します。
Start(long Flag)
引数:Flag…[0: すべて 1:選択のみ]
説明:カレントキューのアイテムを開始します。
Stop(long Flag)
引数:Flag…[0: すべて 1:選択のみ]
説明:カレントキューのアイテムを停止します。
Dialup()
説明:ダイアルアップします。
Hangup()
説明:回線を切断します。
Paste(long Flag )
引数:Flag…[0: 通常 1: URL展開]
説明:貼り付けします。
EnumQueueFolders(BSTR AbsolutePath)
引数: AbsolutePath…取得するPath
戻り値:BSTR
説明:フォルダを絶対Pathで列挙した文字列を取得します。
GetOptionData(BSTR Section,BSTR Ident)
引数: Section,Ident…Ini形式
戻り値:BSTR
説明:Ini形式のオプションデータを取得します。
SetOptionData(BSTR Section,BSTR Ident,BSTR Value)
引数:Section,Ident,Value…Ini形式
説明:オプションデータをセットします。独自のデータを永続的に保存可能です。
GetFolderData(BSTR Section,BSTR Ident)
引数: Section,Ident…Ini形式
戻り値:BSTR
説明:Ini形式のカレントフォルダのデータを取得します。
SetFolderData(BSTR Section,BSTR Ident,BSTR Value)
引数:Section,Ident,Value…Ini形式
説明:カレントフォルダのデータをセットします。独自のデータを永続的に保存可能です。
CreateQueueFolder(BSTR Name,VARIANT_BOOL OpenFolder)
引数:Name…フォルダ名 OpenFolder…作成後にカレントフォルダを変更するかどうか
戻り値:VARIANT_BOOL
説明:カレントフォルダの下にフォルダを作成します。
AddIRI(BSTR IriaListText )
引数:IriaListText…Iria形式のリスト
説明:Iria形式のリストを加えます。
ImportLinks(BSTR Urls,long Flag)
引数:Urls…Urlリスト Flag…使用していません
説明:リンクのインポートを起動します。
AddUrlAndReferer(BSTR Urls,BSTR Referer,long Flag)
引数:Urls…Urlリスト Flag…使用していません
説明:Referer付きでURLリストを追加します。
DeleteQueueFolder(BSTR AbsolutePath,VARIANT_BOOL Confirm)
引数: AbsolutePath…削除するフォルダの絶対Path Confirm…Trueで確認ダイアログを表示
戻り値:VARIANT_BOOL
説明:キューフォルダを削除します。
CreateQueueItem(BSTR DataText,VARIANT_BOOL Confirm)
引数: DataText…アイテム文字列 Confirm…確認するかどうか
戻り値: VARIANT_BOOL
説明: キューアイテムを作成します
ExecuteAction(BSTR ActionName)
引数: ActionName…アクションの名前
戻り値: VARIANT_BOOL
説明: メニューのアクションを実行します。action.txtを参照。
GetItemData(long Index)
引数:Index…カレントキューのアイテムのインデックス
戻り値:アイテム文字列。
説明:カレントキューのインデックスの位置にあるアイテムのデータを返します。データのフォーマットは以下を参照。[s]は文字列、[b]はブール値、[i]は数値、[d]はDouble。各項目はタブ文字で区切られています。
URL[s] フォルダ[s] ファイル名[s] Referer[s] Cookie[s] CRC,MD5[s] 分割数[i] 認証使用[b] ユーザID[s] パスワード[s] 登録日時[d] 成功[b] コメント[s] ファイルサイズ[i] ダウンロードサイズ[i] エラー[b] ダウンロードしたファイル名[s] 成功日時[d] 元のキュー[s]
SetItemData(long Index,BSTR Value)
引数:Index…カレントキューのアイテムのインデックス Value…アイテム文字列
戻り値:
説明:カレントキューのインデックスの位置にあるアイテムのデータをセットします
GetItemSelected(long Index)
引数:Index…カレントキューのアイテムのインデックス
戻り値:VARIANT_BOOL
説明:カレントキューのインデックスの位置にあるアイテムが選択されているかどうか。
SetItemSelected(long Index,VARIANT_BOOL Value)
引数:Index…カレントキューのアイテムのインデックス Value…選択
戻り値:
説明:カレントキューのインデックスの位置にあるアイテムを選択切り替えします。
UrlEncode(BSTR Str,BSTR IgnoreChars,VARIANT_BOOL SpaceToPlus)
引数:Str…文字列 IgnoreChars…無視する文字 SpaceToPlus…空白を+に変換するかどうか
戻り値:BSTR…エンコードした文字列。
説明:文字列をURLエンコードします。
UrlDecode(BSTR Str,VARIANT_BOOL PlusToSpace)
引数:Str…文字列 PlusToSpace…+を空白に変換するかどうか
戻り値:BSTR…デコードした文字列。
説明:文字列をURLデコードします。
Invalidate();
引数:
戻り値:
説明:リスト表示を更新します。
BeginProgressBar(long MaxCount)
引数:MaxCount…最大数
戻り値:
説明:プログレスバーを開始します。
EndProgressBar()
引数:
戻り値:
説明:プログレスバーを終了します。
ProgressBarStepBy(long Delta)
引数:Delta…進行数
戻り値:
説明:プログレスバーを進めます。
DeleteItem(long Index )
引数:カレントキューのインデックスの位置にあるアイテム。
戻り値:
説明:アイテムを削除します。
GetItemFilename(long Index)
引数:カレントキューのインデックスの位置にあるアイテム。
戻り値:BSTR…ファイル名
説明:URLアイテムの保存ファイル名を取得します。
ForceQueueFolders(BSTR AbsolutePath,VARIANT_BOOL OpenFolder,long Flag)
引数:AbsolutePath…作成するフォルダの絶対Path OpenFolder…trueでフォルダを開く Flag…1でダイアログを表示
戻り値:BSTR…作成したフォルダの絶対Path。
説明:キューフォルダを作成する。
UpQueueFolder()
引数:
戻り値:VARIANT_BOOL
説明:フォルダを一つ上に移動する
ChangeTab(long Mode )
引数:Mode…0でキュー 1で履歴
戻り値:
説明:タブの切り替え。
GetItemIndexFilename(long Index)
引数:Index…カレントキューのインデックスの位置にあるアイテム。
戻り値:BSTR…インデックスファイル名(xxxx.xxx_irvine)
説明:ダウンロード途中のファイルのインデックスファイル名を得る。
GetItemFileSize(long Index)
引数:Index…カレントキューのインデックスの位置にあるアイテム。
戻り値:long…ファイルサイズ。
説明:アイテムの保存ファイルのサイズを得る。
GetFileSize(BSTR Filename)
引数:Filename…ファイル名。
戻り値:long…ファイルサイズ。
説明:ファイルのサイズを得る。
EnumQueueFolders2(BSTR AbsolutePath)
引数:AbsolutePath…キューフォルダ名
戻り値:BSTR…改行で区切られた相対Pathのフォルダ名
説明:キューフォルダを列挙する。
OptionDataExists(BSTR Section,BSTR Ident)
引数:Section,Ident…iniファイル形式で指定。
戻り値:VARIANT_BOOL…存在すればTrue。
説明:オプションデータに値が存在するかどうか。
FolderDataExists(BSTR Section,BSTR Ident)
引数:Section,Ident…iniファイル形式で指定。
戻り値:VARIANT_BOOL…存在すればTrue。
説明:カレントフォルダデータに値が存在するかどうか。
StartImportLinks()
引数:
説明:リンクのインポートを開始します。
StopImportLinks()
引数:
説明:リンクのインポートを停止します。
AddQueueItem(BSTR ParentFolder,BSTR DataText)
引数:ParentFolder…追加するフォルダの絶対パス、空文字を指定するとカレント DataText…アイテム文字列
戻り値:BSTR…アイテムを追加したフォルダの絶対パス。アイテムは振り分けで別のフォルダに登録される場合があります。
説明: キューアイテムを加えます
DeleteQueueItem(long Index)
引数:Index…カレントキューの位置
説明:DeleteItemと同じ。
ClearImportLinks()
引数:
説明:リンクのインポートのデータをクリアします。
SaveImportLinks(BSTR Filename)
引数:Filename…ファイル名
説明:ファイルへリンクのインポートのデータを保存します。
LoadImportLinks(BSTR Filename)
引数:Filename…ファイル名
説明:ファイルへリンクのインポートのデータを読み込みます。
CloseImportLinks()
引数:
説明:リンクのインポートを閉じます。
RegistImportLinks(BSTR FolderPath)
引数:FolderPath…登録するキューフォルダ
説明:リンクのインポートの選択URLを登録します。
IsBusyImportLinks()
引数:
戻り値:VARIANT_BOOL
説明:リンクのインポートが実行中かどうか。
IsBusy()
引数:
戻り値:VARIANT_BOOL
説明:ダウンロードを実行中かどうか。
FolderExists(BSTR AbsolutePath)
引数:AbsolutePath…フォルダの絶対パス
戻り値:VARIANT_BOOL
説明:キューフォルダが存在するかどうか。
ExtractQueuetem(long Index)
引数: Index…アイテムのインデックス。
戻り値:
説明:ごみ箱に移動しないでアイテムを削除する。
ExpandUrls(BSTR Urls)
引数: Urls…URLリスト。
戻り値:BSTR
説明:URLリストを展開します。新式のみ。
GetOptionValue(BSTR Ident)
引数: Ident…Ini形式
戻り値:BSTR
説明:Section不要のオプションデータを取得します。
SetOptionValue(BSTR Ident,BSTR Value)
引数:Ident,Value…Ini形式
説明:Section不要のオプションデータをセットします。
GetFoldeValue(BSTR Ident)
引数: Ident…Ini形式
戻り値:BSTR
説明:Section不要のカレントフォルダのデータを取得します。
SetFolderValue(BSTR Ident,BSTR Value)
引数:Ident,Value…Ini形式
説明:Section不要のカレントフォルダのデータをセットします。
OptionValueExists(BSTR Ident)
引数:Ident…iniファイル形式で指定。
戻り値:VARIANT_BOOL…存在すればTrue。
説明:オプションデータに値が存在するかどうか。
FolderValueExists(BSTR Ident)
引数:Ident…iniファイル形式で指定。
戻り値:VARIANT_BOOL…存在すればTrue。
説明:カレントフォルダデータに値が存在するかどうか。
ShowMessage(BSTR Title,BSTR Msg,long Interval)
引数:Title…タイトル Msg…メッセージ Interval…インターバル。
説明:メッセージを表示する。
○Irvine.Item
・プロパティ
Data
戻り値: BSTR
説明: アイテム文字列。書き込み可能。
Url
戻り値: BSTR
説明: URL。書き込み可能。
Folder
戻り値: BSTR
説明: 個別の保存フォルダ。書き込み可能。
Filename
戻り値: BSTR
説明: 別名で保存ファイル名。書き込み可能。
Referer
戻り値: BSTR
説明: 個別のReferer。書き込み可能。
Cookie
戻り値: BSTR
説明: 個別のCookie。書き込み可能。
Check
戻り値: BSTR
説明: CRC16,32,MD5。書き込み可能。
SplitCount
戻り値: long
説明: 個別の分割数。書き込み可能。
Authorization
戻り値: VARIANT_BOOL
説明: 個別の認証使用。書き込み可能。
UserId
戻り値: BSTR
説明: 個別の認証ユーザID。書き込み可能。
Password
戻り値: BSTR
説明: 個別の認証パスワード。書き込み可能。
RegistDate
戻り値: double
説明: 登録日時。書き込み可能。
Success
戻り値: VARIANT_BOOL
説明: 成功。書き込み可能。
Comment
戻り値: BSTR
説明: コメント。書き込み可能。
FileSize
戻り値: long
説明: ファイルサイズ。書き込み可能。
DLSize
戻り値: long
説明: ダウンロードサイズ。書き込み可能。
Error
戻り値: VARIANT_BOOL
説明: 失敗。書き込み可能。
DownloadedFilename
戻り値: BSTR
説明: ダウンロードしたファイル名。書き込み可能。
SuccessDate
戻り値: Double
説明: 成功日時。書き込み可能。
Queue
戻り値: BSTR
説明: 元のキュー名。書き込み可能。
○Irvine.Folder
・プロパティ
ItemCount
戻り値:long
説明:アイテム数。
Items[long Index]
戻り値:Irvine.Item
説明: アイテム。書き込み可能。
FolderCount
戻り値:long
説明:下位フォルダ数。
Folders[long Index]
戻り値:Irvine.Folder
説明:下位のフォルダ。
Parent
戻り値:Irvine.Folder
説明:上位フォルダ。
Data[BSTR Section,BSTR Ident]
戻り値:BSTR
説明:INI形式のフォルダデータ。書き込み可能。独自のデータを保存できます。
Count
戻り値:long
説明:下位フォルダ数。FolderCountと同じ。
AbsolutePath
戻り値:BSTR
説明:フォルダの絶対パス。書き込み可能。
Path
戻り値:BSTR
説明:フォルダの絶対パス。AbsolutePathと同じ。書き込み可能。
Name
戻り値: BSTR
説明:フォルダ名。
ItemData[long Index]
戻り値:BSTR
説明: アイテム文字列。書き込み可能。
ActiveDownloadCount
戻り値:long
説明:ダウンロード実行数。
ActiveQueueCount
戻り値:long
説明:ダウンロード待機数。
Values[BSTR Ident]
戻り値:BSTR
説明:Section不要のINI形式のフォルダデータ。書き込み可能。
・メソッド
IsCurrent()
引数:
戻り値:VARIANT_BOOL
説明:フォルダがカレントかどうか。
IsDefault()
引数:
戻り値:VARIANT_BOOL
説明:フォルダがデフォルトかどうか。
IsTrash()
引数:
戻り値:VARIANT_BOOL
説明:フォルダがごみ箱かどうか。
IsRoot()
引数:
戻り値:VARIANT_BOOL
説明:フォルダがルートフォルダかどうか。
DataExists(BSTR Section,BSTR Ident)
引数: Section,Ident…INI形式。
戻り値:VARIANT_BOOL
説明:フォルダデータが存在するかどうか。
AddItem(Irvine.Item Item)
引数:Item…アイテム。
戻り値:long…追加したインデックス。
説明:アイテムを加える。
AddItemData(BSTR DataText)
引数:DataText…アイテム文字列。
戻り値:long…追加したインデックス。
説明:アイテムを加える。
DeleteItem(long Index)
引数: Index…アイテムのインデックス。
戻り値:
説明:アイテムを削除する。
Start()
引数:
戻り値:
説明:すべてのダウンロードを開始する。
Stop()
引数:
戻り値:
説明:すべてのダウンロードを停止する。
StartItem(long Index)
引数: Index…アイテムのインデックス。
戻り値:
説明:アイテムのダウンロードを開始する。
StopItem(long Index)
引数: Index…アイテムのインデックス。
戻り値:
説明:アイテムのダウンロードを停止する。
GetItemFilename(long Index)
引数: Index…アイテムのインデックス。
戻り値:BSTR
説明:アイテムの保存ファイル名。
GetItemIndexFilename(long Index)
引数: Index…アイテムのインデックス。
戻り値:BSTR
説明:アイテムの保存ファイルのインデックスファイル名(xxxxxx.xxx_irvine)。
GetItemFileSize(long Index)
引数: Index…アイテムのインデックス。
戻り値:long
説明:アイテムの保存ファイルのサイズ。
DownloadItem(long Index)
引数: Index…アイテムのインデックス。
戻り値:
説明:アイテムのダウンロードを直接開始する。
IsBusy()
引数:
戻り値:VARIANT_BOOL
説明:実行中のアイテムがあるか。
Exists()
引数:
戻り値:VARIANT_BOOL
説明:キューフォルダが存在するか。
Make()
引数:
戻り値:VARIANT_BOOL
説明:キューフォルダが無い場合はPathのフォルダを作成する。
ExtractItem(long Index)
引数: Index…アイテムのインデックス。
戻り値:
説明:ごみ箱に移動しないでアイテムを削除する。
ValueExists(BSTR Ident)
引数: Ident…INI形式。
戻り値:VARIANT_BOOL
説明:Section不要のフォルダデータが存在するかどうか。
AssignData(IFolder* Source)
引数: Source…Irvine.Folder。
戻り値:
説明:データをSourceからコピーします。
○Irvine.UrlManager(リンクのインポート)
・プロパティ
OptionValues[BSTR Ident]
引数:Ident…ini形式
戻り値:BSTR
説明:アイテム数。
Items[long Index]
引数:Index
戻り値:BSTR
説明:リストのURL。
ItemCount
戻り値:long
説明:アイテム数。
ItemSelected[long Index]
引数:Index
戻り値:VARIANT_BOOL
説明:選択アイテム。書き込み可能。
SelectedItemCount
戻り値:long
説明:選択アイテム数。
Depth
戻り値:long
説明:取得階層数。書き込み可能。
ThreadCount
戻り値:long
説明:実行スレッド数。書き込み可能。
TagAHREF
戻り値:VARIANT_BOOL
説明:Tag。書き込み可能。
TagIMGSRC
戻り値:VARIANT_BOOL
説明:Tag。書き込み可能。
TagFRAMESRC
戻り値:VARIANT_BOOL
説明:Tag。書き込み可能。
TagIFRAMESRC
戻り値:VARIANT_BOOL
説明:Tag。書き込み可能。
TagMETAREFRESH
戻り値:VARIANT_BOOL
説明:Tag。書き込み可能。
TagBGSOUND
戻り値:VARIANT_BOOL
説明:Tag。書き込み可能。
TagOther
戻り値:VARIANT_BOOL
説明:Tag。書き込み可能。
ExtHTML
戻り値:VARIANT_BOOL
説明:拡張子。書き込み可能。
ExtTEXT
戻り値:VARIANT_BOOL
説明:拡張子。書き込み可能。
ExtIMAGE
戻り値:VARIANT_BOOL
説明:拡張子。書き込み可能。
ExtARCHIVE
戻り値:VARIANT_BOOL
説明:拡張子。書き込み可能。
ExtAUDIO
戻り値:VARIANT_BOOL
説明:拡張子。書き込み可能。
ExtMOVIE
戻り値:VARIANT_BOOL
説明:拡張子。書き込み可能。
ExtEtc
戻り値:VARIANT_BOOL
説明:拡張子。書き込み可能。
ExtRegExp
戻り値:VARIANT_BOOL
説明:拡張子。書き込み可能。
Referer
戻り値:BSTR
説明:URL取得時のReferer。
UserAgent
戻り値:BSTR
説明:URL取得時のUserAgent。
Proxy
戻り値:BSTR
説明:URL取得時のProxy。
UseProxy
戻り値:VARIANT_BOOL
説明:URL取得時にProxyを使うかどうか。
ProxyUserId
戻り値:BSTR
説明:URL取得時のProxyUserId。
ProxyPassword
戻り値:BSTR
説明:URL取得時のProxyPassword。
・メソッド
Close()
説明:終了します。
Start()
説明:URL取得を開始します。
Stop()
説明:URL取得を中止します。
Clear()
説明:URLをクリアします。
Show()
説明:表示します。
OptionValueExists(BSTR Ident)
引数: Ident…INI形式。
戻り値:VARIANT_BOOL
説明:オプションデータが存在するかどうか。
IsBusy()
戻り値:VARIANT_BOOL
説明:URL取得中かどうか。
Regist()
説明:選択URLを登録します。
AddQueue(BSTR Urls)
引数: Urls…URLリスト。
説明:取得キューにURLを追加します。
ClearQueue()
説明:取得キューをクリアします。
SelectExt()
説明:指定拡張子を選択します。