Funzione CfSetPinState (cfapi.h)

Questa funzione imposta lo stato del pin di un segnaposto, che rappresenta la finalità di un utente. Qualsiasi applicazione, non solo il provider di sincronizzazione, può chiamare questa funzione.

Sintassi

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

Parametri

[in] FileHandle

Handle del file segnaposto. La piattaforma sincronizza correttamente l'operazione con altre richieste attive. Un attributo o un handle di accesso non è sufficiente. Il chiamante deve avere READ_DATA o WRITE_DAC l'accesso al segnaposto. In caso contrario, l'operazione ha esito negativo con STATUS_CLOUD_FILE_ACCESS_DENIED.

[in] PinState

Stato del segnaposto del file segnaposto. Per un elenco di valori PinState validi, vedere CF_PIN_STATE.

[in] PinFlags

Flag di stato del pin. Impostare PinFlags su uno dei valori seguenti:

• Se si specifica CF_SET_PIN_FLAG_RECURSE, la piattaforma applica lo stato del pin a FileHandle e a ogni file in modo ricorsivo. Questo flag è rilevante solo se FileHandle è un handle per una directory.
• Se si specifica CF_SET_PIN_FLAG_RECURSE_ONLY, la piattaforma applica lo stato del pin a ogni file in modo ricorsivo sotto FileHandle, ma non a FileHandle stesso.
• Se si specifica CF_SET_PIN_FLAG_RECURSE_STOP_ON_ERROR, la piattaforma arresta la ricorsione quando rileva il primo errore. In caso contrario, la piattaforma ignora l'errore e continua la ricorsione.

Usare CF_SET_PIN_FLAG_NONE per specificare nessun flag.

[in, out, optional] Overlapped

Consente di eseguire la chiamata in modo asincrono. Per altri dettagli, vedere la sezione Osservazioni .

Valore restituito

Se questa funzione ha esito positivo, restituisce S_OK. In caso contrario, restituisce un codice di errore HRESULT .

Osservazioni:

Quando si specifica e si combina un oggetto FileHandle asincrono con Overlapped, la piattaforma può eseguire la chiamata in modo asincrono.

È necessario inizializzare la struttura sovrapposta con un evento di attesa. Se questa funzione restituisce HRESULT_FROM_WIN32(ERROR_IO_PENDING),è possibile attendere usando GetOverlappedResult. Se non si specifica questo parametro, la piattaforma esegue la chiamata API in modo sincrono, indipendentemente dalla modalità di creazione dell'handle.

Requisiti

Requisito	Value
Client minimo supportato	Windows 10, versione 1709 [solo app desktop]
Server minimo supportato	Windows Server 2016 [solo app desktop]
Piattaforma di destinazione	Windows
Header	cfapi.h
Library	CldApi.lib
DLL	CldApi.dll

Vedere anche

GetOverlappedResult

CF_PIN_STATE

CF_SET_PIN_FLAGS