Функция SHIsFileAvailableOffline (shellapi.h)

Статья
08/26/2023

Определяет, доступны ли файл или папка для автономного использования. Эта функция также определяет, будет ли файл открыт из сети, из локального кэша автономных файлов или из обоих расположений.

Синтаксис

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

Эта функция может возвращать одно из этих значений.

Код возврата	Описание
S_OK	Файл или каталог кэшируется. Он доступен в автономном режиме, если не задано OFFLINE_STATUS_INCOMPLETE .
E_INVALIDARG	Недопустимый путь или не является сетевым путем. Файл или каталог не кэшируются.
E_FAIL	Файл или каталог не кэшируются.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	shellapi.h
Библиотека	Shell32.lib
DLL	Shell32.dll (версия 5.0 или более поздняя)

Поделиться через