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

Gera um valor que indica se o item está habilitado.

Sintaxe

HRESULT IsEnabled();

Retornar valor

Tipo: HRESULT

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

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

Se os sinalizadores SYNCMGR_ICM_QUERY_BEFORE_ENABLE ou SYNCMGR_ICM_QUERY_BEFORE_DISABLE forem definidos na máscara retornada de GetCapabilities, o manipulador deverá gerenciar seu próprio estado habilitado e, portanto, deve retornar S_OK ou S_FALSE. Qualquer outro valor retornado será considerado um erro.

Comentários

Se um item estiver desabilitado, ele não será sincronizado pelo Centro de Sincronização. Além disso, muitas das ações possíveis disponíveis para um item, como Sincronização, são removidas ou desabilitadas na interface do usuário.

Um item pode implementar um estado Desconectado retornando S_FALSE de IsEnabled e definindo o sinalizador SYNCMR_IPM_PREVENT_ENABLE em sua implementação GetPolicies . Isso mostra o item como desabilitado e impede que o usuário o habilite manualmente.

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

O Sync Center 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 CMyDeviceSyncItem::IsEnabled()
{
    // Return a previously-calculated value.
    return (_fIsEnabled ? S_OK : S_FALSE);
}

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	syncmgr.h