SHIsFileAvailableOffline 函数 (shellapi.h)
确定文件或文件夹是否可供脱机使用。 此函数还确定是从网络、本地脱机文件缓存还是从这两个位置打开文件。
语法
SHSTDAPI SHIsFileAvailableOffline(
[in] PCWSTR pwszPath,
[out, optional] DWORD *pdwStatus
);
参数
[in] pwszPath
类型: PCWSTR
指向指定网络文件或目录的完整路径的字符串值的指针。 此路径不需要采用 UNC 格式。 如果 pszPath 不是网络路径,则函数返回E_INVALIDARG。
[out, optional] pdwStatus
类型: LPDWORD
指向 类型为 DWORD 的变量的指针,如果函数成功,该变量将接收以下一个或多个标志。
OFFLINE_STATUS_LOCAL (0x01)
如果文件处于打开状态,它将在缓存中打开。
OFFLINE_STATUS_REMOTE (0x02)
如果文件处于打开状态,则它在服务器上打开。
OFFLINE_STATUS_INCOMPLETE (0x04)
本地副本当前不完整。 在同步文件之前,无法在脱机模式下打开该文件。
返回值
类型: HRESULT
此函数可以返回其中一个值。
返回代码 | 说明 |
---|---|
|
缓存文件或目录。 除非设置了 OFFLINE_STATUS_INCOMPLETE ,否则它处于脱机状态。 |
|
路径无效或不是网络路径。 未缓存文件或目录。 |
|
未缓存文件或目录。 |
注解
如果 pszPath 是目录, 则 SHIsFileAvailableOffline 不会返回 OFFLINE_STATUS_INCOMPLETE 标志。
如果 SHIsFileAvailableOffline 同时返回 OFFLINE_STATUS_LOCAL 和 OFFLINE_STATUS_REMOTE,则文件或目录在这两个位置均处于打开状态。 当服务器处于联机状态时,这种情况很常见。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows 2000 Professional [仅限桌面应用] |
最低受支持的服务器 | Windows 2000 Server [仅限桌面应用] |
目标平台 | Windows |
标头 | shellapi.h |
Library | Shell32.lib |
DLL | Shell32.dll (5.0 或更高版本) |