Método ISyncMgrControl::EnableItem (syncmgr.h)

Habilita ou desabilita um item de sincronização gerenciado por um manipulador especificado.

Sintaxe

HRESULT EnableItem(
  [in] BOOL                  fEnable,
  [in] LPCWSTR               pszHandlerID,
  [in] LPCWSTR               pszItemID,
  [in] HWND                  hwndOwner,
  [in] SYNCMGR_CONTROL_FLAGS nControlFlags
);

Parâmetros

[in] fEnable

Tipo: BOOL

TRUE para habilitar; FALSE para desabilitar.

[in] pszHandlerID

Tipo: LPCWSTR

Um ponteiro para um buffer que contém a ID exclusiva do manipulador. Essa cadeia de caracteres tem o comprimento máximo MAX_SYNCMGR_ID incluindo o caractere nulo de terminação.

[in] pszItemID

Tipo: LPCWSTR

Um ponteiro para um buffer que contém a ID exclusiva do item. Essa cadeia de caracteres tem o comprimento máximo MAX_SYNCMGR_ID incluindo o caractere nulo de terminação.

[in] hwndOwner

Digite: HWND

Um identificador para uma janela que pode ser usada pelo item para exibir qualquer interface do usuário necessária. Esse valor pode ser NULL.

[in] nControlFlags

Tipo: SYNCMGR_CONTROL_FLAGS

Um valor da enumeração SYNCMGR_CONTROL_FLAGS especificando se a habilitação ou desabilitação do item deve ser executada de forma síncrona ou assíncrona.

Retornar valor

Tipo: HRESULT

Se o método for bem-sucedido, ele retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

Um item habilitado é um item que pode ser sincronizado.

Se o item especificado retornar SYNCMGR_ICM_QUERY_BEFORE_ENABLE ou SYNCMGR_ICM_QUERY_BEFORE_DISABLE na máscara retornada do método GetCapabilities , o usuário receberá uma caixa de diálogo de confirmação solicitada antes que o item seja habilitado ou desabilitado. Se nenhuma interface do usuário de consulta for solicitada ou quando o usuário confirmar a operação, o método Enable do item será chamado.

Se SYNCMGR_CF_WAIT estiver definido no parâmetro nControlFlags , EnableItem não retornará até que o Sync Center tenha processado essa notificação.

Exemplos

O exemplo a seguir mostra o uso de ISyncMgrControl::EnableHandler pelo procedimento de um manipulador.

void MiscProc(...)
{
    ...

    // Get the Sync Center control object.
    ISyncMgrControl *pControl = NULL;
    
    hr = CoCreateInstance(CLSID_SyncMgrControl, 
                          CLSCTX_SERVER, 
                          IID_PPV_ARGS(&pControl));
    if (SUCCEEDED(hr))
    {
        // Tell Sync Center to disable the item.
        hr = pControl->EnableItem(FALSE, 
                                  s_szMySyncHandlerID,
                                  s_szMySyncHandlerMusicContentID, 
                                  hwnd,
                                  SYNCMGR_CF_WAIT);
        pControl->Release();
    }

    ...

}

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