en-tête cfapi.h

Cet en-tête est utilisé par l’API Filtre cloud. Pour plus d'informations, consultez les pages suivantes :

• API de filtre cloud

cfapi.h contient les interfaces de programmation suivantes :

Fonctions

CfCloseHandle Ferme le handle de fichier ou de répertoire retourné par CfOpenFileWithOplock. Cela ne doit pas être utilisé avec les handles de fichier Win32 standard, uniquement sur les handles utilisés dans CfApi.h.
CfConnectSyncRoot Initie la communication bidirectionnelle entre un fournisseur de synchronisation et l’API de filtre de synchronisation.
CfConvertToPlaceholder Convertit un fichier/répertoire normal en fichier/répertoire d’espace réservé.
CfCreatePlaceholders Crée un ou plusieurs fichiers d’espace réservé ou répertoires sous une arborescence racine de synchronisation.
CfDisconnectSyncRoot Déconnecte un canal de communication créé par CfConnectSyncRoot.
CfExecute Point d’entrée principal pour toutes les opérations d’espace réservé basées sur une clé de connexion. Il est destiné à être utilisé par un fournisseur de synchronisation pour répondre à différents rappels à partir de la plateforme.
CfGetCorrelationVector Permet au fournisseur de synchronisation d’interroger le vecteur de corrélation actuel pour un fichier d’espace réservé donné.
CfGetPlaceholderInfo Obtient les différentes caractéristiques d’un fichier ou d’un dossier d’espace réservé.
CfGetPlaceholderRangeInfo Obtient des informations de plage sur un fichier ou un dossier d’espace réservé.
CfGetPlaceholderRangeInfoForHydration Obtient des informations de plage sur un fichier ou un dossier d’espace réservé en utilisant ConnectionKey, TransferKey et FileId comme identificateurs.
CfGetPlaceholderStateFromAttributeTag Obtient un ensemble d’états d’espace réservé en fonction des valeurs FileAttributes et ReparseTag du fichier.
CfGetPlaceholderStateFromFileInfo Obtient un ensemble d’états d’espace réservé en fonction des différentes informations du fichier.
CfGetPlaceholderStateFromFindData Obtient un ensemble d’états d’espace réservé en fonction de la structure WIN32_FIND_DATA.
CfGetPlatformInfo Obtient les informations de version de la plateforme.
CfGetSyncRootInfoByHandle Obtient diverses caractéristiques de la racine de synchronisation contenant un fichier donné spécifié par un descripteur de fichier.
CfGetSyncRootInfoByPath Obtient diverses informations de racine de synchronisation en fonction d’un fichier sous la racine de synchronisation.
CfGetTransferKey Initie un transfert de données dans un fichier ou un dossier d’espace réservé.
CfGetWin32HandleFromProtectedHandle Convertit un handle protégé en handle Win32 afin qu’il puisse être utilisé avec toutes les API Win32 basées sur un handle.
CfHydratePlaceholder Hydrate un fichier d’espace réservé en s’assurant que la plage d’octets spécifiée est présente sur le disque dans l’espace réservé. Cela est valide uniquement pour les fichiers.
CfOpenFileWithOplock Ouvre un handle opaque asynchrone dans un fichier ou un répertoire (pour les fichiers normaux et les fichiers d’espace réservé) et configure un verrou d’opération approprié sur celui-ci en fonction des indicateurs ouverts.
CfQuerySyncProviderStatus Interroge un fournisseur de synchronisation pour obtenir l’état du fournisseur.
CfReferenceProtectedHandle Permet à l’appelant de référencer un handle protégé à un handle Win32 qui peut être utilisé avec des API Win32 non CfApi.
CfRegisterSyncRoot Effectue une inscription racine de synchronisation unique.
CfReleaseProtectedHandle Libère un handle protégé référencé par CfReferenceProtectedHandle.
CfReleaseTransferKey Libère une clé de transfert obtenue par CfGetTransferKey.
CfReportProviderProgress Permet à un fournisseur de synchronisation de signaler la progression hors bande.
CfReportProviderProgress2 Permet à un fournisseur de synchronisation de signaler la progression hors bande. Étend CfReportProviderProgress avec des paramètres supplémentaires.
CfReportSyncStatus Permet à un fournisseur de synchronisation d’informer la plateforme de son état sur une racine de synchronisation spécifiée sans avoir à se connecter d’abord avec un appel à CfConnectSyncRoot.
CfRevertPlaceholder Rétablit un espace réservé à un fichier normal, supprimant toutes les caractéristiques spéciales telles que la balise d’analyse, l’identité de fichier, etc.
CfSetCorrelationVector Permet à un fournisseur de synchronisation d’indiquer à la plateforme d’utiliser un vecteur de corrélation spécifique à des fins de télémétrie sur un fichier d’espace réservé. Ce paramètre est facultatif.
CfSetInSyncState Définit l’état de synchronisation d’un fichier ou d’un dossier d’espace réservé.
CfSetPinState Cela définit l’état d’épingle d’un espace réservé, utilisé pour représenter l’intention d’un utilisateur. Toute application (pas seulement le fournisseur de synchronisation) peut appeler cette fonction.
CfUnregisterSyncRoot Annule l’inscription d’une racine de synchronisation précédemment inscrite.
CfUpdatePlaceholder Mises à jour caractéristiques du fichier ou du répertoire d’espace réservé.
CfUpdateSyncProviderStatus Mises à jour l’état actuel du fournisseur de synchronisation.

Structures

CF_CALLBACK_INFO Contient des informations de rappel courantes.
CF_CALLBACK_PARAMETERS Contient des paramètres spécifiques au rappel, tels que le décalage de fichier, la longueur, les indicateurs, etc.
CF_CALLBACK_REGISTRATION Rappels à inscrire par le fournisseur de synchronisation.
CF_FILE_RANGE Spécifie une plage de données dans un fichier d’espace réservé.
CF_FS_METADATA Métadonnées de fichier d’espace réservé ou de répertoire.
CF_HYDRATION_POLICY Spécifie la stratégie d’hydratation principale et son modificateur.
CF_OPERATION_INFO Informations sur une opération sur un fichier ou un dossier d’espace réservé.
CF_OPERATION_PARAMETERS Paramètres d’une opération sur un fichier ou un dossier d’espace réservé.
CF_PLACEHOLDER_BASIC_INFO Informations de base sur les espaces réservés.
CF_PLACEHOLDER_CREATE_INFO Contient des informations d’espace réservé pour la création de nouveaux fichiers ou répertoires d’espace réservé.
CF_PLACEHOLDER_STANDARD_INFO Informations d’espace réservé standard.
CF_PLATFORM_INFO Retourne des informations pour la plateforme de fichiers cloud. Cela est destiné aux fournisseurs de synchronisation s’exécutant sur plusieurs versions de Windows.
CF_POPULATION_POLICY Spécifie la stratégie de remplissage primaire et son modificateur.
CF_PROCESS_INFO Contient des informations sur un processus utilisateur.
CF_SYNC_POLICIES Définit les stratégies de synchronisation utilisées par une racine de synchronisation.
CF_SYNC_REGISTRATION Détails du fournisseur de synchronisation et de la racine de synchronisation à inscrire.
CF_SYNC_ROOT_BASIC_INFO Informations de base sur la racine de synchronisation.
CF_SYNC_ROOT_PROVIDER_INFO Synchroniser les informations du fournisseur racine.
CF_SYNC_ROOT_STANDARD_INFO Informations racines de synchronisation standard.
CF_SYNC_STATUS Utilisé dans une structure de CF_OPERATION_INFO pour décrire l’état d’une racine de synchronisation spécifiée.

Énumérations

CF_CALLBACK_CANCEL_FLAGS Indicateurs de rappel pour annuler l’extraction des données d’un fichier ou d’un dossier d’espace réservé.
CF_CALLBACK_CLOSE_COMPLETION_FLAGS Indicateurs de rappel pour informer un fournisseur de synchronisation qu’un espace réservé sous l’une de ses racines de synchronisation qui a été précédemment ouvert pour l’accès en lecture/écriture/suppression est maintenant fermé.
CF_CALLBACK_DEHYDRATE_COMPLETION_FLAGS Indicateur de rappel pour informer le fournisseur de synchronisation qu’un espace réservé sous l’une de ses racines de synchronisation a été correctement déshydraté.
CF_CALLBACK_DEHYDRATE_FLAGS Indicateurs de rappel pour informer un fournisseur de synchronisation qu’un espace réservé sous l’une de ses racines de synchronisation va être déshydraté.
CF_CALLBACK_DEHYDRATION_REASON Spécifie la raison pour laquelle un fichier cloud a été déshydraté.
CF_CALLBACK_DELETE_COMPLETION_FLAGS Indicateurs de rappel pour informer un fournisseur de synchronisation qu’un espace réservé a été supprimé avec succès.
CF_CALLBACK_DELETE_FLAGS Ce rappel est utilisé pour informer le fournisseur de synchronisation qu’un fichier d’espace réservé ou un répertoire situé sous l’une de ses racines de synchronisation est sur le point d’être supprimé ou non supprimé.
CF_CALLBACK_FETCH_DATA_FLAGS Indicateurs de rappel pour extraire les données d’un fichier ou d’un dossier d’espace réservé.
CF_CALLBACK_FETCH_PLACEHOLDERS_FLAGS Indicateurs permettant d’extraire des informations sur le contenu d’un fichier ou d’un répertoire d’espace réservé.
CF_CALLBACK_OPEN_COMPLETION_FLAGS Indicateurs de rappel pour informer un fournisseur de synchronisation qu’un espace réservé a été correctement ouvert pour l’accès en lecture/écriture/suppression.
CF_CALLBACK_RENAME_COMPLETION_FLAGS Indicateur de rappel pour informer le fournisseur de synchronisation qu’un espace réservé sous l’une de ses racines de synchronisation a été renommé avec succès.
CF_CALLBACK_RENAME_FLAGS Rappelez les indicateurs pour informer le fournisseur de synchronisation qu’un espace réservé sous l’une de ses racines de synchronisation est sur le point d’être renommé ou déplacé.
CF_CALLBACK_TYPE Contient les différents types de rappels utilisés sur les fichiers ou dossiers d’espace réservé.
CF_CALLBACK_VALIDATE_DATA_FLAGS Indicateurs pour valider les données d’un fichier ou d’un répertoire d’espace réservé.
CF_CONNECT_FLAGS Informations supplémentaires qui peuvent être demandées par un fournisseur de synchronisation lorsque ses rappels sont appelés.
CF_CONVERT_FLAGS Indicateurs de conversion de fichier/répertoire/répertoire normal en fichier d’espace réservé/répertoire.
CF_CREATE_FLAGS Indicateurs pour la création d’un fichier ou d’un répertoire d’espace réservé.
CF_DEHYDRATE_FLAGS Indicateurs de déshydratation d’espace réservé.
CF_HARDLINK_POLICY Spécifie si les liens physiques sont autorisés sur les fichiers d’espace réservé.
CF_HYDRATE_FLAGS Indicateurs d’hydratation des données d’espace réservé.
CF_HYDRATION_POLICY_MODIFIER Permet à un fournisseur de synchronisation de contrôler la façon dont les fichiers d’espace réservé doivent être hydratés par la plateforme. Il s’agit d’un modificateur qui peut être utilisé avec la stratégie principale:_CF_HYDRATION_POLICY_PRIMARY.
CF_HYDRATION_POLICY_PRIMARY Permet à un fournisseur de synchronisation de contrôler la façon dont les fichiers d’espace réservé doivent être hydratés par la plateforme. Il s’agit de la stratégie principale.
CF_IN_SYNC_STATE Spécifie l’état de synchronisation pour les fichiers et dossiers d’espace réservé.
CF_INSYNC_POLICY Stratégie permettant à un fournisseur de synchronisation de contrôler quand la plateforme doit effacer l’état synchronisé sur un fichier d’espace réservé ou un répertoire.
CF_OPEN_FILE_FLAGS Indicateurs permettant de demander diverses autorisations lors de l’ouverture d’un fichier.
CF_OPERATION_ACK_DATA_FLAGS Indicateurs permettant de vérifier et d’accuser réception des données d’un fichier ou d’un dossier d’espace réservé.
CF_OPERATION_ACK_DEHYDRATE_FLAGS Indicateurs permettant d’accuser réception de la déshydratation d’un fichier ou d’un répertoire d’espace réservé.
CF_OPERATION_ACK_DELETE_FLAGS Indicateurs permettant d’accuser réception de la suppression d’un fichier ou d’un répertoire d’espace réservé.
CF_OPERATION_ACK_RENAME_FLAGS Indicateurs permettant d’accuser réception du nom du fichier d’espace réservé ou du répertoire.
CF_OPERATION_RESTART_HYDRATION_FLAGS Indicateurs permettant de redémarrer l’hydratation des données sur un fichier ou un dossier d’espace réservé.
CF_OPERATION_RETRIEVE_DATA_FLAGS Indicateurs permettant de récupérer les données d’un fichier ou d’un dossier d’espace réservé.
CF_OPERATION_TRANSFER_DATA_FLAGS Indicateurs permettant de transférer des données afin d’hydrater un fichier ou un dossier d’espace réservé.
CF_OPERATION_TRANSFER_PLACEHOLDERS_FLAGS Indicateurs permettant de spécifier le comportement lors du transfert d’un fichier ou d’un répertoire d’espace réservé.
CF_OPERATION_TYPE Types d’opérations qui peuvent être effectuées sur des fichiers d’espace réservé et des répertoires.
CF_PIN_STATE Épingler les états d’un fichier ou d’un répertoire d’espace réservé.
CF_PLACEHOLDER_CREATE_FLAGS Indicateurs pour la création d’un espace réservé par place.
CF_PLACEHOLDER_INFO_CLASS Classes d’informations pour les informations d’espace réservé.
CF_PLACEHOLDER_MANAGEMENT_POLICY Spécifie une stratégie de gestion des espaces réservés pour une structure CF_SYNC_POLICIES.
CF_PLACEHOLDER_RANGE_INFO_CLASS Types de la plage de données de fichier d’espace réservé.
CF_PLACEHOLDER_STATE État d’un fichier ou dossier d’espace réservé.
CF_POPULATION_POLICY_MODIFIER Définit les modificateurs de stratégie de population. Il s’agit d’un modificateur qui peut être utilisé avec la stratégie principale:_CF_POPULATION_POLICY_PRIMARY.
CF_POPULATION_POLICY_PRIMARY Permet à un fournisseur de synchronisation de contrôler la façon dont les répertoires et fichiers d’espace réservé doivent être créés par la plateforme. Il s’agit de la stratégie principale.
CF_REGISTER_FLAGS Indicateurs pour l’inscription et la mise à jour d’une racine de synchronisation.
CF_REVERT_FLAGS Indicateurs de restauration d’un fichier d’espace réservé à un fichier normal.
CF_SET_IN_SYNC_FLAGS Indicateurs d’état de synchronisation pour les fichiers et dossiers d’espace réservé.
CF_SET_PIN_FLAGS Indicateurs d’épingle de l’espace réservé.
CF_SYNC_PROVIDER_STATUS État actuel d’un fournisseur de synchronisation.
CF_SYNC_ROOT_INFO_CLASS Types d’informations racine de synchronisation.
CF_UPDATE_FLAGS Indicateurs pour la mise à jour d’un fichier ou d’un répertoire d’espace réservé.