CfSetPinState, fonction (cfapi.h)

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.

Syntaxe

HRESULT CfSetPinState(
  [in]                HANDLE           FileHandle,
  [in]                CF_PIN_STATE     PinState,
  [in]                CF_SET_PIN_FLAGS PinFlags,
  [in, out, optional] LPOVERLAPPED     Overlapped
);

Paramètres

[in] FileHandle

Handle du fichier d’espace réservé. La plateforme synchronise correctement l’opération avec d’autres requêtes actives. Un attribut ou un handle sans accès est suffisant. L’appelant doit avoir READ_DATA ou WRITE_DAC accès à l’espace réservé, sinon l’opération échoue avec STATUS_CLOUD_FILE_ACCESS_DENIED.

[in] PinState

État d’épingle du fichier d’espace réservé. Pour obtenir la liste des valeurs PinState valides, consultez CF_PIN_STATE.

[in] PinFlags

Indicateurs d’état de broche. PinFlags peut être défini sur les valeurs suivantes :

• Si CF_PIN_FLAG_RECURSE est spécifié, la plateforme applique l’état d’épingle à FileHandle et à chaque fichier en dessous de manière récursive (applicable uniquement si FileHandle est un handle d’un répertoire).
• Si CF_PIN_FLAG_RECURSE_ONLY est spécifié, la plateforme applique l’état d’épingle à chaque fichier de manière récursive sous FileHandle, mais pas à FileHandle lui-même.
• Si CF_PIN_FLAG_RECURSE_STOP_ERROR est spécifié, la plateforme arrête la récursivité lors de la première erreur. Sinon, la plateforme ignore l’erreur et poursuit la récursivité.

[in, out, optional] Overlapped

Autorise l’exécution asynchrone de l’appel. Pour plus d’informations, consultez la section Remarques .

Valeur retournée

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

Remarques

Lorsqu’il est spécifié et combiné avec un FileHandle asynchrone, Le chevauchement permet à la plateforme d’effectuer l’appel de manière asynchrone.

L’appelant doit avoir initialisé la structure superposée avec un événement à attendre. Si cela retourne HRESULT_FROM_WIN32(ERROR_IO_PENDING), l’appelant peut alors attendre à l’aide de GetOverlappedResult. Si elle n’est pas spécifiée, la plateforme effectue l’appel d’API de manière synchrone, quelle que soit la façon dont le handle a été créé.

Configuration requise

Voir aussi

GetOverlappedResult

CF_PIN_STATE

CF_SET_PIN_FLAGS