Win32 API 日本語リファレンス
ホーム › Storage.OfflineFiles › IOfflineFilesCache

IOfflineFilesCache

COM
📘 Microsoft Learn (日本語) · English
IID855d6203-7914-48b9-8d40-4c56f5acffc5継承元IUnknown自前メソッド開始 vtbl3

メソッド 17

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

vtbl 3 HRESULT Synchronize(HWND hwndParent, LPWSTR* rgpszPaths, DWORD cPaths, BOOL bAsync, DWORD dwSyncControl, IOfflineFilesSyncConflictHandler* pISyncConflictHandler, IOfflineFilesSyncProgress* pIProgress, GUID* pSyncId)
hwndParentHWNDinoptional進捗 UI を表示する際の親ウィンドウハンドルである。UI が不要な場合は NULL を指定できる。
rgpszPathsLPWSTR*in同期対象のパス文字列の配列である。
cPathsDWORDinrgpszPaths 配列に含まれるパスの数を指定する DWORD である。
bAsyncBOOLin非同期で同期処理を実行するかどうかを指定する BOOL である。
dwSyncControlDWORDin同期動作を制御するフラグを指定する DWORD である。
pISyncConflictHandlerIOfflineFilesSyncConflictHandler*inoptional同期中に発生した競合を処理する IOfflineFilesSyncConflictHandler へのポインタである。不要な場合は NULL を指定できる。
pIProgressIOfflineFilesSyncProgress*inoptional進捗通知を受け取る IOfflineFilesSyncProgress へのポインタである。不要な場合は NULL を指定できる。
pSyncIdGUID*inoptionalこの同期操作を識別する GUID を受け取るポインタである。不要な場合は NULL を指定できる。
vtbl 4 HRESULT DeleteItems(LPWSTR* rgpszPaths, DWORD cPaths, DWORD dwFlags, BOOL bAsync, IOfflineFilesSimpleProgress* pIProgress)
rgpszPathsLPWSTR*in削除対象のパス文字列の配列である。
cPathsDWORDinrgpszPaths 配列に含まれるパスの数を指定する DWORD である。
dwFlagsDWORDin削除動作を制御するフラグを指定する DWORD である。
bAsyncBOOLin非同期で削除処理を実行するかどうかを指定する BOOL である。
pIProgressIOfflineFilesSimpleProgress*inoptional進捗通知を受け取る IOfflineFilesSimpleProgress へのポインタである。不要な場合は NULL を指定できる。
vtbl 5 HRESULT DeleteItemsForUser(LPWSTR pszUser, LPWSTR* rgpszPaths, DWORD cPaths, DWORD dwFlags, BOOL bAsync, IOfflineFilesSimpleProgress* pIProgress)
pszUserLPWSTRin削除対象とするユーザーを指定する文字列である。
rgpszPathsLPWSTR*in削除対象のパス文字列の配列である。
cPathsDWORDinrgpszPaths 配列に含まれるパスの数を指定する DWORD である。
dwFlagsDWORDin削除動作を制御するフラグを指定する DWORD である。
bAsyncBOOLin非同期で削除処理を実行するかどうかを指定する BOOL である。
pIProgressIOfflineFilesSimpleProgress*inoptional進捗通知を受け取る IOfflineFilesSimpleProgress へのポインタである。不要な場合は NULL を指定できる。
vtbl 6 HRESULT Pin(HWND hwndParent, LPWSTR* rgpszPaths, DWORD cPaths, BOOL bDeep, BOOL bAsync, DWORD dwPinControlFlags, IOfflineFilesSyncProgress* pIProgress)
hwndParentHWNDinoptional進捗 UI を表示する際の親ウィンドウハンドルである。UI が不要な場合は NULL を指定できる。
rgpszPathsLPWSTR*inピン留め対象のパス文字列の配列である。
cPathsDWORDinrgpszPaths 配列に含まれるパスの数を指定する DWORD である。
bDeepBOOLinサブフォルダーを含めて再帰的にピン留めするかどうかを指定する BOOL である。
bAsyncBOOLin非同期でピン留め処理を実行するかどうかを指定する BOOL である。
dwPinControlFlagsDWORDinピン留め動作を制御するフラグを指定する DWORD である。
pIProgressIOfflineFilesSyncProgress*inoptional進捗通知を受け取る IOfflineFilesSyncProgress へのポインタである。不要な場合は NULL を指定できる。
vtbl 7 HRESULT Unpin(HWND hwndParent, LPWSTR* rgpszPaths, DWORD cPaths, BOOL bDeep, BOOL bAsync, DWORD dwPinControlFlags, IOfflineFilesSyncProgress* pIProgress)
hwndParentHWNDinoptional進捗 UI を表示する際の親ウィンドウハンドルである。UI が不要な場合は NULL を指定できる。
rgpszPathsLPWSTR*inピン留め解除対象のパス文字列の配列である。
cPathsDWORDinrgpszPaths 配列に含まれるパスの数を指定する DWORD である。
bDeepBOOLinサブフォルダーを含めて再帰的にピン留めを解除するかどうかを指定する BOOL である。
bAsyncBOOLin非同期でピン留め解除処理を実行するかどうかを指定する BOOL である。
dwPinControlFlagsDWORDinピン留め解除動作を制御するフラグを指定する DWORD である。
pIProgressIOfflineFilesSyncProgress*inoptional進捗通知を受け取る IOfflineFilesSyncProgress へのポインタである。不要な場合は NULL を指定できる。
vtbl 8 HRESULT GetEncryptionStatus(BOOL* pbEncrypted, BOOL* pbPartial)
pbEncryptedBOOL*outキャッシュが暗号化されているかどうかを受け取る BOOL へのポインタである。
pbPartialBOOL*outキャッシュが部分的にのみ暗号化されているかどうかを受け取る BOOL へのポインタである。
vtbl 9 HRESULT Encrypt(HWND hwndParent, BOOL bEncrypt, DWORD dwEncryptionControlFlags, BOOL bAsync, IOfflineFilesSyncProgress* pIProgress)
hwndParentHWNDinoptional進捗 UI を表示する際の親ウィンドウハンドルである。UI が不要な場合は NULL を指定できる。
bEncryptBOOLin暗号化するか(TRUE)復号するか(FALSE)を指定する BOOL である。
dwEncryptionControlFlagsDWORDin暗号化動作を制御するフラグを指定する DWORD である。
bAsyncBOOLin非同期で暗号化処理を実行するかどうかを指定する BOOL である。
pIProgressIOfflineFilesSyncProgress*inoptional進捗通知を受け取る IOfflineFilesSyncProgress へのポインタである。不要な場合は NULL を指定できる。
vtbl 10 HRESULT FindItem(LPWSTR pszPath, DWORD dwQueryFlags, IOfflineFilesItem** ppItem)
pszPathLPWSTRin検索対象とするキャッシュ項目のパスを指定する文字列である。
dwQueryFlagsDWORDinクエリ動作を制御するフラグを指定する DWORD である。
ppItemIOfflineFilesItem**out見つかった項目を表す IOfflineFilesItem を受け取るポインタのアドレスである。
vtbl 11 HRESULT FindItemEx(LPWSTR pszPath, IOfflineFilesItemFilter* pIncludeFileFilter, IOfflineFilesItemFilter* pIncludeDirFilter, IOfflineFilesItemFilter* pExcludeFileFilter, IOfflineFilesItemFilter* pExcludeDirFilter, DWORD dwQueryFlags, IOfflineFilesItem** ppItem)
pszPathLPWSTRin検索対象とするキャッシュ項目のパスを指定する文字列である。
pIncludeFileFilterIOfflineFilesItemFilter*inoptional対象に含めるファイルを指定する IOfflineFilesItemFilter へのポインタである。不要な場合は NULL を指定できる。
pIncludeDirFilterIOfflineFilesItemFilter*inoptional対象に含めるディレクトリを指定する IOfflineFilesItemFilter へのポインタである。不要な場合は NULL を指定できる。
pExcludeFileFilterIOfflineFilesItemFilter*inoptional対象から除外するファイルを指定する IOfflineFilesItemFilter へのポインタである。不要な場合は NULL を指定できる。
pExcludeDirFilterIOfflineFilesItemFilter*inoptional対象から除外するディレクトリを指定する IOfflineFilesItemFilter へのポインタである。不要な場合は NULL を指定できる。
dwQueryFlagsDWORDinクエリ動作を制御するフラグを指定する DWORD である。
ppItemIOfflineFilesItem**out見つかった項目を表す IOfflineFilesItem を受け取るポインタのアドレスである。
vtbl 12 HRESULT RenameItem(LPWSTR pszPathOriginal, LPWSTR pszPathNew, BOOL bReplaceIfExists)
pszPathOriginalLPWSTRin変更前の項目パスを指定する文字列である。
pszPathNewLPWSTRin変更後の新しい項目パスを指定する文字列である。
bReplaceIfExistsBOOLin変更先が既に存在する場合に上書きするかどうかを指定する BOOL である。
vtbl 13 HRESULT GetLocation(LPWSTR* ppszPath)
ppszPathLPWSTR*outオフラインファイルキャッシュの格納場所のパスを受け取る文字列ポインタのアドレスである。返された文字列は解放する。
vtbl 14 HRESULT GetDiskSpaceInformation(ULONGLONG* pcbVolumeTotal, ULONGLONG* pcbLimit, ULONGLONG* pcbUsed, ULONGLONG* pcbUnpinnedLimit, ULONGLONG* pcbUnpinnedUsed)
pcbVolumeTotalULONGLONG*outボリューム全体の総容量(バイト数)を受け取る ULONGLONG へのポインタである。
pcbLimitULONGLONG*outキャッシュ全体に許可された上限容量(バイト数)を受け取る ULONGLONG へのポインタである。
pcbUsedULONGLONG*outキャッシュで使用中の容量(バイト数)を受け取る ULONGLONG へのポインタである。
pcbUnpinnedLimitULONGLONG*outピン留めされていない項目に許可された上限容量(バイト数)を受け取る ULONGLONG へのポインタである。
pcbUnpinnedUsedULONGLONG*outピン留めされていない項目が使用中の容量(バイト数)を受け取る ULONGLONG へのポインタである。
vtbl 15 HRESULT SetDiskSpaceLimits(ULONGLONG cbLimit, ULONGLONG cbUnpinnedLimit)
cbLimitULONGLONGinキャッシュ全体に設定する上限容量(バイト数)を指定する ULONGLONG である。
cbUnpinnedLimitULONGLONGinピン留めされていない項目に設定する上限容量(バイト数)を指定する ULONGLONG である。
vtbl 16 HRESULT ProcessAdminPinPolicy(IOfflineFilesSyncProgress* pPinProgress, IOfflineFilesSyncProgress* pUnpinProgress)
pPinProgressIOfflineFilesSyncProgress*inoptional管理者ピン留めポリシー適用時のピン留め進捗を受け取る IOfflineFilesSyncProgress へのポインタである。不要な場合は NULL を指定できる。
pUnpinProgressIOfflineFilesSyncProgress*inoptional管理者ピン留めポリシー適用時のピン留め解除進捗を受け取る IOfflineFilesSyncProgress へのポインタである。不要な場合は NULL を指定できる。
vtbl 17 HRESULT GetSettingObject(LPWSTR pszSettingName, IOfflineFilesSetting** ppSetting)
pszSettingNameLPWSTRin取得する設定の名前を指定する文字列である。
ppSettingIOfflineFilesSetting**out取得した設定を表す IOfflineFilesSetting を受け取るポインタのアドレスである。
vtbl 18 HRESULT EnumSettingObjects(IEnumOfflineFilesSettings** ppEnum)
ppEnumIEnumOfflineFilesSettings**out設定オブジェクトを列挙する IEnumOfflineFilesSettings を受け取るポインタのアドレスである。
vtbl 19 HRESULT IsPathCacheable(LPWSTR pszPath, BOOL* pbCacheable, OFFLINEFILES_CACHING_MODE* pShareCachingMode)
pszPathLPWSTRinキャッシュ可能かどうかを判定する対象のパスを指定する文字列である。
pbCacheableBOOL*out指定パスがキャッシュ可能かどうかを受け取る BOOL へのポインタである。
pShareCachingModeOFFLINEFILES_CACHING_MODE*out対象共有のキャッシュモードを受け取る OFFLINEFILES_CACHING_MODE へのポインタである。

HSP用 COM定義

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

出力引数: 
#define global IID_IOfflineFilesCache "{855D6203-7914-48B9-8D40-4C56F5ACFFC5}"
#usecom global IOfflineFilesCache IID_IOfflineFilesCache "{48C6BE7C-3871-43CC-B46F-1449A1BB2FF3}"
#comfunc global IOfflineFilesCache_Synchronize              3 sptr,var,int,int,int,sptr,sptr,var
#comfunc global IOfflineFilesCache_DeleteItems              4 var,int,int,int,sptr
#comfunc global IOfflineFilesCache_DeleteItemsForUser       5 wstr,var,int,int,int,sptr
#comfunc global IOfflineFilesCache_Pin                      6 sptr,var,int,int,int,int,sptr
#comfunc global IOfflineFilesCache_Unpin                    7 sptr,var,int,int,int,int,sptr
#comfunc global IOfflineFilesCache_GetEncryptionStatus      8 var,var
#comfunc global IOfflineFilesCache_Encrypt                  9 sptr,int,int,int,sptr
#comfunc global IOfflineFilesCache_FindItem                 10 wstr,int,sptr
#comfunc global IOfflineFilesCache_FindItemEx               11 wstr,sptr,sptr,sptr,sptr,int,sptr
#comfunc global IOfflineFilesCache_RenameItem               12 wstr,wstr,int
#comfunc global IOfflineFilesCache_GetLocation              13 var
#comfunc global IOfflineFilesCache_GetDiskSpaceInformation  14 var,var,var,var,var
#comfunc global IOfflineFilesCache_SetDiskSpaceLimits       15 int64,int64
#comfunc global IOfflineFilesCache_ProcessAdminPinPolicy    16 sptr,sptr
#comfunc global IOfflineFilesCache_GetSettingObject         17 wstr,sptr
#comfunc global IOfflineFilesCache_EnumSettingObjects       18 sptr
#comfunc global IOfflineFilesCache_IsPathCacheable          19 wstr,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。