Função CfSetPinState (cfapi.h)

Essa função define o estado do pin de um espaço reservado, que representa 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. Defina PinFlags como um dos seguintes valores:

• Se você especificar CF_SET_PIN_FLAG_RECURSE, a plataforma aplicará o estado do pino ao FileHandle e a cada arquivo recursivamente abaixo dele. Esse sinalizador será relevante somente se FileHandle for um identificador para um diretório.
• Se você especificar CF_SET_PIN_FLAG_RECURSE_ONLY, a plataforma aplicará o estado do pino a cada arquivo recursivamente abaixo de FileHandle, mas não ao próprio FileHandle .
• Se você especificar CF_SET_PIN_FLAG_RECURSE_STOP_ON_ERROR, a plataforma interromperá a recursão quando encontrar o primeiro erro. Caso contrário, a plataforma ignorará o erro e continuará a recursão.

Use CF_SET_PIN_FLAG_NONE para especificar nenhum sinalizador.

[in, out, optional] Overlapped

Permite que a chamada seja executada de forma assíncrona. Consulte a seção Comentários para obter mais detalhes.

Valor de retorno

Se essa função for bem-sucedida, ela retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT .

Observações

Quando você especifica e combina um FileHandle assíncrono com Sobreposto, a plataforma pode executar a chamada de forma assíncrona.

Você deve inicializar a estrutura sobreposta com um evento para aguardar. Se essa função retornar HRESULT_FROM_WIN32(ERROR_IO_PENDING),você poderá aguardar usando GetOverlappedResult. Se você não especificar esse parâmetro, a plataforma executará a chamada à API de forma síncrona, independentemente de como você criou o identificador.

Requirements

Consulte também

GetOverlappedResult

CF_PIN_STATE

CF_SET_PIN_FLAGS