Irvine ActiveX オートメーション (ver 0.4.4) API仕様書

概要

IrvineのActiveXオートメーションAPIの詳細な仕様をまとめたものです。スクリプトからIrvineを操作するためのリファレンスとして活用できます。

使い方

VBScriptやJScriptからActiveXオブジェクトを生成して利用します。

VBScript例

set irvine = CreateObject("Irvine.Api")
MsgBox("Irvineのバージョンは " & irvine.Version & " です。")

JScript例

irvine = new ActiveXObject("Irvine.Api");
irvine.Download("http://127.0.0.1/", 1);

オブジェクト一覧

  • Irvine.Api
  • Irvine.Item
  • Irvine.Folder
  • Irvine.UrlManager

Irvine.Api (APIのメイン制御)

プロパティ

名前説明
VersionBSTRバージョン情報
BuildBSTRビルド番号
ApplicationPathBSTR実行ファイルパス
PluginsPathBSTRプラグインフォルダパス
ItemCountlongキュー内アイテム数
SelectedItemCountlong選択アイテム数
ActiveDownloadCountlong実行中アイテム数
ActiveQueueCountlongキュー内実行待ち数

メソッド

名前引数説明
AddUrlBSTR Urls, long FlagURLリストを追加
DownloadBSTR Url, long Flag即時ダウンロード
Save設定保存
Quit終了
Clearキュークリア
Startlong Flag開始
Stoplong Flag停止

Irvine.Item (個別ダウンロードアイテム)

プロパティ

名前説明
DataBSTRアイテム文字列
UrlBSTRURL
FolderBSTR保存先フォルダ
FilenameBSTRファイル名
RefererBSTRリファラ
CookieBSTRクッキー
SplitCountlong分割数
AuthorizationVARIANT_BOOL認証有無

Irvine.Folder (フォルダ管理)

プロパティ

名前説明
ItemCountlongアイテム数
FolderCountlong下位フォルダ数
NameBSTRフォルダ名

メソッド

名前引数説明
AddItemIrvine.Item Itemアイテム追加
DeleteItemlong Indexアイテム削除
Startダウンロード開始
Stop停止

Irvine.UrlManager (URLインポート)

プロパティ

名前説明
ItemCountlongURL数
Items[long Index]BSTRURL
Depthlong取得階層数

メソッド

名前引数説明
Startなし開始
Stopなし停止

VBA サンプルコード1(Irvineを使った即時ダウンロード)

Sub DownloadFileWithIrvine()
Dim irvine As Object
Dim item As Object
Dim downloadUrl As String
Dim saveFolder As String
Dim saveFileName As String

' --- ユーザー指定部分 ---
downloadUrl = "http://example.com/sample.zip" ' ダウンロードURL
saveFolder = "C:\Downloads" ' 保存先フォルダ
saveFileName = "sample.zip" ' 保存するファイル名
' --------------------------

' Irvine オブジェクト作成
Set irvine = CreateObject("Irvine.Api")

' 一時的にキューへ追加
irvine.AddUrl downloadUrl, 0 ' Flag: 0=通常追加

' 最後に追加したアイテムを取得(末尾のアイテム)
Set item = irvine.Current.Items(irvine.Current.ItemCount - 1)

' 保存先フォルダとファイル名を設定
item.Folder = saveFolder
item.Filename = saveFileName

' 即時ダウンロード開始
irvine.Current.StartItem irvine.Current.ItemCount - 1

MsgBox "ダウンロードを開始しました。", vbInformation

' 後始末
Set item = Nothing
Set irvine = Nothing
End Sub

ポイント

項目説明
保存先フォルダsaveFolder にフルパスで指定
ファイル名saveFileName に指定
即時ダウンロードStartItem メソッドで対象アイテムだけ即開始
URLdownloadUrl にダウンロード対象のURL

ご要望に基づき、
CSV形式のリスト(ファイル名, URL)を読み込んで、指定したファイル名指定URL から Irvine を使って一括ダウンロードする VBAサンプル を作成しました。


VBA サンプルコード2 ファイル名とURLをCSVリストから一括ダウンロード

Sub BulkDownloadWithIrvineFromCSV()
    Dim irvine As Object
    Dim item As Object
    Dim csvFilePath As String
    Dim saveFolder As String
    Dim fileNo As Integer
    Dim line As String
    Dim data() As String
    Dim fileName As String
    Dim fileUrl As String
    
    ' --- ユーザー設定(編集する部分) ---
    csvFilePath = "C:\path\to\list.csv"  ' CSVファイルのパス
    saveFolder = "C:\Downloads"          ' 保存先フォルダ
    ' -----------------------------------
    
    ' Irvine オブジェクト生成
    Set irvine = CreateObject("Irvine.Api")
    
    ' CSVファイルを開く
    fileNo = FreeFile
    Open csvFilePath For Input As #fileNo
    
    ' 1行ずつ処理
    Do While Not EOF(fileNo)
        Line Input #fileNo, line
        line = Trim(line)
        If Len(line) > 0 Then
            data = Split(line, ",")
            If UBound(data) = 1 Then
                fileName = Trim(data(0))
                fileUrl = Trim(data(1))
                
                ' URL追加
                irvine.AddUrl fileUrl, 0
                
                ' 追加した最後のアイテムを取得
                Set item = irvine.Current.Items(irvine.Current.ItemCount - 1)
                
                ' 保存フォルダとファイル名設定
                item.Folder = saveFolder
                item.Filename = fileName
                
                ' 即時ダウンロード開始
                irvine.Current.StartItem irvine.Current.ItemCount - 1
            End If
        End If
    Loop
    
    Close #fileNo
    
    MsgBox "すべてのダウンロードを開始しました。", vbInformation
    
    ' 後始末
    Set item = Nothing
    Set irvine = Nothing
End Sub


使い方

  1. 上記のコードを ExcelのVBAモジュール に貼り付け。
  2. csvFilePathファイル名とURLリストのCSVファイルのパス を指定。
  3. saveFolder保存したいフォルダのパス を指定。
  4. マクロ実行(F5キーやVBAから呼び出し)。

CSVファイル例

写真1.jpg,https://www.aaaa.com/img/photo.jpg
風景1.jpg,https://www.aaaa.com/img/nautre.jpg
電車1.jpg,https://www.aaaa.com/img/train.jpg
電車2.jpg,https://www.aaaa.com/img/trainex.jpg
風景2.jpg,https://www.aaaa.com/img/seaside.jpg
写真2.jpg,https://www.aaaa.com/img/mountain.jpg

機能ポイント

項目説明
CSV形式ファイル名, URL 形式で記載(カンマ区切り)
保存先指定saveFolder で一括指定
ファイル名指定CSVの1列目が保存するファイル名
URL指定CSVの2列目がダウンロード元URL
即時開始追加後すぐに StartItem で開始

注意事項

  • 保存先フォルダ(saveFolder)は必ず存在するパスにしてください(無いと失敗)。
  • ファイル名は拡張子も含めて指定してください(例:example.jpg)。
  • Irvineが常駐/起動 している必要があります。
  • Irvineの設定で「即時ダウンロード許可」にしておくとスムーズです。

コメント

タイトルとURLをコピーしました