ホーム › Networking.BackgroundIntelligentTransferService › IBackgroundCopyJob1

IBackgroundCopyJob1

COM

📘 Microsoft Learn (日本語) · English

IID59f5553c-2031-4629-bb18-2645a6970947継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IBackgroundCopyJob1 インターフェイスは、ジョブへのファイルの追加やジョブの状態の取得に使用します。

メソッド 8

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT CancelJob()

vtbl 4 HRESULT GetProgress(DWORD dwFlags, DWORD* pdwProgress)

GetProgress メソッドは、ジョブの進行状況を取得するために使用します。

dwFlags

DWORD

取得する進行状況の種類。次のいずれかのフラグを指定します。

値	意味
QM_PROGRESS_PERCENT_DONE	ダウンロードの完了率 (パーセント) を返します。
QM_PROGRESS_SIZE_DONE	ダウンロード済みのバイト数を返します。
QM_PROGRESS_TIME_DONE	サポートされていません。

pdwProgress

DWORD*

out

ダウンロードの進行状況。dwFlags に応じて、ダウンロード済みのバイト数またはダウンロードの完了率 (パーセント) を表します。

戻り値

このメソッドは、次の HRESULT 値のほか、その他の値を返します。

戻り値	説明
S_OK	ジョブの進行状況を正常に取得しました。
E_NOTIMPL	dwFlags パラメーターに QM_PROGRESS_TIME_DONE を指定することはできません。

vtbl 5 HRESULT GetStatus(DWORD* pdwStatus, DWORD* pdwWin32Result, DWORD* pdwTransportResult, DWORD* pdwNumOfRetries)

GetStatus メソッドは、ジョブの状態を取得するために使用します。

pdwStatus

DWORD*

out

ジョブの状態。状態には次のフラグのうち 1 つ以上が設定されます。

値	意味
QM_STATUS_JOB_FOREGROUND	サポートされていません。
QM_STATUS_JOB_INCOMPLETE	QMGR がジョブをまだダウンロード中です。
QM_STATUS_JOB_COMPLETE	ジョブが完了しました。
QM_STATUS_JOB_ERROR	ジョブの処理中にエラーが発生しました。

pdwWin32Result

DWORD*

out

Win32 エラーコード。QM_STATUS_JOB_ERROR の dwStatus フラグが設定されている場合にのみ有効です。

pdwTransportResult

DWORD*

out

HTTP エラーコード。QM_STATUS_JOB_ERROR の dwStatus フラグが設定されている場合にのみ有効です。

pdwNumOfRetries

DWORD*

out

エラー発生後に QMGR がジョブのダウンロードを試行した回数。QM_STATUS_GROUP_ERROR の dwStatus フラグが設定されている場合にのみ有効です。

戻り値

このメソッドは、次の HRESULT 値のほか、その他の値を返します。

戻り値	説明
S_OK	ジョブの状態を正常に取得しました。

vtbl 6 HRESULT AddFiles(DWORD cFileCount, FILESETINFO** ppFileSet)

AddFiles メソッドは、ダウンロードする 1 つ以上のファイルをジョブに追加するために使用します。

cFileCount	DWORD	in	ジョブに追加する pFileInfo 内のファイル数。
ppFileSet	FILESETINFO**	in	ダウンロードするファイルのリモート名とローカル名を格納した FILESETINFO 構造体の配列。

戻り値

このメソッドは、次の HRESULT 値のほか、その他の値を返します。

戻り値	説明
S_OK	ファイルがジョブに正常に追加されました。
E_INVALIDARG	ローカルファイル名またはリモートファイル名が無効です。たとえば、リモートファイル名がサポートされていないプロトコルを指定している場合などです。
E_ACCESSDENIED	クライアント上の指定されたディレクトリに書き込む権限がユーザーにありません。

vtbl 7 HRESULT GetFile(DWORD cFileIndex, FILESETINFO* pFileInfo)

GetFile メソッドは、ジョブ内の指定したファイルのリモートファイル名とローカルファイル名を取得するために使用します。

cFileIndex	DWORD	in	ジョブ内のファイルを識別する 0 から始まるインデックス。
pFileInfo	FILESETINFO*	out	ファイルのリモート名とローカル名を格納する FILESETINFO 構造体。

戻り値

このメソッドは、次の HRESULT 値のほか、その他の値を返します。

戻り値	説明
S_OK	ジョブからファイルを正常に取得しました。
QM_E_ITEM_NOT_FOUND	指定されたインデックスがジョブ内のファイル数を超えています。

解説(Remarks)

IBackgroundCopyJob1::GetFileCount と併用して、ジョブ内のファイルを反復処理します。

vtbl 8 HRESULT GetFileCount(DWORD* pdwFileCount)

GetFileCount メソッドは、ジョブ内のファイル数を取得するために使用します。

pdwFileCount

DWORD*

out

ジョブ内のファイル数。

戻り値

このメソッドは、次の HRESULT 値のほか、その他の値を返します。

戻り値	説明
S_OK	ジョブ内のファイル数を正常に取得しました。

vtbl 9 HRESULT SwitchToForeground()

vtbl 10 HRESULT get_JobID(GUID* pguidJobID)

get_JobID メソッドは、ジョブの識別子を取得するために使用します。

pguidJobID

GUID*

out

ジョブを一意に識別する GUID。

戻り値

このメソッドは、次の HRESULT 値のほか、その他の値を返します。

戻り値	説明
S_OK	ジョブを識別する GUID を正常に取得しました。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IBackgroundCopyJob1 "{59F5553C-2031-4629-BB18-2645A6970947}"
#usecom global IBackgroundCopyJob1 IID_IBackgroundCopyJob1 "{}"
#comfunc global IBackgroundCopyJob1_CancelJob           3
#comfunc global IBackgroundCopyJob1_GetProgress         4 int,var
#comfunc global IBackgroundCopyJob1_GetStatus           5 var,var,var,var
#comfunc global IBackgroundCopyJob1_AddFiles            6 int,var
#comfunc global IBackgroundCopyJob1_GetFile             7 int,var
#comfunc global IBackgroundCopyJob1_GetFileCount        8 var
#comfunc global IBackgroundCopyJob1_SwitchToForeground  9
#comfunc global IBackgroundCopyJob1_get_JobID           10 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IBackgroundCopyJob1 "{59F5553C-2031-4629-BB18-2645A6970947}"
#usecom global IBackgroundCopyJob1 IID_IBackgroundCopyJob1 "{}"
#comfunc global IBackgroundCopyJob1_CancelJob           3
#comfunc global IBackgroundCopyJob1_GetProgress         4 int,sptr
#comfunc global IBackgroundCopyJob1_GetStatus           5 sptr,sptr,sptr,sptr
#comfunc global IBackgroundCopyJob1_AddFiles            6 int,sptr
#comfunc global IBackgroundCopyJob1_GetFile             7 int,sptr
#comfunc global IBackgroundCopyJob1_GetFileCount        8 sptr
#comfunc global IBackgroundCopyJob1_SwitchToForeground  9
#comfunc global IBackgroundCopyJob1_get_JobID           10 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。