脱机文件

脱机文件技术概述。

若要开发脱机文件，需要以下标头：

• 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 报告发往此事件接收器的一个或多个事件已丢失，并且不会传递。
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 返回一个类型代码，用于标识项的类型：_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 确定在脱机工作时是否修改了项的一个或多个属性。
IsLocallyModifiedData 确定脱机工作时是否修改了项的数据。
IsLocallyModifiedTime 确定在脱机工作时是否修改了项的一个或多个时间值。
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 报告脱机文件服务检测到由组策略控制的一个或多个设置值的更改。
PreferenceChangeDetected 报告脱机文件服务检测到一个或多个不受组策略控制的设置值的更改。
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 报告同步特定文件的结果。
同步 将脱机文件缓存中的文件和目录与适用的网络共享文件夹中的相应副本同步。
SyncItemBegin 报告正在开始对项执行同步操作。
SyncItemResult 报告在同步操作期间已处理项。
TransitionOffline 如果可能，将项目脱机转换。
TransitionOnline 如果可能，联机转换项。
TransparentCacheItemNotify 报告已对透明缓存的项执行操作。
Unpin 从脱机文件缓存中取消固定文件、目录和网络共享文件夹。

接口

IEnumOfflineFilesItems 表示 IOfflineFilesItem 接口指针的集合。
IEnumOfflineFilesSettings 枚举与脱机文件服务关联的设置对象。
IOfflineFilesCache 用于管理脱机文件缓存。
IOfflineFilesCache2 实现 RenameItemEx 方法。
IOfflineFilesChangeInfo 表示与脱机工作时对项进行的本地更改相关的信息。
IOfflineFilesConnectionInfo 显示与脱机文件的联机-脱机转换行为关联的查询和操作功能。
IOfflineFilesDirectoryItem 表示脱机文件缓存中的目录项。
IOfflineFilesDirtyInfo 表示有关脱机文件缓存中未同步 (“脏”) 文件的信息。
IOfflineFilesErrorInfo 提供与错误关联的文本说明和原始数据块。
IOfflineFilesEvents 用于报告与脱机文件关联的重大事件。
IOfflineFilesEvents2 用于报告与脱机文件关联的其他事件。
IOfflineFilesEvents3 用于报告与透明缓存项关联的事件。
IOfflineFilesEventsFilter 为已发布事件的接收者提供一种机制，以限制他们接收的事件实例数。
IOfflineFilesFileItem 表示脱机文件缓存中的文件项。
IOfflineFilesFileSysInfo 表示与脱机文件缓存中的文件系统项关联的标准信息。
IOfflineFilesGhostInfo 表示脱机文件缓存中项的重影状态。
IOfflineFilesItem 表示脱机文件缓存中的单个项。
IOfflineFilesItemContainer 用于访问脱机文件缓存中的项枚举功能。
IOfflineFilesItemFilter 表示要应用于枚举的筛选器的实例。
IOfflineFilesPinInfo 表示脱机文件缓存中项的固定状态。
IOfflineFilesPinInfo2 定义一个方法，用于确定是否部分固定脱机文件缓存中的项。
IOfflineFilesProgress 用于向长时间脱机文件操作的调用方报告进度。 (IOfflineFilesProgress)
IOfflineFilesServerItem 表示脱机文件缓存中的服务器项。
IOfflineFilesSetting 表示一个设置，该设置控制脱机文件服务的行为。
IOfflineFilesShareInfo 提供有关缓存项的共享特定信息。
IOfflineFilesShareItem 表示脱机文件缓存中的共享项。
IOfflineFilesSimpleProgress 用于向长时间脱机文件操作的调用方报告进度。 (IOfflineFilesSimpleProgress)
IOfflineFilesSuspend 挂起或释放脱机文件缓存中的共享根树或目录树。
IOfflineFilesSuspendInfo 确定项是否挂起，如果是，则确定该项是否为挂起的根。
IOfflineFilesSyncConflictHandler 由调用 IOfflineFilesCache：：Synchronize 方法的客户端使用，在检测到同步冲突时规定冲突解决策略。
IOfflineFilesSyncErrorInfo 随 IOfflineFilesSyncProgress：：SyncItemResult 方法一起提供，用于传达遇到同步错误的项目的详细信息。
IOfflineFilesSyncErrorItemInfo 提供与同步错误关联的项的文件属性、时间信息和文件大小。
IOfflineFilesSyncProgress 用于在同步和同步相关操作期间向调用方报告进度。
IOfflineFilesTransparentCacheInfo 表示与透明缓存的项关联的信息。