ホーム › Networking.BackgroundIntelligentTransferService › IBackgroundCopyJob4

IBackgroundCopyJob4

COM

📘 Microsoft Learn (日本語) · English

IID659cdeae-489e-11d9-a9cd-000d56965251継承元IBackgroundCopyJob3自前メソッド開始 vtbl47

公式ドキュメント

このインターフェイスは、ピアキャッシュの有効化、ダウンロード時間の制限、およびユーザートークンの特性の確認に使用します。

メソッド 6

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

vtbl 47 HRESULT SetPeerCachingFlags(DWORD Flags)

ジョブのファイルをキャッシュしてピアに提供できるかどうか、およびジョブがピアからコンテンツをダウンロードできるかどうかを決定するフラグを設定します。

Flags

DWORD

ジョブのファイルをキャッシュしてピアに提供できるかどうか、およびジョブがピアからコンテンツをダウンロードできるかどうかを決定するフラグ。設定できるフラグは次のとおりです。

値

意味

BG_JOB_ENABLE_PEERCACHING_CLIENT
0x0001

ジョブはピアからコンテンツをダウンロードできます。

クライアントコンピューターとジョブの両方が Background Intelligent Transfer Service (BITS) によるピアからのファイルのダウンロードを許可していない限り、ジョブはピアからダウンロードしません。クライアントコンピューターがピアからファイルをダウンロードできるようにするには、EnablePeerCaching グループポリシーを設定するか、IBitsPeerCacheAdministration::SetConfigurationFlags メソッドを呼び出して BG_ENABLE_PEERCACHING_CLIENT フラグを設定します。

次のいずれかの状況が発生すると、BITS はダウンロードを停止し、ジョブとキャッシュの設定値に応じて、ピアまたは配信元サーバーのいずれかからの転送を開始するようジョブを再スケジュールします。

キャッシュ側のこの値が TRUE で、ジョブ側の値が TRUE と FALSE の間で切り替わった場合。
ジョブのプロパティのこの値が TRUE で、キャッシュ側の値が TRUE と FALSE の間で切り替わった場合。

その後、ダウンロードは BITS がジョブを停止する前の位置から再開されます。BITS 4.0: このフラグは非推奨です。

BG_JOB_ENABLE_PEERCACHING_SERVER
0x0002

ジョブのファイルをキャッシュしてピアに提供できます。

クライアントコンピューターとジョブの両方が BITS によるファイルのキャッシュと提供を許可していない限り、BITS はファイルをキャッシュしてピアに提供しません。クライアントコンピューター上で BITS がファイルをキャッシュして提供できるようにするには、EnablePeerCaching グループポリシーを設定するか、IBitsPeerCacheAdministration::SetConfigurationFlags メソッドを呼び出して BG_ENABLE_PEERCACHING_SERVER フラグを設定します。BITS 4.0: このフラグは非推奨です。

BG_JOB_DISABLE_BRANCH_CACHE
0x0004

BITS は転送ジョブに Windows BranchCache を使用しません。この設定は、BITS 以外のアプリケーションによる Windows BranchCache の使用には影響しません。

戻り値

このメソッドは次の値を返します。

戻り値	説明
S_OK	成功しました。

解説(Remarks)

これらのフラグの設定は、EnablePeerCaching グループポリシーの設定、または IBitsPeerCacheAdministration::SetConfigurationFlags の呼び出しによってピアキャッシュが有効になっている場合にのみ意味を持ちます。

vtbl 48 HRESULT GetPeerCachingFlags(DWORD* pFlags)

ジョブのファイルをキャッシュしてピアに提供できるかどうか、および BITS がジョブのコンテンツをピアからダウンロードできるかどうかを決定するフラグを取得します。

pFlags

DWORD*

out

ジョブのファイルをキャッシュしてピアに提供できるかどうか、および BITS がジョブのコンテンツをピアからダウンロードできるかどうかを決定するフラグ。設定できるフラグは次のとおりです。

値	意味
BG_JOB_ENABLE_PEERCACHING_CLIENT 0x0001	ジョブはピアからコンテンツをダウンロードできます。
BG_JOB_ENABLE_PEERCACHING_SERVER 0x0002	ジョブのファイルをキャッシュしてピアに提供できます。

戻り値

このメソッドは次の値を返します。

戻り値	説明
S_OK	成功しました。
E_NOTIMPL	その他のフラグ値が設定されている場合。

解説(Remarks)

BITS がピアからダウンロードできるのは、コンピューターレベルとジョブレベルの両方でピアキャッシュが有効になっている場合のみです。この API はジョブレベルにのみ影響します。詳細については、IBackgroundCopyJob4::SetPeerCachingFlags を参照してください。

vtbl 49 HRESULT GetOwnerIntegrityLevel(DWORD* pLevel)

ジョブを作成した、またはジョブの所有権を取得した所有者のトークンの整合性レベルを取得します。

pLevel

DWORD*

out

ジョブを作成した、またはジョブの所有権を取得した所有者のトークンの整合性レベル。

戻り値

このメソッドは次の値を返します。

戻り値	説明
S_OK	成功しました。

解説(Remarks)

ユーザーのトークンの整合性レベルがジョブに与える影響の詳細については、User Account Control and BITS を参照してください。

このメソッドは、GetSidSubAuthority 関数が返す値を返します。設定可能な必須整合性 RID の値については、セキュリティのドキュメントの Well-known SIDs を参照してください。

vtbl 50 HRESULT GetOwnerElevationState(BOOL* pElevated)

ジョブを作成した時点、またはジョブの所有権を取得した時点で、所有者のトークンが昇格されていたかどうかを示す値を取得します。

pElevated

BOOL*

out

ジョブを作成した時点、またはジョブの所有権を取得した時点で所有者のトークンが昇格されていた場合は TRUE、そうでない場合は FALSE になります。

戻り値

このメソッドは次の値を返します。

戻り値	説明
S_OK	成功しました。

解説(Remarks)

昇格されたトークンの詳細については、User Account Control and BITS を参照してください。

ジョブが昇格されたトークンで作成された場合、そのジョブに対する以降のすべての更新も昇格されたトークンで行う必要がある点に注意してください。

vtbl 51 HRESULT SetMaximumDownloadTime(DWORD Timeout)

BITS がジョブ内のファイルの転送に費やす最大時間を設定します。

Timeout

DWORD

BITS がジョブ内のファイルの転送に費やす最大時間 (秒単位)。既定値は 7,776,000 秒 (90 日) です。

戻り値

このメソッドは次の値を返します。

戻り値	説明
S_OK	成功しました。

解説(Remarks)

この値は、ジョブが CONNECTING 状態または TRANSFERRING 状態で費やすことのできる最大経過時間です。QUEUED 状態または TRANSIENT_ERROR 状態で費やされた時間は、タイムアウト値には加算されません。転送時間がタイムアウト値を超えると、ジョブはエラーコード BG_E_MAXDOWNLOAD_TIMEOUT の致命的エラー状態になります。

BITS がジョブのデータを転送している間にコンピューターがスリープした場合、データが転送されていなくてもスリープに費やされた時間はタイムアウトに加算される点に注意してください。

IBackgroundCopyJob::Resume メソッドを呼び出すと、経過時間はリセットされます。

このメソッドは MaxDownloadTime グループポリシーを上書きします。

vtbl 52 HRESULT GetMaximumDownloadTime(DWORD* pTimeout)

BITS がジョブ内のファイルの転送に費やす最大時間を取得します。

pTimeout

DWORD*

out

BITS がジョブ内のファイルの転送に費やす最大時間 (秒単位)。

戻り値

このメソッドは次の値を返します。

戻り値	説明
S_OK	成功しました。

解説(Remarks)

この値は、ジョブが CONNECTING 状態または TRANSFERRING 状態で費やすことのできる最大経過時間です。QUEUED 状態または TRANSIENT_ERROR 状態で費やされた時間は、タイムアウト値には加算されません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IBackgroundCopyJob4 "{659CDEAE-489E-11D9-A9CD-000D56965251}"
#usecom global IBackgroundCopyJob4 IID_IBackgroundCopyJob4 "{}"
#comfunc global IBackgroundCopyJob4_SetPeerCachingFlags     47 int
#comfunc global IBackgroundCopyJob4_GetPeerCachingFlags     48 var
#comfunc global IBackgroundCopyJob4_GetOwnerIntegrityLevel  49 var
#comfunc global IBackgroundCopyJob4_GetOwnerElevationState  50 var
#comfunc global IBackgroundCopyJob4_SetMaximumDownloadTime  51 int
#comfunc global IBackgroundCopyJob4_GetMaximumDownloadTime  52 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IBackgroundCopyJob4 "{659CDEAE-489E-11D9-A9CD-000D56965251}"
#usecom global IBackgroundCopyJob4 IID_IBackgroundCopyJob4 "{}"
#comfunc global IBackgroundCopyJob4_SetPeerCachingFlags     47 int
#comfunc global IBackgroundCopyJob4_GetPeerCachingFlags     48 sptr
#comfunc global IBackgroundCopyJob4_GetOwnerIntegrityLevel  49 sptr
#comfunc global IBackgroundCopyJob4_GetOwnerElevationState  50 sptr
#comfunc global IBackgroundCopyJob4_SetMaximumDownloadTime  51 int
#comfunc global IBackgroundCopyJob4_GetMaximumDownloadTime  52 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。