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

IBitsPeerCacheRecord

COM
IID659cdeaf-489e-11d9-a9cd-000d56965251継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IBitsPeerCacheRecord は、キャッシュ内のファイルに関する情報を取得するために使用します。

メソッド 7

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

vtbl 3 HRESULT GetId(GUID* pVal)

キャッシュ内のレコードを一意に識別する識別子を取得します。

pValGUID*outキャッシュ内のレコードを一意に識別する識別子。

戻り値

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

戻り値 説明
S_OK
成功しました。
vtbl 4 HRESULT GetOriginUrl(LPWSTR* pVal)

キャッシュされたファイルの元の URL を取得します。

pValLPWSTR*outキャッシュされたファイルの元の URL を格納する null 終端文字列。使用後は CoTaskMemFree 関数を呼び出して ppOriginUrl を解放してください。

戻り値

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

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

解説(Remarks)

IBackgroundCopyJobHttpOptions::SetSecurityFlagsBG_HTTP_REDIRECT_POLICY_ALLOW_REPORT または BG_HTTP_REDIRECT_POLICY_DISALLOW に設定されている場合、この URL は BITS ジョブで元々指定された URL と異なることがあります。

vtbl 5 HRESULT GetFileSize(ULONGLONG* pVal)

ファイルのサイズを取得します。

pValULONGLONG*outファイルのサイズ (バイト単位)。

戻り値

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

戻り値 説明
S_OK
成功しました。
vtbl 6 HRESULT GetFileModificationTime(FILETIME* pVal)

サーバー上でファイルが最後に変更された日時を取得します。

pValFILETIME*outサーバー上でファイルが最後に変更された日時。時刻は FILETIME として指定されます。

戻り値

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

戻り値 説明
S_OK
成功しました。
vtbl 7 HRESULT GetLastAccessTime(FILETIME* pVal)

ファイルに最後にアクセスした日時を取得します。

pValFILETIME*outファイルに最後にアクセスした日時。時刻は FILETIME として指定されます。

戻り値

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

戻り値 説明
S_OK
成功しました。
vtbl 8 HRESULT IsFileValidated()

ファイルが検証済みかどうかを判定します。

戻り値

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

戻り値 説明
S_OK
ファイルは検証済みです。
S_FALSE
ファイルは検証されていません。

解説(Remarks)

ファイルを検証すると、そのファイルは提供可能になります。ファイルを検証するには、IBackgroundCopyFile3::SetValidationState メソッドを呼び出します。アプリケーションが SetValidationState を呼び出さずに IBackgroundCopyJob::Complete を呼び出した場合、ファイルは暗黙的に検証されます。検証後にファイルをキャッシュから削除するには、IBitsPeerCacheAdministration::DeleteUrl および IBitsPeerCacheAdministration::DeleteRecord を参照してください。

vtbl 9 HRESULT GetFileRanges(DWORD* pRangeCount, BG_FILE_RANGE** ppRanges)

キャッシュ内に存在するファイルの範囲を取得します。

pRangeCountDWORD*outppRanges の要素数。
ppRangesBG_FILE_RANGE**outキャッシュ内に存在するファイルの範囲を指定する BG_FILE_RANGE 構造体の配列。使用後は CoTaskMemFree 関数を呼び出して ppRanges を解放してください。

戻り値

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

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

解説(Remarks)

このメソッドは、常に少なくとも 1 つの範囲 (ファイル全体) を返します。アプリケーションが IBackgroundCopyJob3::AddFileWithRanges を呼び出してファイルの 1 つ以上の範囲をダウンロードした場合は、複数の範囲が返されることがあります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IBitsPeerCacheRecord "{659CDEAF-489E-11D9-A9CD-000D56965251}"
#usecom global IBitsPeerCacheRecord IID_IBitsPeerCacheRecord "{}"
#comfunc global IBitsPeerCacheRecord_GetId                    3 var
#comfunc global IBitsPeerCacheRecord_GetOriginUrl             4 var
#comfunc global IBitsPeerCacheRecord_GetFileSize              5 var
#comfunc global IBitsPeerCacheRecord_GetFileModificationTime  6 var
#comfunc global IBitsPeerCacheRecord_GetLastAccessTime        7 var
#comfunc global IBitsPeerCacheRecord_IsFileValidated          8
#comfunc global IBitsPeerCacheRecord_GetFileRanges            9 var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。