Fonction CfHydratePlaceholder (cfapi.h)

Article
03/02/2024

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é. Cette option est valide uniquement pour les fichiers.

Syntaxe

HRESULT CfHydratePlaceholder(
  [in]                HANDLE           FileHandle,
  [in]                LARGE_INTEGER    StartingOffset,
  [in]                LARGE_INTEGER    Length,
  [in]                CF_HYDRATE_FLAGS HydrateFlags,
  [in, out, optional] LPOVERLAPPED     Overlapped
);

Paramètres

[in] FileHandle

Handle du fichier d’espace réservé à hydrater. Un attribut ou un handle sans accès est suffisant.

[in] StartingOffset

Décalage du point de départ des données du fichier d’espace réservé.

[in] Length

Longueur, en octets, du fichier d’espace réservé dont les données doivent être disponibles localement sur le disque une fois l’API terminée. Une longueur de CF_EOF (définie comme -1) signifie la fin du fichier. Pour toute sous-plage qui n’est pas présente dans l’espace réservé, la plateforme extrait les données du fournisseur de synchronisation et les stocke sur le disque dans l’espace réservé.

[in] HydrateFlags

Indicateurs d’hydratation de l’espace réservé. HydrateFlags doit être défini sur CF_HYDRATE_FLAG_NONE.

[in, out, optional] Overlapped

Lorsqu’il est spécifié et combiné avec un FileHandle asynchrone, le chevauchement permet à la plateforme d’effectuer l’appel CfHydratePlaceholder de manière asynchrone. Pour plus d’informations, consultez les remarques .

Si ce n’est pas spécifié, la plateforme effectue l’appel d’API de manière synchrone, quelle que soit la façon dont le handle a été créé.

Valeur retournée

Si cette fonction réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

L’appelant doit disposer d’un accès READ_DATA ou WRITE_DAC à l’espace réservé pour être hydraté.

Si l’API retourne HRESULT_FROM_WIN32(ERROR_IO_PENDING) lors de l’utilisation du chevauchement asynchrone, l’appelant peut attendre à l’aide de GetOverlappedResult.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 10, version 1709 [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2016 (applications de bureau uniquement)
Plateforme cible	Windows
En-tête	cfapi.h
Bibliothèque	CldApi.lib
DLL	CldApi.dll

Voir aussi

GetOverlappedResult

Partager via