Метод IOfflineFilesCache::D eleteItemsForUser (cscobj.h)

Удаляет файлы и каталоги пользователя из локального кэша. Удаление элемента контейнера подразумевает рекурсивное удаление всех содержащихся в нем элементов.

Синтаксис

HRESULT DeleteItemsForUser(
  [in] LPCWSTR                     pszUser,
  [in] LPCWSTR                     *rgpszPaths,
  [in] ULONG                       cPaths,
  [in] DWORD                       dwFlags,
  [in] BOOL                        bAsync,
  [in] IOfflineFilesSimpleProgress *pIProgress
);

Параметры

[in] pszUser

Текстовая строка, определяющая пользователя, для которого нужно удалить файлы. Этот параметр доступен только администраторам на локальном компьютере. Текстовая строка может быть идентификатором безопасности пользователя в строковом формате или строкой домен\ имя входа пользователя.

[in] rgpszPaths

Массив указателей на полный UNC-путь к удаляемом файлу или каталогу.

[in] cPaths

Количество путей в rgpszPaths.

[in] dwFlags

Флаги, управляющие поведением операции удаления. Этот параметр может быть одним или несколькими из следующих значений.

OFFLINEFILES_DELETE_FLAG_NOAUTOCACHED (0x00000001)

Не удаляйте автоматически кэшированные элементы. Поведение по умолчанию — автоматическое удаление кэшированных элементов.

OFFLINEFILES_DELETE_FLAG_NOPINNED (0x00000002)

Не удаляйте закрепленные элементы. Поведение по умолчанию — удаление закрепленных элементов.

OFFLINEFILES_DELETE_FLAG_DELMODIFIED (0x00000004)

Удаление, даже если локально изменено в кэше. Поведение по умолчанию — не удалять файлы с несинхронизированными локальными изменениями.

OFFLINEFILES_DELETE_FLAG_ADMIN (0x80000000)

Позволяет администраторам перечислять и удалять все файлы независимо от прав доступа. Если этот флаг установлен, а вызывающий объект не является администратором, функция завершается ошибкой.

[in] bAsync

Указывает, должна ли операция выполняться асинхронно. Если этот параметр имеет значение TRUE, операция планируется для асинхронной операции, и функция возвращается немедленно. Если этот параметр имеет значение FALSE, функция возвращается после завершения операции.

[in] pIProgress

Интерфейс с приемником событий, который будет получать события хода выполнения во время операции. Если события не нужны, этот параметр может иметь значение NULL. Настоятельно рекомендуется предоставлять приемник событий для асинхронных операций. Реализация хода выполнения — единственный способ получать уведомления о завершении асинхронной операции.

Возвращаемое значение

Возвращает S_OK в случае успешного выполнения или значение ошибки в противном случае.

Возвращает значение HRESULT_FROM_WIN32(ERROR_CANCELLED) , если операция отменена. Возвращает значение HRESULT_FROM_WIN32(ERROR_MORE_DATA) , если во время операции произошли ошибки. Используйте метод обратного вызова IOfflineFilesSimpleProgress::ItemResult для обнаружения ошибок по мере их возникновения.

Комментарии

Вызывающий объект должен иметь достаточный доступ к файлам и каталогам для удаления.

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

Если операция удаления каталога не может удалить все содержащиеся в нем файлы или каталоги (например, если доступ запрещен), указанная запись каталога не удаляется. Все файлы и каталоги, удаленные до этого момента, остаются удаленными.

Файлы удаляются только из локального кэша. Связанные файлы на сетевом сервере не затрагиваются.

Удаленные файлы невозможно восстановить через корзину. Удаленные файлы должны быть удалены, чтобы они были доступны в автономном режиме.

Если в параметре rgpszPaths указан только один путь и этот путь относится к одному файлу, возвращаемое значение указывает на результат одной операции удаления. В противном случае вызывающий объект должен реализовать методы обратного вызова хода выполнения в следующем списке и отслеживать метод IOfflineFilesSimpleProgress::ItemResult , чтобы получить результат для каждого обработанного файла и каталога.

Интерфейс событий хода выполнения	Метод	Описание
IOfflineFilesProgress	Начать	Вызывается в начале операции.
IOfflineFilesSyncProgress	SyncItemBegin	Вызывается в начале обработки для каждого файла.
IOfflineFilesSyncProgress	SyncItemResult	Вызывается после удаления каждого файла.
IOfflineFilesProgress	QueryAbort	Периодически вызывается во время операции синхронизации для обнаружения запроса на отмену.
IOfflineFilesProgress	END	Вызывается в конце операции.

Требования

Минимальная версия клиента	Windows Vista
Минимальная версия сервера	Windows Server 2008
Целевая платформа	Windows
Header	cscobj.h
DLL	CscSvc.dll; CscObj.dll

См. также раздел

IOfflineFilesCache