Função CfSetPinState (cfapi.h)
Isso define o estado de fixação de um espaço reservado, usado para representar a intenção de um usuário. Qualquer aplicativo (não apenas o provedor de sincronização) pode chamar essa função.
Sintaxe
HRESULT CfSetPinState(
[in] HANDLE FileHandle,
[in] CF_PIN_STATE PinState,
[in] CF_SET_PIN_FLAGS PinFlags,
[in, out, optional] LPOVERLAPPED Overlapped
);
Parâmetros
[in] FileHandle
O identificador do arquivo de espaço reservado. A plataforma sincroniza corretamente a operação com outras solicitações ativas. Um identificador de atributo ou sem acesso é suficiente. O chamador deve ter acesso READ_DATA ou WRITE_DAC ao espaço reservado; caso contrário, a operação falhará com STATUS_CLOUD_FILE_ACCESS_DENIED.
[in] PinState
O estado do pin do arquivo de espaço reservado. Para obter uma lista de valores pinstate válidos, consulte CF_PIN_STATE.
[in] PinFlags
Os sinalizadores de estado de fixação. PinFlags pode ser definido com os seguintes valores:
- Se CF_PIN_FLAG_RECURSE for especificado, a plataforma aplicará o estado do pino a FileHandle e todos os arquivos recursivamente abaixo dele (relevante somente se FileHandle for um identificador para um diretório).
- Se CF_PIN_FLAG_RECURSE_ONLY for especificado, a plataforma aplicará o estado do pin a cada arquivo recursivamente abaixo de FileHandle, mas não ao Próprio FileHandle .
- Se CF_PIN_FLAG_RECURSE_STOP_ERROR for especificado, a plataforma interromperá a recursão ao encontrar o primeiro erro. Caso contrário, a plataforma ignora o erro e continua a recursão.
[in, out, optional] Overlapped
Permite que a chamada seja executada de forma assíncrona. Consulte a seção Comentários para obter mais detalhes.
Retornar valor
Se essa função for bem-sucedida, ela retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.
Comentários
Quando especificado e combinado com um FileHandle assíncrono, Overlapped permite que a plataforma execute a chamada de forma assíncrona.
O chamador deve ter inicializado a estrutura sobreposta com um evento para aguardar. Se isso retornar HRESULT_FROM_WIN32(ERROR_IO_PENDING), o chamador poderá aguardar usando GetOverlappedResult. Se não for especificado, a plataforma executará a chamada à API de forma síncrona, independentemente de como o identificador foi criado.
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte | Windows 10, versão 1709 [somente aplicativos da área de trabalho] |
| Servidor mínimo com suporte | Windows Server 2016 [somente aplicativos da área de trabalho] |
| Plataforma de Destino | Windows |
| Cabeçalho | cfapi.h |
| Biblioteca | CldApi.lib |
| DLL | CldApi.dll |