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 Флаги для обновления заполнителя файла или каталога.

Functions

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.
CfReportProviderProgresss Позволяет поставщику синхронизации сообщать о ходе выполнения вне диапазона.
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 для описания состояния указанного корневого каталога синхронизации.