Funzione CfSetPinState (cfapi.h)

Questo imposta lo stato del pin di un segnaposto utilizzato per rappresentare 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, altrimenti l'operazione non sarà riuscita con STATUS_CLOUD_FILE_ACCESS_DENIED.

[in] PinState

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

[in] PinFlags

Flag di stato del pin. PinFlags può essere impostato sui valori seguenti:

• Se viene specificato CF_PIN_FLAG_RECURSE , la piattaforma applica lo stato del pin a FileHandle e ogni file ricorsivamente sotto di esso (rilevante solo se FileHandle è un handle in una directory).
• Se viene specificato CF_PIN_FLAG_RECURSE_ONLY , la piattaforma applica lo stato del pin a ogni file ricorsivo sotto FileHandle, ma non a FileHandle stesso.
• Se viene specificato CF_PIN_FLAG_RECURSE_STOP_ERROR , la piattaforma arresterà la ricorsione quando si verifica il primo errore. In caso contrario, la piattaforma ignora l'errore e continua la ricorsione.

[in, out, optional] Overlapped

Consente di eseguire la chiamata in modo asincrono. Per altre informazioni, vedere la sezione Osservazioni .

Valore restituito

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

Commenti

Se specificato e combinato con un FileHandle asincrono, la sovrapposizione consente alla piattaforma di eseguire la chiamata in modo asincrono.

Il chiamante deve aver inizializzato la struttura sovrapposta con un evento da attendere. Se restituisce HRESULT_FROM_WIN32(ERROR_IO_PENDING), il chiamante può attendere l'uso di GetOverlappedResult. Se non specificato, la piattaforma eseguirà la chiamata API in modo sincrono, indipendentemente dalla modalità di creazione dell'handle.

Requisiti

Vedi anche

GetOverlappedResult

CF_PIN_STATE

CF_SET_PIN_FLAGS