オフライン ファイル

オフライン ファイル テクノロジの概要。

オフライン ファイルを開発するには、次のヘッダーが必要です。

• cscapi.h
• cscobj.h

このテクノロジのプログラミング ガイダンスについては、次を参照してください。

• オフライン ファイル

列挙

OFFLINEFILES_CACHING_MODE IOfflineFilesCache::IsPathCacheable や IOfflineFilesShareInfo::GetShareCachingMode などのメソッドで使用されるキャッシュ モードについて説明します。
OFFLINEFILES_COMPARE IOfflineFilesItemFilter::GetTimeFilter メソッドで実行する比較の種類を指定します。
OFFLINEFILES_CONNECT_STATE オフライン ファイル キャッシュ内のアイテムの接続状態について説明します。
OFFLINEFILES_EVENTS イベント シンクによって受信または除外されるイベントを記述するイベント識別子コード。
OFFLINEFILES_ITEM_COPY 項目のローカル コピー、リモート コピー、または元のコピーを照会するかどうかを指定します。
OFFLINEFILES_ITEM_TIME キャッシュ項目に関連付けられている時間値を使用することを指定します。
OFFLINEFILES_ITEM_TYPE オフライン ファイル キャッシュ内のアイテムの種類を識別します。
OFFLINEFILES_OFFLINE_REASON アイテムがオフラインになっている理由を示します。
OFFLINEFILES_OP_RESPONSE アイテムの処理を続行、再試行、または停止するかどうかを指定します。
OFFLINEFILES_PATHFILTER_MATCH イベントがフィルターとどの程度一致する必要があるかを指定します。
OFFLINEFILES_SETTING_VALUE_TYPE IOfflineFilesSetting::GetValueType メソッドによって返されるデータ型を識別します。
OFFLINEFILES_SYNC_CONFLICT_RESOLVE IOfflineFilesSyncConflictHandler::ResolveConflict メソッドによって返される競合解決コードを識別します。
OFFLINEFILES_SYNC_OPERATION 同期エラーが発生したときに実行されていた同期操作の種類を示します。
OFFLINEFILES_SYNC_STATE オフライン ファイル項目の同期状態について説明します。

関数

BackgroundSyncBegin オフライン ファイル サービスがバックグラウンド同期パスの実行を開始していることを報告します。
BackgroundSyncEnd オフライン ファイル サービスがバックグラウンド同期パスを完了したことを報告します。
開始 操作が開始されたことを報告します。
CacheEvictBegin このメソッドは将来使用するために予約されています。 (IOfflineFilesEvents2.CacheEvictBegin)
CacheEvictEnd このメソッドは将来使用するために予約されています。 (IOfflineFilesEvents2.CacheEvictEnd)
CacheIsCorrupted このメソッドは将来使用するために予約されています。 (IOfflineFilesEvents.CacheIsCorrupted)
CacheIsFull このメソッドは将来使用するために予約されています。 (IOfflineFilesEvents.CacheIsFull)
CacheMoved このメソッドは将来使用するために予約されています。 (IOfflineFilesEvents.CacheMoved)
複製 現在の列挙と同じ列挙状態の列挙子の新しいインスタンスを作成します。 (IEnumOfflineFilesItems.Clone)
複製 現在の列挙と同じ列挙状態の列挙子の新しいインスタンスを作成します。 (IEnumOfflineFilesSettings.Clone)
DataLost このイベント シンク宛ての 1 つ以上のイベントが失われ、配信されないことを報告します。
DeleteItems ローカル キャッシュからファイルとディレクトリを削除します。
DeleteItemsForUser ローカル キャッシュからユーザーのファイルとディレクトリを削除します。
DeletePreference 基本設定を削除します。
有効 このメソッドは将来使用するために予約されています。 (IOfflineFilesEvents.Enabled)
Encrypt 呼び出し元ユーザー用にキャッシュされたオフライン ファイル キャッシュの内容を暗号化または暗号化解除します。
EncryptionChanged このメソッドは将来使用するために予約されています。 (IOfflineFilesEvents.EncryptionChanged)
End 操作が終了したことを報告します。
EnumItems このメソッドを実装するキャッシュ項目の子項目の列挙子を返します。 (IOfflineFilesItemContainer.EnumItems)
EnumItemsEx このメソッドを実装するキャッシュ項目の子項目の列挙子を返します。 (IOfflineFilesItemContainer.EnumItemsEx)
EnumSettingObjects IOfflineFilesSetting のインスタンスの列挙子を作成します。
Finditem キャッシュ内の特定のファイルまたはディレクトリ項目を検索します。 (IOfflineFilesCache.FindItem)
FindItemEx キャッシュ内の特定のファイルまたはディレクトリ項目を検索します。 (IOfflineFilesCache.FindItemEx)
GetAttributes アイテムの Win32 属性を取得します。
GetConnectState アイテムがオンラインかオフラインか、オフラインの場合は理由を指定します。
GetDescription エラーを説明するテキスト文字列を取得します。
GetDiskSpaceInformation オフライン ファイル キャッシュで使用されるディスク領域の量と、キャッシュの使用量に適用される領域の制限を取得します。
GetEncryptionStatus オフライン ファイル キャッシュの現在の暗号化状態 (暗号化または暗号化されていない) を取得します。
GetExcludedEvents イベント シンクで受信しないイベントを記述するOFFLINEFILES_EVENTS列挙値の配列を取得します。
GetFileAttributes アイテムの Win32 ファイル属性を取得します。
GetFileSize 項目のサイズを取得します。
GetFileSize 項目のサイズをバイト単位で取得します。
GetFileTimes アイテムの最後の書き込みと変更時刻を取得します。
GetFilterFlags 項目のフラグ ベースのフィルター処理を制御するフラグを提供します。
GetIncludedEvents イベント シンクによって受信する必要があるイベントを記述するOFFLINEFILES_EVENTS列挙値の配列を取得します。
GetItemChangeFlags 同期エラーに関連付けられた同期操作中に発生した変更を示すフラグのセットを含む値を取得します。
GetItemType item:_server、共有、ディレクトリ、またはファイルの種類を識別する型コードを返します。
GetLocalInfo 同期に関係するアイテムのローカル コピーのファイル時刻、サイズ、属性を含む IOfflineFilesSyncErrorItemInfo インターフェイスのインスタンスを取得します。
GetLocation オフライン ファイル キャッシュの現在の完全修飾ディレクトリ パスを取得します。
GetName 特定のオフライン ファイル設定に関連付けられている名前を取得します。
GetOriginalInfo 同期に関係するアイテムの元のコピーのファイル時間、サイズ、属性を含む IOfflineFilesSyncErrorItemInfo インターフェイスのインスタンスを取得します。
GetParentItem アイテムの親の IOfflineFilesItem インターフェイスを取得します。
GetPath オフライン ファイル キャッシュ内のアイテムの完全修飾 UNC パス文字列を取得します。
GetPathFilter UNC パス文字列と、このイベント シンクに配信する必要があるパスベースのイベントを説明するスコープ インジケーターを取得します。
GetPatternFilter 項目名パターンに基づいて列挙項目を制限するフィルター パターン文字列を提供します。
GetPolicy 特定のオフライン ファイル設定に関連付けられているポリシーを取得します。
GetPolicyScope この設定に関連付けられているポリシーのスコープを取得します。
GetPreference 特定のオフライン ファイル設定に関連付けられているマシンごとまたはユーザーごとの基本設定を取得します。
GetPreferenceScope この設定に関連付けられている基本設定の範囲を示します。
GetRawData エラーに関連付けられた内部データを含むバイトブロックを取得します。
GetRemoteInfo 同期に関係するアイテムのリモート コピーのファイル時間、サイズ、および属性を含む IOfflineFilesSyncErrorItemInfo インターフェイスのインスタンスを取得します。
GetSettingObject 特定のオフライン ファイル設定を表す オブジェクトを作成します。
GetShareCachingMode アイテムに最も近い先祖共有のキャッシュ モード構成を取得します。
GetShareItem アイテムに最も近い先祖共有を表すキャッシュ アイテムを検索します。
GetSyncOperation エラーが発生したときに実行されていた同期操作の種類を示す値を取得します。
GetTimeFilter 時間と値の比較セマンティクスを提供し、時間に基づいて項目のフィルター処理を制御します。
GetTimes アイテムに関連付けられている時間値を取得します。
GetValue 特定のオフライン ファイル設定の値を取得します。
GetValueType 特定のオフライン ファイル設定のデータ型を取得します。
InfoAvailable 同期中に、項目のローカル コピー、リモート コピー、または元のコピーに関する情報が取得されたかどうかを示します。
InfoEnumerated 同期中に、項目のローカル コピー、リモート コピー、または元のコピーに対して情報のクエリが実行されたかどうかを示します。
IsCreatedOffline オフライン作業中にオフライン ファイル キャッシュにアイテムが作成されたかどうかを判断します。
IsDeletedOffline オフライン作業中にオフライン ファイル キャッシュからアイテムが削除されたかどうかを判断します。
IsDirty オフライン ファイル キャッシュ内の項目が変更されたかどうかを判断します。
IsEncrypted オフライン ファイル キャッシュ内の項目が暗号化されているかどうかを判断します。
IsGhosted アイテムがゴースト化されているかどうかを判断します。
IsLocallyModifiedAttributes オフライン作業中に 1 つ以上のアイテムの属性が変更されたかどうかを判断します。
IsLocallyModifiedData オフライン作業中にアイテムのデータが変更されたかどうかを判断します。
IsLocallyModifiedTime オフライン作業中に 1 つ以上のアイテムの時間値が変更されたかどうかを判断します。
IsMarkedForDeletion オフライン ファイル キャッシュからアイテムが削除されたかどうかを判断します。
IsPartlyPinned 項目が部分的に固定されているかどうかを判断します。
IsPathCacheable 指定した UNC パスがオフライン ファイル キャッシュ内にあるかどうかを判断します。
IsPinned アイテムがピン留めされているかどうかを判断します。
IsPinnedForComputer グループ ポリシーによって、コンピューター上のすべてのユーザーに対してアイテムがピン留めされたかどうかを判断します。
IsPinnedForFolderRedirection アイテムがフォルダー リダイレクトによってピン留めされたかどうかを判断します。
IsPinnedForUser アイテムがユーザーによってピン留めされたかどうかを判断します。
IsPinnedForUserByPolicy グループ ポリシーによってユーザーに対してアイテムがピン留めされたかどうかを判断します。
IsShareDfsJunction 共有アイテムが DFS ジャンクションか、サーバー上の共有フォルダーかを指定します。
IsSparse オフライン ファイル キャッシュ内の項目がまばらにキャッシュされているかどうかを判断します。
IsSuspended アイテムが中断されているかどうかを判断します。
IsTransparentlyCached アイテムが透過的にキャッシュされるかどうかを判断します。
ItemAddedToCache アイテムがオフライン ファイル キャッシュに追加されたことを報告します。
ItemAvailableOffline リモート コピーが使用できなくなった場合に、オフライン ファイル キャッシュ内のアイテムがオフラインで使用できるようになったことを報告します。
ItemBegin アイテムに対する操作が開始されていることを報告します。
ItemDeletedFromCache オフライン ファイル キャッシュからアイテムが削除されたことを報告します。
ItemDisconnected オフライン ファイル キャッシュ内のアイテムがオンラインからオフラインに切り替わったことを報告します。
ItemModified オフライン ファイル キャッシュ内のアイテムが変更されたことを報告します。
ItemNotAvailableOffline リモート コピーが使用できなくなった場合に、オフライン ファイル キャッシュ内のアイテムがオフラインで使用できなくなったことを報告します。
ItemNotPinned オフライン ファイル キャッシュ内のアイテムがピン留めされていないことを報告します。
ItemPinned オフライン ファイル キャッシュ内のアイテムがピン留めされ、リモート コピーが使用できなくなった場合にオフラインで使用できるようになったことを報告します。
ItemReconnectBegin オフライン ファイル サービスがすべてのオフライン スコープの再接続を試み始めていることを報告します。
ItemReconnected オフライン ファイル キャッシュ内のアイテムがオフラインからオンラインに切り替わったことを報告します。
ItemReconnectEnd オフライン ファイル サービスが、すべてのオフライン スコープの再接続の試行を完了したことを報告します。
ItemRenamed オフライン ファイル キャッシュ内のアイテムのパスの名前が変更されたことを報告します。
ItemResult 操作中にアイテムが処理されたことを報告します。
LocalDirtyByteCount ローカルのオフライン ファイル キャッシュ内の関連付けられたファイルの同期されていない ("ダーティ") データの量を取得します。
NetTransportArrived オフライン ファイル機能がネットワーク トランスポートの到着を検出したことを報告します。
次へ 列挙体の次の項目を取得し、列挙子を進めます。 (IEnumOfflineFilesItems.Next)
次へ 列挙体の次の項目を取得し、列挙子を進めます。 (IEnumOfflineFilesSettings.Next)
NoNetTransports オフライン ファイル機能で、使用可能なネットワーク トランスポートがないことを検出したことを報告します。
OfflineFilesEnable オフライン ファイル機能を有効または無効にします。
OfflineFilesQueryStatus オフライン ファイル機能を有効にするかどうか、有効になっている場合はアクティブかどうかを判断します。
OfflineFilesQueryStatusEx オフライン ファイル機能が有効になっているかどうかと、有効で使用可能かどうかを判断します。 この関数は OfflineFilesQueryStatus 関数と同じですが、出力パラメーターが追加されている点が除きます。
OfflineFilesStart オフライン ファイル サービスを開始します。
ピン留め ファイル、ディレクトリ、ネットワーク共有フォルダーをピン留めします。
ping このイベントは、登録されているすべてのイベント サブスクライバーに定期的に配信されます。
PolicyChangeDetected オフライン ファイル サービスが、グループ ポリシーによって制御される 1 つ以上の設定値の変更を検出したことを報告します。
PreferenceChangeDetected オフライン ファイル サービスが、グループ ポリシーによって制御されていない 1 つ以上の設定値の変更を検出したことを報告します。
PrefetchFileBegin ファイルプリフェッチ操作が開始されたことを報告します。
PrefetchFileEnd ファイルプリフェッチ操作が終了したことを報告します。
ProcessAdminPinPolicy "管理上割り当てられたオフライン ファイル" グループ ポリシーをオフライン ファイルで処理します。
QueryAbort 操作を取り消す必要があるかどうかを判断するために、長い操作中に呼び出される場合があります。
[更新] オフライン ファイル キャッシュから再読み込みすることで、オブジェクトにキャッシュされたデータを更新します。
RemoteDirtyByteCount このメソッドは将来使用するために予約されています。 (IOfflineFilesDirtyInfo.RemoteDirtyByteCount)
RenameItem キャッシュ内の項目の名前を変更します。
RenameItemEx キャッシュ内の項目の名前を変更します。 このメソッドは IOfflineFilesCache::RenameItem メソッドと同じですが、名前変更操作をすぐに実行しようとします。
リセット 列挙を先頭にリセットします。 (IEnumOfflineFilesItems.Reset)
リセット 列挙を先頭にリセットします。 (IEnumOfflineFilesSettings.Reset)
ResolveConflict 同期の競合に対する解決の決定を提供します。
SetConnectState 項目の接続状態を設定します。
SetDiskSpaceLimits オフライン ファイル キャッシュのディスク領域の使用制限を設定します。
SetPreference [オフライン ファイル] 設定に関連付けられているコンピューターごとまたはユーザーごとの基本設定を設定します。
SettingsChangesApplied オフライン ファイル サービスが、グループ ポリシーまたは基本設定の値で検出された変更を適用したことを報告します。
Skip 列挙体内の次に指定された数の要素をスキップします。 (IEnumOfflineFilesItems.Skip)
Skip 列挙体内の次に指定された数の要素をスキップします。 (IEnumOfflineFilesSettings.Skip)
SuspendRoot 共有ルートまたはディレクトリ ツリーを一時停止または解放します。
SyncBegin オフライン ファイル キャッシュが同期操作を開始したことを報告します。
SyncConflictRecAdded 同期の競合が検出され、同期競合ログに記録されたことを報告します。
SyncConflictRecRemoved 同期の競合が存在しなくなったことを報告し、そのレコードが同期競合ログから削除されたことを報告します。
SyncConflictRecUpdated 同期の競合が検出され、競合のレコードが同期競合ログに既に存在していることを報告します。
SyncEnd オフライン ファイル キャッシュが同期操作を終了したことを報告します。
SyncFileResult 特定のファイルを同期した結果を報告します。
Synchronize オフライン ファイル キャッシュ内のファイルとディレクトリを、該当するネットワーク共有フォルダー内の対応するコピーと同期します。
SyncItemBegin アイテムの同期操作が開始されていることを報告します。
SyncItemResult 同期操作中にアイテムが処理されたことを報告します。
TransitionOffline 可能であれば、項目をオフラインに切り替えます。
TransitionOnline 可能であれば、アイテムをオンラインに切り替える。
TransparentCacheItemNotify 透過的にキャッシュされたアイテムに対してアクションが実行されたことを報告します。
解除 オフライン ファイル キャッシュからファイル、ディレクトリ、ネットワーク共有フォルダーのピン留めを解除します。

インターフェイス

IEnumOfflineFilesItems IOfflineFilesItem インターフェイス ポインターのコレクションを表します。
IEnumOfflineFilesSettings オフライン ファイル サービスに関連付けられているオブジェクトの設定を列挙します。
IOfflineFilesCache オフライン ファイル キャッシュを管理するために使用されます。
IOfflineFilesCache2 RenameItemEx メソッドを実装します。
IOfflineFilesChangeInfo オフライン作業中にアイテムに対して行われたローカル変更に関連付けられている情報を表します。
IOfflineFilesConnectionInfo オフライン ファイルのオンラインとオフラインの切り替え動作に関連付けられているクエリとアクションの機能を示します。
IOfflineFilesDirectoryItem オフライン ファイル キャッシュ内のディレクトリ項目を表します。
IOfflineFilesDirtyInfo オフライン ファイル キャッシュ内の同期されていない ("ダーティ") ファイルに関する情報を表します。
IOfflineFilesErrorInfo エラーに関連付けられたテキストの説明と生データ ブロックを提供します。
IOfflineFilesEvents オフライン ファイルに関連付けられている重要なイベントを報告するために使用されます。
IOfflineFilesEvents2 オフライン ファイルに関連付けられている追加のイベントを報告するために使用します。
IOfflineFilesEvents3 透過的にキャッシュされたアイテムに関連付けられているイベントを報告するために使用されます。
IOfflineFilesEventsFilter パブリッシュされたイベントの受信者が受信するイベント インスタンスの数を制限するメカニズムを提供します。
IOfflineFilesFileItem オフライン ファイル キャッシュ内のファイル項目を表します。
IOfflineFilesFileSysInfo オフライン ファイル キャッシュ内のファイル システム項目に関連付けられている標準情報を表します。
IOfflineFilesGhostInfo オフライン ファイル キャッシュ内のアイテムのゴースト状態を表します。
IOfflineFilesItem オフライン ファイル キャッシュ内の 1 つの項目を表します。
IOfflineFilesItemContainer オフライン ファイル キャッシュ内の項目列挙機能にアクセスするために使用されます。
IOfflineFilesItemFilter 列挙に適用するフィルターのインスタンスを表します。
IOfflineFilesPinInfo オフライン ファイル キャッシュ内のアイテムのピン留めされた状態を表します。
IOfflineFilesPinInfo2 オフライン ファイル キャッシュ内の項目が部分的にピン留めされているかどうかを判断するメソッドを定義します。
IOfflineFilesProgress 長いオフライン ファイル操作の呼び出し元に進行状況を報告するために使用されます。 (IOfflineFilesProgress)
IOfflineFilesServerItem オフライン ファイル キャッシュ内のサーバー項目を表します。
IOfflineFilesSetting オフライン ファイル サービスの動作を制御する設定を表します。
IOfflineFilesShareInfo キャッシュされたアイテムに関する共有固有の情報を表示します。
IOfflineFilesShareItem オフライン ファイル キャッシュ内の共有アイテムを表します。
IOfflineFilesSimpleProgress 長いオフライン ファイル操作の呼び出し元に進行状況を報告するために使用されます。 (IOfflineFilesSimpleProgress)
IOfflineFilesSuspend オフライン ファイル キャッシュ内の共有ルートまたはディレクトリ ツリーを中断または解放します。
IOfflineFilesSuspendInfo アイテムが中断されているかどうかを判断し、中断されている場合はルートが中断されているかどうかを判断します。
IOfflineFilesSyncConflictHandler IOfflineFilesCache::Synchronize メソッドを呼び出すクライアントが、検出された同期競合の競合解決戦略を規定するために使用されます。
IOfflineFilesSyncErrorInfo 同期エラーが発生したアイテムの詳細を伝えるために、IOfflineFilesSyncProgress::SyncItemResult メソッドと共に提供されます。
IOfflineFilesSyncErrorItemInfo 同期エラーに関連付けられている項目のファイル属性、時刻情報、およびファイル サイズを提供します。
IOfflineFilesSyncProgress 同期および同期関連の操作中に、呼び出し元に進行状況を報告するために使用されます。
IOfflineFilesTransparentCacheInfo 透過的にキャッシュされたアイテムに関連付けられている情報を表します。