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

Obtém um valor que indica se o manipulador pode ser sincronizado.

Sintaxe

HRESULT IsActive();

Retornar valor

Tipo: HRESULT

Retorna S_OK se o manipulador estiver ativo; 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 do manipulador como o último valor conhecido. Se o último valor conhecido do manipulador nessa situação estiver inativo, o Centro de Sincronização desabilita a tarefa de Instalação . Se o último valor conhecido do manipulador estiver ativo, a tarefa Excluir não será desabilitada.

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

Comentários

Se um manipulador não estiver ativo, ele aparecerá na pasta Configuração de Sincronização. Os manipuladores nessa pasta não podem ser sincronizados. Para mover um manipulador para a pasta do Centro de Sincronização, o usuário seleciona a tarefa De instalação no menu de atalho do manipulador ou no módulo de comando.

Se um manipulador estiver ativo, ele aparecerá na pasta main Central de Sincronização. Um manipulador ativo pode ser sincronizado pelo usuário ou pela interface ISyncMgrControl . Para mover um manipulador para a pasta Configuração de Sincronização, o usuário seleciona a tarefa Excluir no menu de atalho do manipulador ou no módulo de comando.

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 ativo.

STDMETHODIMP CMyDeviceHandler::IsActive()
{
    // Return a previously-calculated value.
    return (_fIsActive ? 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

Confira também

Ativar

ISyncMgrHandlerInfo