Win32 API 日本語リファレンス
ホーム › Networking.BackgroundIntelligentTransferService › IBackgroundCopyGroup

IBackgroundCopyGroup

COM
📘 Microsoft Learn (日本語) · English
IID1ded80a7-53ea-424f-8a04-17fea9adc4f5継承元IUnknown自前メソッド開始 vtbl3

メソッド 15

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

vtbl 3 HRESULT GetProp(GROUPPROP propID, VARIANT* pvarVal)
propIDGROUPPROPin取得対象のグループプロパティを識別するGROUPPROP列挙値。
pvarValVARIANT*out取得したプロパティ値を受け取るVARIANTポインタ。
vtbl 4 HRESULT SetProp(GROUPPROP propID, VARIANT* pvarVal)
propIDGROUPPROPin設定対象のグループプロパティを識別するGROUPPROP列挙値。
pvarValVARIANT*in設定する値を保持するVARIANTポインタ。
vtbl 5 HRESULT GetProgress(DWORD dwFlags, DWORD* pdwProgress)
dwFlagsDWORDin取得する進捗情報の種類を指定するフラグ。
pdwProgressDWORD*outグループの進捗状況を受け取る出力ポインタ。
vtbl 6 HRESULT GetStatus(DWORD* pdwStatus, DWORD* pdwJobIndex)
pdwStatusDWORD*outグループの現在の状態コードを受け取る出力ポインタ。
pdwJobIndexDWORD*out状態に関連するジョブのインデックスを受け取る出力ポインタ。
vtbl 7 HRESULT GetJob(GUID jobID, IBackgroundCopyJob1** ppJob)
jobIDGUIDin取得するジョブを識別するGUID。
ppJobIBackgroundCopyJob1**out指定IDのジョブを表すIBackgroundCopyJob1インターフェイスを受け取る出力ポインタ。
vtbl 8 HRESULT SuspendGroup()
vtbl 9 HRESULT ResumeGroup()
vtbl 10 HRESULT CancelGroup()
vtbl 11 HRESULT get_Size(DWORD* pdwSize)
pdwSizeDWORD*outグループに含まれるジョブ数を受け取る出力ポインタ。
vtbl 12 HRESULT get_GroupID(GUID* pguidGroupID)
pguidGroupIDGUID*outグループを一意に識別するGUIDを受け取る出力ポインタ。
vtbl 13 HRESULT CreateJob(GUID guidJobID, IBackgroundCopyJob1** ppJob)
guidJobIDGUIDin新規ジョブに割り当てるGUID。
ppJobIBackgroundCopyJob1**out生成されたIBackgroundCopyJob1インターフェイスを受け取る出力ポインタ。
vtbl 14 HRESULT EnumJobs(DWORD dwFlags, IEnumBackgroundCopyJobs1** ppEnumJobs)
dwFlagsDWORDin列挙対象を絞り込むためのフラグ。
ppEnumJobsIEnumBackgroundCopyJobs1**outジョブを列挙するIEnumBackgroundCopyJobs1インターフェイスを受け取る出力ポインタ。
vtbl 15 HRESULT SwitchToForeground()
vtbl 16 HRESULT QueryNewJobInterface(GUID* iid, IUnknown** pUnk)
iidGUID*in新しいジョブインターフェイスの識別子(IID)へのポインタ。
pUnkIUnknown**out要求したインターフェイスを実装するオブジェクトを受け取る出力ポインタ。
vtbl 17 HRESULT SetNotificationPointer(GUID* iid, IUnknown* pUnk)
iidGUID*in通知コールバックインターフェイスの識別子(IID)へのポインタ。
pUnkIUnknown*in通知を受け取るコールバックオブジェクトのIUnknownポインタ。NULLで解除可能。

HSP用 COM定義

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

出力引数: 
#define global IID_IBackgroundCopyGroup "{1DED80A7-53EA-424F-8A04-17FEA9ADC4F5}"
#usecom global IBackgroundCopyGroup IID_IBackgroundCopyGroup "{}"
#comfunc global IBackgroundCopyGroup_GetProp                 3 int,var
#comfunc global IBackgroundCopyGroup_SetProp                 4 int,var
#comfunc global IBackgroundCopyGroup_GetProgress             5 int,var
#comfunc global IBackgroundCopyGroup_GetStatus               6 var,var
#comfunc global IBackgroundCopyGroup_GetJob                  7 int,sptr
#comfunc global IBackgroundCopyGroup_SuspendGroup            8
#comfunc global IBackgroundCopyGroup_ResumeGroup             9
#comfunc global IBackgroundCopyGroup_CancelGroup             10
#comfunc global IBackgroundCopyGroup_get_Size                11 var
#comfunc global IBackgroundCopyGroup_get_GroupID             12 var
#comfunc global IBackgroundCopyGroup_CreateJob               13 int,sptr
#comfunc global IBackgroundCopyGroup_EnumJobs                14 int,sptr
#comfunc global IBackgroundCopyGroup_SwitchToForeground      15
#comfunc global IBackgroundCopyGroup_QueryNewJobInterface    16 var,sptr
#comfunc global IBackgroundCopyGroup_SetNotificationPointer  17 var,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。