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 專業版 [僅限傳統型應用程式] |
最低支援的伺服器 | Windows 2000 Server [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | shellapi.h |
程式庫 | Shell32.lib |
Dll | Shell32.dll (5.0 版或更新版本) |