Функция CfExecute (cfapi.h)
Точка входа main для всех операций с заполнителями на основе ключа подключения. Он предназначен для использования поставщиком синхронизации для реагирования на различные обратные вызовы с платформы.
Синтаксис
HRESULT CfExecute(
[in] const CF_OPERATION_INFO *OpInfo,
[in, out] CF_OPERATION_PARAMETERS *OpParams
);
Параметры
[in] OpInfo
Сведения об операции с заполнителем.
[in, out] OpParams
Параметры операции с заполнителем.
Возвращаемое значение
Если эта функция выполняется успешно, она возвращает .S_OK
В противном случае возвращается код ошибки HRESULT .
Комментарии
Допустимый вызов CfExecute сбрасывает таймеры всех ожидающих запросов обратного вызова, относящихся к одному процессу поставщика синхронизации.
CfExecute принимает два аргумента переменного размера, т. е. CF_OPERATION_INFO и CF_OPERATION_PARAMETERS, при этом один идентифицирует тип операции, а другой предоставляет подробные параметры операции. Оба аргумента начинаются с поля StructSize в начале соответствующих структур. Абоненты CfExecute отвечают за точный учет размера структуры.
Платформа предоставляет ConnectionKey, TransferKey и CorrelationVector для всех функций обратного вызова, зарегистрированных в CfConnectSyncRoot. Кроме того, поставщики синхронизации могут получить TransferKey с помощью CfGetTransferKey и CorrelationVector с помощью CfGetCorrelationVector.
При необходимости поставщики синхронизации могут предоставить платформе BLOB-объекты состояния синхронизации. Если в поле SyncStatus в CF_OPERATION_INFO задан указатель, отличный от NULL, его содержимое будет храниться в файле до удаления последнего дескриптора. Платформа будет запрашивать эти сведения при любых неудачных операциях с заполнителем облачного файла. Если он доступен, платформа будет использовать предоставленные сведения для создания более значимого и практического сообщения для пользователя.
Если в поле SyncStatus в CF_OPERATION_INFO задан пустой указатель, платформа очистит ранее заданное состояние синхронизации (если оно существует).
Все операции можно выполнять в произвольном контексте потока в процессе поставщика синхронизации.
Требования
Требование | Значение |
---|---|
Минимальная версия клиента | Windows 10, версия 1709 [только классические приложения] |
Минимальная версия сервера | Windows Server 2016 [только классические приложения] |
Целевая платформа | Windows |
Header | cfapi.h |
Библиотека | CldApi.lib |
DLL | CldApi.dll |