CfSetPinState, fonction (cfapi.h)

Cette fonction définit l’état d’épingle d’un espace réservé, qui représente 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 d’épingle. Définissez PinFlags sur l’une des valeurs suivantes :

• Si vous spécifiez CF_SET_PIN_FLAG_RECURSE, la plateforme applique l’état d’épingle à FileHandle et chaque fichier de manière récursive en dessous. Cet indicateur est pertinent uniquement si FileHandle est un handle vers un répertoire.
• Si vous spécifiez CF_SET_PIN_FLAG_RECURSE_ONLY, la plateforme applique l’état d’épingle à chaque fichier de manière récursive sous FileHandle, mais pas à FileHandle lui-même.
• Si vous spécifiez CF_SET_PIN_FLAG_RECURSE_STOP_ON_ERROR, la plateforme arrête la récursivité lorsqu’elle rencontre la première erreur. Sinon, la plateforme ignore l’erreur et continue la récursivité.

Utilisez CF_SET_PIN_FLAG_NONE pour spécifier aucun indicateur.

[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

Lorsque vous spécifiez et combinez un FileHandle asynchrone avec chevauchement, la plateforme peut effectuer l’appel de façon asynchrone.

Vous devez initialiser la structure superposée avec un événement à attendre. Si cette fonction retourne HRESULT_FROM_WIN32(ERROR_IO_PENDING),vous pouvez attendre à l’aide de GetOverlappedResult. Si vous ne spécifiez pas ce paramètre, la plateforme effectue l’appel d’API de manière synchrone, quelle que soit la façon dont vous avez créé le handle.

Spécifications

Voir aussi

GetOverlappedResult

CF_PIN_STATE

CF_SET_PIN_FLAGS