Método ISyncMgrHandlerInfo::IsEnabled (syncmgr.h)

Obtém um valor que indica se o manipulador está habilitado.

Sintaxe

HRESULT IsEnabled();

Retornar valor

Tipo: HRESULT

Retorna S_OK se o manipulador estiver habilitado; caso contrário, S_FALSE.

Se o manipulador quiser que o Centro de Sincronização mantenha o estado atual, ele poderá retornar E_NOTIMPL. Se qualquer outro valor for retornado, a Central de Sincronização definirá o estado habilitado do manipulador como o último valor conhecido e habilitará ou desabilitará as tarefas associadas conforme apropriado.

Se o sinalizador SYNCMGR_HCM_QUERY_BEFORE_ENABLE ou SYNCMGR_HCM_QUERY_BEFORE_DISABLE estiver definido na máscara retornada de GetCapabilities, o manipulador deverá gerenciar seu próprio estado habilitado e, portanto, deverá retornar S_OK ou S_FALSE. Qualquer outro valor retornado será considerado um erro.

Comentários

Se um manipulador estiver desabilitado, nem ele nem nenhum de seus itens serão sincronizados pelo Centro de Sincronização. Além disso, muitas das ações possíveis disponíveis para um manipulador, como Sincronização, são removidas ou desabilitadas na interface do usuário da pasta do Centro de Sincronização.

Esse valor está disponível na interface do usuário da pasta como a propriedade System.Sync.Enabled (PKEY_Sync_Enabled).

A Central de Sincronização chama esse método sempre que o método UpdateHandler é chamado.

Exemplos

O exemplo a seguir mostra uma implementação desse método que chama uma função de classe privada para recuperar o estado habilitado.

STDMETHODIMP CMyDeviceHandler::IsEnabled()
{
    // Return a previously-calculated value.
    return (_fIsEnabled ? S_OK : S_FALSE);
}

Requisitos

Confira também

Habilitar

ISyncMgrHandlerInfo