ホーム › Storage.OfflineFiles › IOfflineFilesPinInfo

IOfflineFilesPinInfo

COM

📘 Microsoft Learn (日本語) · English

IID5b2b0655-b3fd-497d-adeb-bd156bc8355b継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

オフラインファイルキャッシュ内の項目の固定(ピン留め)状態を表します。

メソッド 5

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

vtbl 3 HRESULT IsPinned(BOOL* pbPinned)

項目が固定(ピン留め)されているかどうかを判定します。

pbPinned

BOOL*

out

項目が何らかの理由で固定されている場合は TRUE を、それ以外の場合は FALSE を受け取ります。

戻り値

成功した場合は S_OK を返し、それ以外の場合はエラー値を返します。

解説(Remarks)

項目がオフラインファイルキャッシュ内で固定されている場合、その項目は自動的な削除(エビクション)から保護され、オフラインでの利用が保証されます。

vtbl 4 HRESULT IsPinnedForUser(BOOL* pbPinnedForUser, BOOL* pbInherit)

項目がユーザーによって固定されたかどうかを判定します。

pbPinnedForUser	BOOL*	out	項目がユーザーによって固定された場合は TRUE を、それ以外の場合は FALSE を受け取ります。
pbInherit	BOOL*	out	固定状態が新しい子項目に継承される場合は TRUE を、それ以外の場合は FALSE を受け取ります。

戻り値

成功した場合は S_OK を返し、それ以外の場合はエラー値を返します。

解説(Remarks)

このメソッドは、IOfflineFilesCache::Pin メソッドで使用される OFFLINEFILES_PIN_CONTROL_FLAG_FORUSER 固定制御フラグに対応します。

vtbl 5 HRESULT IsPinnedForUserByPolicy(BOOL* pbPinnedForUser, BOOL* pbInherit)

項目がグループポリシーによってユーザー向けに固定されたかどうかを判定します。

pbPinnedForUser	BOOL*	out	項目がグループポリシーによってユーザー向けに固定された場合は TRUE を、それ以外の場合は FALSE を受け取ります。
pbInherit	BOOL*	out	固定状態が新しい子項目に継承される場合は TRUE を、それ以外の場合は FALSE を受け取ります。

戻り値

成功した場合は S_OK を返し、それ以外の場合はエラー値を返します。

解説(Remarks)

このメソッドは、IOfflineFilesCache::Pin メソッドで使用される OFFLINEFILES_PIN_CONTROL_FLAG_FORUSER_POLICY 固定制御フラグに対応します。

vtbl 6 HRESULT IsPinnedForComputer(BOOL* pbPinnedForComputer, BOOL* pbInherit)

項目がグループポリシーによってコンピューター上のすべてのユーザー向けに固定されたかどうかを判定します。

pbPinnedForComputer	BOOL*	out	項目がグループポリシーによってユーザー向けに固定された場合は TRUE を、それ以外の場合は FALSE を受け取ります。
pbInherit	BOOL*	out	固定状態が新しい子項目に継承される場合は TRUE を、それ以外の場合は FALSE を受け取ります。

戻り値

成功した場合は S_OK を返し、それ以外の場合はエラー値を返します。

解説(Remarks)

このメソッドは、IOfflineFilesCache::Pin メソッドで使用される OFFLINEFILES_PIN_CONTROL_FLAG_FORALL 固定制御フラグに対応します。

vtbl 7 HRESULT IsPinnedForFolderRedirection(BOOL* pbPinnedForFolderRedirection, BOOL* pbInherit)

項目がフォルダーリダイレクトによって固定されたかどうかを判定します。

pbPinnedForFolderRedirection	BOOL*	out	項目がフォルダーリダイレクトによってユーザー向けに固定された場合は TRUE を、それ以外の場合は FALSE を受け取ります。
pbInherit	BOOL*	out	固定状態が新しい子項目に継承される場合は TRUE を、それ以外の場合は FALSE を受け取ります。

戻り値

成功した場合は S_OK を返し、それ以外の場合はエラー値を返します。

解説(Remarks)

このメソッドは、IOfflineFilesCache::Pin メソッドで使用される OFFLINEFILES_PIN_CONTROL_FLAG_FORREDIR 固定制御フラグに対応します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IOfflineFilesPinInfo "{5B2B0655-B3FD-497D-ADEB-BD156BC8355B}"
#usecom global IOfflineFilesPinInfo IID_IOfflineFilesPinInfo "{}"
#comfunc global IOfflineFilesPinInfo_IsPinned                      3 var
#comfunc global IOfflineFilesPinInfo_IsPinnedForUser               4 var,var
#comfunc global IOfflineFilesPinInfo_IsPinnedForUserByPolicy       5 var,var
#comfunc global IOfflineFilesPinInfo_IsPinnedForComputer           6 var,var
#comfunc global IOfflineFilesPinInfo_IsPinnedForFolderRedirection  7 var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IOfflineFilesPinInfo "{5B2B0655-B3FD-497D-ADEB-BD156BC8355B}"
#usecom global IOfflineFilesPinInfo IID_IOfflineFilesPinInfo "{}"
#comfunc global IOfflineFilesPinInfo_IsPinned                      3 sptr
#comfunc global IOfflineFilesPinInfo_IsPinnedForUser               4 sptr,sptr
#comfunc global IOfflineFilesPinInfo_IsPinnedForUserByPolicy       5 sptr,sptr
#comfunc global IOfflineFilesPinInfo_IsPinnedForComputer           6 sptr,sptr
#comfunc global IOfflineFilesPinInfo_IsPinnedForFolderRedirection  7 sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。