API облачного фильтра

Обзор технологии API облачного фильтра.

Для разработки API облачного фильтра вам потребуются следующие заголовки:

• cfapi.h

Рекомендации по программированию для этой технологии см. в следующих разделах:

• API облачного фильтра

Перечисления

CF_CALLBACK_CANCEL_FLAGS Флаги обратного вызова для отмены получения данных для файла заполнителя или папки.
CF_CALLBACK_CLOSE_COMPLETION_FLAGS Флаги обратного вызова для уведомления поставщика синхронизации о том, что заполнитель в одном из корней синхронизации, который ранее был открыт для доступа на чтение, запись и удаление, теперь закрыт.
CF_CALLBACK_DEHYDRATE_COMPLETION_FLAGS Флаг обратного вызова, информирующий поставщика синхронизации о том, что заполнитель в одном из корней синхронизации успешно обезвожен.
CF_CALLBACK_DEHYDRATE_FLAGS Флаги обратного вызова для уведомления поставщика синхронизации о том, что заполнитель в одном из корней синхронизации будет обезвожен.
CF_CALLBACK_DEHYDRATION_REASON Указывает причину обезвоженного облачного файла.
CF_CALLBACK_DELETE_COMPLETION_FLAGS Флаги обратного вызова для уведомления поставщика синхронизации об успешном удалении заполнителя.
CF_CALLBACK_DELETE_FLAGS Этот обратный вызов используется для информирования поставщика синхронизации о том, что файл заполнителя или каталог в одном из корней синхронизации будет удален или отменен.
CF_CALLBACK_FETCH_DATA_FLAGS Флаги обратного вызова для получения данных для файла заполнителя или папки.
CF_CALLBACK_FETCH_PLACEHOLDERS_FLAGS Флаги для получения сведений о содержимом файла заполнителя или каталога.
CF_CALLBACK_OPEN_COMPLETION_FLAGS Флаги обратного вызова для уведомления поставщика синхронизации о том, что заполнитель успешно открыт для доступа на чтение, запись и удаление.
CF_CALLBACK_RENAME_COMPLETION_FLAGS Флаг обратного вызова, информирующий поставщика синхронизации о том, что заполнитель в одном из корней синхронизации успешно переименован.
CF_CALLBACK_RENAME_FLAGS Флаги обратного вызова, чтобы сообщить поставщику синхронизации о том, что заполнитель в одном из корней синхронизации будет переименован или перемещен.
CF_CALLBACK_TYPE Содержит различные типы обратных вызовов, используемые в файлах заполнителей или папках.
CF_CALLBACK_VALIDATE_DATA_FLAGS Флаги для проверки данных файла заполнителя или каталога.
CF_CONNECT_FLAGS Дополнительные сведения, которые могут быть запрошены поставщиком синхронизации при вызове его обратных вызовов.
CF_CONVERT_FLAGS Обычные флаги преобразования файла или каталога в заполнитель или каталог.
CF_CREATE_FLAGS Флаги для создания файла заполнителя или каталога.
CF_DEHYDRATE_FLAGS Флаги дегидратации заполнителей.
CF_HARDLINK_POLICY Указывает, разрешены ли жесткие ссылки в файлах заполнителей.
CF_HYDRATE_FLAGS Флаги гидратации данных заполнителей.
CF_HYDRATION_POLICY_MODIFIER Позволяет поставщику синхронизации управлять тем, как файлы заполнителей должны быть увожены платформой. Это модификатор, который можно использовать с основной политикой:_CF_HYDRATION_POLICY_PRIMARY.
CF_HYDRATION_POLICY_PRIMARY Позволяет поставщику синхронизации управлять тем, как файлы заполнителей должны быть увожены платформой. Это основная политика.
CF_IN_SYNC_STATE Указывает состояние синхронизации для файлов-заполнителей и папок.
CF_INSYNC_POLICY Политика, позволяющая поставщику синхронизации управлять тем, когда платформа должна очищать состояние синхронизации в файле заполнителя или каталоге.
CF_OPEN_FILE_FLAGS Флаги для запроса различных разрешений на открытие файла.
CF_OPERATION_ACK_DATA_FLAGS Флаги для проверки и подтверждения данных для файла-заполнителя или папки.
CF_OPERATION_ACK_DEHYDRATE_FLAGS Флаги для подтверждения дегидратации файла заполнителя или каталога.
CF_OPERATION_ACK_DELETE_FLAGS Флаги для подтверждения удаления файла заполнителя или каталога.
CF_OPERATION_ACK_RENAME_FLAGS Флаги для подтверждения переименования файла заполнителя или каталога.
CF_OPERATION_RESTART_HYDRATION_FLAGS Флаги для перезапуска гидратации данных в файле заполнителя или папке.
CF_OPERATION_RETRIEVE_DATA_FLAGS Флаги для получения данных для файла-заполнителя или папки.
CF_OPERATION_TRANSFER_DATA_FLAGS Флаги для передачи данных для восстановления файла заполнителя или папки.
CF_OPERATION_TRANSFER_PLACEHOLDERS_FLAGS Флаги для указания поведения при передаче файла заполнителя или каталога.
CF_OPERATION_TYPE Типы операций, которые могут выполняться с файлами заполнителей и каталогами.
CF_PIN_STATE Закрепление состояний файла заполнителя или каталога.
CF_PLACEHOLDER_CREATE_FLAGS Флаги для создания заполнителя на основе каждого заполнителя.
CF_PLACEHOLDER_INFO_CLASS Классы сведений для сведений о заполнителях.
CF_PLACEHOLDER_MANAGEMENT_POLICY Задает политику управления заполнителями для структуры CF_SYNC_POLICIES.
CF_PLACEHOLDER_RANGE_INFO_CLASS Типы диапазона данных файла заполнителей.
CF_PLACEHOLDER_STATE Состояние файла заполнителя или папки.
CF_POPULATION_POLICY_MODIFIER Определяет модификаторы политики заполнения. Это модификатор, который можно использовать с основной политикой:_CF_POPULATION_POLICY_PRIMARY.
CF_POPULATION_POLICY_PRIMARY Позволяет поставщику синхронизации управлять созданием заполнителей каталогов и файлов платформой. Это основная политика.
CF_REGISTER_FLAGS Флаги для регистрации и обновления корневого каталога синхронизации.
CF_REVERT_FLAGS Флаги для восстановления файла заполнителя в обычный файл.
CF_SET_IN_SYNC_FLAGS Флаги состояния синхронизации для файлов-заполнителей и папок.
CF_SET_PIN_FLAGS Флаги закрепления заполнителей.
CF_SYNC_PROVIDER_STATUS Текущее состояние поставщика синхронизации.
CF_SYNC_ROOT_INFO_CLASS Типы корневой информации синхронизации.
CF_UPDATE_FLAGS Флаги для обновления файла заполнителя или каталога.

Функции

CfCloseHandle Закрывает дескриптор файла или каталога, возвращенный CfOpenFileWithOplock. Его не следует использовать со стандартными дескрипторами файлов Win32, только для дескрипторов, используемых в CfApi.h.
CfConnectSyncRoot Инициирует двунаправленный обмен данными между поставщиком синхронизации и API фильтра синхронизации.
CfConvertToPlaceholder Преобразует обычный файл или каталог в файл-заполнитель или каталог.
CfCreatePlaceholders Создает один или несколько новых файлов заполнителей или каталогов в корневом дереве синхронизации.
CfDisconnectSyncRoot Отключает канал связи, созданный cfConnectSyncRoot.
CfExecute Основная точка входа для всех операций с заполнителями на основе ключа подключения. Он предназначен для использования поставщиком синхронизации для реагирования на различные обратные вызовы с платформы.
CfGetCorrelationVector Позволяет поставщику синхронизации запрашивать текущий вектор корреляции для заданного файла заполнителя.
CfGetPlaceholderInfo Возвращает различные характеристики файла-заполнителя или папки.
CfGetPlaceholderRangeInfo Возвращает сведения о диапазоне для файла заполнителя или папки.
CfGetPlaceholderRangeInfoForHydration Возвращает сведения о диапазоне для файла-заполнителя или папки, используя ConnectionKey, TransferKey и FileId в качестве идентификаторов.
CfGetPlaceholderStateFromAttributeTag Возвращает набор состояний заполнителей на основе значений FileAttributes и ReparseTag файла.
CfGetPlaceholderStateFromFileInfo Возвращает набор состояний заполнителей на основе различных сведений о файле.
CfGetPlaceholderStateFromFindData Возвращает набор состояний заполнителей на основе структуры WIN32_FIND_DATA.
CfGetPlatformInfo Возвращает сведения о версии платформы.
CfGetSyncRootInfoByHandle Возвращает различные характеристики корня синхронизации, содержащего заданный файл, указанный дескриптором файла.
CfGetSyncRootInfoByPath Получает различные сведения о корнях синхронизации, заданные в корневом каталоге синхронизации.
CfGetTransferKey Инициирует передачу данных в файл-заполнитель или папку.
CfGetWin32HandleFromProtectedHandle Преобразует защищенный дескриптор в дескриптор Win32, чтобы его можно было использовать со всеми API Win32 на основе дескрипторов.
CfHydratePlaceholder Удаляет файл заполнителя, гарантируя, что указанный диапазон байтов присутствует на диске в заполнителье. Это допустимо только для файлов.
CfOpenFileWithOplock Открывает асинхронный непрозрачный дескриптор для файла или каталога (как для обычных файлов, так и для файлов заполнителей) и настраивает для него правильную блокировку на основе открытых флагов.
CfQuerySyncProviderStatus Запрашивает поставщик синхронизации для получения состояния поставщика.
CfReferenceProtectedHandle Позволяет вызывающей объекту ссылаться на защищенный дескриптор Win32, который можно использовать с API Win32, не использующего CfApi.
CfRegisterSyncRoot Выполняет однократную корневую регистрацию синхронизации.
CfReleaseProtectedHandle Освобождает защищенный дескриптор, на который ссылается CfReferenceProtectedHandle.
CfReleaseTransferKey Освобождает ключ передачи, полученный cfGetTransferKey.
CfReportProviderProgress Позволяет поставщику синхронизации сообщать о ходе выполнения вне диапазона.
CfReportProviderProgress2 Позволяет поставщику синхронизации сообщать о ходе выполнения вне диапазона. Расширяет CfReportProviderProgress с помощью дополнительных параметров.
CfReportSyncStatus Позволяет поставщику синхронизации уведомлять платформу о своем состоянии в указанном корневом каталоге синхронизации без предварительного подключения с помощью вызова CfConnectSyncRoot.
CfRevertPlaceholder Возвращает заполнитель к обычному файлу, убирая все специальные характеристики, такие как тег повторного преобразования, идентификатор файла и т. д.
CfSetCorrelationVector Позволяет поставщику синхронизации указать платформе использовать определенный вектор корреляции для телеметрии в файле заполнителя. Водить описание не обязательно.
CfSetInSyncState Задает синхронизированное состояние для файла-заполнителя или папки.
CfSetPinState При этом задается состояние закрепления заполнителя, используемого для представления намерения пользователя. Любое приложение (а не только поставщик синхронизации) может вызывать эту функцию.
CfUnregisterSyncRoot Отменяет регистрацию ранее зарегистрированного корневого каталога синхронизации.
CfUpdatePlaceholder Обновления характеристики файла заполнителя или каталога.
CfUpdateSyncProviderStatus Обновления текущее состояние поставщика синхронизации.

Структуры

CF_CALLBACK_INFO Содержит общие сведения о обратном вызове.
CF_CALLBACK_PARAMETERS Содержит параметры обратного вызова, такие как смещение файла, длина, флаги и т. д.
CF_CALLBACK_REGISTRATION Обратные вызовы, зарегистрированные поставщиком синхронизации.
CF_FILE_RANGE Указывает диапазон данных в файле заполнителя.
CF_FS_METADATA Файл-заполнитель или метаданные каталога.
CF_HYDRATION_POLICY Указывает основную политику гидратации и ее модификатор.
CF_OPERATION_INFO Сведения об операции с файлом-заполнителем или папкой.
CF_OPERATION_PARAMETERS Параметры операции с файлом-заполнителем или папкой.
CF_PLACEHOLDER_BASIC_INFO Основные сведения о заполнителях.
CF_PLACEHOLDER_CREATE_INFO Содержит сведения о заполнителях для создания новых файлов заполнителей или каталогов.
CF_PLACEHOLDER_STANDARD_INFO Стандартные сведения о заполнителях.
CF_PLATFORM_INFO Возвращает сведения для платформы облачных файлов. Это предназначено для поставщиков синхронизации, работающих в нескольких версиях Windows.
CF_POPULATION_POLICY Указывает основную политику заполнения и ее модификатор.
CF_PROCESS_INFO Содержит сведения о пользовательском процессе.
CF_SYNC_POLICIES Определяет политики синхронизации, используемые корнем синхронизации.
CF_SYNC_REGISTRATION Сведения о поставщике синхронизации и корневом каталоге синхронизации для регистрации.
CF_SYNC_ROOT_BASIC_INFO Основные сведения о корневом каталоге синхронизации.
CF_SYNC_ROOT_PROVIDER_INFO Синхронизация сведений о корневом поставщике.
CF_SYNC_ROOT_STANDARD_INFO Сведения о корневом каталоге стандартной синхронизации.
CF_SYNC_STATUS Используется в структуре CF_OPERATION_INFO для описания состояния указанного корня синхронизации.